wiki.netio-products.com - User contributions [en]

MQTT-flex

2020-02-24T10:24:29Z

Vkristof: /* Simple MQTT-flex configuration + explanation */ - note about debugging of config on your local device to prevent remote device hang/freeze/brick

The MQTT-flex version of the MQTT protocol can be configured in detail thanks to the “flex” extension.

https://www.netio-products.com/en/glossary/mqtt-flex

<b>Why MQTT-flex</b> <br>
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 opportunity to integrate NETIO device with any system with different data approach.

Configuration of MQTT in devices supporting <i>MQTT flex</i> is done by [https://en.wikipedia.org/wiki/JSON JSON (JavaScript Object Notation)]. 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.

===Supported devices:===
* [https://www.netio-products.com/en/device/powercable-mqtt-101x PowerCable MQTT 101x] <br>
* PowerCable OEM (DevKit) <br>
* PowerPDU 4PS <br>
* PowerDIN 4PZ <br>
* PowerBOX 3Px <br>

<b>FW version:</b> <br>
>2.2.1

= Simple MQTT-flex configuration + explanation =

''We strongly recommend to create and test MQTT-flex configuration on "local" device what can be easily restarted. The validation of config before saving is not 100% and for example some specific typos can cause a freeze of a device - the solution is to restart a device (unplug/plug input power cable). If the configuration is saved and device is working then there are no known failure case so it is safe to use this configuration on the "remote" devices.''

{
"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"
}
]
}
]
}
}
=== Client Configuration (broker section) ===
Put here MQTT client connection setup

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>.

"broker":{
"url":"broker.hivemq.com",
"protocol":"mqtt",
"port":1883,
"ssl":false,
"type":"generic",
"username":"freedom",
"password":"peace|LOVE|empathy4ALL"
},

=== Device Control (subscribe section) ===
Put here array of topics where to subscribe

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>

"subscribe":[{
"topic":"netio/${DEVICE_NAME}/output/1/action",
"qos":0,
"target":"OUTPUTS/1/ACTION",
"action":"${payload}"
}
],

=== Output State monitoring (publish section) ===
Put here array of topics where to publish.

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>

"publish":[{
"topic":"netio/${DEVICE_NAME}/output/1/state",
"qos":0,
"retain":true,
"payload":"${OUTPUTS/1/STATE}",
"events":[
{
"type":"timer",
"period":"1000"
}
]
}
]

= Config sections =

== Broker ==
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 />
=== Attributes table overview ===
{| 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
|}

=== Examples ===
==== Standard setup ====
==== SSL secured setup ====
==== Variables used setup ====

== Subscribe ==
=== Hints to usage ===
When receive message in <b><i>topic</b></i> do <b><i>action</b></i> on <b><i>target</b></i>.

<b><i>actiondef</b></i>: When message in <b><i>topic</b></i> match <b><i>actiondef payload</b></i> do <b><i>action</b></i> on <b><i>target</b></i>.

=== Attributes table overview ===
{| 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}"
|-
| style="background-color:#efefef;" | actiondef<sup>Not supported yet</sup>
| style="background-color:#efefef;" | optional
| style="background-color:#efefef;" |
| style="background-color:#efefef;" |
| style="background-color:#efefef;" |
|-
| style="background-color:#efefef;" | json<sup>Not supported yet</sup>
| style="background-color:#efefef;" | optional
| style="background-color:#efefef;" |
| style="background-color:#efefef;" |
| style="background-color:#efefef;" |
|}

=== Examples ===
==== Toggle output with standard payload ====
==== Toggle output with custom payload ====
==== Subscribe to more than one topic ====

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 ==

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)

=== Hints to usage ===
When <b><i>event</b></i> send message with <b><i>payload</b></i> to <b><i>topic</b></i>.

=== Attributes table overview ===
{| 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;" |
|-
| style="background-color:#efefef;" | type
| style="background-color:#efefef;" |
| style="background-color:#efefef;" |
| style="background-color:#efefef;" |
| style="background-color:#efefef;" |
|-
| style="background-color:#efefef;" | source
| style="background-color:#efefef;" |
| style="background-color:#efefef;" |
| style="background-color:#efefef;" |
| style="background-color:#efefef;" |
|-
| style="background-color:#efefef;" | delta
| style="background-color:#efefef;" |
| style="background-color:#efefef;" |
| style="background-color:#efefef;" |
| style="background-color:#efefef;" |
|-
| style="background-color:#efefef;" | period
| style="background-color:#efefef;" |
| style="background-color:#efefef;" |
| style="background-color:#efefef;" |
| style="background-color:#efefef;" |
| style="background-color:#efefef;" |
|-
| style="background-color:#efefef;" | payloaddef<sup>Not supported yet</sup>
| style="background-color:#efefef;" |
| style="background-color:#efefef;" |
| style="background-color:#efefef;" |
| style="background-color:#efefef;" |
|}

