Enlighted provides APIs for integration with third-party systems and applications. The Enlighted Manage has two distinct API product families: Energy and Environment APIs and Occupancy APIs . The Energy and Environment APIs support energy reporting and lighting control use cases, while Occupancy APIs support various real-time space management, space utilization, and security use cases.
Energy and Environmental APIs are complimentary with the purchase of Connected Lighting or IoT sensors and do not require additional licenses.
Occupancy APIs require Sensor license as well as API license. The API license provides three API calls:
API License (EM-API-OCC-01/02/03)
The API Sensor License enables users to realize the full value of sensor data via Enlighted's advanced occupancy APIs. Customers can request for 1/2/3-year contracts. For the sensors to report occupancy data, you will need the licenses based on the number of sensors configured in the system. Refer to the License Types and Product Codes.
-
Real-time Area Occupancy
-
Real-time Desk Occupancy
-
Fine-grain Motion License
1. Real-time Area Occupancy
The Real-time Area Occupancy API is most commonly used to support the following use cases:
- Real-time availability of bookable spaces (conference rooms and phone booths)
- Automated check-in of bookable spaces
- Utilization reporting for bookable spaces
- Occupancy based control of HVAC systems
Enable Zonal Sensors
The sensors in the area will start reporting occupancy data only after they are activated as zonal sensors. Refer to the article Enable Zonal Sensors to enable them as zonal sensors to get occupancy data.
An area is a grouping of sensors with an Area ID. The request will return a single data point for all sensors in the area. If you ever need to see the IDs of all areas, you can query those by using the Get All Areas request.
Compliance: Compliance for these licenses is determined based on the quantity of active API Licenses relative to the quantity of areas enabled as zone sensors. When the quantity of these licenses is less than the quantity of areas configured as zonal sensors, the system will be out of compliance.
When a customer with IoT or Connected Lighting sensors receives an 'out of compliance' warning message when areas are enabled as zone sensors, please ignore this message and it will not adversely affect system operation. Enlighted will address this in the next release.
2. Real-time Desk Occupancy
The Real-time Desk Occupancy API is most commonly used to support the following use cases:
- Real-time availability of unassigned desks
- Automated desk check-in
- Utilization of desks
Enable Desk Sensors
When sensors are designated as a Desk Sensor, the sensors report real-time occupancy status. Follow the procedure described in Enable Desk Sensors to designate sensors as 'Desk Sensor' Fixture Type, and then use the following API to provide desk occupancy data.
Compliance: Compliance for these licenses is determined based on the quantity of active API Licenses relative to the quantity of sensors with a Fixture Type of 'Desk Sensor'.
3. Fine-grain Motion License
The Fine-grain Motion API is most commonly used to support the following use cases:
- Utilization of large open spaces
- Break-in forensics
Enable Fine-Grain Motion
When the Motion API is enabled, the sensor will send 5-second motion bit data to Manage every 5 minutes. Refer to the article Enable Sensors for Fine-grain Motion. The following API provides Fine-grain motion data:
Compliance: Compliance for these licenses is determined based on the quantity of active API Licenses relative to the quantity of sensors with 'Motion API' enabled.
Upload API Licenses
See Request License for purchasing additional sensor licenses. Refer to the article License Management for an overview of how licenses are managed.
When API licenses are purchased and successfully uploaded, the License Management screen displays the active API License uploaded along with the number of licenses. For instructions about how to upload a license, see Upload License.
For example, the number of API licenses available is displayed on the screen. The license quantity of 100 means you can enable up to 100 sensors or areas to report occupancy information.
Recommended articles:
