Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

[Support in progress]Support added October 2021

Codecs & Templates have been expanded to allow exposing commands into our dashboard UI. When these are selected they allow us to trigger commands to the device that will set certain common configuration options that we’ve chosen to expose.

Info

These options must be supported in the Codec as well as a downlink_commands section added to the Custom Template.

Table of Contents
Code Block
    "variables": [
      {
        "order": 0,
        "label": "Reading Interval",
        "type": "string",
        "key": "command.interval",
        "form": "select",
        "min": null,
        "max": null,
        "required": true,
        "hide_on_setup": true,
        "help_texts": [{"value": "Device must be online before changing interval setting", "order": 0}],
        "default_value": "600",
        "values": [
          {
            "label": "30 seconds",
            "value": "30"
          },
  • The key (e.g. command.interval) tells the codec what type of downlink command is defined/used.

  • Make use of Displaying user friendly text is done using the label and help_texts options to display user friendly text . Use these so that it is clear to the user what these options do when selected in our Settings UI.

...

Code Block
[
    {
      "order": 0,
      "label": null,
      "variables": [
        {
          "order": 0,
          "label": "Reading Interval",
          "type": "string",
          "key": "command.interval",
          "form": "select",
          "min": null,
          "max": null,
          "required": true,
          "hide_on_setup": true,
         "help_texts": [{"value": "Device must be online before changing interval setting", "order": 0}],
          "default_value": "600",
          "values": [
            {
              "label": "30 seconds",
              "value": "30"
            },
            {
              "label": "1 minute",
              "value": "60"
            },
            {
              "label": "2 minutes",
              "value": "120"
            },
            {
              "label": "5 minutes",
              "value": "300"
            },
            {
              "label": "10 minutes",
              "value": "600"
            },
            {
              "label": "15 minutes",
              "value": "900"
            },
            {
              "label": "20 minutes",
              "value": "1200"
            },
            {
              "label": "30 minutes",
              "value": "1800"
            },
            {
              "label": "1 hour",
              "value": "3600"
            },
            {
              "label": "6 hours",
              "value": "21600"
            }
          ]
        }
      ]
    }
  ]

...