Difference between revisions of "MQTT-flex"

From wiki.netio-products.com
Jump to navigation Jump to search
(added atributes table)
Line 6: Line 6:
 
PowerCable firmware – 2.1.0 and later
 
PowerCable firmware – 2.1.0 and later
 
<br />
 
<br />
 +
 +
=== MQTT flex JSON config phylosophy ===
 +
  {
 +
      "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...
 +
                      }
 +
                  ]
 +
              }
 +
          ]
 +
  }
 +
}
 +
  
 
=== Broker section ===
 
=== Broker section ===

Revision as of 14:40, 26 July 2019

MQTT is implemented as M2M API protocol, where NETIO device is publisher providing output status and its measurements and subscriber is allowing to control NETIO power outputs via public or internal MQTT brokers.

With MQTT-flex the users can easily define the MQTT topics and payloads by themself 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 and at the end of this article are some examples and links to configurations, which can be used towards public brokers as HiveMQ, IBM Watson, Azure, which you can sometimes directly, sometimes with slight modification (as putting yours Bluemix/Azure credentials) just copy&paste and see data flying between the computers, draw some sexy graphs and have big party with this feature :) ENJOY!

requirements:

PowerCable firmware – 2.1.0 and later

MQTT flex JSON config phylosophy

 {
      "config":{
          "broker":{
              config atribute 1 separated by comma... ,
              config atribute 2 separated by comma... ,
              config atribute 3 separated by comma... ,
              ... ,
              config atribute LAST not 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 not 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 not 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 not separated by comma...
                      }
                  ]
              }
          ]
  }
}


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

Subscriber section

Publish section

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


Config example

   {
       "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":"change",
                       "source":"OUTPUTS/1/STATE"
                   }
               ]
           },
           {
               "topic":"netio/${DEVICE_NAME}/output/1/load",
               "qos":0,
               "retain":false,
               "payload":"${OUTPUTS/1/LOAD}",
               "events":[
                   {
                       "type":"timer",
                       "period":1111
                   },
                   {
                       "type":"delta",
                       "source":"OUTPUTS/1/LOAD",
                       "delta":1
                   }      
               ]
           }
       ]
   }
 }


Subscribe topic for control of the output:

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

Publish topics for monitoring of the output state and load:

• netio/<DEVICE_NAME>/output/1/state with payload providing output 1 state value - published when the output state change • netio/<DEVICE_NAME>/output/1/load with payload providing actual load of output 1 – published every 1111 seconds or when load change by 1W

possible source:

OUTPUTS/X/VOLTAGE", OUTPUTS/X/CURRENT" OUTPUTS/X/POWER_FACTOR .exp = 100, .div = 1}, OUTPUTS/X/LOAD .exp = 1, .div = 1000}, OUTPUTS/X/STATE OUTPUTS/X/ACTION OUTPUTS/X/DELAY &uintValidator, .exp = 1, .div = 1 OUTPUTS/X/NAME OUTPUTS/X/FREQUENCY .exp = 1, .div = 1000}, OUTPUTS/X/ENERGY .exp = 1, .div = 10}, OUTPUTS/X/ENERGY_START OUTPUTS/X/ENERGY_START_FMT OUTPUTS/TOTAL/ENERGY .exp = 1, .div = 10}, OUTPUTS/TOTAL/LOAD .exp = 1, .div = 1000}, OUTPUTS/TOTAL/CURRENT OUTPUTS/TOTAL/VOLTAGE .exp = 1, .div = 100}, OUTPUTS/TOTAL/POWER_FACTOR", .exp = 100, .div = 1}, OUTPUTS/TOTAL/FREQUENCY" .exp = 1, .div = 1000},

available variables:

DEVICE_NAME DEVICE_MAC BRAND_NAME BRAND_TYPE