Skip to main content

Device Settings

The Settings tab in the device detail view lets you configure a device's name, location, tags, environment variables, and firmware settings. Changes to firmware settings will apply immediately to the device, changing other settings will require a re-sync of workflows that device is in for the changes to show up for skills in that specific workflow.


Basic information

Device name

The device name is a free-form label that identifies the device within your organization. Device names must be unique across your organization.

To rename a device:

  1. Open the device detail view and click the Settings tab.
  2. Update the Name field.
  3. Click Save.

Location

Assigning a location to a device does two things:

  • Sets the device's position on the Map view on the Devices page.
  • Sets the device's local timezone, which is automatically injected as the TZ and OPTRA_DEVICE_TIMEZONE environment variables passed to every skill running on the device.

To assign or change a location:

  1. Select a location from the Location dropdown.
  2. Click Save.

To create a new location inline, click + Add Location in the dropdown. You can provide a name, address, and GPS coordinates.

tip

Setting an accurate location and timezone ensures that skills relying on time-based logic behave correctly, and that log timestamps are easy to interpret.


Tags

Tags are labels you can attach to devices for filtering and organization. For example, you might tag devices by site (warehouse), environment (production), or purpose (vision-inspection).

  • A device can have multiple tags.
  • Tags are shared across your organization (one tag can be applied to many devices).
  • Tags appear as badges in the device detail view and can be used as filters on the Devices page.

To add or remove tags:

  1. Open the Settings tab.
  2. Use the Tags field to add existing tags or type a new tag name to create one inline.
  3. Click Save.

Enable / disable

The Enable toggle controls whether the device is active in the portal.

  • Enabled (default): The device is active. Skills are deployed, outputs are collected, and logs are available.
  • Disabled: The device is deactivated in the portal. This does not physically turn off the device hardware but prevents it from receiving new deployments.
note

Disabling a device requires the Admin role.


Environment variables

Environment variables are key-value pairs passed to every skill running on the device. Device-level variables override any matching variables defined at the skill or workflow level.

See Environment Variables for the full list of default system variables and the rules for defining custom ones.


Firmware settings

Firmware settings are key-value pairs that configure the device's on-board control software — separate from skill configuration.

note

Firmware settings require firmware version 2.3.10 or later. If your device is running an older version, update the firmware first.

  • Keys must not contain ., $, #, or spaces.
  • Changes are pushed to the device over the air. If the push fails (for example, the setting value is incorrect), the portal will display an error.
  • The current reported value from the device is shown alongside the configured value, so you can confirm the device has applied the change.

Maintenance window

The maintenance window controls when the portal is allowed to automatically apply firmware updates to the device.

SettingDescription
EnabledToggle on to activate scheduled maintenance windows
DayThe day (or "Daily") on which updates should be applied
HourThe hour of the day (0–23) at which updates should start
TimezoneWhether to use UTC or the device's local timezone (from its assigned location)

When a new firmware version becomes available, the update will be queued and applied automatically during the next maintenance window rather than immediately.

tip

Schedule maintenance windows during off-peak hours to minimize any disruption to running skills.

See Firmware for more details on how updates work.