Environmental Summary Data

Written By Sam Walton (Super Administrator)

Updated at May 31st, 2024

Table of Contents

Method Parameters Environmental measures Data model

Applies to version 2024.01 or later

The IBSS Platform supports integration with a variety of environmental sensors and BMS. The data from these sensors can be collected and summarised within the IBSS Platform to give the user and services managers clear information on the environmental conditions with the Intelligent Building.

Method

The IBSS API provides access to the collated environmental zone data as daily summaries using:

1 GET /v1/{nodeid}/EnvironmentalZoneDailySummary

Parameters

nodeid – the identifier of the floor or building for which the environmental data should be retrieved
startDate – the first date (inclusive) for which the environmental data should be retrieved
endDate – the last date (inclusive) for which the environmental data should be retrieved
$top – the maximum number of rows to return
$select – explicitly select which columns to return data for
$filter – apply a filter to return specific rows of environmental data

Environmental measures

The IBSS platform supports the following environmental measures:

Temperature
Humidity
CO - carbon monoxide
CO2 - carbon dioxide
PM25 - parts per million 2.5 μm
PM10 - parts per million 10 μm
TVOC - total volatile organic compounds
Sound_Level
Light_Level
Battery_Level

Data model

The returned data set contains the following data (unless overridden by the $select parameter):

"Summary_Date_Local": "2024-03-13",
    "Record_Id": "20240313_AllDay_6_10001",
    "ID": 65840130,
    "EventId": "22_d15f9aff-5140-4cc3-9f0f-baa77ff879db",
    "Env_Zone_Id": 10001,
    "IsWorking_Day": 1,
    "Node_Id": 6,
    "Env_Zone_Name": "TEST-ZONE001",
    "Env_Temperature": 0,
    "Env_Humidity": 0,
    "Env_CO": 0,
    "Env_CO2": 0,
    "Env_PM25": 0,
    "Env_PM10": 0,
    "Env_TVOC": 0,
    "Env_Sound_Level": 0,
    "Env_Light_Level": 0,
    "Env_Battery_Level": 0,
    "IAQ_Status": 0,
    "Env_Temperature_Status": 0,
    "Env_Humidity_Status": 0,
    "Env_CO_Status": 0,
    "Env_CO2_Status": 0,
    "Env_Humidity_Range": 0,
    "Env_Temperature_Range": 0,
    "Env_PM25_Status": 0,
    "Env_PM10_Status": 0,
    "Env_TVOC_Status": 0,
    "Env_Sound_Level_Status": 0,
    "Env_Sound_Level_Range": 0,
    "Env_Light_Level_Status": 0,
    "Env_Light_Level_Range": 0,
    "Env_Battery_Level_Status": 0,
    "Env_Zone_Status": 0,
    "Summary_Date": "2024-03-13T00:00:00Z"

Field Name	Description
Summary_Date_Local	Generated automatically.
Record_Id	Generated automatically.
ID	Summary data ID, generated automatically.
EventId	Generated automatically.
Env_Zone_Id	The ID of the environmental zone.
IsWorking_Day	0: the day for which the values are calculated is not a working day. 1: the day for which the values are calculated is a working day.
Node_Id	ID of the building.
Env_Zone_Name	The name of the environmental zone.
Env_Measure	The time weighted value of the Measure across the calculation period.
Env_Measure_Status	0: the Measure has not been used in the calculation period. 1: the Measure is within normal range, i.e. it is between its high and low limit. 2: the Measure has exceeded its first level, i.e. it is between high and high-high or it is between low and low-low. 3: the Measure has exceeded its second level, i.e. it is above high-high or it is below low-low.
Env_Measure_Range	-1: the Measure is below the normal range 0: the Measure is not used or is within the normal range 1: the Measure is above the normal range Examples: Env_Humidity_Range Env_Temperature_Range Env_Sound_Level_Range Env_Light_Level_Range
IAQ_Status	1: Good status 2: OK, normal status 3: Poor status
Env_Zone_Status	The maximum value of all Env_Measure_Status fields.
Summary_Date	The date for which the summary is created, this date is always in local time.

Parameters used in earlier versions than 2024.01:

Field Name	Description
Summary_Day_Type	The time period covered by the summary record: AllDay: from midnight to midnight. WorkingHours: the period between the working hours start and working hours end parameters. NonWorkingHours: the period between midnight and the working hours start parameter and the period between the working hours end parameter and the next midnight. OfficeHours: the period between the office hours start and office hours end parameters (effectively the time that the building is open/accessible). NonOfficeHours: the period between midnight and the office hours start parameter and the period between the working hours end parameter and the next midnight.
Env_Zone_Sensors	The number of sensors included in the zone calculations at any point during the time period covered.
Env_Zone_Sensors_Updated_Perc	The percentage of updates received against the total number of updates expected.

Method

Parameters

Environmental measures

Data model

Related Articles