get_equipment

FactsService.get_equipment(building_id, equipment_name=None, equipment_type=None, is_active=True, result_format='pandas')

Return the equipments for a building.

API documentation: http://facts.prod.ecorithm.com/api/v1/#/Equipment/equipment_get

Args:

building_id (str): Building id to get facts for.

Example: 1

Kwargs:

equipment_name (string): Equipment name to filter on.

Example: ‘VAV_01’

equipment_type (string): equipment_type to filter on.

Example: ‘AHU’

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    equipment_id     equipment_type    equipment_name       last_updated
=====  ================   ==============   ================   =====================
0            192              'AHU'            'VAV-01'       '2017-12-07T19:04:18Z'
1            304              'VAV'            'AHU-01'       '2017-12-07T19:04:18Z'

Json Example:

{'data': [{'equipment_id': 1092,
           'equipment_name': 'AHU_G1',
           'equipment_type': 'AHU',
           'last_updated': '2017-12-07T19:04:18Z'},
           {'equipment_id': 1093,
            'equipment_name': 'AHU_G1_ExhaustFan',
            'equipment_type': 'AHU',
            'last_updated': '2017-12-07T19:04:18Z'}]
}

Csv Example:

'equipment_id,equipment_type,equipment_name,last_updated


1092,AHU,AHU_G1,2017-12-07T19:04:18Z


1094,AHU,AHU_G1_ReturnFanVFD,2017-12-07T19:04:18Z

Tuple Example:

[response_tuple(equipment_id=1092, equipment_type='AHU',
                equipment_name='AHU_G1',
                last_updated='2017-12-07T19:04:18Z'),
 response_tuple(equipment_id=1093, equipment_type='AHU',
                equipment_name='AHU_G1_ExhaustFan',
                last_updated='2017-12-07T19:04:18Z')]

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_equipment(building_id=26,
                                result_format='json')
        {'data': [{'equipment_id': 1092,
                   'equipment_name': 'AHU_G1',
                   'equipment_type': 'AHU',
                   'last_updated': '2017-12-07T19:04:18Z'},
                   {'equipment_id': 1093,
                    'equipment_name': 'AHU_G1_ExhaustFan',
                    'equipment_type': 'AHU',
                    'last_updated': '2017-12-07T19:04:18Z'}]
        }