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

Get environmental sensor data.

API endpoint

environmentalData/customer id

Request method

GET

Request headers

-

Request URL parameters

Limit by devices

You may restrict result by a comma delimited list of slcIDs of devices. No comma at the beginning or end of this list.

devices=1578,1579

Limit by sensor types

You may restrict result by a comma delimited list of sensor type ids. No comma at the beginning or end of this list.

types=2,8

Response content

EntityTypeNullableDescription
environmentalDataobject (mainEntity)no

mainEntity

EntityTypeNullableDescription
customer_idintnoslcID of customer
devicesarray (devices)nodevices

devices

EntityTypeNullableDescription
idintnoslcID of device
namestringyesname of device
typeint (sensorType)nosensor type
dataobject (data)nodata

data

EntityTypeNullableDescription
sample_timetimestampnodate and time
temperaturefloatyestemperature in °C
water_levelfloatyeswater level in meters
humidityfloatyeshumidity in %
wind_speedfloatyeswind_speed in km/h
brightness_southintyesbrightness in lux
brightness_westintyesbrightness in lux
brightness_eastintyesbrightness in lux
vocfloatyesair quaility index VOC
noxfloatyesair quaility index Nitrogen Oxide
carbonDioxidefloatyesCO2 in ppm
rainbooleanyesdoes it rain?
ambient_noise_latestintyescurrent ambient noise in dB (A-weighting)
ambient_noise_minintyesambient noise in dB
ambient_noise_maxintyesambient noise in dB
particleMatter_typicalParticleSizeintyestypical fine dust particle size in μm
particleMatter_Samplesarray (particleMatter_Samples)yes
active_energy_import_L1floatyesAbsolute energy meter phase 1 in kWh
active_energy_import_L2floatyesAbsolute energy meter phase 2 in kWh
active_energy_import_L3floatyesAbsolute energy meter phase 3 in kWh
voltage_L1floatyesPhase 1 voltage in volts
voltage_L2floatyesPhase 2 voltage in volts
voltage_L3floatyesPhase 3 voltage in volts
voltage_L1_minfloatyesVoltage phase 1 in volts minimum value
voltage_L1_maxfloatyesVoltage phase 1 in volts maximum value
voltage_L2_minfloatyesVoltage phase 2 in volts minimum value
voltage_L2_maxfloatyesVoltage phase 2 in volts maximum value
voltage_L3_minfloatyesVoltage phase 3 in volts minimum value
voltage_L3_maxfloatyesVoltage phase 3 in volts maximum value
current_L1floatyesCurrent phase 1 in amperes
current_L2floatyesCurrent phase 2 in amperes
current_L3floatyesCurrent phase 3 in amperes
active_power_import_L1floatyesActive power instantaneous value phase 1 in W
active_power_import_L2floatyesActive power instantaneous value phase 2 in W
active_power_import_L3floatyesActive power instantaneous value phase 3 in W
switch_statesuint8yesSwitching states for SLC-RC switch (1st bit = switch 1 / 2nd bit = switch 2 / 3rd bit = switch 3)
alarm_code_2uint32 (alarmCodes)yesEnergy alarm flags

particleMatter_Samples

EntityTypeNullableDescription
particleSizebytenoparticle size in μm
numberConcentrationfloatnonumber of particles per cm3
massConcentrationfloatnomass concentration μg/m³

sensorType

ValueDescription
1Theben weather station
2Sensirion particle matter sensor
3Theben TheRonda P360-330 (motion/brightness sensor)
4Sensirion CO2 sensor
5Water level sensor
6Power Meter
7Sensirion Air Quality Sensor
8SLC-Enviro
9ISKRA smart meter
10Ambient noise sensor

alarmCodes (Flag/Bit)

ValueDescription
0Total power failure
1Power resumed
2Voltage failure L1
3Voltage failure L2
4Voltage failure L3
5Voltage L1 resumed
6Voltage L2 resumed
7Voltage L3 resumed
8Voltage L1 resumed
9Phase Asymmetry
10-
11Phase sequence incorrect
12Unexpected consumption
13Unexpected consumption
14Bad voltage quality L1
15Bad voltage quality L2
16Bad voltage quality L3
17External alarm
18Local communication attempt
31Disconnect/reconnect failure

Response: example in JSON

{"environmentalData": {
		"customer_id": "4",
		"devices": [
			{
				"id": "244152",
				"name": "Feinstaub Sensor",
				"type": "2",
				"data": {
					"sample_time": "2024-03-01 12:30",
					"particleMatter_typicalParticleSize": "0.541114",
					"particleMatter_Samples": [
						{
							"particleSize": "5",
							"numberConcentration": "5.24153"
						},
						{
							"particleSize": "10",
							"numberConcentration": "6.2603",
							"massConcentration": "0.789617"
						},
						{
							"particleSize": "25",
							"numberConcentration": "6.30181",
							"massConcentration": "0.834991"
						},
						{
							"particleSize": "40",
							"numberConcentration": "6.30373",
							"massConcentration": "0.834991"
						},
						{
							"particleSize": "100",
							"numberConcentration": "6.30489",
							"massConcentration": "0.834991"
						}
					]
				}
			},
			{
				"id": "353998",
				"name": "SLC-Enviro",
				"type": "8",
				"data": {
					"timestamp": "2023-12-15 13:45",
					"temperature": "24.46",
					"humidity": "30.12",
					"voc": "71",
					"nox": "2"
				}
			},
			{
				"id": "460036",
				"name": "Noise Level Sensor #5352551",
				"type": "10",
				"data": {
					"timestamp": "2024-02-29 14:30",
					"ambient_noise_latest": "39",
					"ambient_noise_min": "35",
					"ambient_noise_max": "59"
				}
			}
		]
	}}