Data Dictionary

The Data Dictionary (DD) stores configuration parameters, Energy totalizers, and other state parameters such as power consumption and output level for 6LoWireless devices.

Although relationships between events and actons are stored in the Action Function Table (AFT), the DD compliments it by providing the location for parameters such as ‘High End Trim’, ‘Occupancy State’, and ‘Daylight Harvesting Tuning’.

The DD supports 64bit variables to allow up to 20 years of energy totalization before roll over

Structure

{"idx":"0","dname":"RSSI","cval":"-34e0","un":"dbm"}
{"idx":"10","dname":"Channel 1","cval":"0e0","un":"%"}
{"idx":"19","dname":"Baseline Wh","cval":"19086656e-2","un":"Wh"}
{"idx":"20","dname":"Energy","cval":"6437630e-2","un":"Wh"}
{"idx":"22","dname":"PIR Value","cval":"0e0","un":"state"}
{"idx":"26","dname":"Timeout Mode","cval":"0e0","un":"state"}
{"idx":"28","dname":"Light","cval":"1e0","un":"%"}]

Requesting It

A GET request to the coap endpoint datamanagerlog is used to query a device for its data dictionary. It takes the following parameters:

  • force
    • ex: datamanagerlog?force=1
    • This is an integer value between 1 and 7 currently
    • If no force parameter is passed, the default value of ?force=1 will be used
  • start
    • ex: datamanagerlog?force=1&start=4
    • This is an interger value that represents the first idx to be returned
    • If no stop parameter is included, only the datapoint with idx matching the start parameter will be returned.
  • stop
    • ex: datamanagerlog?force=1&start=4&stop=6
    • This is an interger value that represents the last idx to be returned
    • in this instance, datapoints with idx 4,5,6 (3 total) will be returned. Note, if an idx is requested but does not exist in the DD, that datapoint will simply not be returned, or an empty array will be returned.

Verbosity

Verbosity relates to the force parameter that is passed in. The following levels of verbosity in response are available:

  1. Return all meaningful datapoints
  2. Return every datapoint in the DD, across all force values
  3. Return ever datapoint in the DD, without names or units !?
  4. Returns an empty array for the one im working with….
  5. Return only the data to be logged every 5 minutes
  6. Return only writeable points
  7. Return advanced/hidden config