Onboard Data Python API documentation
This package provides Python bindings to Onboard Data’s building data API, allowing easy and lightweight access to building data.
For example, we can retrieve the last week of temperature data from all Zone Temperature points associated with FCUs in the Laboratory building:
import pandas as pd import onboard.client from datetime import datetime, timezone, timedelta from onboard.client.models import PointSelector, TimeseriesQuery, PointData from typing import List client = OnboardClient(api_key='your-api-key-here') query = PointSelector() query.point_types = ['Zone Temperature'] # can list multiple query.equipment_types = ['fcu'] query.buildings = ['Laboratory'] selection = client.select_points(query) start = datetime.now(pytz.utc) - timedelta(days=7) end = datetime.now(pytz.utc) timeseries_query = TimeseriesQuery(point_ids = selection['points'], start = start, end = end) sensor_data = points_df_from_streaming_timeseries(client.stream_point_timeseries(timeseries_query))
For installation instructions, and to get set up with API access, refer to :ref:`Initial Setup`_.
While we are committed to backwards-compatibility, this project is under active development. If you discover a feature that would be helpful, or any unexpected behavior, please contact us at email@example.com
Copyright 2018-2022 Onboard Data Inc
Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.