Configuration parameters

The unique identifier of the device.
(alphanumeric)

The URL of esthesis server to register this device with.
(alphanumeric/URL)

A comma-separated list of key-value pairs to be sent as attributes.
(alphanumeric)

A flag indicating whether the device should try to automatically obtain newer firmware once per day.
(boolean, false)

The category of data posted as demo data.
(alphanumeric, demo)

The frequency in which demo data is generated (in seconds).
(integer, 0)

Whether the embedded HTTP server is enabled or not.
(boolean, false)

The IP address where the embedded HTTP server listens to.
(alphanumeric/IP address, 127.0.0.1)

The port in which the embedded HTTP server listens to.
(integer, 8080)

The username to connect to the embedded HTTP endpoint. If defined, it must be sent as Basic auth together with the password.
(alphanumeric)

The password to connect to the embedded HTTP endpoint. If defined, it must be sent as Basic auth together with its username.
(alphanumeric)

Whether the embedded MQTT server is enabled or not.
(boolean, false)

The IP address where the embedded MQTT server listens to.
(IP address, 127.0.0.1)

The port in which the embedded MQTT server listens to.
(integer, 1883)

The username to connect to the embedded MQTT endpoint.
(alphanumeric)

The password to connect to the embedded MQTT endpoint.
(alphanumeric)

The frequency to send health reports (in seconds).
(integer, 300)

The number of seconds to wait before retrying a failed HTTP request.
(integer, 60)

The number of seconds after which an HTTP call times out.
(integer, 60)

The characters length to abbreviate log messages to.
(integer, 1024)

The logging level to use [trace, debug, info].
(alphanumeric, info)

The filesystem location of a Lua script to transform incoming payloads for telemetry data pushed via the HTTP endpoint.
(alphanumeric)

The filesystem location of a Lua script to transform incoming payloads for metadata data pushed via the HTTP endpoint.
(alphanumeric)

The filesystem location of a Lua script to transform incoming payloads for telemetry data pushed via the MQTT endpoint.
(alphanumeric)

The filesystem location of a Lua script to transform incoming payloads for metadata data pushed via the MQTT endpoint.
(alphanumeric)

A custom MQTT telemetry endpoint to be handled by a user-defined Lua script. The first argument of this parameter is the name of the topic, and the second argument is the Lua script to be executed. This parameter can be repeated to define additional topics.
(alphanumeric alphanumeric)

A custom MQTT metadata endpoint to be handled by a user-defined Lua script. The first argument of this parameter is the name of the topic, and the second argument is the Lua script to be executed. This parameter can be repeated to define additional topics.
(alphanumeric alphanumeric)

A custom HTTP telemetry endpoint to be handled by a user-defined Lua script. The first argument of this parameter is the name of the endpoint, and the second argument is the Lua script to be executed. This parameter can be repeated to define additional topics.
(alphanumeric alphanumeric)

A custom HTTP metadata endpoint to be handled by a user-defined Lua script. The first argument of this parameter is the name of the endpoint, and the second argument is the Lua script to be executed. This parameter can be repeated to define additional topics.
(alphanumeric alphanumeric)

The number of seconds that a queued inflight message should exist before being purged.
(integer, 60)

The number of seconds to wait before failing an outgoing MQTT message.
(integer, 60)

A flag indicating whether the device should start paused.
(boolean, false)

The frequency to ping esthesis CORE (in seconds)
(integer, 60)

The file to store the agent’s configuration.
(alphanumeric, $HOME/.esthesis/device/esthesis.properties)

The script used to install new provisioning packages.
(alphanumeric, $HOME/.esthesis/device/firmware.sh)

The script used to reboot the device.
(alphanumeric, $HOME/.esthesis/device/reboot.sh)

If set, the registration request will include it as a header.
(alphanumeric)

The secure file to store sensitive parts of the agent's configuration.
(alphanumeric, $HOME/.esthesis/device/secure/esthesis.properties

A flag indicating whether provisioning requests should be accompanied by a signature token.
(alphanumeric, false

The script used to shut down the device.
(alphanumeric, $HOME/.esthesis/device/shutdown.sh)

The algorithm to use to produce signatures.
(alphanumeric, SHA256WITHRSA)

The remote commands this device supports:
e: Execute arbitrary
f: Firmware update
r: Reboot
s: Shutdown
p: Ping
h: Health report


(alphanumeric, efrsph)

A comma-separated list of tags to associate with this device. Tag names should only contain letters, numbers, and underscore.
(alphanumeric)

The folder to temporarily store provisioning packages.
(alphanumeric, OS default temp directory)

The MQTT topic to use for command request messages.
(alphanumeric, esthesis/command/request)

The MQTT topic to use for command reply messages.
(alphanumeric, esthesis/command/reply)

The MQTT topic to post demo data.
(alphanumeric, esthesis/telemetry)

The MQTT topic to use for metadata messages.
(alphanumeric, esthesis/metadata)

The MQTT topic to use for ping messages.
(alphanumeric, esthesis/ping)

The MQTT topic to use for telemetry messages.
(alphanumeric, esthesis/telemetry)

A file with a single line of text depicting the current version of the firmware running on the device.
(alphanumeric, $HOME/.esthesis/device/version)

The MQTT topic to report the firmware version.
(alphanumeric, esthesis/metadata)

Report the version number available in the specified version file once during boot.
(alphanumeric, false

Whether outgoing HTTPS connections should have TLS verified.
(boolean, true)