Lighting APIs Overview
The Enlighted lighting solution optimizes energy savings while enhancing occupant productivity, well-being, and security. Manage server stores sensor, status, and fault data from fixtures in the building, allowing users to configure fixture lighting behavior and monitor energy consumption and device status.
Manage supports standard REST-based APIs, including XML and JSON message formats. Developers can write applications using REST APIs to query and retrieve information from Manage. The sample responses to the web services are in JSON or XML format. Users must be authenticated to send or receive API requests to and from Manage. See User Authentication for APIs.
After user authorization, the APIs allow users to monitor energy consumption, BACnet health and turn lights on during an emergency, obtain organization, floor, area, and fixture details. The Demand Response APIs contribute to energy load reduction and savings during peak demand time.
In addition to the physical devices, groups are a cluster of sensors that communicate with each other in the area to control lighting based on occupancy or motion. A switch controls the light level of a group of selected fixtures on the floor. Each set of light levels controlled by the switch is called a scene.
Sample Code Example:
The API sample code responses described in the API calls are based on the following example.
Let’s consider Acme Inc. organization structure with two campuses Hampton and Monroe campus. The Monroe campus comprises a single Main building with three floors: Floor one, Floor two, and Floor three. Floor 1 accommodates two areas Hardware and Software used by the respective engineering teams. The area comprises a grouping of a subset of devices, including sensors, Enlighted Room Control (ERC) switches, plugloads, etc., on the floor. All devices are identified with a unique device ID and name. The sensors in an area can be enabled as zone sensors to report occupancy information.
Refer to the following APIs:
- Area APIs
- Fixture APIs
- Plugload APIs
- Conference Room APIs
- Data APIs
- Demand Response APIs
- Bluetooth Services APIs
- Tunable White APIs
- DALI Emergency APIs
- Manage APIs
When you are familiar with the APIs, refer to the sample scenario use case example.