=== Examples ===
==== Publish energy periodically (event timer) ====
==== Publish current on change (delta) ====
==== Publish output state ====
==== Publish to more than one topic with different events ====

= 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
* Payload Topic variables

== Target Source Variables ==

The list of available variables for each

=== OUTPUTS variables ===
==== VOLTAGE ====
Unit: <code>V</code>

Type: integer

Allowed in: <code>"payload"</code> <code>"source"</code>

Example 1: <code>"payload":"Present RMS voltage on output 1 is ${OUTPUTS/1/VOLTAGE}"</code>

Example 2: <code>"source":"${OUTPUTS/1/VOLTAGE}"</code>

==== CURRENT ====
Unit: <code>mA</code>

Type: integer

Allowed in: <code>"payload"</code> <code>"source"</code>

Example 1: <code>"payload":"Present RMS current on output 1 is ${OUTPUTS/1/CURRENT}"</code>

Example 2: <code>"source":"${OUTPUTS/1/CURRENT}"</code>

==== POWER_FACTOR ====
Unit: <code>[-]</code>

Type: float (2 decimals)

Allowed in: <code>"payload"</code> <code>"source"</code>

Example 1: <code>"payload":"True Power Factor on output 1 is ${OUTPUTS/1/POWER_FACTOR}"</code>

Example 2: <code>"source":"${OUTPUTS/1/POWER_FACTOR}"</code>

==== LOAD ====
Unit: <code>W</code>

Type: integer

Allowed in: <code>"payload"</code> <code>"source"</code>

Example 1: <code>"payload":"Present load on output 1 is ${OUTPUTS/1/ENERGY}Wh"</code>

Example 2: <code>"payload":"Device's power connected to output 1 is ${OUTPUTS/1/ENERGY}Wh"</code>

Example 3: <code>"source":"${OUTPUTS/1/ENERGY}"</code>

==== STATE ====
Type: bool(integer) - <code>0</code> or <code>1</code>

Allowed in: <code>"payload"</code> <code>"source"</code>

Example 1: <code>"payload":"Present output 1 state is ${OUTPUTS/1/STATE}"</code>

Example 2: <code>"source":"${OUTPUTS/1/STATE}"</code>

==== ACTION ====
Type: integer

Possible actions:
* <code>0</code> - set state OFF
* <code>1</code> - set state ON
* <code>2</code> - short OFF (restart)
* <code>3</code> - short ON
* <code>4</code> - toggle (switch)
* <code>5</code> - no change

Allowed in: <code>"target"</code>

Example: <code>"target":"OUTPUTS/1/ACTION"</code>

==== DELAY [ms] ====
==== NAME ====
==== FREQUENCY ====
Unit: <code>Hz</code>

Type: integer

Allowed in: <code>"payload"</code> <code>"source"</code>

Example: <code>"payload":"Frequency in power grid is ${OUTPUTS/1/ENERGY}Hz"</code>

==== ENERGY ====
Unit: <code>Wh</code>

Type: integer

Allowed in: <code>"payload"</code> <code>"source"</code>

Example 1: <code>"payload":"Consumed energy on output 1 is ${OUTPUTS/1/ENERGY}Wh"</code>

Example 2: <code>"source":"${OUTPUTS/1/ENERGY}"</code>

==== ENERGY_START ====
Unit: <code>unix timestamp</code>

Type: integer

Allowed in: <code>"payload"</code>

Example 1: <code>"payload":"Energy measured since ${OUTPUTS/1/ENERGY_START} unix time"</code>

Example 2: <code>"payload":"${OUTPUTS/1/ENERGY_START}"</code> is output payload <code>1567654639</code>

==== ENERGY_START_FMT ====
Unit: <code>fmt date format</code>

Type: string

Allowed in: <code>"payload"</code>

