FAQ¶

Occupancy APIs¶

Q: How long is Occupancy API data available?¶

A: For the Fine-Grain Motion, Occupancy API, data is retained with 5 min granularity for 45 days. If you need to store occupancy data for a longer period, consider the Space offering. The real-time data from Area APIs is not stored in the database.

Q: What is the granularity and delay of the occupancy data provided by the sensors through the API?¶

A: The Occupancy API data provided by the sensors is in real-time, with a delay of only 5 minutes. The Fine-Grain Motion API provides occupancy information for the last 5 minutes, with a granularity of 5 seconds at the time when the sensor last reported.

Q: How far back is the occupancy data available for the Space application? Does the granularity change over time?¶

A: If the Energy Manager (EM) server is located on-site, you can access Occupancy data in the Space application from up to 45 days ago. However, if the EM is connected to eCloud or EMC (Energy Manager in the Cloud), you can access Occupancy data from the time the system was first deployed.

Q: Will a RestAPI call to Manage provide the most recent area (zonal) occupancy status from the Manage database?¶

A: Yes. When an area is enabled as a Zonal area and API License (EM-API-OCC) has been purchased based on the number of sensors configured in the system, you can expect sub-minute end-to-end latency.

Q: Does placing a sensor into an Area and enabling Zonal Occupancy enable the sensor to start reporting occupancy events immediately?¶

A: Yes. The sensor reports area occupancy status. Refer to Enable Zonal area to enable sensors in an area to report occupancy.

Q: If Zone Sensor is enabled, will a zoned sensor report an occupancy event immediately to Manage server? Will it report a vacancy event 90 seconds after the most recent occupancy detection?¶

A: Yes. The sensor sends Area Occupancy Status to Manage by Real-Time packet, sent when the Area Occupancy Status: occupied (1) or unoccupied (0) event occurs. When the event occurs, a counter of 90 seconds starts on the sensor. An API License (EM-API-OCC) is required for the sensor to send real-time occupancy.

Q: If a sensor was placed into an Area, but Zonal Occupancy was not enabled, will the sensor still report Occupancy status?¶

A: No.

Q: Does a zonal sensor only report the first occupancy event in the vacancy state, or does it report each time it detects motion?¶

A: The sensor will report Occupancy Status via Real-Time packet every 90 sec as long as the sensor continuously detects motion.