slControl API

LogoutChangelog (26.08.2024)Legal notesBasic usageRequest EmulatorTroubleshooting
Global
Get list of accessible customersGet lookup tables for settingsGet lookup tables for devicesGet lookup tables for operationModeGet lookup tables for gatewaysGet lookup tables for jobsGet lookup tables for alerts
Customers
Get customer configurationUpdate customer configurationGet mesh network
Groups
Get group tree
Lamp switches
Get lamp switchesUpdate lamp switches
Luminaire points
Get luminaire pointsUpdate luminaire pointsCreate luminaire pointsDelete luminaire points
Devices
Get devicesGet device dataGet device stateUpdate device dataUpdate device operation stateGet operation modeUpdate operation modeDelete deviceDelete devices
Devices - Statistics/Logs
Get radar dataGet motion dataGet device energyGet environmental data
Gateways
Get gatewaysGet gateway dataCreate gatewaysDelete a gateway
Jobs
Get jobs state of a deviceGet job state by slcID
Alerts
Get alertsCreate alertsUpdate alerts

Get operation mode

This request delivers the operation mode of a lamp.

API endpoint

operationMode/slcDeviceAddress

Request method

GET

Request headers

-

Request URL parameters

-

Response content

EntityTypeNullableDescription
operationModearray (mainEntity)no

mainEntity

EntityTypeNullableDescription
device_idintnoslcDeviceAddress
namestringyesname (optional)
mode_idint (modeType)noon/off mode
profile_mode_idintyesDimmprofil Typ (0 = Zeitbasiertes Dimmprofil (default), 1=Bewegungsvolumen basiertes Dimmprofil)
env_brightness_onbyteyesEinschaltpunkt im Umgebungshelligkeits-Modus (Roh-Wert)
env_brightness_offbyteyesAusschaltpunkt im Umgebungshelligkeits-Modus (Roh-Wert)
time_on_timetimeyesEinschaltzeit im Zeit-Modus
time_off_timetimeyesAusschaltzeit im Zeit-Modus
base_led_brightnessbytenobase brightness in %
dim_stepsarray (operationModeDimStep)nolist of dim steps (max. 14 / priority ascending)
motion_detection_enabledboolnoGibt an, ob die Bewegungserkennung aktiv ist
motion_led_brightnessbyteyesLED brightness in % on movement
motion_hold_timeshortyesHaltezeit während einer Bewegung in Sekunden (1-600)
motion_limit_by_timeboolyesGibt an, ob die Bewegungserkennung auf einen bestimmten Zeitraum beschränkt ist
motion_on_timetimeyesZeitbeschränkung der Bewegungserkennung (von)
motion_off_timetimeyesZeitbeschränkung der Bewegungserkennung (bis)
extswitch_mode_idint (switchMode)noModus des Erweiterungs-Schaltausgangs
extswitch_default_stateboolnoStandardwert des Erweiterungs-Schaltausgangs Noch unbenutzt (Default = false)
extswitch_time_slicesarray (extSwitchTimeSlice)noListe mit Zeitschlitzen in denen der Erweiterung-Schaltausgang ein / ausgeschaltet werden soll (max. 4)
motionvolume_masterboolyesBewegungsvolumen-Dimmprofil: Masterleuchte (ja/nein)
motionvolume_intervalbyteyesBewegungsvolumen-Dimmprofil: Aktualisierungsinterval in Minuten (1-60)
motionvolume_street_numberushortyesBewegungsvolumen-Dimmprofil: Mastersensor-ID
motionvolume_stepsarray (motionVolumeDimStep)yesBewegungsvolumen-Dimmprofil: Volumen-Dimmstufen

operationModeDimStep

EntityTypeNullableDescription
daysbyte (flags)noweekday(s) when this dim step is active
led_brightnessbytenoLED brightness in % while this dim step is active
motion_led_brightnessbyteyesLED Helligkeit in % während einer Bewegung. NULL => Basis-Bewegungs-Helligkeit (motion_led_brightness) aus dem Betriebsmodus wird übernommen
disable_motion_detectionboolnoGibt an, ob die Bewegungserkennung deaktiviert wird, während diese Dimmstufe aktiv ist
start_timetimenostart time of this dim step
end_timetimenoend time of this dim step

extSwitchTimeSlice

EntityTypeNullableDescription
daysbyte (flags)noweekday(s) when this time slice is active
output_stateboolnooutput state (true = high; false = low) while this time slice is active - not in use (default = true)
disable_motion_detectionboolnonot yet in use (default = false)
start_timetimenostart time of this time slice
end_timetimenoend time of this time slice

motionVolumeDimStep

EntityTypeNullableDescription
counter_volumeushortnomotion counter volume in 1/h
brightnessbytenolamp brightness in %

modeType

ValueDescription
0Manuell
1Nach Zeit
2Nach Umgebungshelligkeit
3Nach Zeit und Umgebungshelligkeit
424-Stunden (Ringmodus)

Response: example in XML

n.a.

Response: example in JSON

{
	"operationMode": {
		"id": 2247,
		"name": "",
		"mode_id": 4,
		"env_brightness_on": 0,
		"env_brightness_off": 0,
		"time_on_time": "00:00",
		"time_off_time": "00:00",
		"base_led_brightness": 81,
		"dim_steps": [{
			"days": 127,
			"led_brightness": 42,
			"disable_motion_detection": false,
			"motion_led_brightness": 62,
			"start_time": "22:00",
			"end_time": "04:00"
		}, {
			"days": 127,
			"led_brightness": 0,
			"disable_motion_detection": false,
			"motion_led_brightness": 29,
			"start_time": "00:00",
			"end_time": "03:00"
		}],
		"motion_detection_enabled": true,
		"motion_led_brightness": 0,
		"motion_hold_time": 1,
		"motion_limit_by_time": false,
		"motion_on_time": "00:00",
		"motion_off_time": "00:00",
		"extswitch_mode_id": 0,
		"extswitch_default_state": false,
		"extswitch_time_slices": [{
			"days": 127,
			"output_state": true,
			"disable_motion_detection": false,
			"start_time": "00:00:00",
			"end_time": "00:00:00"
		}]
	}
}