Example 1: <code>"payload":"Energy measured since ${OUTPUTS/1/ENERGY_START}"</code>

Example 2: <code>"payload":"${OUTPUTS/1/ENERGY_START_FMT}"</code> is output payload <code>2019-09-05T03:37:19+00:00</code>

=== INPUT variables <sup>Not yet implemented</sup> ===
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

== Payload/topic variables ==
=== List ===
===== DEVICE_NAME =====
Can be used in: "payload", "topic"

===== DEVICE_MAC =====

===== UPTIME <sup>Not yet implemented</sup> =====

===== PAYLOAD =====
Can be used in: "action"

===== OUTPUT_ID <sup>Not yet implemented</sup>=====

===== WIFI_SIGNAL<sup>Not yet implemented</sup> =====

=== Examples ===
"payload":"${DEVICE_NAME}"

"topic":"netio/${DEVICE_NAME}/output/1/action"

"action":"${PAYLOAD}"

= Extended MQTT flex JSON config examples =

== Default NETIO MQTT-flex configuration ==
This example demonstrates setup for connection to public <code>broker.hivemq.com</code>, measurement reporting and output control.

The device cabe be controlled via <code>netio/${DEVICE_NAME}/output/1/action topic</code> by sending standard NETIO action values:
* 0 - OFF
* 1 - ON
* 2 - SHORT OFF
* 3 - SHORT ON
* 4 - TOGGLE
* 5 - NO ACTION.

The device report measurements:

* Output state - every 15 minutes or by change
* Voltage [V]- every 5 minutes or by change of 1 V
* Current [mA]- every 5 minutes or by change of 50 mA
* Load(Power) [W]- every 5 minutes or by change of 10 W
* Energy(Consumption) [Wh]- every 15 minutes or by change of 1Wh
* True Power Factor (TPF) [-]- every 5 minutes or by change of 0.02
* Frequency [Hz]- every 1 hour or by change of 0.1 Hz

For register all values, you can use wildcard <code>netio/${DEVICE_NAME}/output/1/#</code>

{
"config":{
"broker":{
"url":"broker.hivemq.com",
"protocol":"mqtt",
"port":1883,
"ssl":false,
"type":"generic",
"username":"",
"password":"",
"clientid":"moje${DEVICE_NAME}${DEVICE_MAC}",
"keepalive":30
},
"subscribe":[
{
"topic":"netio/${DEVICE_NAME}/output/1/action",
"qos":0,
"target":"OUTPUTS/1/ACTION",
"action":"${payload}"
},
{
"topic":"netio/${DEVICE_NAME}/output/1/switch",
"qos":0,
"target":"OUTPUTS/1/ACTION",
"action":4
}
],
"publish":[
{
"topic":"netio/${DEVICE_MAC}/output/1/state",
"qos":0,
"retain":true,
"payload":"${OUTPUTS/1/STATE}",
"events":[
{
"type":"change",
"source":"OUTPUTS/1/STATE"
},
{
"type":"timer",
"period":900
}
]
},
{
"topic":"netio/${DEVICE_NAME}/output/1/voltage",
"qos":0,
"retain":false,
"payload":"${OUTPUTS/1/VOLTAGE}",
"events":[
{
"type":"timer",
"period":300
},
{
"type":"delta",
"source":"OUTPUTS/1/VOLTAGE",
"delta":1
}
]
},
{
"topic":"netio/${DEVICE_NAME}/output/1/current",
"qos":0,
"retain":false,
"payload":"${OUTPUTS/1/CURRENT}",
"events":[
{
"type":"timer",
"period":300
},
{
"type":"delta",
"source":"OUTPUTS/1/CURRENT",
"delta":50
}
]
},
{
"topic":"netio/${DEVICE_NAME}/output/1/load",
"qos":0,
"retain":false,
"payload":"${OUTPUTS/1/LOAD}",
"events":[
{
"type":"timer",
"period":300
},
{
"type":"delta",
"source":"OUTPUTS/1/LOAD",
"delta":10
}
]
},
{
"topic":"netio/${DEVICE_NAME}/output/1/energy",
"qos":0,
"retain":false,
"payload":"${OUTPUTS/1/ENERGY}",
"events":[
{
"type":"timer",
"period":900
},
{
"type":"delta",
"source":"OUTPUTS/1/ENERGY",
"delta":1
}
]
},
{
"topic":"netio/${DEVICE_NAME}/output/1/tpf",
"qos":0,
"retain":false,
"payload":"${OUTPUTS/1/POWER_FACTOR}",
"events":[
{
"type":"timer",
"period":900
},
{
"type":"delta",
"source":"OUTPUTS/1/POWER_FACTOR",
"delta":0.02
}
]
},
{
"topic":"netio/${DEVICE_NAME}/output/1/frequency",
"qos":0,
"retain":false,
"payload":"${OUTPUTS/1/FREQUENCY}",
"events":[
{
"type":"timer",
"period":3600
},
{
"type":"delta",
"source":"OUTPUTS/1/FREQUENCY",
"delta":0.1
}
]
}
]
}
}

