State Endpoints
State Endpoints⚓︎
Get State⚓︎
| Method | Endpoint | Description |
|---|---|---|
| GET | /switcher/get_state | Returns the current state of a device. |
Query Params
| Param | Type | Description | Required | Example |
|---|---|---|---|---|
| type | Device Type | the type of the selected device | Yes | mini |
| id | string | the id of the selected device | Yes | ab1c2d |
| key | string | the login key of the selected device | No | 18 |
| ip | string | the ip address of the selected device | Yes | 10.0.0.1 |
| index | integer | the circuit number to operate | No | 0 |
| token | string | the user token from Switcher API | No | zvVvd7JxtN7CgvkD1Psujw== |
State Response
| Key | Type | Example |
|---|---|---|
| state | string | ON |
| time_left | string | 01:15:32 |
| time_on | string | 00:14:28 |
| auto_shutdown | string | 02:30:00 |
| power_consumption | string | 1274 |
| electric_current | string | 16.4 |
Get Breeze State⚓︎
| Method | Endpoint | Description |
|---|---|---|
| GET | /switcher/get_breeze_state | Returns the current state of Breeze devices. |
Query Params
| Param | Type | Description | Required | Example |
|---|---|---|---|---|
| type | Device Type | the type of the selected device | Yes | mini |
| id | string | the id of the selected device | Yes | ab1c2d |
| key | string | the login key of the selected device | No | 18 |
| ip | string | the ip address of the selected device | Yes | 10.0.0.1 |
| index | integer | the circuit number to operate | No | 0 |
| token | string | the user token from Switcher API | No | zvVvd7JxtN7CgvkD1Psujw== |
Breeze State Response
| Key | Type | Example |
|---|---|---|
| state | string | ON |
| mode | string | COOL |
| fan_level | string | AUTO |
| temperature | integer | 9.5 |
| target_temperature | string | 0, |
| swing | string | ON |
| remote_id | string | DLK65863 |
Get Shutter State⚓︎
| Method | Endpoint | Description |
|---|---|---|
| GET | /switcher/get_shutter_state | Returns the current state of Shutter devices. |
Query Params
| Param | Type | Description | Required | Example |
|---|---|---|---|---|
| type | Device Type | the type of the selected device | Yes | mini |
| id | string | the id of the selected device | Yes | ab1c2d |
| key | string | the login key of the selected device | No | 18 |
| ip | string | the ip address of the selected device | Yes | 10.0.0.1 |
| index | integer | the circuit number to operate | No | 0 |
| token | string | the user token from Switcher API | No | zvVvd7JxtN7CgvkD1Psujw== |
Get Light State⚓︎
| Method | Endpoint | Description |
|---|---|---|
| GET | /switcher/get_light_state | Returns the current state of Light devices. |
Query Params
| Param | Type | Description | Required | Example |
|---|---|---|---|---|
| type | Device Type | the type of the selected device | Yes | mini |
| id | string | the id of the selected device | Yes | ab1c2d |
| key | string | the login key of the selected device | No | 18 |
| ip | string | the ip address of the selected device | Yes | 10.0.0.1 |
| index | integer | the circuit number to operate | No | 0 |
| token | string | the user token from Switcher API | No | zvVvd7JxtN7CgvkD1Psujw== |
Shutter State Response
| Key | Type | Example |
|---|---|---|
| direction | string | SHUTTER_STOP |
| position | integer | 95 |