1 file was added to this release more than 14 days after its initial publication. Inspect the release files before installing.
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.
Release files for onboard-client 1.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
File added late
1 file was uploaded more than 14 days after the first file in this release.
While project maintainers occasionally add legitimate files to an existing release, late additions can also indicate a security compromise.
We recommend inspecting the release files before installing.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| onboard.client-1.0.0.tar.gz | 6.9 kB | Details |
Built distributions (wheels)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| onboard.client-1.0.0-py3.7.egg | Legacy Egg format | - | - | Details |
| onboard.client-1.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 28.0 kB
Release files / onboard.client-1.0.0.tar.gz
| Download URL | onboard.client-1.0.0.tar.gz |
|---|---|
| Size | 6.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a44e461d1db9ffb4922f2ffa11787f54bd0c546cdf0351c534222689385bcc9d
|
|
BLAKE2b-256 checksum How to use checksums |
22af42987b4b2938e7f1111c319a3ee31a40661e7cc0517aaa673d7912b4d965
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is 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
|
Release files / onboard.client-1.0.0-py3.7.egg
File added late
This file was uploaded more than 14 days after the first file in this release.
While project maintainers occasionally add legitimate files to an existing release, late additions can also indicate a security compromise.
We recommend inspecting the release file before installing.
| Download URL | onboard.client-1.0.0-py3.7.egg |
|---|---|
| Size | 8.6 kB |
| Tags | Egg |
|
SHA-256 checksum How to use checksums |
4feba47a54009d01652be77aafbfc6cda91b8f3512f6db407ab22f96f07084c8
|
|
BLAKE2b-256 checksum How to use checksums |
8be348c888dc5995aaba73f4b12408d32e6201ca33539d89ff8a648cfd808bf3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is 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
|
Release files / onboard.client-1.0.0-py3-none-any.whl
| Download URL | onboard.client-1.0.0-py3-none-any.whl |
|---|---|
| Size | 12.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
36263247bdffdd541eb61eb4ef96bacfc8298228fd03b18e0e98cb1f738c3240
|
|
BLAKE2b-256 checksum How to use checksums |
dd0d8d74349d82fa1d0819a2bf024df61398bf7071648d0a2b075848a76f2f09
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is 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
|