Welcome to NETIO resources & projects & documentation overview

2020-01-03T10:40:32Z

Vkristof:

<div style="text-align: center; white-space: nowrap;">
<div style="display: inline-block; padding: 0 0 0 0; border-left: 0px solid gray; width: 40%; vertical-align: top; white-space: normal;">
<div style="text-align: center; white-space: nowrap;">

<div style="background: #eaf6f2; display: inline-block; margin: 0 1em 0 1em; border-left: 0px solid gray; width: 45%; vertical-align: top; white-space: normal;">
<h2 style="background: #005f41; color: #FFF; margin: 0 0 0 0; padding: 0 1em 0 1em;">Interoperability</h2>
<div style=" display: inline-block; padding: 0 1em 0 1em;text-align: left; vertical-align: top; white-space: normal;">
=== M2M API doc ===
[[MQTT]]

[[MQTT-flex]]

[[JSON API]]

[[XML API]]

[[URL API]]

[[SNMP]]

[[Telnet/Kshell]]

[[Modbus TCP]]

[[SIP]]

[[HTTP(s) Push - JSON/XML]]

[[M2M Lua Active Client]]

=== Integrations ===
[https://www.home-assistant.io/components/netio/ Home Assistant]

[[IBM Cloud]] - MQTT-flex

[[IBM Cloud]] - NETIO 4x MQTT-LUA

[[Azure IoT Hub]] - MQTT

[[HiveMQ]] - MQTT-flex

[[NodeRED]] - JSON API

[https://www.jam-software.com/serversentinel/online_manual/EN/index.html?actions_netio230bnetworkpowersocket.html Jam-software - ServerSentinel]
</div>
</div>
<div style="background: #eaf6f2; display: inline-block; padding: 0 0 0 0; border-left: 0px solid gray; width: 50%; vertical-align: top; white-space: normal;">
<h2 style="background: #005f41; color: #FFF; margin: 0 0 0 0; padding: 0 1em 0 1em;"> Community </h2>
<div style=" display: inline-block; padding: 0 1em 0 1em;text-align: left; vertical-align: top; white-space: normal;">
=== Tools ===
[https://github.com/netioproducts GitHub - official]

[https://github.com/Koukaam/netio-utils/tree/master/actions GitHub - obsolete (Koukaam)]

[[NETIO UDP Discover]]

[[NETIO UPnP (Universal Plug and Play)]]

=== Community ===
[https://github.com/distopik/netio-4c-prometheus Prometheus integration]

[https://github.com/stdevel/check_netio Nagios plugin]

[https://github.com/elmicro/fhem_netio_4x_pm FHEM module by Elmicro]

[https://github.com/imolein/lua-netio LUA control Library]

[https://github.com/netioproducts/c-sharp-examples/tree/master/netioControllerXML-Stefano M2M XML API integration in C#]

[https://github.com/rynr/netio Java Control Library]

[https://github.com/st3veV/Netio-OpenHAB OpenHAB using MQTT]

[https://jirikuba.github.io/NETIO.SpinaniHDO/ NETIO controlled by HDO]

[https://groups.google.com/forum/#!topic/openhab/O6psocjU70s Read consumption in OpenHAB - HTTP]

[https://www.instructables.com/id/How-to-Work-With-JSON-in-Node-RED/ NETIO 4All from NodeRED]

[https://github.com/theone1984/netio-jenkins Jenkins plugin]
</div>
</div>

</div>

</div>
<div style="display: inline-block; padding: 0 1em 0 0; border-right: 0px solid gray; width: 60%; vertical-align: top; white-space: normal;">
<div style="background: #eaf6f2; display: inline-block; margin: 0 1em 0 1em; border-left: 0px solid gray; width: 98%; vertical-align: top; white-space: normal;">
<h2 style="background: #005f41; color: #FFF; margin: 0 0 0 0; padding: 0 1em 0 1em;"> NETIO Lua Programming </h2>
<div style=" display: inline-block; padding: 0 1em 0 1em;text-align: justify; vertical-align: top; white-space: normal;">

=== Don't know LUA? ===
==== [https://www.lua.org/pil/contents.html Official Lua tutorial] ====
If you are new to Lua and programming as such and if you are eager to learn, this is your starting point. Before you proceed to NETIO Sockets, this [https://www.lua.org/demo.html online environment] will be a good place to test your first scripts.
==== [https://www.lua.org/manual/5.3/ Official Lua manual] ====
Although you won't need everything mentioned here, it is worth to peek here from time to time to grasp the concepts of effective Lua programming.

=== Lua in NETIO ===
If you already know Lua, just keep in mind that <b>NETIO Lua loops are limited to 32k cycles</b> and all <b>numbers are integers, not decimals</b> like in standard Lua.
==== [[Lua basics for other language programmers]] ====
A quick jump into NETIO Lua programming if you mastered another programming language. It's simple...
==== [[NETIO Lua Tips & Philosophy]] ====
Explanation of starting LUA scripts in NETIO devices and some tips how to hack NETIO to doing what you want.

==== [[NETIO Specific Reference manual]] ====
If you can already code in Lua, NETIO-specific Lua functions is your main guide to programing NETIO Sockets.

==== [[Examples & Aplication notes]] ====
Aplication notes for devices supporting LUA programming. Example configurations downloads and Script programming explanation with direct links to reference
</div>
</div>
</div>
</div>
__NOTOC__

MQTT-flex

2019-07-28T21:23:33Z

Vkristof:

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 user can easily define the MQTT topics and payloads by himself 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 family – MQTT flex supported from <sub> 2.1.0</sub> firmware release.

=== 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...
}
]
}
]
}
}

=== 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>}

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 definitions and its units: ====

* 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]

==== 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

==== available variables for definitions in MQTT-flex: ====

* DEVICE_NAME
* DEVICE_MAC
* BRAND_NAME
* BRAND_TYPE

MQTT-flex

2019-07-28T20:42:06Z

Vkristof:

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 user can easily define the MQTT topics and payloads by himself 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 family – MQTT flex supported from <sub> 2.1.0</sub> firmware release.

=== 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...
}
]
}
]
}
}

=== 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
|}

Subscribe topic 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>}

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" [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]

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

available variables for definitions in MQTT-flex:

DEVICE_NAME
DEVICE_MAC
BRAND_NAME
BRAND_TYPE

MQTT-flex

2019-07-28T19:53:18Z

Vkristof:

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 user can easily define the MQTT topics and payloads by himself 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 family – MQTT flex supported from <sub> 2.1.0</sub> firmware release.

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

=== 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...
}
]
}
]
}
}

