Frequently Asked Questions
What does Onboard do?
Onboard Data offers an efficient solution for collecting, labeling and storing your building data. This enables you to turn your data into actionable insights for optimizing building performance and making smarter decisions.
Where do I manage my building data?
You can manage your data with Onboard's Portal, a web-based application developed by Onboard. It serves as the central platform for managing your building deployment and its data. With the Portal, you can monitor and export real-time data, configure alerts, and manage your Onboard account, all in one place. Onboard uses multi-factor authentication to secure your login.
Does Onboard offer a free trial of its software?
Yes, Onboard provides a free sandbox account for new users to explore and test our software. Request your sandbox account today on the Onboard Data website.
How do I switch from sandbox to my own account?
When you are ready to deploy Onboard's software on your own building, contact sales@onboarddata.io to upgrade from sandbox account.
Where can I get help or submit feedback on Onboard’s software?
Onboard’s Help Center offers a wide range of guides to help you use our software and tools. If you can’t find what you’re looking for, have a feature request, or want to share feedback, head over to our Online Community for support from the Onboard team. For sensitive or building-specific issues, please reach out to us directly at support@onboarddata.io.
How do I join Onboard’s Online Community?
If you have an Onboard account, simply navigate to the Community tab within the portal.
When I log into my Onboard account, it prompts me to enter a six-digit code. Where do I find it?
This code is part of Multi-Factor Authentication (MFA). When you first signed up, you likely set up the MFA using an app on your phone like Google Authenticator or Authy. Open that app to retrieve the six-digit code and use it in the prompt to complete your login.
If you no longer have access to the app, email us at support@onboarddata.io to reset your account's MFA registration.
How does Onboard collect data from a building?
Onboard collects data by deploying it's Edge software on your building’s IP network. This serves as the link between your building and Onboard. It connects to your building’s systems, collects real-time data, and securely transmits it to the Onboard Portal.
What does the Edge software do?
Onboard’s Edge software is the software that runs on your building’s IP network and it connects all of your devices (furnaces, boilers, air conditioners, chillers, lighting, elevators, service water heating, and meters) to Onboard’s Cloud. Installing an Edge Node is the first step in the process of onboarding your building
How long does it typically take to set up a building?
The installation of the Edge software on your building's network takes just minutes. After installation, the software connects with your building systems, and starts collecting data. It may take up to 24 hours for the data to appear on the Onboard Portal.
What protocols does Onboard support?
Onboard connects to your building systems using BACnet or Modbus protocols.
When does real-time data collection begin for my building?
Real-time data collection begins as soon as the Edge software is successfully installed on your building network. You can model data in the Staging Interface at your own pace. Once a point(s) is published through staging, the collected historical data is automatically backfilled and live data collection continues for that point(s) going forward. Incrementally published points will begin collecting time-series data from the moment they are published
Does Onboard modify the data collected from the building?
No, Onboard collects and stores the exact metadata and telemetry from the building. You may see the data being displayed in its default units on Onboard. For example, temperature readings are displayed in Fahrenheit by default but can be changed in system settings.
What happens if internet access goes down?
After a successful installation, the Edge Node collects data even without internet access. After the connection is restored, the data is automatically sent to the Onboard server.
What happens if my building has a power outage?
The Edge Node cannot collect data during a power outage. However, it resumes data collection automatically once power is restored.
How long will collected data remain available?
Onboard’s data retention policy states that data will be retained for up to two years. Data older than this may still be accessible but is not guaranteed to remain available indefinitely.
What is the frequency of data collection?
The software collects data at 1 min intervals by default.
Can someone outside of Onboard access the Edge software?
No, Onboard does not provide access to the Edge software to prevent credential loss and tampering.
What happens if my building has a power outage?
The Edge Node cannot collect data during a power outage. However, it resumes data collection automatically once power is restored.
Does the Edge software write any data to the building network?
No, the Edge software only performs read-only operations. It does not write or send any commands back to the building’s network.
Do I need to install Edge Software separately for BACnet and Modbus?
No, only 1 Edge software is needed to be installed and it can connect to both BACnet and Modbus. This assumes that there are no IP / subnet collisions. Multiple Edge installations are only needed in the case of multiple subnets.
Can Onboard connect with BACnet MS/TP and Modbus TCP devices if they are connected to IP routers?
Yes, if the devices are exposed through their controllers.
How does Onboard connect to Modbus Devices?
We have pre-defined templates and automation that map Modbus devices to equipment types and each register to a point type with a corresponding unit. See Edge Software Installation Requirements for more info
Does Onboard support native connections to MS/TP or Modbus RTU?
Onboard does not natively support MS/TP or Modbus RTU. To connect these devices, use a gateway that converts communication protocols to BACnet/IP or Modbus TCP/IP.
Does the Edge software require outbound access?
Yes, the Edge software requires outbound internet access to securely transmit data to Onboard's server. To see the specific requirements, see: Edge Software Requirements
Does Onboard require inbound access to connected with the Edge software?
Inbound access is not required for Onboard to connect with the Edge software.
Instead, we use WireGuard to establish a secure VPN tunnel from the Edge Node to our cloud using the outbound access. Once this tunnel is active, all necessary communications flow securely through that tunnel.
How does Onboard support IT security requirements for maintenance and monitoring?
The hardware on which the Onboard software is installed including the OS & firewall is fully managed and controlled by your IT team.
For the Onboard software, all maintenance and updates are handled by Onboard.
How does Onboard secure its Edge software?
Onboard does not provide direct access to the software. This restriction helps protect system integrity and reduces the potential attack surface. Additionally, the software does not require any inbound connections, further minimizing exposure.
For more information on our security practices, see: Onboard Security Brief
Where is the Onboard platform and its services hosted?
Onboard hosts its platform and services including data storage on AWS in the USA
Can Onboard store its data in AWS outside USA?
We understand the concern and while this capability isn’t available yet, we are exploring multi-region region AWS support
Does the Edge software support IT tools like Splunk, Nessus, or EDR tools?
The Edge software does not support installing third-party agents like Splunk, Nessus, or EDR. Instead, we recommend securing the network with firewalls and restricting Edge software access to only the necessary domains.
How do I access the Onboard API?
Once your Onboard account is set up, visit our API & DOCs page to explore our API.
How do I create my API keys?
You can navigate to the API KEYS tab under your Account Settings. From there, you can create and manage multiple API keys as needed.
Which API Scopes should I add to my API keys?
To start querying your Building data, include these scopes with your API keys: Auth, Buildings: Read, &General.
Does Onboard offer any tools to simplify API access?
Can I retrieve only Change of Value (COV) data from Onboard’s time-series API?
The API returns all sampled time-series data by default. To get COV-only data, you can post-process the results to extract changes in value.
Can I get notified of Change of Value (CoV) instead of polling the API continuously?
Onboard does not currently support CoV based notifications. You can set up polling the API at regular intervals to detect changes in values as needed.
Does the API support modifiers or applying conversion rates such as Natural Gas volume to energy units (like kWh)?
The API does not support applying modifiers or custom conversion rates. You can post-process the exported data to apply your own conversion factors as needed.
Does Onboard support integration with SkySpark?
Onboard does not currently offer native tooling for SkySpark integration. However, users can write their own SkySpark client to connect and import data from Onboard API.
Does Onboard support any plugins for building dashboards?
Onboard currently supports integration with Grafana. Grafana allows users to create interactive, real-time dashboards that help visualize trends and monitor building performance at scale.
How can I graph trends across my entire building portfolio using Onboard?
Users can create visualizations using our Grafana integration or with Python or R SDKs. Alternatively, data can be exported and used to build charts in Excel.
Are there any limits on API queries?
Yes, API queries for time-series data are limited to 120 requests per hour.
How do I try out Onboard’s Staging UI?
You can request access to a editable sandbox building in the Staging Interface by emailing us at support@onboarddata.io. We’ll set you up so you can explore the interface and test features.
Which tab on Staging should I start data modeling from?
On Staging, You can start modeling from any tab you like. The staging workflow is flexible and non-linear, allowing users to start making changes from anywhere.
What if I make a mistake? Is there an undo option?
Staging does not currently support an explicit “undo” action. However, you can simply perform another action to correct the previous one.
New equipment or sensors have been added to my building. How do I add them to the Staging Interface?
Make sure the new equipment and/or sensors are configured to be discoverable by the Edge Node. Then, contact Onboard Support to let us know they’re ready. We’ll notify you once they appear in the Staging Area for modeling. Once modeled and published, the new points will begin streaming within 24 hours.
If I unpublish an equipment and/or its points, and then publish them again, will I retain the historical data?
Once a point is unpublished, its historical data is not retained. If you publish it again, it will start collecting data as a new point from that moment forward.