Onboard API SDK
Project description
Onboard Portal Python SDK
This package provides Python bindings to Onboard Data's building data API. For more details, you can consult the API's swagger documentation.
API Access
You'll need an API key or existing account in order to use this client. If you don't have one and would like to start prototyping against an example building please request a key here.
Client usage example
First, you'll need to install the client (requires Python >= 3.6 )
$ pip install onboard.client
Now you can use the client to fetch timeseries data for sensors by building or based on type.
from onboard.client import OnboardClient
client = OnboardClient(api_key='your-key-here')
client.whoami() # verify access & connectivity
client.get_all_point_types() # retrieve available types of sensors
# retrieve the past 6 hours of data for sensors measuring CO2 ppm
import datetime
from onboard.client.models import PointSelector
query = PointSelector()
query.point_types = ['Zone Carbon Dioxide']
query.buildings = ['Example Building']
selection = client.select_points(query)
end = datetime.datetime.utcnow()
start = end - datetime.timedelta(hours=6)
sensor_metadata = client.get_points_by_ids(selection['points'])
sensor_data = client.query_point_timeseries(selection['points'], start, end)
License
Copyright 2018-2020 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
http://www.apache.org/licenses/LICENSE-2.0
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
Hashes for onboard.client-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 36263247bdffdd541eb61eb4ef96bacfc8298228fd03b18e0e98cb1f738c3240 |
|
MD5 | b32c74efaac5d6b28c5b5783d9a8db3b |
|
BLAKE2b-256 | dd0d8d74349d82fa1d0819a2bf024df61398bf7071648d0a2b075848a76f2f09 |