=== 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;" | Quality of Sevice - MQTT 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
|-

=== Publish section ===

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>}

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

MQTT-flex

2019-07-24T09:05:27Z

Vkristof:

MQTT-flex

2019-07-24T09:03:38Z

Vkristof: prvni faze porodni

MQTT-flex

2019-07-17T11:31:36Z

Vkristof:

MQTT-flex

2019-07-17T11:26:26Z

Vkristof:

MQTT is implemented as M2M API protocol, where NETIO device is publisher providing output status and subscriber allowing control of NETIO power outputs (power sockets 230V or power outlets
IEC-320 110/230V). With MQTT-flex the users can easily define the MQTT topics and payloads.

PowerCable firmware – 2.1.0 and later

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
}
]
}
]
}
}

description/details:

Broker section

Parameters:
Item Description Example/values
url MQTT broker URL broker.hivemq.com
Protocol Protocol used for communication with broker [mqtt]
Port MQTT broker port 1883
Ssl SSL security selector [false|true]
Type Communication/setup type option [generic]
username Credentials for MQTT broker - username freedom
password Credentials for MQTT broker - password peace|LOVE|empathy4ALL
clientid [optional] MQTT clientid. Max. 32 characters. Variables ${MAC} or ${DEVICE_NAME} can be used. myUniqueID1234
keepalive [optional] MQTT keep alive period in seconds 90

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

