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 device data

This request delivers data about a lamp.

API endpoint

device/slcDeviceAddress

Request method

GET

Request headers

-

Request URL parameters

-

Response content

EntityTypeNullableDescription
devicearray (mainEntity)no

mainEntity

EntityTypeNullableDescription
idintnoslcDeviceAddress of this device
customer_idintnoslcID of customer
namestringyesname of device
serial_numberstringyesserial number
latitudefloatyeslatitude (WGS84)
longitudefloatyeslongitude (WGS84)
manual_led_brightnessbyteyesLED-Helligkeit im Manuellen Betriebsmodus
env_brightness_masterboolyestrue if this device is acting as environment brightness master
manual_override_switch_groupsbyte[8] - 64 flags, 8 per byteyesÜbergeordneter Lichtschalter-Gruppen-Konfiguration
motion_neighbor_devicesint[]yesNachbargeräte für Bewegungserkennung (max. 16 Einträge)
led_temperature_limitbyteyesLED-Temperatur-Limit, bei welcher die Leuchte heruntergeregelt wird
neighbor_rssi_limitsbyteyesMinimale Empfangsstärke der Nachbarleuchten (in dbm)
ralab_motion_sensor_configarray (ralabMotionSensorConfig)yesKonfiguration für den Ralab Radar-Bewegungssensor
output_configarray (deviceOutputConfig)yesAusgangskonfiguration der Steuerung
lfc_configarray (lfcConfig)yesLichtstrom-Korrektur-Einstellungen (aka LFC, aka CLO) der Leuchte
has_rf_pin_setboolyesHas Device RF-PIN set?
hardware_type_namestringyesname of device hardware type

ralabMotionSensorConfig

EntityTypeNullableDescription
sensitivitybytenosensitivity of the sensor in %

deviceOutputConfig

EntityTypeNullableDescription
output_typeint (outputType)nooutput type of the controller
fade_off_timefloatnofade off time in ms
fade_on_timefloatnofade on time in ms
min_dim_stepfloatnoAbstufung (Zeiteinheit hängt von Ausgangstyp ab). Typ: 0.001

lfcConfig

EntityTypeNullableDescription
led_lifetimeuintnoLebenszeit der LED-Module [h]
eol_outputbytenoAusgangs-Lichtleistung des LED-Moduls am Ende der Lebenszeit [%]
limiting_factorbytenoLimiting factor of the led output (e.g. max. output percentage) [%]
curve_gammafloat (range: 0.0 - 1.0)noLichstromabnahme des LED-Moduls im Verhältnis der Zeit. Als Annäherung wird eine Gamma-Kurve verwendet. Dieser Wert gibt den Krümmungsfaktor (gamma) an.

outputType

ValueDescription
0Deaktiviert
1Analog (0-10V)
2Analog invertiert (10-0V)
3PWM
4PWM invertiert
5PWM S3
6PWM M5
7PWM S3 linear
8DALI (Default: Logarithmic)
9DALI Linear

Response: example in XML

n.a.

Response: example in JSON

{
	"device": {
		"id": 140438,
		"customer_id": 2,
		"name": "2486",
		"latitude": 46.8554955557026,
		"longitude": 9.51534038630935,
		"manual_led_brightness": 0,
		"env_brightness_master": false,
		"led_temperature_limit": 80,
		"neighbor_rssi_limit": -102,
		"manual_override_switch_groups": [1, 0, 0, 0, 0, 0, 0, 0],
		"ralab_motion_sensor_config": {
			"limit": 0,
			"sensitivity": 0
		},
		"output_config": {
			"output_type": 8,
			"fade_off_time": 100,
			"fade_on_time": 66,
			"min_dim_step": 0.1
		},
		"lfc_config": {
			"led_lifetime": 75000,
			"eol_output": 80,
			"limiting_factor": 100,
			"curve_gamma": 1
		},
		"motion_neighbor_devices": []
	}
}