Gateway Configuration

Who it’s for

Engineers deploying a ThingsBoard IoT Gateway who need to configure it from the platform rather than by editing files on the host. The widget gives the gateway’s own settings a place on a dashboard, including creating the gateway device in the first place.

What it does

The Gateway Configuration widget edits a single gateway’s configuration from the dashboard and can create the gateway device if it does not exist yet. The configuration can be downloaded as an archive, named by a configurable file name, for keeping alongside a deployment record.

• Configuration from the platform rather than from the host filesystem, which is what makes a remote gateway manageable.
• The gateway device can be created from the widget, with a configurable device type for new gateways.
• The configuration downloads as an archive with a name you choose, so a deployment can keep a copy.
• The success message and the name-already-exists message are both editable, which matters where the dashboard is used by a team following a written procedure.
• The Gateway Configuration widget handles one gateway: connectors are managed by the Gateway connectors widget, and a multi-gateway view needs a widget per gateway or a state that switches between them.

How to set up

Data keys

The Gateway Configuration widget takes no datasource and no data keys — it works against the gateway device it is pointed at. The default configuration carries a leftover demo datasource, which can be removed.

Gateway

Setting	Default	Effect
Widget title	Gateway Configuration	The caption above the form
Default archive file name	configurationGateway	The name of the downloaded configuration archive
Device type for new gateway	Platform default	The device profile assigned when the widget creates a gateway
Success message	Platform default	Shown when the configuration saves
Name already exists message	Platform default	Shown when creating a gateway whose name is taken

Set the device type for new gateways to the profile your gateways actually use. A gateway created against the wrong profile picks up the wrong rule chain and the wrong attribute defaults, and that is not obvious from the gateway’s own behavior.

How to customize

• To assign the right profile to new gateways — set the Device type for new gateway.
• To name downloaded archives usefully — set the Default archive file name, ideally to something that identifies the site.
• To match your team’s procedure — edit the success and name already exists messages to the wording the runbook uses.
• To caption the form — set the Widget title.

Tips

• Download the configuration archive after every change and keep it with the deployment record. The platform holds the current state, and reconstructing what a gateway looked like before a change is otherwise guesswork.
• Name the archive after the site rather than leaving the generic default. A folder of files all called configurationGateway is indistinguishable once more than one gateway is in service.