MQTT is implemented as M2M API protocol, where NETIO device is publisher providing output status and subscriber allowing control of NETIO power outputs (power sockets 230V or power outlets
IEC-320 110/230V). With MQTT-flex the users can easily define the MQTT topics and payloads.

PowerCable firmware – 2.1.0 and later

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
}
]
}
]
}
}

description/details:

Broker section

Parameters:
Item Description Example/values
url MQTT broker URL broker.hivemq.com (mqtts://broker.your-lovely-domain.com - to connect to SSL capable MQTT broker)
Port MQTT broker port 1883
Ssl SSL security selector [false|true]
Type Communication/setup type option [generic] (reserved for future use)
username Credentials for MQTT broker - username freedom
password Credentials for MQTT broker - password peace|LOVE|empathy4ALL
clientid [optional] MQTT clientid. Max. 32 characters. Variables ${DEVICE_MAC} or ${DEVICE_NAME} can be used. myUniqueID1234
keepalive [optional] MQTT keep alive period in seconds 90

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", .param = nullptr, .translateFunc = nullptr, .validator = nullptr, .exp = 1, .div = 1000},
OUTPUTS/X/ENERGY", .param = nullptr, .translateFunc = nullptr, .validator = nullptr, .exp = 1, .div = 10},
OUTPUTS/X/ENERGY_START",
OUTPUTS/X/ENERGY_START_FMT",
OUTPUTS/TOTAL/ENERGY", .param = nullptr, .translateFunc = nullptr, .validator = nullptr, .exp = 1, .div = 10},
OUTPUTS/TOTAL/LOAD", .param = nullptr, .translateFunc = nullptr, .validator = nullptr, .exp = 1, .div = 1000},
OUTPUTS/TOTAL/CURRENT"
OUTPUTS/TOTAL/VOLTAGE", .param = nullptr, .translateFunc = nullptr, .validator = nullptr, .exp = 1, .div = 100},
OUTPUTS/TOTAL/POWER_FACTOR", .param = nullptr, .translateFunc = nullptr, .validator = nullptr, .exp = 100, .div = 1},
OUTPUTS/TOTAL/FREQUENCY", .param = nullptr, .translateFunc = nullptr, .validator = nullptr, .exp = 1, .div = 1000},

available variables:

DEVICE_NAME
DEVICE_MAC
BRAND_NAME
BRAND_TYPE

MQTT-flex

2019-07-16T12:12:23Z

Vkristof: Created page with "MQTT is implemented as M2M API protocol, where NETIO device is publisher providing output status and subscriber allowing control of NETIO power outputs (power sockets 230V or..."

File:Output.png

2019-07-12T06:31:50Z

Vkristof:

HiveMQ

2019-07-10T14:45:57Z

Vkristof:

example integration with Cobra/PowerCable/PowerPDU4PS + HiveMQ public broker + MQTT Dash Android App

cobra MQTT-flex configuration:

{
"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":5
},
{
"type":"delta",
"source":"OUTPUTS/1/LOAD",
"delta":1
}
]
}
]
}
}

HiveMQ connection settings (just to check, that data are being send towards internet):

http://www.hivemq.com/demos/websocket-client/

- put username, password and click connect

- to check, that data are being send towards broker click 'Add Supscription' and fill in the Topic like: netio/{DEVICE_NAME}/# where replace {DEVICE_NAME} with name of your device (i.e.: if the name of your device is COBRA-8C, then put into this field: netio/COBRA-8C/# ). hash character ('#') stands for wildcard for all other subtopics (like state, voltage, energy etc.)

- to check, that your device can listen to MQTT messages sent through broker fill in the section PUBLISH with Topic netio/{DEVICE_NAME}/output/{OUTPUT_NUM}/action (for example for second output of device named COBRA-8C put 'netio/COBRA-8C/output/2/action') here. for test, put the value number 4, which means toggle (0 - switch output off, 1 - switch output on, 2 - toggle output to the inverse state)

Android App MQTT Dash (you can use any other, of course):
https://play.google.com/store/apps/details?id=net.routix.mqttdash&hl=en

HiveMQ

2019-07-10T14:09:42Z

Vkristof:

example integration with Cobra/PowerCable/PowerPDU4PS + HiveMQ public broker + MQTT Dash Android App

cobra MQTT-flex configuration:
{
{
"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":5
},
{
"type":"delta",
"source":"OUTPUTS/1/LOAD",
"delta":1
}
]
}
]
}
}
}

