Get Actuator state
- Rudi Vankeirsbilck
- Pieter Werbrouck
Description
Returns the state of the specified Comfort plug, Smappee Switch, the returned value is ON_ON or OFF_OFF. In case of an output module the returned value can be: ON_ON, ON_OFF, OFF_ON, OFF_OFF (2 relays in the Output module and can be combined as one)
Resource URL
https://app1pub.smappee.net/dev/v3/servicelocation/[SERVICELOCATIONID]/actuator/[ACTUATORID]/state
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) |
ACTUATORID | Path Parameter | The id of the actuator object that will be turned on (see Get Servicelocation Info) |
Example
https://app1pub.smappee.net/dev/v3/servicelocation/123/actuator/2/state
Result
"ON"
Versioning
Version 1 (v1)
This call does not exist in this version
Version 2 (v2)
This call was introduced in this version
Version 3 (v3)
From this version onward, the possible results are
ON_ON
ON_OFF
OFF_ON
OFF_OFF
where ON_ON is equivalent to ON for Smappee Switch and Comfort Plug and OFF_OFF is equivalent to OFF for Smappee Switch and Comfort Plug.