Versions Compared

Version Old Version 1 New Version Current
Changes made by

Brent Meriwether (Unlicensed)

Brent Meriwether (Unlicensed)

Saved on

Key

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

...

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.

Support options and documentation is found here: Downlink Interval Doc

...

Image Removed

Example (command.interval)

Code Block
[ { "order": 0, "label": null, "

Link to our Google Doc showing templates and testing status.

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.

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

See the tech doc with full details for more info: Downlink Interval Doc

...

Image Added

Example (command.interval)

Code Block
[
    {
       {"order": 0,
      "label": null,
      "labelvariables": [
   "1 minute",    {
          "valueorder": "60"0,
          "label": "Reading },Interval",
          "type": "string",
      {    "key": "command.interval",
          "labelform": "2 minutesselect",
          "min": null,
   "value": "120"      "max": null,
     },     "required": true,
      {    "hide_on_setup": true,
         "labelhelp_texts": [{"value"5: minutes",Device must be online before changing interval setting", "order": 0}],
          "default_value": "300600",
            },"values": [
            {
              "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"
            }
          ]
        }
      ]
    }
  ]

Defining variables keys prefixed with “command.” allows Prometheus to pick those variables, encode unitary commands through the codec, and trigger the downlink eventually.

However the “command.” prefix will be stripped before calling the codec.

Prometheus will trigger codec with a single command for each setting changed, queuing all commands at the LNS level.

...

Notes
 Note
Unless specifically required (approved?), do not add interval of less than 10 minutes. It will only lead to hardware and RMA troubles for us. If necessary we can do this as a one-off configuration by issuing downlink commands to hardware via the console, there’s no reason to expose smaller values to users in the UI.