Package: OnboardClient 1.0.0
Christopher Dudas-Thomas
OnboardClient: Bindings for Onboard Data's Building Data API
Provides a wrapper for the Onboard Data building data API <https://api.onboarddata.io/swagger>. Along with streamlining access to the API, this package simplifies access to sensor time series data, metadata (sensors, equipment, and buildings), and details about the Onboard data model/ontology.
Authors:
OnboardClient_1.0.0.tar.gz
OnboardClient_1.0.0.tar.gz(r-4.5-noble)OnboardClient_1.0.0.tar.gz(r-4.4-noble)
OnboardClient_1.0.0.tgz(r-4.4-emscripten)OnboardClient_1.0.0.tgz(r-4.3-emscripten)
OnboardClient.pdf |OnboardClient.html✨
OnboardClient/json (API)
| # Install 'OnboardClient' in R: |
| install.packages('OnboardClient', repos = c('https://cran.r-universe.dev', 'https://cloud.r-project.org')) |
This package does not link to any Github/Gitlab/R-forge repository. No issue tracker or development information is available.
Last updated 2 years agofrom:57c648c262. Checks:OK: 2. Indexed: yes.
| Target | Result | Date |
|---|---|---|
| Doc / Vignettes | OK | Sep 07 2024 |
| R-4.5-linux | OK | Sep 07 2024 |
Exports:api.getapi.postapi.setupapi.statusget_building_infoget_buildingsget_deploymentsget_equip_typesget_equipment_by_idsget_metadataget_orgsget_point_typesget_points_by_idsget_staged_dataget_timeseriesget_timeseries_rawget_usersPointSelectorpromote_staged_dataselect_pointsupload_staging
Dependencies:askpassclicpp11curldata.tabledplyrfansigenericsgluehttrjsonlitelifecyclelubridatemagrittrmimeopensslpillarpkgconfigplyrpurrrR6Rcpprlangrrapplyrstudioapistringistringrsystibbletidyrtidyselecttimechangeutf8vctrswithr
Readme and manuals
Help Manual
| Help page | Topics |
|---|---|
| Access API keys and URL from System Environment | api.access |
| API GET call | api.get |
| API POST call | api.post |
| Set up Onboard API keys and URL in system environment | api.setup |
| Check the status of your connection with the Onboard API | api.status |
| Building Info | get_building_info |
| Buildings | get_buildings |
| Deployments | get_deployments |
| Equipment Types | get_equip_types |
| Equipment by ID | get_equipment_by_ids |
| Metadata | get_metadata |
| Organizations | get_orgs |
| Point Types | get_point_types |
| Points by ID | get_points_by_ids |
| Get Staged Data | get_staged_data |
| Time-Series Data | get_timeseries |
| Raw Time-Series Data | get_timeseries_raw |
| Users | get_users |
| PointSelector | PointSelector |
| Promote data on Staging Area | promote_staged_data |
| Select Points | select_points |
| Upload to Staging Area | upload_staging |