Aggregate Sensor Energy Data by Floor¶
Enlighted Manage software v4.4 release and above supports this API.
This API returns the total energy consumption in watt-hour for all fixtures on the floor. Users can retrieve energy consumption data for up to forty-five days. The energy data is pre-aggregated in fifteen-minute intervals (96 records per day), adhering to most measurement and verification (M&V) reporting standards.
Request¶
GET https://{em_ip_address_or_hostname}/ems/api/org/facility/v2/facilityEnergyStatsOfFloor/15min/floor/{floor_id}/{from_date}/{to_date}?page={page}
Parameters¶
Request¶
| Parameter | Description |
|---|---|
em_ip_address_or_hostname | Manage’s IP address or hostname |
floor_id | Floor identifier. Use the Get All Floors  API, or in EM, select Facility > Floor > in the left panel, and click the Settings tab to obtain the Floor ID. |
from_date | Start date to display energy consumption data. Format: (yyyyMMddHHmmss). year/month/day/hour/minutes/seconds. |
to_date | End date to stop displaying energy consumption data. Format: (`yyyyMMDDHHmmss). year/month/day/hour/minutes/seconds. |
page | The requested page number. Each page displays 96 records corresponding to 24 hours of energy consumption data. For example, when a user requests 30 days of energy consumption data, the 15th page will have the energy consumption details for the 15th day of the requested period. |
Response¶
| Parameter | Description |
|---|---|
id | Floor Identifier. |
name | Floor name |
intervalStart | Time from when data is retrieved (YYYY-MM-DDTHHLMM:SS{+/-GMT}) |
baseenergy | Displays the baseline energy consumption in watt-hour of the fixtures. The difference between baseEnergy and energy is savedEnergy. Base energy is the amount of energy the fixtures will consume if their dimLevel was 100% for the entire period; energy will never be greater than baseEnergy. |
energy | The energy consumed by all fixtures in watt-hour on the floor for the period. |
savedEnergy | The energy saved by the fixtures in watt-hour on the floor for the period. - savedEnergy = baseEnergy - energy; -savedEnergy = occSavings + ambientSavings + manual Savings |
occSavings | Fixture energy savings from baseline when lights are switched off due to vacancy. |
ambientSavings | Fixture energy savings from baseline when lights are dimmed due to available ambient daylight. |
manualSavings | Fixture energy savings from baseline when lights are manually controlled. |
Sample Request¶
Using the Floor ID '1' returned by the Get All Floors API, request the aggregate energy consumption for fixtures on the floor from 5:30am on Feb. 12, 2019 to 5:30am on Feb. 19, 2019. The sample response shows details returned for fixtures on the floor for the specified time period for page 2 (Feb. 13, 5:30am to Feb. 14, 5:30am).
GET https://192.80.3.2/ems/api/org/facility/v2/facilityEnergyStatsoffloor/15min/floor/1/20190212053000/20190219053000?page=2
Sample Response¶
{
"facilityEnergyStats": [
{
"id": "1",
"intervalStart":"2019-02-13T05:30:00+05:30",
"name": "7th Floor",
"baseEnergy": "38.85",
"energy": "16.00",
"savedEnergy": "22.85",
"occSavings": "16.20",
"ambientSavings":"0.00",
"tuneupSavings": "6.65",
"manualSavings":"0.00"
},
{
"id": "1",
"intervalStart":"2019-02-13T05:45:00+05:30",
"name": "7th Floor",
"baseEnergy": "38.85",
"energy": "16.00",
"savedEnergy": "22.85",
"occSavings": "16.20",
"ambientSavings":"0.00",
"tuneupSavings": "6.65",
"manualSavings":"0.00"
},
{
"id": "1",
"intervalStart":"2019-02-13T06:00:00+05:30",
"name": "7th Floor",
"baseEnergy": "38.85",
"energy": "16.00",
"savedEnergy": "22.85",
"occSavings": "16.20",
"ambientSavings":"0.00",
"tuneupSavings": "6.65",
"manualSavings":"0.00"
},
{
"id": "1",
"intervalStart":"2019-02-13T06:15:00+05:30",
"name": "7th Floor",
"baseEnergy": "38.85",
"energy": "16.00",
"savedEnergy": "22.85",
"occSavings": "16.20",
"ambientSavings":"0.00",
"tuneupSavings": "6.65",
"manualSavings":"0.00"
},
{
"id": "1",
"intervalStart":"2019-02-13T06:30:00+05:30",
"name": "7th Floor",
"baseEnergy": "38.85",
"energy": "16.00",
"savedEnergy": "22.85",
"occSavings": "16.20",
"ambientSavings":"0.00",
"tuneupSavings": "6.65",
"manualSavings":"0.00"
},
]
}