Skip to main content

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

onboard.client-1.0.0.tar.gz (6.9 kB view details)

Uploaded Source

Built Distributions

onboard.client-1.0.0-py3.7.egg (8.6 kB view details)

Uploaded Egg

onboard.client-1.0.0-py3-none-any.whl (12.5 kB view details)

Uploaded Python 3

File details

Details for the file onboard.client-1.0.0.tar.gz.

File metadata

  • Download URL: onboard.client-1.0.0.tar.gz
  • Upload date:
  • Size: 6.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.7.7

File hashes

Hashes for onboard.client-1.0.0.tar.gz
Algorithm Hash digest
SHA256 a44e461d1db9ffb4922f2ffa11787f54bd0c546cdf0351c534222689385bcc9d
MD5 6adac1b990a9c085f4a6c18b161c95df
BLAKE2b-256 22af42987b4b2938e7f1111c319a3ee31a40661e7cc0517aaa673d7912b4d965

See more details on using hashes here.

File details

Details for the file onboard.client-1.0.0-py3.7.egg.

File metadata

  • Download URL: onboard.client-1.0.0-py3.7.egg
  • Upload date:
  • Size: 8.6 kB
  • Tags: Egg
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.7.7

File hashes

Hashes for onboard.client-1.0.0-py3.7.egg
Algorithm Hash digest
SHA256 4feba47a54009d01652be77aafbfc6cda91b8f3512f6db407ab22f96f07084c8
MD5 c793847b392721c46e31a46ba46f896f
BLAKE2b-256 8be348c888dc5995aaba73f4b12408d32e6201ca33539d89ff8a648cfd808bf3

See more details on using hashes here.

File details

Details for the file onboard.client-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: onboard.client-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 12.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.7.7

File hashes

Hashes for onboard.client-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 36263247bdffdd541eb61eb4ef96bacfc8298228fd03b18e0e98cb1f738c3240
MD5 b32c74efaac5d6b28c5b5783d9a8db3b
BLAKE2b-256 dd0d8d74349d82fa1d0819a2bf024df61398bf7071648d0a2b075848a76f2f09

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page