The SolarUser OCPP API supports sending OCPP messages to connected chargers via the SolarUser /instr/add instruction API. All standard OCPP messages that can be initiated by an OCPP Central System are supported. This document has documentation on the most common messages for convenience.

Any OCPP response message sent by a charger back to SolarNetwork will be stored with the SolarNetwork instruction itself in the resultParameters property. You can use the SolarUser /instr/view API to see the instruction status and result, when it becomes available.

For OCPP 1.6, the instruction topic must be OCPP_v16, e.g. the endpoint to use is /instr/add/OCPP_v16. The following request properties are common to all requests:

Each supported OCPP v1.6 message requires a specific params.action value and often additional parameters. The additional parameters can be provided either via the params.msg value, as a full OCPP v1.6 JSON object string, or as additional instruction parameters that match the OCPP v1.6 JSON message property names. When using params.msg the JSON should not include the action, chargePointId, or chargerIdentifier properties in the JSON value; those must be specified as normal instruction parameter values.

For example, you could send a ChangeAvailability message to a charger using the params.msg JSON value like this (note now the params.msg value is a JSON-escaped string value, not nested JSON):

{
  "nodeId": "1",
  "params": {
    "action": "ChangeAvailability",
    "chargerIdentifier": "CP0001",
    "msg": "{\"connectorId\":1,\"type\":\"Inoperative\"}"
  }
}

Or you could send the same message using additional instruction parameters, like this:

{
  "nodeId": "1",
  "params": {
    "action": "ChangeAvailability",
    "chargerIdentifier": "CP0001",
    "connectorId": "1",
    "type": "Inoperative"
  }
}

This latter approach can be useful for simple OCPP messages, while more complex messages are easier to encode as JSON in the params.msg parameter.

The following enumerations are used across different OCPP 1.6 messages.

The ChargingRateUnitType enumeration contains the following values:

The RecurrencyKindType enumeration contains the following values:

This section outlines the OCPP v1.6 messages most relevant to SolarNetwork.

The ChangeAvailabilty action provides a way to toggle a charge point connector on/off. See section 5.2 of the OCPP 1.6 specification for more information.

The following additional params values are defined for this action:

An example POST to /solaruser/api/v1/sec/instr/add/OCPP_v16 looks like this:

{
  "nodeId": "1",
  "params": {
    "action": "ChangeAvailability",
    "chargerIdentifier": "CP0001",
    "msg": "{\"connectorId\":1,\"type\":\"Inoperative\"}"
  }
}

The RemoteStartTransaction action provides a way to initiate a charging session remotely. See section 5.11 of the OCPP 1.6 specification for more information.

The following additional params values are defined for this action:

An example POST to /solaruser/api/v1/sec/instr/add/OCPP_v16 looks like this:

{
  "nodeId": "1",
  "params": {
    "action": "RemoteStartTransaction",
    "chargerIdentifier": "CP0001",
    "msg": "{\"connectorId\":1,\"idTag\":\"AF013D4AFD\"}"
  }
}

The RemoteStopTransaction action provides a way to stop a charging session remotely. See section 5.12 of the OCPP 1.6 specification for more information.

The following additional params values are defined for this action:

An example POST to /solaruser/api/v1/sec/instr/add/OCPP_v16 looks like this:

{
  "nodeId": "1",
  "params": {
    "action": "RemoteStopTransaction",
    "chargerIdentifier": "CP0001",
    "msg": "{\"transactionId\":12345}"
  }
}

The SetChargingProfile action provides a way to set a charge point's charging profile. See section 5.16 of the OCPP 1.6 specification for more information.

The following additional params values are defined for this action:

An example POST to /solaruser/api/v1/sec/instr/add/OCPP_v16 looks like this (note that the msg value is wrapped across multiple lines for legibility; a real request would not be wrapped):

{
  "nodeId": "1",
  "params": {
    "action": "SetChargingProfile",
    "chargerIdentifier": "CP0001",
    "msg": "{\"connectorId\":1,\"csChargingProfiles\":{\"chargingProfileId\":1,
    		\"stackLevel\":0,\"chargingProfilePurpose\":\"ChargePointMaxProfile\",
    		\"chargingProfileKind\":\"ChargePointMaxProfile\",
    		\"chargingSchedule\":{\"chargingRateUnit\":\"W\",\"chargingSchedulePeriod\":[
    		{\"startPeriod\":0,\"limit\":5000},{\"startPeriod\":43200,\"limit\":2000}]}}}"
  }
}

A ChargingProfile object contains the following propertyes:

The ChargingProfilePurposeType enumeration contains the following values:

The ChargingProfileKindType enumeration contains the following values:

A ChargingSchedule object contains the following properties:

The ChargingProfileKindType enumeration contains the following values:

A ChargingSchedulePeriod object contains the following properties:

The TriggerMessage action provides a way request a charge point to send a specific message back to SolarNetwork. See section 5.17 of the OCPP 1.6 specification for more information.

The following additional params values are defined for this action:

An example POST to /solaruser/api/v1/sec/instr/add/OCPP_v16 looks like this:

{
  "nodeId": "1",
  "params": {
    "action": "TriggerMessage",
    "chargerIdentifier": "CP0001",
    "msg": "{\"requestedMessage\":\"MeterValues\",\"connectorId\":1}"
  }
}

The MessageTrigger enumeration contains the following values: