Skip to content
Stand with Ukraine flag

Gateway general configuration

  • Widget
  • v1.0.0
  • Sep 1, 2026
  • MIT license
  • v4.2+ | Built-in

Allows to create or edit general gateway configuration.

Widget Type
  • Latest
Category
  • Input Forms
Use Cases
  • Industrial Automation

Who it’s for

Engineers managing ThingsBoard IoT Gateways across a fleet who need a general-purpose configuration surface — creating a gateway, editing an existing one, working through the settings that are not specific to any one connector.

What it does

The Gateway general configuration widget creates and edits gateway configuration from the dashboard, covering the general settings rather than the per-connector ones. At 11×8 it is the largest of the gateway configuration widgets, giving the full set of options room to be worked through rather than scrolled past.

  • General settings in one place — the parameters that govern the gateway itself rather than any individual integration.
  • Gateways can be created as well as edited, so onboarding a new unit does not need a separate step.
  • Configuration is done from the platform, which is what makes a gateway on a remote site manageable without host access.
  • The generous default size reflects the amount of configuration involved.
  • The Gateway general configuration widget covers the gateway: connectors are managed by the Gateway connectors widget, and a page dedicated to one unit is better served by the single-device configuration widget.

How to set up

Data keys

The Gateway general configuration widget works against the gateway device it is pointed at rather than a configured key list.

KeyRoleTypeDescription
Gateway configuration keysThe configuration the widget reads and writesAttributePoint the datasource at the gateway device; the widget reads and writes that gateway’s own configuration.

Confirm the gateway is connected before making changes. Configuration saved while a gateway is offline is applied when it reconnects, which delays any error long enough that it is no longer obviously related to the edit.

How to customize

  • To manage a different gateway — change the datasource entity, since the widget follows whatever it is bound to.
  • To give the form room — keep the widget at or above its default size, because the general configuration set is large.

Tips

  • Change one thing at a time and confirm the gateway comes back before the next. A gateway restarts to apply configuration, and a batch of edits gives no indication which one stopped it reconnecting.
  • Pair this widget with the gateway’s statistics charts on the same dashboard. Configuration changes show up there as a break in the metrics, which is the quickest confirmation available that the gateway restarted and resumed.

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.