The CatchpennyAPI allows you to remotely control and monitor a Catchpenny Electric Energy Storage System (E2S2).
Secure connection (TLS) is available through port 8883.
Provide your API key as the user and leave pw empty
Channel for requesting system info
publishing to this channel causes system info request
The ID of the E2S2 Unit
Accepts the following message:
System information request message for the addressed E2S2
{
"TimeStamp": "2019-08-24T14:15:22Z"
}
Channel for publishing system information
System information of the E2S2 unit
The ID of the E2S2 Unit
Accepts the following message:
{
"TimeStamp": "2019-08-24T14:15:22Z",
"FirmwareVersion": "string",
"SystemModel": "string",
"SerialNumber": "string",
"SystemVersion": "string"
}
Channel for requesting system configuration information
publishing to this channel causes config information request
The ID of the E2S2 Unit
Accepts the following message:
Configuration information request message for the addressed E2S2
{
"TimeStamp": "2019-08-24T14:15:22Z"
}
Channel for publishing configuration information information
Configuration information of the E2S2 unit
The ID of the E2S2 Unit
Accepts the following message:
{
"TimeStamp": "2019-08-24T14:15:22Z",
"NumberOfCHargers": 0,
"NumberOfDischargers": 0,
"MaxChargingPower": 0,
"MaxDischargingPower": 0,
"EnergyCapcity": 0
}
Channel for requesting status update from E2S2
Request status update on StatusUpdate channel via publishin to this channel
The ID of the E2S2 Unit
Accepts the following message:
Status information request message for the addressed E2S2
{
"TimeStamp": "2019-08-24T14:15:22Z"
}
Channel for publishing status updates
Status update of the E2S2 unit
The ID of the E2S2 Unit
Accepts the following message:
{
"TimeStamp": "2019-08-24T14:15:22Z",
"NumberOfRegisteredErrors": 0,
"MaxCriticalityLevel": "Debug",
"CatchpennyStatus": "string"
}
Channel for the query of the managed catchpenny devices in the E2S2 system(chargers, dischargers, batteries)
publishing to this channel causes a catchpenny device query
The ID of the E2S2 Unit
Accepts the following message:
Catchpenny devices query request message for the addressed E2S2
{
"TimeStamp": "2019-08-24T14:15:22Z"
}
Channel for publishing the list of managed catchpenny devices (chargers, dischargers, batteries)
Json lists of managed catchpenny devices
The ID of the E2S2 Unit
Accepts the following message:
List of catchpenny devices managed by the E2S2
{
"TimeStamp": "2019-08-24T14:15:22Z"
}
Channel for requesting a specific charger device data
publishing to this channel causes charger device data query
The ID of the E2S2 Unit
Accepts the following message:
Charger device data request message for the addressed E2S2
{
"TimeStamp": "2019-08-24T14:15:22Z"
}
Channel for publishing charger device data
Charger device data messages
The ID of the E2S2 Unit
Accepts the following message:
{
"TimeStamp": "2019-08-24T14:15:22Z",
"ChargerId": 0,
"PowerACL1": 0,
"PowerACL2": 0,
"PowerACL3": 0,
"VoltageACL1": 0,
"VoltageACL2": 0,
"VoltageACL3": 0,
"CurrentACL1": 0,
"CurrentACL2": 0,
"CurrentACL3": 0,
"Temperature": 0,
"DCVoltage": 0,
"DCCurrent": 0,
"Status": "string",
"Error": "string"
}
Channel for requesting a specific discharger device data
publishing to this channel causes discharger device data query
The ID of the E2S2 Unit
Accepts the following message:
Charger device data request message for the addressed E2S2
{
"TimeStamp": "2019-08-24T14:15:22Z"
}
Channel for publishing discharger device data
discharger device data
The ID of the E2S2 Unit
Accepts the following message:
{
"TimeStamp": "2019-08-24T14:15:22Z",
"ChargerId": 0,
"PowerACL1": 0,
"PowerACL2": 0,
"PowerACL3": 0,
"VoltageACL1": 0,
"VoltageACL2": 0,
"VoltageACL3": 0,
"CurrentACL1": 0,
"CurrentACL2": 0,
"CurrentACL3": 0,
"Temperature": 0,
"DCVoltage": 0,
"DCCurrent": 0,
"Status": "string",
"Error": "string"
}
Channel for requesting a specific battery device data
publishing to this channel causes battery device data query
The ID of the E2S2 Unit
Accepts the following message:
Battery device data request message for the addressed E2S2
{
"TimeStamp": "2019-08-24T14:15:22Z"
}
Channel for publishing battery device data
battery device data messages
The ID of the E2S2 Unit
Accepts the following message:
{
"TimeStamp": "2019-08-24T14:15:22Z",
"MinCellVoltage": 0,
"MaxCellVoltage": 0,
"AverageCellVoltage": 0,
"MinCellTemperature": 0,
"MaxCellTemperature": 0,
"AverageCellTemperature": 0,
"StateOfCharge": 0,
"StateOfHealth": 0,
"Status": "string",
"Error": "string"
}
Channel for requesting power from the catchpenny TODO - update this for system - catchpenny PowerRequest
power request
The ID of the E2S2 Unit
Accepts the following message:
Message for requesting power from the addressed E2S2
{
"TimeStamp": "2019-08-24T14:15:22Z",
"Power": 0
}
Channel which is used by the IQHOME gateway to communicate modbus data
The ID of the IQHOME gateway
Accepts the following message:
Message from the IQHOME gateway containing the Modbus read response
{
"TimeStamp": "2019-08-24T14:15:22Z"
}
Channel for publishing L1 power of an asset to OpenRemote
Realm on OpenRemote where the target asset is listed
Client ID of the MQTT connection between the OpenRemote MQTT broker and the client components
ID of the OpenRemote asset
Accepts the following message:
Message to set the power of the associated OpenRemote assets
Channel for publishing L2 power of an asset to OpenRemote
Realm on OpenRemote where the target asset is listed
Client ID of the MQTT connection between the OpenRemote MQTT broker and the client components
ID of the OpenRemote asset
Accepts the following message:
Message to set the power of the associated OpenRemote assets
Channel for publishing L3 power of an asset to OpenRemote
Realm on OpenRemote where the target asset is listed
Client ID of the MQTT connection between the OpenRemote MQTT broker and the client components
ID of the OpenRemote asset
Accepts the following message:
Message to set the power of the associated OpenRemote assets
Channel for publishing 3 or 1 phase power of an asset to OpenRemote
Realm on OpenRemote where the target asset is listed
Client ID of the MQTT connection between the OpenRemote MQTT broker and the client components
ID of the OpenRemote asset
Accepts the following message:
Message to set the power of the associated OpenRemote assets
Channel for publishing L1 reactive of an asset to OpenRemote
Realm on OpenRemote where the target asset is listed
Client ID of the MQTT connection between the OpenRemote MQTT broker and the client components
ID of the OpenRemote asset
Accepts the following message:
Message to set the power of the associated OpenRemote assets
Channel for publishing L2 reactive of an asset to OpenRemote
Realm on OpenRemote where the target asset is listed
Client ID of the MQTT connection between the OpenRemote MQTT broker and the client components
ID of the OpenRemote asset
Accepts the following message:
Message to set the power of the associated OpenRemote assets
Channel for publishing L3 reactive of an asset to OpenRemote
Realm on OpenRemote where the target asset is listed
Client ID of the MQTT connection between the OpenRemote MQTT broker and the client components
ID of the OpenRemote asset
Accepts the following message:
Message to set the power of the associated OpenRemote assets
Channel for publishing L1 AC current of an asset to OpenRemote
Realm on OpenRemote where the target asset is listed
Client ID of the MQTT connection between the OpenRemote MQTT broker and the client components
ID of the OpenRemote asset
Accepts the following message:
Message to set the current of the associated OpenRemote assets
Channel for publishing L2 AC current of an asset to OpenRemote
Realm on OpenRemote where the target asset is listed
Client ID of the MQTT connection between the OpenRemote MQTT broker and the client components
ID of the OpenRemote asset
Accepts the following message:
Message to set the current of the associated OpenRemote assets
Channel for publishing L3 AC current of an asset to OpenRemote
Realm on OpenRemote where the target asset is listed
Client ID of the MQTT connection between the OpenRemote MQTT broker and the client components
ID of the OpenRemote asset
Accepts the following message:
Message to set the current of the associated OpenRemote assets
Channel for publishing L1 AC voltage of an asset to OpenRemote
Realm on OpenRemote where the target asset is listed
Client ID of the MQTT connection between the OpenRemote MQTT broker and the client components
ID of the OpenRemote asset
Accepts the following message:
Message to set the voltage of the associated OpenRemote assets
Channel for publishing L2 AC voltage of an asset to OpenRemote
Realm on OpenRemote where the target asset is listed
Client ID of the MQTT connection between the OpenRemote MQTT broker and the client components
ID of the OpenRemote asset
Accepts the following message:
Message to set the voltage of the associated OpenRemote assets
Channel for publishing L3 AC voltage of an asset to OpenRemote
Realm on OpenRemote where the target asset is listed
Client ID of the MQTT connection between the OpenRemote MQTT broker and the client components
ID of the OpenRemote asset
Accepts the following message:
Message to set the voltage of the associated OpenRemote assets
Channel for publishing AC frequency of an asset to OpenRemote
Realm on OpenRemote where the target asset is listed
Client ID of the MQTT connection between the OpenRemote MQTT broker and the client components
ID of the OpenRemote asset
Accepts the following message:
Message to set the frequency of the associated OpenRemote assets
Channel for publishing power factor of an asset to OpenRemote
Realm on OpenRemote where the target asset is listed
Client ID of the MQTT connection between the OpenRemote MQTT broker and the client components
ID of the OpenRemote asset
Accepts the following message:
Message to set the power factor of the associated OpenRemote assets
System information request message for the addressed E2S2
Configuration information request message for the addressed E2S2
Status information request message for the addressed E2S2
Catchpenny devices query request message for the addressed E2S2
List of catchpenny devices managed by the E2S2
Charger device data request message for the addressed E2S2
Battery device data request message for the addressed E2S2
Message for requesting power from the addressed E2S2
Message from the IQHOME gateway containing the Modbus read response
Message to set the power of the associated OpenRemote assets
Message to set the current of the associated OpenRemote assets
Message to set the voltage of the associated OpenRemote assets
Message to set the frequency of the associated OpenRemote assets
Message to set the power factor of the associated OpenRemote assets