Modify the operation mode of a device. Field communication job will be triggered if successful.
operationMode/slcDeviceAddress
PUT
-
-
| Entity | Type | Nullable | Description |
|---|---|---|---|
| operationMode | array (mainEntity) | no |
| Entity | Type | Nullable | Description |
|---|---|---|---|
| device_id | int | no | slcDeviceAddress |
| name | string | yes | name (optional) |
| mode_id | int (modeType) | no | on/off mode |
| profile_mode_id | int | yes | Dimmprofil Typ (0 = Zeitbasiertes Dimmprofil (default), 1=Bewegungsvolumen basiertes Dimmprofil) |
| env_brightness_on | byte | yes | Einschaltpunkt im Umgebungshelligkeits-Modus (Roh-Wert) |
| env_brightness_off | byte | yes | Ausschaltpunkt im Umgebungshelligkeits-Modus (Roh-Wert) |
| time_on_time | time | yes | Einschaltzeit im Zeit-Modus |
| time_off_time | time | yes | Ausschaltzeit im Zeit-Modus |
| base_led_brightness | byte | no | base brightness in % |
| dim_steps | array (operationModeDimStep) | no | list of dim steps (max. 14 / priority ascending) |
| motion_detection_enabled | bool | no | Gibt an, ob die Bewegungserkennung aktiv ist |
| motion_led_brightness | byte | yes | LED brightness in % on movement |
| motion_hold_time | short | yes | Haltezeit während einer Bewegung in Sekunden (1-600) |
| motion_limit_by_time | bool | yes | Gibt an, ob die Bewegungserkennung auf einen bestimmten Zeitraum beschränkt ist |
| motion_on_time | time | yes | Zeitbeschränkung der Bewegungserkennung (von) |
| motion_off_time | time | yes | Zeitbeschränkung der Bewegungserkennung (bis) |
| extswitch_mode_id | int (switchMode) | no | Modus des Erweiterungs-Schaltausgangs |
| extswitch_default_state | bool | no | Standardwert des Erweiterungs-Schaltausgangs Noch unbenutzt (Default = false) |
| extswitch_time_slices | array (extSwitchTimeSlice) | no | Liste mit Zeitschlitzen in denen der Erweiterung-Schaltausgang ein / ausgeschaltet werden soll (max. 4) |
| motionvolume_master | bool | yes | Bewegungsvolumen-Dimmprofil: Masterleuchte (ja/nein) |
| motionvolume_interval | byte | yes | Bewegungsvolumen-Dimmprofil: Aktualisierungsinterval in Minuten (1-60) |
| motionvolume_street_number | ushort | yes | Bewegungsvolumen-Dimmprofil: Mastersensor-ID |
| motionvolume_steps | array (motionVolumeDimStep) | yes | Bewegungsvolumen-Dimmprofil: Volumen-Dimmstufen |
| Entity | Type | Nullable | Description |
|---|---|---|---|
| days | byte (flags) | no | weekday(s) when this dim step is active |
| led_brightness | byte | no | LED brightness in % while this dim step is active |
| motion_led_brightness | byte | yes | LED Helligkeit in % während einer Bewegung. NULL => Basis-Bewegungs-Helligkeit (motion_led_brightness) aus dem Betriebsmodus wird übernommen |
| disable_motion_detection | bool | no | Gibt an, ob die Bewegungserkennung deaktiviert wird, während diese Dimmstufe aktiv ist |
| start_time | time | no | start time of this dim step |
| end_time | time | no | end time of this dim step |
| Entity | Type | Nullable | Description |
|---|---|---|---|
| days | byte (flags) | no | weekday(s) when this time slice is active |
| output_state | bool | no | output state (true = high; false = low) while this time slice is active - not in use (default = true) |
| disable_motion_detection | bool | no | not yet in use (default = false) |
| start_time | time | no | start time of this time slice |
| end_time | time | no | end time of this time slice |
| Entity | Type | Nullable | Description |
|---|---|---|---|
| counter_volume | ushort | no | motion counter volume in 1/h |
| brightness | byte | no | lamp brightness in % |
| Value | Description |
|---|---|
| 0 | Manuell |
| 1 | Nach Zeit |
| 2 | Nach Umgebungshelligkeit |
| 3 | Nach Zeit und Umgebungshelligkeit |
| 4 | 24-Stunden (Ringmodus) |
| Value | Description |
|---|---|
| 0 | Immer aus |
| 1 | Immer ein |
| 2 | EVG Modus |
| 3 | Nach Zeit |
{
"operationMode": {
"mode_id": 3,
"env_brightness_on": 60,
"env_brightness_off": 77,
"time_on_time": "04:04",
"time_off_time": "03:03",
"base_led_brightness": 100,
"dim_steps": [{
"days": 127,
"led_brightness": 69,
"disable_motion_detection": false,
"motion_led_brightness": 62,
"start_time": "22:00",
"end_time": "03:33"
}, {
"days": 127,
"led_brightness": 0,
"disable_motion_detection": false,
"motion_led_brightness": 27,
"start_time": "00:00",
"end_time": "03:00"
}],
"motion_detection_enabled": true,
"motion_led_brightness": 100,
"motion_hold_time": 305,
"motion_limit_by_time": true,
"motion_on_time": "00:00",
"motion_off_time": "00:00",
"extswitch_mode_id": 0,
"extswitch_default_state": false,
"extswitch_time_slices": []
}
}
200 OK
{
"job": slcID of generated field communication job
}
400 Bad Request
{
"error": 1000
}
| Code | Description |
| 1000 | Too many dim steps (>14) |
| 1001 | Too many time slices (>4) |
| 1002 | Base Led Brightness cannot be > 100% |
| 1003 | Device not found |
| 1004 | Invalid JSON |