API License

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 sensor software licenses and do not require any additional software licenses. Occupancy APIs require IoT sensors as well as additional API software licenses based on the APIs used. The following three API licenses are available:

  1. Real-time Area Occupancy License (API-RTO-AREA)
  2. Real-time Desk Occupancy License (API-RTO-DSK)
  3. Fine-grain Motion License (API-MB-SU)

1. Real-time Area Occupancy License (API-RTO-AREA)

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

Compliance for these licenses is determined based on the quantity of active Real-time Area Occupancy 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. Areas enabled as zonal sensors will report real-time occupancy status. Otherwise, occupancy data is not reported for the area. The following APIs provide area occupancy data.

Note: BACnet Real-time area occupancy status does not require API subscription. You only need the Connected Lighting (CL) Sensor license for reporting BMS integration via BACnet.

However, if 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 License (API-RTO-DSK)

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

Compliance for these licenses is determined based on the quantity of active Real-time Desk Occupancy API Licenses relative to the quantity of sensors with a Fixture Type of 'Desk Sensor'. 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.

3. Fine-grain Motion License (API-MB-SU)

The Fine-grain Motion API is most commonly used to support the following use cases:

  • Utilization of large open spaces
  • Break-in forensics

Compliance for these licenses is determined based on the quantity of active Fine-grain Motion API Licenses relative to the quantity of sensors with 'Motion API' enabled. 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:

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 Type uploaded along with the number of licenses. For instructions about how to upload a license, see Upload License. 

For example, the number of Real-time occupancy 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.

API.png

Recommended articles:

Was this article helpful?
1 out of 1 found this helpful
Have more questions? Submit a request

Comments

Article is closed for comments.