cloud.smarthq.service.photovoltaicpanel¶
Description¶
Service that represents the state of a photovoltaic panel.
Example Device Response (Digital Twin API)¶
Service representing a photovoltaic panel energy.
{
"adapterId": "0000000000000000000000000000000000000000",
"alertTypes": [],
"createdDateTime": "2022-03-04T12:12:12.123Z",
"deviceId": "0000000000000000000000000000000000000000000000000000000000000000",
"deviceType": "cloud.smarthq.device.photovoltaicpanel",
"gatewayId": "0000000000000000000000000000000000000000000000000000000000000000",
"kind": "device#item",
"lastPresenceTime": "2022-03-04T12:12:12.123Z",
"lastSyncTime": "2022-03-04T12:12:12.123Z",
"presence": "OFFLINE",
"removable": true,
"services": [
{
"serviceType": "cloud.smarthq.service.photovoltaicpanel",
"lastSyncTime": "2022-03-04T12:12:12.123Z",
"domainType": "cloud.smarthq.domain.energy",
"supportedCommands": [],
"state": {
"energyProducedValue": 88.0
},
"serviceId": "0000000000000000000000000000000000000000000000000000000000000000",
"serviceDeviceType": "cloud.smarthq.device.photovoltaicpanel",
"config": {
"energyProducedUnits": "cloud.smarthq.type.photovoltaicpanel.kwh"
},
"lastStateTime": "2022-03-04T12:12:12.123Z"
}
],
"userId": "000000000000000"
}
Service representing a photovoltaic panel power.
{
"adapterId": "0000000000000000000000000000000000000000",
"alertTypes": [],
"createdDateTime": "2022-03-04T12:12:12.123Z",
"deviceId": "0000000000000000000000000000000000000000000000000000000000000000",
"deviceType": "cloud.smarthq.device.photovoltaicpanel",
"gatewayId": "0000000000000000000000000000000000000000000000000000000000000000",
"kind": "device#item",
"lastPresenceTime": "2022-03-04T12:12:12.123Z",
"lastSyncTime": "2022-03-04T12:12:12.123Z",
"presence": "OFFLINE",
"removable": true,
"services": [
{
"serviceType": "cloud.smarthq.service.photovoltaicpanel",
"lastSyncTime": "2022-03-04T12:12:12.123Z",
"domainType": "cloud.smarthq.domain.power",
"supportedCommands": [],
"state": {
"energyProducedValue": 89.0
},
"serviceId": "0000000000000000000000000000000000000000000000000000000000000000",
"serviceDeviceType": "cloud.smarthq.device.photovoltaicpanel",
"config": {
"energyProducedUnits": "cloud.smarthq.type.photovoltaicpanel.kw"
},
"lastStateTime": "2022-03-04T12:12:12.123Z"
}
],
"userId": "000000000000000"
}
Configuration¶
The following are properties for the gateway/device sync as part of the "config" object for each individual service.
Field Name | Property Type | Required |
---|---|---|
energyProducedUnits | PHOTOVOLTAICPANEL | Yes |
State¶
The following are properties for the device state report as part of the "state" object for each individual service.
Field Name | Property Type | Required |
---|---|---|
energyProducedValue | DOUBLE | Yes |
Data Types¶
DOUBLE¶
Value must be an double. Field specific restrictions such as a minimum and maximum may apply depending on the field.
PHOTOVOLTAICPANEL¶
PHOTOVOLTAICPANEL | Documentation |
---|---|
cloud.smarthq.type.photovoltaicpanel.kw | kW |
cloud.smarthq.type.photovoltaicpanel.kwh | Kwh |