get_point_mapping¶
-
FactsService.
get_point_mapping
(building_id, equipment_names=[], equipment_types=[], point_classes=[], eco_point_ids=[], display_names=[], native_names=[], point_class_expression=[], native_name_expression=[], display_name_expression=[], is_active=True, result_format='pandas')¶ Return the point mapping for a building.
API documentation: http://facts.prod.ecorithm.com/api/v1/#/Point-Mapping/point_mapping_get
Args:
building_id (str): Building id to get facts for.
Example: 1
Kwargs:
equipment_names (list): List of equipment names to filter facts for.
Example: [‘VAV_01’, ‘VAV_02’]
equipment_types (list): List of equipment types to filter facts for.
Example: [‘VAV’, ‘AHU’]
point_classes (list): List of point_classes to filter facts for.
Example: [‘SpaceAirTemperature’, ‘CoolingCoilUnitFeedback’]
eco_point_ids (list): List of eco_point_ids to filter facts for.
Example: [1, 2, 3]
display_names (list): List of display_names to filter facts for.
Example: [‘SpaceTemp’, ‘AirFlow’]
native_names (list): List of native_names to filter facts for.
Example: [‘name-1’, ‘name-2’]
point_class_expression (list): List of equipment / equipment type + point class regex expressions to filter facts. Equipment / equipment type and point class regex expressions are space delimited. for.
Example: [‘VAV.* SpaceAirTemperature’, ‘AHU Space.*’]
native_name_expression (list): List of native-name regex expressions to filter facts.
Example: [‘nam.*’, ‘nati-.*’]
display_name_expression (list): List of equipment / equipment type + display name regex expressions to filter facts. Equipment / equipment type and point class regex expressions are space delimited.
Example: [‘VAV.* SpaceAirTemperature’, ‘AHU Space.*’]
is_active (boolean): Return the active / in-active native-names
Example: True
result_format (str): Output format type. (Pandas, tuple, csv, json)
Example: ‘pandas’
- Returns:
(DataFrame or list or csv or json depending on the requested result format).
DataFrame Example:
index eco_point_id display_name native_name point_class equipment_name equipment_type last_updated ===== ================ ============ ============ ========================= ============== ================ ======================= 0 192 'SpaceTemp' 'name-1' 'SpaceAirTemperature' 'VAV-01' 'VAV' "2017-12-07T19:04:18Z" 1 304 'CoolingCoil' 'name-2' 'CoolingCoilUnitFeedback' 'AHU-01' 'AHU' "2017-12-07T19:04:18Z"
Json Example:
{ "data": [ { "equipment_name": "VAV_01", "equipment_type": "VAV", "native_name": "Native-Name-1", "eco_point_id": 3, "point_class": "SpaceAirTemperature", "native_name_id": 1283, "display_name": "SpaceTemp", "last_updated": "2017-11-17T17:44:04Z" }, { "equipment_name": "VAV_02", "equipment_type": "VAV", "native_name": "Native-Name-1", "eco_point_id": 4, "point_class": "SpaceAirTemperature", "native_name_id": 1283, "display_name": "SpaceTemp", "last_updated": "2017-11-17T17:44:04Z" } ] }
Csv Example:
'point_class,display_name,native_name, equipment_type,equipment_name,eco_point_id SpaceAirTemperature,SpaceTemp, UCSB/275/VAV_301/NAE11/N2-2.275-VAV-301.ZN-T,VAV,VAV_301,85743, SpaceAirTemperatureSetPointWhenCooling, SpaceTempSetPoint_ActualCooling, UCSB/275/VAV_301/NAE11/N2-2.275-VAV-301.ACLG-SET,VAV,VAV_301, 85744, SpaceAirTemperatureSetPointWhenHeating, SpaceTempSetPoint_ActualHeating, UCSB/275/VAV_301/NAE11/N2-2.275-VAV-301.AHTG-SET,VAV,VAV_301,85745'
Tuple Example:
[response_tuple(point_class='SpaceAirTemperature', display_name='SpaceTemp', native_name='UCSB/275/VAV_301/NAE11/N2-2.275-VAV-301.ZN-T', equipment_type='VAV', equipment_name='VAV_301', eco_point_id=85743), response_tuple(point_class='SpaceAirTemperatureSetPointWhenCooling', display_name='SpaceTempSetPoint_ActualCooling', native_name='UCSB/275/VAV_301/NAE11/N2-2.275-VAV-301.ACLG-SET', equipment_type='VAV', equipment_name='VAV_301', eco_point_id=85744)]
Note
And invalid api request will return back the raw api response.
- Example:
{“message”: {“NoData”: “No data for provided parameters”}}
Example Usage:
>>> from eco_connect import FactsService >>> facts_service = FactsService() >>> facts_service.get_point_mapping(building_id=26, result_format='json') { "data": [ { "equipment_name": "VAV_01", "equipment_type": "VAV", "native_name": "Native-Name-1", "eco_point_id": 3, "point_class": "SpaceAirTemperature", "native_name_id": 1283, "display_name": "SpaceTemp", "last_updated": "2017-11-17T17:44:04Z" }, { "equipment_name": "VAV_02", "equipment_type": "VAV", "native_name": "Native-Name-1", "eco_point_id": 4, "point_class": "SpaceAirTemperature", "native_name_id": 1283, "display_name": "SpaceTemp", "last_updated": "2017-11-17T17:44:04Z" } ] }