HiveMQ connection settings (just to check, that data are being send towards internet):

Android App MQTT Dash (you can use any other, of course):
https://play.google.com/store/apps/details?id=net.routix.mqttdash&hl=en

HiveMQ

2019-07-10T14:06:24Z

Vkristof: init

Welcome to NETIO resources & projects & documentation overview

2019-07-10T12:17:24Z

Vkristof:

<div style="text-align: center; white-space: nowrap;">
<div style="display: inline-block; padding: 0 2em 2em 2em; margin-bottom: 2em; width: 46%; min-width: 15em; border-right: 1px solid gray; text-align: justify; vertical-align: top; white-space: normal;">

<h2 style="background: #005f41; color: #FFF; margin: 0 -1em; padding: 0 1em;"> NETIO Resources</h2>
<div style="text-align: center; white-space: nowrap;">
<div style="display: inline-block; padding: 0 0 0 0; width: 50%; margin-bottom: 1em; margin-top: 1em; min-width: 10em; text-align: justify; vertical-align: top; white-space: normal;">

=== M2M API Reference ===
[[MQTT-flex]]

[[MQTT]]

[[JSON API]]

[[XML API]]

[[URL API]]

[[SNMP]]

[[Telnet/Kshell]]

[[Modbus TCP]]

=== Integrations ===
[https://www.home-assistant.io/components/netio/ Home Assistant]

[[IBM Cloud]] - MQTT-flex

[[Azure IoT Hub]] - MQTT

[[HiveMQ]] - MQTT-flex

[[NodeRED]] - JSON API

[https://www.jam-software.com/serversentinel/online_manual/EN/index.html?actions_netio230bnetworkpowersocket.html Jam-software - ServerSentinel]

</div>

<div style="display: inline-block; padding: 0 0 2em 2em; margin-bottom: 1em; margin-top: 1em; border-left: 1px solid gray; width: 50%; min-width: 10em; text-align: justify; white-space: normal;">

=== Public projects & examples ===
==== Official ====
[https://github.com/netioproducts GitHub - official]

[https://github.com/Koukaam/netio-utils/tree/master/actions GitHub - obsolete (Koukaam)]

==== Community ====
[https://github.com/stdevel/check_netio Nagios plugin]

[https://github.com/elmicro/fhem_netio_4x_pm FHEM module by Elmicro]

[https://github.com/imolein/lua-netio LUA control Library]

[https://github.com/rynr/netio Java Control Library]

[https://github.com/st3veV/Netio-OpenHAB OpenHAB using MQTT]

[https://jirikuba.github.io/NETIO.SpinaniHDO/ NETIO controlled by HDO]

[https://groups.google.com/forum/#!topic/openhab/O6psocjU70s Read consumption in OpenHAB - HTTP]

[https://www.instructables.com/id/How-to-Work-With-JSON-in-Node-RED/ Controll NETIO 4All from NodeRED]

</div>
</div>

</div>

<div style="display: inline-block; padding: 0 2em; border-left: 1px solid gray; width: 46%; min-width: 15em; text-align: justify; white-space: normal;">

<h2 style="background: #005f41; color: #FFF; margin: 0 -1em; padding: 0 1em;"> NETIO Lua Programming </h2>
NETIO uses Lua as its scripting language. To master it, follow these references:

=== [https://www.lua.org/pil/contents.html Lua tutorial] ===
If you are new to Lua and programming as such and if you are eager to learn, this is your starting point. Before you proceed to NETIO Sockets, this [https://www.lua.org/demo.html online environment] will be a good place to test your first scripts.

=== [https://www.lua.org/manual/5.3/ Lua manual] ===
Although you won't need everything mentioned here, it is worth to peek here from time to time to grasp the concepts of effective Lua programming.

=== [[NETIO Lua Manual]] ===
A quick jump into NETIO Lua programming if you mastered another programming language. If you already know Lua, just keep in mind that NETIO Lua loops are limited to 32k cycles and all numbers are integers, not decimals like in standard Lua.

=== [[NETIO Lua Reference]] ===
If you can already code in Lua, NETIO-specific Lua functions is your main guide to programm NETIO Sockets.

=== [[LUA Aplication notes]] ===
Aplication notes for devices supporting LUA programming. Example configurations downloads and Script programming explanation with direct links to reference

</div>
</div>

__NOTOC__