View source for MQTT-flex

There is a lot of approaches in integration of MQTT in devices and systems. One vendor prefer one topic with structured data payload, the another one prefer tree topic structure with simple value in data payload. MQTT-flex is a standard [https://en.wikipedia.org/wiki/MQTT MQTT] with specific configuration approach. The goal of MQTT-flex is to give a user oportunity to integrate NETIO device with any system with different data approach.

With MQTT-flex you can easily define the MQTT topics, payloads and device behaviour via text configuration in JSON object format. Since there is then lot of possibilities with such freestyle flexibility allowed, you can find bellow full set of all implemented attributes.

<b>Supported devices:</b>
<br>
PowerCable MQTT, PowerCable OEM (DevKit), PowerPDU 4PS, PowerDIN 4PZ, PowerBox 3Px 

=== Simple MQTT-flex configuration example ===

==== Client Configuration (broker section) ====
This configuration example set NETIO device to connect to <b>broker.hivemq.com</b> with <b>mqtt</b> protocol, <b>no ssl</b> connection with credetials <b>freedom/peace|love|empathy4ALL</b>. 

==== Device Control (subscribe section) ====
Device <b>output 1</b> is controlled with <b>action</b> received by subscription to <b>netio/${DEVICE_NAME}/output/1/action</b> topic with <b>QOS 0</b> 

==== Output State monitoring (publish section) ====
Device send every <b>1000 ms</b> message to topic <b></b> with <b>QOS 0</b>, <b>retain true</b> information with <b>output 1 state</b>

 {
      "config":{
         "broker":{
             "url":"broker.hivemq.com",
             "protocol":"mqtt",
             "port":1883,
             "ssl":false,
             "type":"generic",
             "username":"freedom",
             "password":"peace|LOVE|empathy4ALL"
         },
         "subscribe":[{
                "topic":"netio/${DEVICE_NAME}/output/1/action",
                "qos":0,
                "target":"OUTPUTS/1/ACTION",
                "action":"${payload}"
            }
        ],
        "publish":[{
                "topic":"netio/${DEVICE_NAME}/output/1/state",
                "qos":0,
                "retain":true,
                "payload":"${OUTPUTS/1/STATE}",
                "events":[
                    {
                        "type":"timer",
                        "period":"1000"
                    }
                ]
            }
        ]
    }
 }


=== Parameters ===
* source
* target
* payload
* event
* delta
* timer
* type
* period
* actiondef

=== Target / Source ===
In MQTT-flex we use targets and sources specify where to apply some change or get value. Practically it means addressing of INPUTS/OUTPUTS and adding command or variable.

* <b>source</b> - specifies from where the value will be read (specifies the source of data for payload, change detection, delta calculation)
* <b>target</b> - specifies where the data should be sent or command applied (e.g. specifies the target for ACTION)

==== INPUT / OUTPUT (Target) selection ====

NETIO Devices can have inputs and outputs which can be different type. When you want to work with some variable you have to specify on which I/O. For doing that in MQTT-flex is implemented structured addressing with <b>"/"</b> separator. See the steps below how to compose source or target.

# At first specify if requested variable is from/for INPUT or OUTPUT using keywords <b>"OUTPUTS"</b> or <b>"INPUTS"</b> .
# Add <b>"/"</b> separator
# Specify the number of INPUT/OUTPUT to <b>1</b>(or TOTAL for summary statistics if available)
# Add <b>"/"</b> separator
# Specify requested variable or command

<b>Note:</b> Not all of OUTPUTS/INPUTS support all variables. Available variables are closely connected with the device functions and I/O features.

<b>Note2:</b> INPUTS not yet implemented

==== Examples: ====

adressing controll of output 3
 OUTPUTS/3/ACTION
getting voltage on output 1
 OUTPUTS/1/VOLTAGE

=== Commands ===
 
=== Variables ===
In some parameters is nescessary to use variables to get current state and measurements. <b>Variables are separated in  two categories:</b>

* Target/Source variables
* System variables

==== Target Source Variables ====

The list of available variables for each 



===== OUTPUTS variables =====

* OUTPUTS/X/VOLTAGE" [V]
* OUTPUTS/X/CURRENT"  [mA]
* OUTPUTS/X/POWER_FACTOR [1]
* OUTPUTS/X/LOAD mW
* OUTPUTS/X/STATE [1]
* OUTPUTS/X/ACTION 
* OUTPUTS/X/DELAY unsigned int [ms]
* OUTPUTS/X/NAME [string]
* OUTPUTS/X/FREQUENCY [Hz] two decimals
* OUTPUTS/X/ENERGY [Wh]
* OUTPUTS/X/ENERGY_START [epoch]
* OUTPUTS/X/ENERGY_START_FMT [YYYY-MM-DD]

===== INPUT variables =====
Not yet implemented

===== TOTALs - for future use with devices having more than 1 measured output=====

* OUTPUTS/TOTAL/ENERGY
* OUTPUTS/TOTAL/LOAD
* OUTPUTS/TOTAL/CURRENT
* OUTPUTS/TOTAL/VOLTAGE
* OUTPUTS/TOTAL/POWER_FACTOR
* OUTPUTS/TOTAL/FREQUENCY
==== System variables ====

* DEVICE_NAME
* DEVICE_MAC
* BRAND_NAME
* BRAND_TYPE

=== Broker section ===
here you have to define URL or IP address of machine hosting MQTT broker, level of security used for protocol, auth data and optionally some specific MQTT attributes, which are in the spec, but not mandatory required
<br />

{| class="wikitable"
! style="font-weight:bold; background-color:#9b9b9b;" | Item
! style="font-weight:bold; background-color:#9b9b9b;" | Presence
! style="font-weight:bold; background-color:#9b9b9b;" | Possible Values
! style="font-weight:bold; background-color:#9b9b9b;" | Description
! style="font-weight:bold; background-color:#9b9b9b;" | JSON Config Usage
|-
| style="background-color:#efefef;" | url
| style="background-color:#efefef;" | mandatory
| style="background-color:#efefef;" | 
| style="background-color:#efefef;" | MQTT broker URL
| style="background-color:#efefef;" | "url":"broker.hivemq.com"
|-
| style="background-color:#efefef;" | port
| style="background-color:#efefef;" | mandatory
| style="background-color:#efefef;" | 1 - 65535
| style="background-color:#efefef;" | MQTT broker port
| style="background-color:#efefef;" | "port":1883
|-
| style="background-color:#efefef;" | ssl
| style="background-color:#efefef;" | mandatory
| style="background-color:#efefef;" | true, false
| style="background-color:#efefef;" | Use SSL crypted communication selector
| style="background-color:#efefef;" | "ssl":false
|-
| style="background-color:#efefef;" | type
| style="background-color:#efefef;" | mandatory
| style="background-color:#efefef;" | generic
| style="background-color:#efefef;" | Communication/setup type option
| style="background-color:#efefef;" | "type":"generic"
|-
| style="background-color:#efefef;" | username
| style="background-color:#efefef;" | mandatory
| style="background-color:#efefef;" | regexp+len
| style="background-color:#efefef;" | Credentials for MQTT broker
| style="background-color:#efefef;" | "username":"freedom"
|-
| style="background-color:#efefef;" | password
| style="background-color:#efefef;" | mandatory
| style="background-color:#efefef;" | regexp+len
| style="background-color:#efefef;" | Credentials for MQTT broker
| style="background-color:#efefef;" | "password":"peace|LOVE|empathy4ALL"
|-
| style="background-color:#efefef;" | clientid
| style="background-color:#efefef;" | optional
| style="background-color:#efefef;" | regexp+len
| style="background-color:#efefef;" | MQTT clientid. Max. 32 characters. Variables ${DEVICE_MAC} or ${DEVICE_NAME} can be used
| style="background-color:#efefef;" | "clientid":"myEcoTable01"
|-
| style="background-color:#efefef;" | keepalive
| style="background-color:#efefef;" | optional
| style="background-color:#efefef;" | 1 - 65535
| style="background-color:#efefef;" | MQTT keep alive period in seconds
| style="background-color:#efefef;" | "keepalive":90
|}



=== Subscriber section ===

{| class="wikitable"
! style="font-weight:bold; background-color:#9b9b9b;" | Item
! style="font-weight:bold; background-color:#9b9b9b;" | Presence
! style="font-weight:bold; background-color:#9b9b9b;" | Possible Values
! style="font-weight:bold; background-color:#9b9b9b;" | Description
! style="font-weight:bold; background-color:#9b9b9b;" | JSON Config Usage
|-
| style="background-color:#efefef;" | topic
| style="background-color:#efefef;" | mandatory
| style="background-color:#efefef;" | see table below
| style="background-color:#efefef;" | specification of the topic, which MQTT-flex device listens from broker and act accordingly
| style="background-color:#efefef;" | "topic":"netio/${DEVICE_NAME}/output/1/action"
|-
| style="background-color:#efefef;" | qos
| style="background-color:#efefef;" | mandatory
| style="background-color:#efefef;" | 0, 1 or 2
| style="background-color:#efefef;" | MQTT's Quality of Sevice - definition {here|http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/errata01/os/mqtt-v3.1.1-errata01-os-complete.html#_Toc442180912}
| style="background-color:#efefef;" | "qos":0
|-
| style="background-color:#efefef;" | target
| style="background-color:#efefef;" | mandatory
| style="background-color:#efefef;" | 
| style="background-color:#efefef;" | internal definition of action, which can be performed above the specified output
| style="background-color:#efefef;" | "target":"OUTPUTS/1/ACTION"
|-
| style="background-color:#efefef;" | action
| style="background-color:#efefef;" | mandatory
| style="background-color:#efefef;" | 
| style="background-color:#efefef;" | a payload or a value the action attribute needs to have passed to
| style="background-color:#efefef;" | "action":"${payload}"
|}


Subscribe topic payload values specification for control of the output:

netio/<DEVICE_NAME>/output/1/<b>action</b> with payload for output control : (0 – off, 1 – on, 2 – short off, 3 – short on, 4 – toggle, 5 – no change)


=== Publish section ===

when you need to send some data from device towards the broker, you have to specify it in the publish section - you can send measurement data as they are implemented, or you can use translation tables to send some pre-defined strings or even send JSON object. these attributes can be send periodicaly every time the timer reached specified value in seconds or based on value change (something like delta principle, but using only value differrence within defined period)

{| class="wikitable"
! style="font-weight:bold; background-color:#9b9b9b;" | Item
! style="font-weight:bold; background-color:#9b9b9b;" | Presence
! style="font-weight:bold; background-color:#9b9b9b;" | Possible Values
! style="font-weight:bold; background-color:#9b9b9b;" | Description
! style="font-weight:bold; background-color:#9b9b9b;" | JSON Config Usage
|-
| style="background-color:#efefef;" | topic
| style="background-color:#efefef;" | mandatory
| style="background-color:#efefef;" | see table below
| style="background-color:#efefef;" | definition of the topic, how it is registered towards MQTT broker
| style="background-color:#efefef;" | "topic":"netio/${DEVICE_NAME}/output/1/load"
|-
| style="background-color:#efefef;" | qos
| style="background-color:#efefef;" | mandatory
| style="background-color:#efefef;" | see table below
| style="background-color:#efefef;" | MQTT's Quality of Sevice - definition {here|http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/errata01/os/mqtt-v3.1.1-errata01-os-complete.html#_Toc442180912}
| style="background-color:#efefef;" | 
|-
| style="background-color:#efefef;" | retain
| style="background-color:#efefef;" | mandatory
| style="background-color:#efefef;" | boolean: true or false
| style="background-color:#efefef;" | MQTT's attribute to specify to broker how to store last received information - section 3.3.1.3 of {MQTT doc|http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/errata01/os/mqtt-v3.1.1-errata01-os-complete.html#_Toc442180841}
| style="background-color:#efefef;" | "retain":true
|-
| style="background-color:#efefef;" | payload
| style="background-color:#efefef;" | mandatory
| style="background-color:#efefef;" | see table below
| style="background-color:#efefef;" | definition of the topic, how it is registered towards MQTT broker
| style="background-color:#efefef;" | "topic":"netio/${DEVICE_NAME}/output/1/load"
|-
| style="background-color:#efefef;" | events
| style="background-color:#efefef;" | mandatory
| style="background-color:#efefef;" | see table below
| style="background-color:#efefef;" | definition of events used for triggering sending of data via mqtt (change, delta, timer)
| style="background-color:#efefef;" | 
|}



=== Basic MQTT flex JSON config example ===

 <nowiki> </nowiki>  {
 <nowiki> </nowiki>      "config":{
 <nowiki> </nowiki>         "broker":{
 <nowiki> </nowiki>             "url":"broker.hivemq.com",
 <nowiki> </nowiki>             "protocol":"mqtt",
 <nowiki> </nowiki>             "port":1883,
 <nowiki> </nowiki>             "ssl":false,
 <nowiki> </nowiki>             "type":"generic",
 <nowiki> </nowiki>             "username":"freedom",
 <nowiki> </nowiki>             "password":"peace|LOVE|empathy4ALL"
 <nowiki> </nowiki>         },
 <nowiki> </nowiki>         "subscribe":[{
 <nowiki> </nowiki>                "topic":"netio/${DEVICE_NAME}/output/1/action",
 <nowiki> </nowiki>                "qos":0,
 <nowiki> </nowiki>                "target":"OUTPUTS/1/ACTION",
 <nowiki> </nowiki>                "action":"${payload}"
 <nowiki> </nowiki>            }
 <nowiki> </nowiki>        ],
 <nowiki> </nowiki>        "publish":[
 <nowiki> </nowiki>            {
 <nowiki> </nowiki>                "topic":"netio/${DEVICE_NAME}/output/1/state",
 <nowiki> </nowiki>                "qos":0,
 <nowiki> </nowiki>                "retain":true,
 <nowiki> </nowiki>                "payload":"${OUTPUTS/1/STATE}",
 <nowiki> </nowiki>                "events":[
 <nowiki> </nowiki>                    {
 <nowiki> </nowiki>                        "type":"change",
 <nowiki> </nowiki>                        "source":"OUTPUTS/1/STATE"
 <nowiki> </nowiki>                    }
 <nowiki> </nowiki>                ]
 <nowiki> </nowiki>            },
 <nowiki> </nowiki>            {
 <nowiki> </nowiki>                "topic":"netio/${DEVICE_NAME}/output/1/load",
 <nowiki> </nowiki>                "qos":0,
 <nowiki> </nowiki>                "retain":false,
 <nowiki> </nowiki>                "payload":"${OUTPUTS/1/LOAD}",
 <nowiki> </nowiki>                "events":[
 <nowiki> </nowiki>                    {
 <nowiki> </nowiki>                        "type":"timer",
 <nowiki> </nowiki>                        "period":1111
 <nowiki> </nowiki>                    },
 <nowiki> </nowiki>                    {
 <nowiki> </nowiki>                        "type":"delta",
 <nowiki> </nowiki>                        "source":"OUTPUTS/1/LOAD",
 <nowiki> </nowiki>                        "delta":1
 <nowiki> </nowiki>                    }      
 <nowiki> </nowiki>                ]
 <nowiki> </nowiki>            }
 <nowiki> </nowiki>        ]
 <nowiki> </nowiki>    }
 <nowiki> </nowiki>}


=== MQTT flex JSON config philosophy ===

Configuration of MQTT in devices supporting <i>MQTT flex</i> is done by {{JSON (JavaScript Object Notation)|https://en.wikipedia.org/wiki/JSON}}. The file is separated into <b>3 sections according to their meaning</b>:

*  <b>broker</b> (client connection setup)
*  <b>publish</b> (array of topics where to publish)
*  <b>subscribe</b> (array of topics where to subscribe)

 {
       "config":{
           "broker":{
               config atribute 1 separated by comma... ,
               config atribute 2 separated by comma... ,
               config atribute 3 separated by comma... ,
               ... ,
               config atribute LAST <b>not</b> separated by comma...
           },
           "subscribe":[
               {
                   config atribute 1 separated by comma... ,
                   config atribute 2 separated by comma... ,
                   config atribute 3 separated by comma... ,
                   ... ,
                   config atribute LAST <b>not</b> separated by comma...
               }
           ],
           "publish":[
               {
                   first publish config atribute 1 separated by comma... ,
                   first publish config atribute 3 separated by comma... ,
                   ... ,
                   "events":[
                       {
                           first publish events config atribute 1 separated by comma... ,
                           first publish events config atribute 2 separated by comma... ,
                           ... ,
                           first publish events config atribute LAST <b>not</b> separated by comma...
                       }
                   ]
               },
               {
                   second publish config atribute 1 separated by comma... ,
                   second publish config atribute 3 separated by comma... ,
                   ... ,
                   "events":[
                       {
                           second publish events config atribute 1 separated by comma... ,
                           second publish events config atribute 2 separated by comma... ,
                           ... ,
                           second publish events config atribute LAST <b>not</b> separated by comma...
                       }
                   ]
               }
           ]
   }
 }