Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Description
Returns detailed information of a specific service location:
General information
Appliances
Actuators (Smappee Switch / Comfort plug)
Sensors (Gas & Water monitor)
Channel configuration (Smappee electricity monitor)
Resource URL
https://app1pub.smappee.net/dev/v3/servicelocation/[SERVICELOCATIONID]/info
HTTP method
GET
HTTP header
Authorization: Bearer [ACCESS_TOKEN]
[ACCESS_TOKEN] being the access token received from the Get token or Refresh token authentication calls.
Parameters
Parameter | Type | Description |
---|---|---|
SERVICELOCATIONID | Path Parameter | The actual id of an accessible service location (see Get Servicelocations) |
Example
https://app1pub.smappee.net/dev/v3/servicelocation/123/info
Result
Code Block | ||
---|---|---|
| ||
{ "serviceLocationId": 123, "serviceLocationUuid": "6eefadeb-5c08-47cd-87b6-9897acb9fb8f", "name": "My Place", "timezone": "Europe/Brussels", "lon": 0.0, "lat": 0.0, "electricityCost": 0.0, "electricityCurrency": "EUR", "appliances": [ { "id": 1, "name": "Coffeemaker", "type": "cooking" }, { "id": 2, "name": "Refrigerator", "type": "refridgeration" } ], "actuators": [ { "id": 6, "monitorId": 7, "name": "4006002529", "serialNumber": "4006002529", "type": "CCD_LEAF_LITE", "states": [ { "id": "ON_ON", "name": "on", "current": true }, { "id": "OFF_OFF", "name": "off", "current": false } ] }, { "id": 2, "monitorId": 9, "name": "Output module Example", "serialNumber": "5800000005", "type": "INFINITY_OUTPUT_MODULE", "channels": [ { "id": 1, "sensorId": 4, "type": "OUTPUT", "enabled": true } ], "states": [ { "id": "ON_ON", "name": "On", "current": true, "channels": [ "ON" ] }, { "id": "OFF_OFF", "name": "Off", "current": false, "channels": [ "OFF" ] } ] } ], "sensors": [ { "id": 2, "name": "3003000078", "channels": [ { "name": "Garage", "ppu": 100.0, "uom": "m3", "enabled": false, "type": "gas", "channel": 1 }, { "name": "Outdoor", "ppu": 100.0, "uom": "m3", "enabled": false, "type": "water", "channel": 2 } ] } ], "channelsConfiguration": { "inputChannels": [ { "ctInput": 0, "name": "", "phase": 0, "inputChannelType": "CONSUMPTION", "inputChannelConnection": "GRID", "reversed": true, "nilm": true, "balanced": false, "inputChannelCTType": "CT50_100_200" }, { "ctInput": 1, "name": "", "phase": 0, "inputChannelType": "CONSUMPTION", "inputChannelConnection": "SUBMETER", "reversed": false, "nilm": true, "balanced": false, "inputChannelCTType": "CT50_100_200" }, { "ctInput": 2, "name": "", "phase": 0, "inputChannelType": "CONSUMPTION", "inputChannelConnection": "OFF_GRID", "reversed": false, "nilm": false, "balanced": false, "inputChannelCTType": "CT50_100_200" }, { "ctInput": 3, "name": "", "phase": 0, "inputChannelType": "UNUSED", "inputChannelConnection": "GRID", "reversed": false, "nilm": false, "balanced": false, "inputChannelCTType": "CT50_100_200" }, { "ctInput": 4, "name": "", "phase": 0, "inputChannelType": "UNUSED", "inputChannelConnection": "GRID", "reversed": false, "nilm": false, "balanced": false, "inputChannelCTType": "CT50_100_200" }, { "ctInput": 5, "name": "", "phase": 0, "inputChannelType": "UNUSED", "inputChannelConnection": "GRID", "reversed": false, "nilm": false, "balanced": false, "inputChannelCTType": "CT50_100_200" }, { "ctInput": 6, "name": "", "phase": 0, "inputChannelType": "UNUSED", "inputChannelConnection": "GRID", "reversed": false, "nilm": false, "balanced": false, "inputChannelCTType": "CT50_100_200" }, { "ctInput": 7, "name": "", "phase": 0, "inputChannelType": "UNUSED", "inputChannelConnection": "GRID", "reversed": false, "nilm": false, "balanced": false, "inputChannelCTType": "CT50_100_200" }, { "ctInput": 8, "name": "", "phase": 0, "inputChannelType": "UNUSED", "inputChannelConnection": "GRID", "reversed": false, "nilm": false, "balanced": false, "inputChannelCTType": "CT50_100_200" } ] } } |
Possible state values
The possible values for the states of an actuator are: ON_ON, ON_OFF, OFF_ON, OFF_OFF
Versioning
Version 1 (v1)
General information
Appliances
Actuators (Smappee Switch / Comfort plug)
Sensors (Gas & Water monitor)
Version 2 (v2)
Channel configuration section was added to the payload of V1
General information
Appliances
Actuators (Smappee Switch / Comfort plug)
Sensors (Gas & Water monitor)
Channel configuration
Version 3 (v3)
Type of actuator was added. The possible values are:
COMFORT_PLUG
SWITCH
INFINITY_OUTPUT_MODULE
States were added, including a marker which state is the current state. For output modules, each state will also contain the state of each channel that is included.
Channels were added for output modules.
Page Properties | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
|
Panel | ||
---|---|---|
| ||
|