Gateway configuration (Single device)
Allows to create or choose the gateway and edit its configuration.
Who it’s for
Engineers setting up a ThingsBoard IoT Gateway on a dashboard dedicated to that one gateway — a commissioning page, a per-site panel. The widget covers both creating the gateway device and editing its configuration, so the whole setup happens in one place.
What it does
The Gateway configuration (Single device) widget creates or selects a gateway device and edits its configuration in a single tall form. Unlike the general configuration widget, it is bound to one gateway at a time, which is what makes it right for a page about a specific unit rather than a fleet.
- Create or choose in one step — the gateway device can be created from here if it does not exist yet.
- One gateway per widget, which keeps a commissioning page unambiguous about what is being configured.
- The full gateway configuration is editable from the platform rather than from the host filesystem.
- A tall default size, 7.5×9, because the configuration form genuinely needs the height.
- The widget title is configurable, which matters on a page carrying several gateway-related widgets.
- The Gateway configuration (Single device) widget handles configuration: connectors are managed by the Gateway connectors widget.
How to set up
Data keys
The Gateway configuration (Single device) widget works against the gateway device it is pointed at rather than a configured key list.
| Key | Role | Type | Description |
|---|---|---|---|
| Gateway configuration keys | The configuration the widget reads and writes | Attribute | Point the datasource at the gateway device. The widget can also create that device when one does not exist yet. |
Gateway
| Setting | Default | Effect |
|---|---|---|
| Widget title | Gateway configuration (Single device) | The caption above the form |
Give the widget enough height. The configuration form is long, and a widget sized down to fit a grid row turns it into a scrolling window that is difficult to work through.
How to customize
- To name the panel — set the Widget title, ideally to the site or the gateway’s role rather than the generic default.
- To point at a different gateway — change the datasource entity, since the widget follows whatever it is bound to.
Tips
- Use this widget on a per-gateway page and the general configuration widget where a fleet is managed. Binding a configuration form to one device is what stops a change being applied to the wrong unit, which is the failure that matters most here.
- Give the gateway a name that identifies the site before configuring anything else. The name is what every other widget and every audit record refers to, and renaming later leaves a trail of references to something that no longer exists under that name.
Share Your Widget with the Community
Built a custom widget? Export it as a JSON from ThingsBoard and publish it to the IoT Hub through a simple 4-step wizard (Upload, Listing, Readme, Review & Submit). Share it with thousands of ThingsBoard developers worldwide and get featured in the catalog.