1. Enlighted Inc
  2. APIs
  3. Manage APIs

Manage APIs

Manage stores sensor data, occupancy status, and fault data from all fixtures in a building. The APIs allow users to monitor energy consumption, BACnet health, and lights during an emergency.

Follow
Print articles

Get Energy Manager Aggregate Energy Consumption

Retrieves the aggregate energy consumption in watt-hour for all fixtures and plugloads in the building for the last 15 minutes managed by Enlighted Manage (EM). The response is a JSON element with energy-lighting and energy-plugload parameters.

For example, if the request has been sent between 10:05:00 and 10:19:59 am, energy data is sent for the period from 9:45 to 10:00 am. Likewise, if the request is between 10:20:00 and 10:34:59, data is sent for the period from 10:00 to 10:15 am. The data is aggregated at 5-minute intervals and is rounded to the nearest last 15 minutes interval set. 

Request

GET https: //{em_ip_address_or_hostname}/ems/api/org/em/v1/energy/

Parameters

Request
em_ip_address or hostname: The Manage’s IP address or hostname
Response
energy-lighting: Reports aggregate energy consumption in watt-hour (Wh) for the last 15 minutes for all lighting fixtures managed by the EM
energy-plugload: Reports aggregate energy consumption in watt-hour (Wh) for the last 15 minutes for all plugloads managed by the EM

Sample Code

Using the EM IP address, obtain the aggregate energy consumption for all lighting fixtures and plugloads in the building.

Get https://{192.80.3.2}/ems/api/org/em/v1/energy/

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Type: application/json
Content-Length: 7582
Date: Sat, 21 Jul 2015 17:06:51 GMT
{
  "energy-lighting": "21550.96"
  "energy-plugload": "3650.64"
}

 

Set Emergency

During an emergency, this command automatically sets the lighting level for all fixtures controlled by Manage to the maximum level of 100% or full-on, so the floor is entirely lit up.

Request

POST https://{em_ip_address_or_hostname}/ems/api/org/em/v1/setEmergency?time=60

Parameters

Request 
em_ip_address or hostname:  Manage IP address or hostname
time: The emergency duration time. Set to 60 minutes by default
Response 
status:

 0 – Lights are on to a maximum level of 100% or full-on
 1 – Lights are off

Sample Code

Using the IP address, set all lights to full on for 60 minutes during an emergency.

Post https://{192.80.3.2}/ems/api/org/em/v1/setEmergency?time=60

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Type: application/json
Content-Length: 7582
Date: Sat, 21 Jul 2015 17:06:51 GMT
{
  "status": "0"
}

 

Get BACnet Health

The Enlighted Manage (EM) integrates seamlessly with the Building Management System (BMS) via the BACnet interface. Use this API to poll the Manage to determine if BACnet is running or not running.

Request

GET https://{em_ip_address_or_hostname}/ems/api/org/bacnet/health

Parameters

Request 
em_ip_address or hostname: The Manage’s IP address or hostname
Response 
status: 0 – BACnet is running
1 – BACnet not running

Sample Code

Poll the EM with the IP address to see if BACnet is running. The response ‘0’ indicates BACnet is running.

Get https://{192.80.3.2}/ems/api/org/bacnet/health

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Type: application/json
Content-Length: 7582
Date: Sat, 21 Jul 2015 17:06:51 GMT
{
  "status": "0"
}