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 energy

Get energy data.

API endpoint

deviceEnergy/slcID of customer

Request method

GET

Request headers

-

Request URL parameters

Limit by devices

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

device=1578,1579

Limit number of records

You may restrict the number of records each device will return. You will always get the newest records first. Default limit is 10'000.

limit=100

You may restrict the result to first and/or last value for each device (edges means first + last). The number of records is not limited in this case (as each device delivers two records at most).

limit=first|last|edges

Limit by time

You may restrict the recordset by start time and/oder end time. Timeconstraints are local time.

from=2017-11-25T08:00:35
to=2017-11-25T15:00:35

Response content

EntityTypeNullableDescription
deviceEnergy[]array (mainEntity)no

mainEntity

EntityTypeNullableDescription
device_idintnoslcID of device
energy_counteruintnototal energy counter value in 1/10 Wh
sample_timetimestampnodate and time of readout of the counter value

Response: example in XML

<?xml version="1.0" encoding="UTF-8" ?>
<slControl>
	<deviceEnergy>
		<device_id>15378</device_id>
		<energy_counter>1000</energy_counter>
		<sample_time>2018-04-05 14:50:00</sample_time>
	</deviceEnergy>
	<deviceEnergy>
		<device_id>15378</device_id>
		<energy_counter>1000</energy_counter>
		<sample_time>2018-04-05 14:50:00</sample_time>
	</deviceEnergy>
	<deviceEnergy>
		<device_id>15378</device_id>
		<energy_counter>1000</energy_counter>
		<sample_time>2018-04-05 14:50:00</sample_time>
	</deviceEnergy>
	<deviceEnergy>
		<device_id>15378</device_id>
		<energy_counter>1000</energy_counter>
		<sample_time>2018-04-05 14:50:00</sample_time>
	</deviceEnergy>
	<deviceEnergy>
		<device_id>15378</device_id>
		<energy_counter>1000</energy_counter>
		<sample_time>2018-04-05 14:50:00</sample_time>
	</deviceEnergy>
	<deviceEnergy>
		<device_id>15378</device_id>
		<energy_counter>1000</energy_counter>
		<sample_time>2018-04-05 14:50:00</sample_time>
	</deviceEnergy>
	<deviceEnergy>
		<device_id>15378</device_id>
		<energy_counter>1000</energy_counter>
		<sample_time>2018-04-05 14:50:00</sample_time>
	</deviceEnergy>
	<deviceEnergy>
		<device_id>15378</device_id>
		<energy_counter>1000</energy_counter>
		<sample_time>2018-04-05 14:50:00</sample_time>
	</deviceEnergy>
	<deviceEnergy>
		<device_id>15378</device_id>
		<energy_counter>1000</energy_counter>
		<sample_time>2018-04-05 14:50:00</sample_time>
	</deviceEnergy>
	<deviceEnergy>
		<device_id>15378</device_id>
		<energy_counter>1000</energy_counter>
		<sample_time>2018-04-05 14:50:00</sample_time>
	</deviceEnergy>
</slControl>

Response: example in JSON

{
	"deviceEnergy": [{
		"device_id": "15378",
		"energy_counter": "1000",
		"sample_time": "2018-04-05 14:50:00"
	}, {
		"device_id": "15378",
		"energy_counter": "1000",
		"sample_time": "2018-04-05 14:50:00"
	}, {
		"device_id": "15378",
		"energy_counter": "1000",
		"sample_time": "2018-04-05 14:50:00"
	}, {
		"device_id": "15378",
		"energy_counter": "1000",
		"sample_time": "2018-04-05 14:50:00"
	}, {
		"device_id": "15378",
		"energy_counter": "1000",
		"sample_time": "2018-04-05 14:50:00"
	}, {
		"device_id": "15378",
		"energy_counter": "1000",
		"sample_time": "2018-04-05 14:50:00"
	}, {
		"device_id": "15378",
		"energy_counter": "1000",
		"sample_time": "2018-04-05 14:50:00"
	}, {
		"device_id": "15378",
		"energy_counter": "1000",
		"sample_time": "2018-04-05 14:50:00"
	}, {
		"device_id": "15378",
		"energy_counter": "1000",
		"sample_time": "2018-04-05 14:50:00"
	}, {
		"device_id": "15378",
		"energy_counter": "1000",
		"sample_time": "2018-04-05 14:50:00"
	}]
}