FAQ — IoT Hub Users
General
Section titled “General”Who can use IoT Hub?
Section titled “Who can use IoT Hub?”IoT Hub is available to all ThingsBoard users — Community Edition, Professional Edition, Cloud (PaaS), and Edge. You can browse the catalog without an account. Installing items requires a running ThingsBoard instance.
Is IoT Hub free to use?
Section titled “Is IoT Hub free to use?”Browsing and installing items is free. All items published during the current launch phase are released under the Apache 2.0 license. Advanced monetization features (paid items, premium subscriptions) are planned for a future phase.
What ThingsBoard version do I need?
Section titled “What ThingsBoard version do I need?”Each item lists a minimum supported ThingsBoard version on its detail page. Check this before installing. Items that require Professional Edition features are labeled accordingly.
Finding items
Section titled “Finding items”How do I search for items?
Section titled “How do I search for items?”Use the search bar at the top of any catalog page. Searches match item names, descriptions, and tags. You can also filter by use case category (Fleet Tracking, Smart Building, Industrial Automation, etc.) within each item type.
How do I know if an item requires Professional Edition?
Section titled “How do I know if an item requires Professional Edition?”Items that use PE-only features (e.g., advanced rule chain nodes, white-labeling) display a Professional Edition badge on their catalog card and detail page.
Can I preview an item before installing?
Section titled “Can I preview an item before installing?”Yes. Each item has a detail page with a description, preview images, and a Readme that documents exactly what the item does, which telemetry keys it expects, and what entities it creates. Read the Readme before installing.
Installing items
Section titled “Installing items”Will installing a solution template overwrite my existing dashboards?
Section titled “Will installing a solution template overwrite my existing dashboards?”No. Solution templates always create new entities with unique names. They do not modify or overwrite anything already in your instance.
Can I install the same item more than once?
Section titled “Can I install the same item more than once?”Yes, with some caveats:
- Widgets are identified by their FQN — reinstalling the same version does nothing new. Installing a new version updates the existing widget definition.
- Solution templates and devices create new entities on each install, so installing twice creates two sets of entities.
- Rule chains, calculated fields, and alarm rules follow the same update-in-place behavior as widgets.
An item requires specific telemetry keys — what happens if my device sends different keys?
Section titled “An item requires specific telemetry keys — what happens if my device sends different keys?”The item will install successfully, but it won’t function correctly until your device sends the exact key names the item expects. Check the Readme for the required key names (they are case-sensitive) and rename your device’s telemetry keys or add a transformation rule chain to map them.
Installation failed with a version error
Section titled “Installation failed with a version error”Check that your ThingsBoard instance version meets the minimum version requirement shown on the item detail page. Some items require Professional Edition features — verify the edition badge on the listing before installing.
Using installed items
Section titled “Using installed items”Can I customize an item after installing it?
Section titled “Can I customize an item after installing it?”Yes. Once installed, items are standard ThingsBoard entities. You can edit dashboards, modify rule chains, adjust alarm thresholds, and change widget settings freely. Customizations are local to your instance and do not affect the IoT Hub listing.
Will my customizations be overwritten when I update to a new version?
Section titled “Will my customizations be overwritten when I update to a new version?”For widgets: updating replaces the widget type definition, which may reset customizations made directly to the widget’s template or controller script. Dashboard-level settings (data keys, layout, widget settings) are preserved.
For rule chains, calculated fields, and alarm rules: updating replaces the definition. Export a backup of your customized version before updating if you want to preserve changes.
Widget doesn’t show data after installation
Section titled “Widget doesn’t show data after installation”Confirm that your device sends the exact telemetry key names documented in the widget’s Readme. Key names are case-sensitive.
Calculated field shows no output
Section titled “Calculated field shows no output”Verify that the source telemetry keys exist on the device and that the calculated field is assigned to the correct device profile.
How do I know when a new version of an installed item is available?
Section titled “How do I know when a new version of an installed item is available?”Currently, there is no automatic notification. Check the item’s detail page on IoT Hub periodically, or follow the contributor’s profile to track their updates.
Licensing and reuse
Section titled “Licensing and reuse”What license do IoT Hub items use?
Section titled “What license do IoT Hub items use?”All items published during the launch phase use the Apache 2.0 license. You are free to use, modify, and integrate them into your own solutions. You cannot re-publish another contributor’s item on IoT Hub as your own — the review process enforces this.
Can I use an installed item in a commercial project?
Section titled “Can I use an installed item in a commercial project?”Yes. Apache 2.0 permits commercial use. There is no restriction on using IoT Hub items in production deployments.
Getting help
Section titled “Getting help”Where do I report a problem with an item?
Section titled “Where do I report a problem with an item?”Contact the contributor directly using the contact information on their Creator profile (visible on the item detail page).
Where do I get help with ThingsBoard itself?
Section titled “Where do I get help with ThingsBoard itself?”Was this helpful?