https://wiki.netio-products.com/api.php?action=feedcontributions&feedformat=atom&user=Tbezstarosta
wiki.netio-products.com - User contributions [en]
2026-04-28T11:10:05Z
User contributions
MediaWiki 1.32.0
https://wiki.netio-products.com/index.php?title=MQTT-flex&diff=1090
MQTT-flex
2026-03-17T15:06:29Z
<p>Tbezstarosta: /* HUMIDITY */</p>
<hr />
<div>The MQTT-flex version of the MQTT protocol can be configured in detail thanks to the “flex” extension.<br />
<br />
https://www.netio-products.com/en/glossary/mqtt-flex <br />
<br />
<b>Why MQTT-flex</b> <br><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.<br />
<br />
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.<br />
<br />
===Supported devices:===<br />
* PowerCable MQTT 101x <br><br />
* PowerCable REST 101x <br><br />
* PowerPDU 4PS <br><br />
* PowerPDU 4KS <br><br />
* PowerPDU 8QS <br><br />
* PowerDIN 4PZ <br><br />
* PowerBOX 3Px <br><br />
* PowerBOX 4Kx <br><br />
<br />
<b>FW version:</b> <br><br />
>2.2.1<br />
<br />
===Not supported NETIO devices:===<br />
* PowerPDU 4C <br><br />
* NETIO 4 <br><br />
* NETIO 4All <br><br />
<br />
= Simple MQTT-flex configuration + explanation =<br />
<br />
''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.''<br />
<br />
{<br />
"config":{<br />
"broker":{<br />
"url":"broker.hivemq.com",<br />
"protocol":"mqtt",<br />
"port":1883,<br />
"ssl":false,<br />
"type":"generic",<br />
"username":"freedom",<br />
"password":"peace|LOVE|empathy4ALL"<br />
},<br />
"subscribe":[{<br />
"topic":"netio/${DEVICE_NAME}/output/1/action",<br />
"qos":0,<br />
"target":"OUTPUTS/1/ACTION",<br />
"action":"${payload}"<br />
}<br />
],<br />
"publish":[{<br />
"topic":"netio/${DEVICE_NAME}/output/1/state",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/STATE}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":"1000"<br />
}<br />
]<br />
}<br />
]<br />
}<br />
}<br />
=== Client Configuration (broker section) ===<br />
Put here MQTT client connection setup<br />
<br />
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>. <br />
<br />
"broker":{<br />
"url":"broker.hivemq.com",<br />
"protocol":"mqtt",<br />
"port":1883,<br />
"ssl":false,<br />
"type":"generic",<br />
"username":"freedom",<br />
"password":"peace|LOVE|empathy4ALL"<br />
},<br />
<br />
=== Device Control (subscribe section) ===<br />
Put here array of topics where to subscribe<br />
<br />
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> <br />
<br />
"subscribe":[{<br />
"topic":"netio/${DEVICE_NAME}/output/1/action",<br />
"qos":0,<br />
"target":"OUTPUTS/1/ACTION",<br />
"action":"${payload}"<br />
}<br />
],<br />
<br />
=== Output State monitoring (publish section) ===<br />
Put here array of topics where to publish.<br />
<br />
Device send every <b>1000 s</b> message to topic <b></b> with <b>QOS 0</b>, <b>retain true</b> information with <b>output 1 state</b><br />
<br />
"publish":[{<br />
"topic":"netio/${DEVICE_NAME}/output/1/state",<br />
"qos":0,<br />
"retain":true,<br />
"payload":"${OUTPUTS/1/STATE}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":"1000"<br />
}<br />
]<br />
}<br />
]<br />
<br />
= Config sections =<br />
<br />
== Broker ==<br />
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 />
<br /><br />
=== Attributes table overview ===<br />
{| class="wikitable"<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Item<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Presence<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Possible Values<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Description<br />
! style="font-weight:bold; background-color:#9b9b9b;" | JSON Config Usage<br />
|-<br />
| style="background-color:#efefef;" | url<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | MQTT broker URL<br />
| style="background-color:#efefef;" | "url":"broker.hivemq.com"<br />
|-<br />
| style="background-color:#efefef;" | port<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | 1 - 65535<br />
| style="background-color:#efefef;" | MQTT broker port<br />
| style="background-color:#efefef;" | "port":1883<br />
|-<br />
| style="background-color:#efefef;" | protocol<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | protocol spec - mqtt<br />
| style="background-color:#efefef;" | "protocol": "mqtt"<br />
|-<br />
| style="background-color:#efefef;" | ssl<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | true, false<br />
| style="background-color:#efefef;" | Use SSL crypted communication selector<br />
| style="background-color:#efefef;" | "ssl":false<br />
|-<br />
| style="background-color:#efefef;" | type<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | generic<br />
| style="background-color:#efefef;" | Communication/setup type option<br />
| style="background-color:#efefef;" | "type":"generic"<br />
|-<br />
| style="background-color:#efefef;" | username<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | regexp+len<br />
| style="background-color:#efefef;" | Credentials for MQTT broker. Max. 128 characters (since FW 3.2.4).<br />
| style="background-color:#efefef;" | "username":"freedom"<br />
|-<br />
| style="background-color:#efefef;" | password<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | regexp+len<br />
| style="background-color:#efefef;" | Credentials for MQTT broker. Max. 256 characters (since FW 3.2.4).<br />
| style="background-color:#efefef;" | "password":"peace|LOVE|empathy4ALL"<br />
|-<br />
| style="background-color:#efefef;" | clientid<br />
| style="background-color:#efefef;" | optional<br />
| style="background-color:#efefef;" | regexp+len<br />
| style="background-color:#efefef;" | MQTT clientid. Max. 128 characters (since FW 3.2.4). Variables ${DEVICE_MAC} or ${DEVICE_NAME} can be used<br />
| style="background-color:#efefef;" | "clientid":"myEcoTable01"<br />
|-<br />
| style="background-color:#efefef;" | keepalive<br />
| style="background-color:#efefef;" | optional<br />
| style="background-color:#efefef;" | 1 - 65535<br />
| style="background-color:#efefef;" | MQTT keep alive period in seconds<br />
| style="background-color:#efefef;" | "keepalive":90<br />
|}<br />
<br />
Note 1: <b>clientid</b> attribute is <b>mandatory for MQTT(s)</b> communication. When not configured, random ID will be generated.<br />
<br />
Note 2: To proper communication with MS Azure - it is necessary to set up IoT Hub to use TLS 1.2<br />
<br />
See section "TLS 1.2 enforcement available in select regions" in following guidelines https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-tls-support<br />
<br />
=== Examples ===<br />
==== Standard setup ====<br />
<br />
<br />
==== Security (SSL / TLS) secured setup ====<br />
You can enable MQTTs by using the encrypted port <b>8883</b> + <b>"ssl":true</b>.<br />
<br />
==== Variables used setup ====<br />
<br />
== Subscribe ==<br />
=== Hints to usage ===<br />
When receive message in <b><i>topic</b></i> do <b><i>action</b></i> on <b><i>target</b></i>.<br />
<br />
<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>.<br />
<br />
=== Attributes table overview ===<br />
{| class="wikitable"<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Item<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Presence<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Possible Values<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Description<br />
! style="font-weight:bold; background-color:#9b9b9b;" | JSON Config Usage<br />
|-<br />
| style="background-color:#efefef;" | topic<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | see table below<br />
| style="background-color:#efefef;" | specification of the topic, which MQTT-flex device listens from broker and act accordingly. Max. 128 characters. The "#" can be used since FW 3.2.4 - see note under this table.<br />
| style="background-color:#efefef;" | "topic":"netio/${DEVICE_NAME}/output/1/action"<br />
|-<br />
| style="background-color:#efefef;" | qos<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | 0, 1 or 2<br />
| 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}<br />
| style="background-color:#efefef;" | "qos":0<br />
|-<br />
| style="background-color:#efefef;" | target<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | internal definition of action, which can be performed above the specified output<br />
| style="background-color:#efefef;" | "target":"OUTPUTS/1/ACTION"<br />
|-<br />
| style="background-color:#efefef;" | action<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | a payload or a value the action attribute needs to have passed to<br />
| style="background-color:#efefef;" | "action":"${payload}"<br />
|-<br />
| style="background-color:#efefef;" | actiondef<sup>Not supported yet</sup><br />
| style="background-color:#efefef;" | optional<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
|-<br />
| style="background-color:#efefef;" | json<sup>Not supported yet</sup><br />
| style="background-color:#efefef;" | optional<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
|}<br />
<br />
Note: The "#" wildcard can be used in subscribe topic definition. The multi-level wildcard character MUST be specified either on its own or following a topic level separator. In either case it MUST be the last character specified in the Topic.<br />
<br />
For example, if a Device subscribes to “devices/{device_id}/messages/devicebound/#”, it would receive messages published using these topic names:<br />
<br />
“devices/{device_id}/messages/devicebound/”<br />
<br />
“devices/{device_id}/messages/devicebound/{property_bag}”<br />
<br />
This should be usefull for use with MS Azure - IoT hub.<br />
<br />
=== MQTT Subscribe as event to trigger action <sup><code>FW 4.0.0+</code></sup> ===<br />
<br />
This feature allow to subscribe to specific MQTT topic and pass payload to Rules or MQTT-flex as event.<br />
<br />
target: <code>PROTOCOLS/MQTT/EVENT</code><br />
<br />
"subscribe": [<br />
{<br />
"action": "${payload}",<br />
"qos": 0,<br />
"target": "PROTOCOLS/MQTT/EVENT",<br />
"topic": "broker/12345/MQTT_EVENT/"<br />
}<br />
]<br />
<br />
=== Examples ===<br />
==== Toggle output with standard payload ==== <br />
==== Toggle output with custom payload ==== <br />
==== Subscribe to more than one topic ====<br />
==== Trigger Rule and MQTT publish from MQTT subscribe <sup><code>FW 4.0.0+</code></sup> ====<br />
This example show Request response implementation in MQTT and toggle action made by Rules.<br />
<br />
When message with payload <code>getValues</code> is published to topic <code>broker/gv90018g/COMMAND</code> MQTT flex will create an event with name <code>PROTOCOLS/MQTT/EVENT</code> (fixed name cannot be changed) and value <code>getValues</code>. On this event will act all events and conditions set in MQTT-flex and Rules which are set to listening to change on <code>PROTOCOLS/MQTT/EVENT</code> and equals to value <code>getValues</code>. See <b>bold</b> marked parameters in example configuration below. <br />
<br />
Once the triggered action is done it is needed to reset MQTT channel to <code>OK</code> status becaus event are reacting only to change. If the channel is not reset the next even would not be triggered.<br />
<br />
<b>Rules Configuration:</b><br />
{<br />
"conditions": {<br />
<b>"PROTOCOLS/MQTT/EVENT": "getValues"</b><br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 4<br />
}<br />
}<br />
<br />
<b>MQTT Configuration:</b><br />
{<br />
"broker":{<br />
"clientid":"netio${DEVICE_SN}",<br />
"keepalive":30,<br />
"password":"abcdefghijk",<br />
"port":8883,<br />
"protocol":"mqtt",<br />
"ssl":true,<br />
"type":"generic",<br />
"url":"broker.cloud.netio.eu",<br />
"username":"gv90018g"<br />
},<br />
"groupEvents":[<br />
{<br />
"events":[<br />
{<br />
<b>"source":"PROTOCOLS/MQTT/EVENT",<br />
"type":"change",<br />
"value":"getValues"</b><br />
}<br />
],<br />
"appliedTopics":[<br />
"broker/gv90018g/OUTPUTS/1/STATE",<br />
<b>"broker/gv90018g/COMMAND"</b><br />
]<br />
}<br />
],<br />
"publish":[<br />
{<br />
"payload":"${OUTPUTS/1/STATE}",<br />
"qos":0,<br />
"retain":true,<br />
"topic":"broker/gv90018g/OUTPUTS/1/STATE"<br />
},<br />
{<br />
"payload":"OK",<br />
"qos":0,<br />
"retain":true,<br />
"topic":"broker/gv90018g/COMMAND"<br />
}<br />
],<br />
"subscribe":[<br />
{<br />
"action":"${payload}",<br />
"qos":0,<br />
<b>"target":"PROTOCOLS/MQTT/EVENT"</b>,<br />
"topic":"broker/gv90018g/COMMAND"<br />
}<br />
]<br />
}<br />
<br />
<br />
<br />
Subscribe topic payload values specification for control of the output:<br />
<br />
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)<br />
<br />
== Publish ==<br />
<br />
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)<br />
<br />
=== Hints to usage ===<br />
When <b><i>event</b></i> send message with <b><i>payload</b></i> to <b><i>topic</b></i>.<br />
<br />
=== Attributes table overview ===<br />
{| class="wikitable"<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Item<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Presence<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Possible Values<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Description<br />
! style="font-weight:bold; background-color:#9b9b9b;" | JSON Config Usage<br />
|-<br />
| style="background-color:#efefef;" | topic<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | see table below<br />
| style="background-color:#efefef;" | definition of the topic, how it is registered towards MQTT broker. Max. 128 characters. <br />
| style="background-color:#efefef;" | "topic":"netio/${DEVICE_NAME}/output/1/load"<br />
|-<br />
| style="background-color:#efefef;" | qos<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | see table below<br />
| 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}<br />
| style="background-color:#efefef;" | <br />
|-<br />
| style="background-color:#efefef;" | retain<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | boolean: true or false<br />
| 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}<br />
| style="background-color:#efefef;" | "retain":true<br />
|-<br />
| style="background-color:#efefef;" | payload<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | see table below<br />
| style="background-color:#efefef;" | definition of the payload, what is send to the MQTT broker.<br />
| style="background-color:#efefef;" | "payload":"${OUTPUTS/1/STATE}"<br />
|-<br />
| style="background-color:#efefef;" | events<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | see table below<br />
| style="background-color:#efefef;" | definition of events used for triggering sending of data via mqtt (change, delta, timer)<br />
| style="background-color:#efefef;" | <br />
|-<br />
| style="background-color:#efefef;" | type<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" |<br />
|-<br />
| style="background-color:#efefef;" | source<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" |<br />
|-<br />
| style="background-color:#efefef;" | delta<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" |<br />
|-<br />
| style="background-color:#efefef;" | period<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" |<br />
| style="background-color:#efefef;" |<br />
|-<br />
| style="background-color:#efefef;" | payloaddef<sup>Not supported yet</sup><br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" |<br />
|}<br />
<br />
=== Examples ===<br />
==== Publish energy periodically (event timer) ==== <br />
==== Publish current on change (delta) ==== <br />
==== Publish output state ====<br />
==== Publish to more than one topic with different events ====<br />
<br />
= Target / Source =<br />
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.<br />
<br />
* <b>source</b> - specifies from where the value will be read (specifies the source of data for payload, change detection, delta calculation)<br />
* <b>target</b> - specifies where the data should be sent or command applied (e.g. specifies the target for ACTION)<br />
<br />
=== INPUT / OUTPUT (Target) selection ===<br />
<br />
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.<br />
<br />
# At first specify if requested variable is from/for INPUT or OUTPUT using keywords <b>"OUTPUTS"</b> or <b>"INPUTS"</b> .<br />
# Add <b>"/"</b> separator<br />
# Specify the number of INPUT/OUTPUT to <b>1</b>(or TOTAL for summary statistics if available)<br />
# Add <b>"/"</b> separator<br />
# Specify requested variable or command<br />
<br />
<b>Note:</b> Not all of OUTPUTS/INPUTS support all variables. Available variables are closely connected with the device functions and I/O features.<br />
<br />
<b>Note2:</b> INPUTS available only on NETIO PowerDIN 4PZ<br />
<br />
=== Examples: ===<br />
<br />
adressing controll of output 3<br />
OUTPUTS/3/ACTION<br />
getting voltage on output 1<br />
OUTPUTS/1/VOLTAGE<br />
getting state of input 1<br />
INPUTS/1/STATE<br />
getting temperature [C] - sensor connected of input 1<br />
INPUTS/1/TEMP<br />
getting temperature [F] - sensor connected of input 2<br />
INPUTS/2/TEMPF<br />
getting humidity [%] - sensor connected of input 2<br />
INPUTS/2/HUMIDITY<br />
<br />
= Group Events<sup><code>FW 4.0.0+</code></sup> =<br />
Group events are smart way how to keep configuration simple. It is not replacement of publish section specification but it is extension to trigger group of different topics to be published on the same event.<br />
<br />
See the example below. There is specific event on status change on every output and additionally the device sends periodic status every 60 seconds.<br />
<br />
{<br />
"broker": {<br />
"clientid": "netio${DEVICE_SN}",<br />
"keepalive": 30,<br />
"password": "",<br />
"port": 1883,<br />
"protocol": "mqtt",<br />
"ssl": false,<br />
"type": "generic",<br />
"url": "broker.hivemq.com",<br />
"username": ""<br />
},<br />
<b>"groupEvents": [<br />
{<br />
"events":[<br />
{<br />
"period": 60,<br />
"type": "timer"<br />
}<br />
],<br />
"appliedTopics":[<br />
"devices/${DEVICE_NAME}/output/1/state",<br />
"devices/${DEVICE_NAME}/output/2/state"<br />
]<br />
}<br />
],</b><br />
"publish": [<br />
{<br />
"events": [<br />
{<br />
"source": "OUTPUTS/1/STATE",<br />
"type": "change"<br />
}<br />
],<br />
"payload": "${OUTPUTS/1/STATE}",<br />
"qos": 0,<br />
"retain": false,<br />
<b> "topic": "devices/${DEVICE_NAME}/output/1/state"</b><br />
},{<br />
"events": [<br />
{<br />
"source": "OUTPUTS/2/STATE",<br />
"type": "change"<br />
}<br />
],<br />
"payload": "${OUTPUTS/2/STATE}",<br />
"qos": 0,<br />
"retain": false,<br />
<b> "topic": "devices/${DEVICE_NAME}/output/2/state"</b><br />
}<br />
]<br />
}<br />
<br />
= Variables =<br />
In some parameters is nescessary to use variables to get current state and measurements. <b>Variables are separated in two categories:</b><br />
<br />
* Target/Source variables<br />
* Payload Topic variables<br />
<br />
== Target Source Variables ==<br />
<br />
The list of available variables for each <br />
<br />
=== OUTPUTS variables ===<br />
==== VOLTAGE ====<br />
Unit: <code>V</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Present RMS voltage on output 1 is ${OUTPUTS/1/VOLTAGE}"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/VOLTAGE}"</code><br />
<br />
==== CURRENT ====<br />
Unit: <code>mA</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Present RMS current on output 1 is ${OUTPUTS/1/CURRENT}"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/CURRENT}"</code><br />
<br />
==== POWER_FACTOR ====<br />
Unit: <code>[-]</code><br />
<br />
Type: float (2 decimals)<br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"True Power Factor on output 1 is ${OUTPUTS/1/POWER_FACTOR}"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/POWER_FACTOR}"</code><br />
<br />
==== LOAD ====<br />
Unit: <code>W</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Present load on output 1 is ${OUTPUTS/1/LOAD}W"</code><br />
<br />
Example 2: <code>"payload":"Device's load connected to output 1 is ${OUTPUTS/1/LOAD}W"</code><br />
<br />
Example 3: <code>"source":"${OUTPUTS/1/LOAD}"</code><br />
<br />
==== STATE ====<br />
Type: bool(integer) - <code>0</code> or <code>1</code><br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Present output 1 state is ${OUTPUTS/1/STATE}"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/STATE}"</code><br />
<br />
==== ACTION ====<br />
Type: integer<br />
<br />
Possible actions:<br />
* <code>0</code> - set state OFF<br />
* <code>1</code> - set state ON<br />
* <code>2</code> - short OFF (restart)<br />
* <code>3</code> - short ON<br />
* <code>4</code> - toggle (switch)<br />
* <code>5</code> - no change<br />
<br />
Allowed in: <code>"target"</code><br />
<br />
Example: <code>"target":"OUTPUTS/1/ACTION"</code><br />
<br />
==== DELAY [ms] ====<br />
==== NAME ====<br />
==== FREQUENCY ====<br />
Unit: <code>Hz</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example: <code>"payload":"Frequency in power grid is ${OUTPUTS/1/ENERGY}Hz"</code><br />
<br />
==== ENERGY ====<br />
Energy consumed by an device connected to NETIO device output.<br />
<br />
Unit: <code>Wh</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Consumed energy on output 1 is ${OUTPUTS/1/ENERGY}Wh"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/ENERGY}"</code><br />
<br />
==== REVERSE_ENERGY ====<br />
Energy delivered back to grid. For example from solar system connected to NETIO device output.<br />
<br />
Unit: <code>Wh</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Delivered energy on output 1 is ${OUTPUTS/1/REVERSE_ENERGY}Wh"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/REVERSE_ENERGY}"</code><br />
<br />
<br />
==== ENERGY_START ====<br />
Date when the counters ENERGY and REVERSE_ENERGY have been resetted by user.<br />
<br />
Unit: <code>unix timestamp</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code><br />
<br />
Example 1: <code>"payload":"Energy measured since ${OUTPUTS/1/ENERGY_START} unix time"</code><br />
<br />
Example 2: <code>"payload":"${OUTPUTS/1/ENERGY_START}"</code> is output payload <code>1567654639</code><br />
<br />
==== ENERGY_START_FMT ====<br />
Date when the counters ENERGY and REVERSE_ENERGY have been resetted by user.<br />
<br />
Unit: <code>fmt date format</code><br />
<br />
Type: string <br />
<br />
Allowed in: <code>"payload"</code><br />
<br />
Example 1: <code>"payload":"Energy measured since ${OUTPUTS/1/ENERGY_START}"</code><br />
<br />
Example 2: <code>"payload":"${OUTPUTS/1/ENERGY_START_FMT}"</code> is output payload <code>2019-09-05T03:37:19+00:00</code><br />
<br />
==== ENERGY_NR ====<br />
Non-resettable counter of Energy consumed by an device connected to NETIO device output.<br />
<br />
Unit: <code>Wh</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Consumed energy on output 1 is ${OUTPUTS/1/ENERGY_NR}Wh"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/ENERGY_NR}"</code><br />
<br />
==== REVERSE_ENERGY_NR ====<br />
Non-resettable counter of Energy delivered back to grid. For example from solar system connected to NETIO device output.<br />
<br />
Unit: <code>Wh</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Delivered energy on output 1 is ${OUTPUTS/1/REVERSE_ENERGY_NR}Wh"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/REVERSE_ENERGY_NR}"</code><br />
<br />
<br />
<br />
==== TOTALs - for use with devices having more than 1 measured output ====<br />
<br />
* OUTPUTS/TOTAL/ENERGY<br />
* OUTPUTS/TOTAL/LOAD<br />
* OUTPUTS/TOTAL/CURRENT<br />
* OUTPUTS/TOTAL/VOLTAGE<br />
* OUTPUTS/TOTAL/POWER_FACTOR<br />
* OUTPUTS/TOTAL/FREQUENCY<br />
* OUTPUTS/TOTAL/PHASE<br />
* OUTPUTS/TOTAL/REVERSE_ENERGY<br />
* OUTPUTS/TOTAL/ENERGY_NR<br />
* OUTPUTS/TOTAL/REVERSE_ENERGY_NR<br />
* OUTPUTS/TOTAL/ENERGY_START<br />
* OUTPUTS/TOTAL/ENERGY_START_FMT<br />
<br />
<br />
==== REST_JSON ====<br />
Allow use of NETIO JSON structure to control outputs.<br />
<br />
Type: string / JSON<br />
<br />
Allowed in: <code>"target"</code> for Subscribe section<br />
<br />
Example: <code>"target": "REST_JSON"</code><br />
<br />
The payload is JSON structure identical to NETIO JSON API M2M Protocol (documentation available at https://www.netio-products.com/files/NETIO-M2M-API-Protocol-JSON.pdf). You can control one or multiple outputs.<br />
<br />
Payload example 1 - Toggle output 1: <code>{"Outputs":[{"ID": 1,"Action": 4}]}</code><br />
<br />
Payload example 2 - Turn output 1 OFF and output 3 ON: <code>{"Outputs":[{"ID":1,"Action":0},{"ID":3,"Action":1}]}</code><br />
<br />
=== INPUT variables ===<br />
==== STATE ====<br />
Type: bool(integer) - <code>0</code> or <code>1</code><br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Present input 1 state is ${INPUTS/1/STATE}"</code><br />
<br />
Example 2: <code>"source":"${INPUTS/1/STATE}"</code><br />
<br />
==== S0 ====<br />
S0 Counter value<br />
Unit: <code>-</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Input 1 S0 Counter value is ${INPUTS/1/S0}impulses"</code><br />
<br />
Example 2: <code>"source":"${INPUTS/1/S0}"</code><br />
<br />
==== TEMPERATURE ====<br />
Temperature measurement in Celsius, Fahrenheit<br />
*In case of a disconnected sensor or a malfunction, the return value is 999<br />
Unit: <code> [C], [F] </code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Input 1 Temperature value in degree of Celsius is ${INPUTS/1/TEMP} [C] "</code><br />
<br />
Example 2: <code>"source":"${INPUTS/1/TEMP}"</code><br />
<br />
Example 3: <code>"payload":"Input 1 Temperature value in degree of Fahrenheit is ${INPUTS/1/TEMPF} [F] "</code><br />
<br />
Example 4: <code>"source":"${INPUTS/1/TEMPF}"</code><br />
<br />
==== HUMIDITY ====<br />
Relative Humidity measurement <br />
*In case of a disconnected sensor or a malfunction, the return value is 999<br />
Unit: <code> [%]</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Input 1 Humidity value is ${INPUTS/1/HUMIDITY} %"</code><br />
<br />
Example 2: <code>"source":"${INPUTS/1/HUMIDITY}"</code><br />
<br />
== Payload/topic variables ==<br />
<br />
=== DEVICE_NAME ===<br />
Can be used in: "payload", "topic"<br />
<br />
Example 1: <code>"payload":"${DEVICE_NAME}"</code><br />
<br />
Example 2: <code>"topic":"netio/${DEVICE_NAME}/output/1/action"</code><br />
<br />
=== DEVICE_MAC ===<br />
Can be used in: "payload", "topic"<br />
<br />
Example 1: <code>"payload":"${DEVICE_MAC}"</code><br />
<br />
Example 2: <code>"topic":"netio/${DEVICE_MAC}/output/1/action"</code><br />
<br />
=== UTC_TIME <sup><code>FW 4.0.0+</code></sup>===<br />
<br />
send unix timestamp of devices actual time<br />
<br />
Can be used in: "payload"<br />
<br />
Example 1: <code>"payload": "${UTC_TIME}"</code><br />
<br />
=== UPTIME <sup>Not yet implemented</sup> ===<br />
<br />
=== PAYLOAD ===<br />
Can be used in: "action"<br />
<br />
Example: <code>"action":"${PAYLOAD}"</code><br />
<br />
=== OUTPUT_ID <sup>Not yet implemented</sup>===<br />
<br />
=== WIFI_SIGNAL<sup>Not yet implemented</sup> ===<br />
<br />
=== OUTPUTS_STATUS ===<br />
Provide complete outputs status and measurement if supported.<br />
<br />
Type: string / JSON<br />
<br />
Allowed in: <code>"payload"</code> for Publish section<br />
<br />
Example: <code>"payload":"${OUTPUTS_STATUS}"</code><br />
<br />
Payload example: <code>{ "GlobalMeasure":{"Voltage":236,"TotalCurrent":72,"TotalLoad":11,"TotalEnergy":167,"OverallPowerFactor":0.64,"Frequency":50.07,"Phase":-36.86,"EnergyStart":"2020-06-30T17:04:48+01:00"}, "Outputs":[ {"ID":1,"Name":"Power output 1","State":1,"Action":6,"Delay":2020,"Current":72,"PowerFactor":0.64,"Phase":-36.86,"Energy":139,"ReverseEnergy":0,"Load":11}, {"ID":2,"Name":"Power output 2","State":1,"Action":6,"Delay":2020,"Current":0,"PowerFactor":1.00,"Phase":0.00,"Energy":27,"ReverseEnergy":0,"Load":0}, {"ID":3,"Name":"Free Contact 3","State":1,"Action":6,"Delay":2020}, {"ID":4,"Name":"Free Contact 4","State":1,"Action":6,"Delay":2020} ]}</code><br />
<br />
=== INPUTS_STATUS ===<br />
Provide complete inputs status if supported. Since FW 3.0.0<br />
<br />
Type: string / JSON<br />
<br />
Allowed in: <code>"payload"</code> for Publish section<br />
<br />
Example: <code>"payload":"${INPUTS_STATUS}"</code><br />
<br />
Payload example: <code>{ "Inputs":[ {"ID":1,"Name":"Input 1","State":0,"S0Counter":0}, {"ID":2,"Name":"Input 2","State":0,"S0Counter":0} ]}</code><br />
<br />
=== INOUT_STATUS ===<br />
Provide complete inputs and output status and measurement if supported. Since FW 3.0.0<br />
<br />
Type: string / JSON<br />
<br />
Allowed in: <code>"payload"</code> for Publish section<br />
<br />
Example: <code>"payload":"${INOUT_STATUS}"</code><br />
<br />
Payload example: <code>{ "GlobalMeasure":{"Voltage":238,"TotalCurrent":105,"TotalLoad":17,"TotalEnergy":1451,"OverallPowerFactor":0.67,"Frequency":50.03,"Phase":-33.67,"EnergyStart":"2020-06-30T17:04:48+01:00"}, "Outputs":[ {"ID":1,"Name":"Power output 1","State":0,"Action":6,"Delay":5000,"Current":0,"PowerFactor":1.00,"Phase":0.00,"Energy":701,"ReverseEnergy":0,"Load":0}, {"ID":2,"Name":"Power output 2","State":1,"Action":6,"Delay":5000,"Current":105,"PowerFactor":0.65,"Phase":-33.67,"Energy":750,"ReverseEnergy":0,"Load":17}, {"ID":3,"Name":"Free Contact 3","State":1,"Action":6,"Delay":5000}, {"ID":4,"Name":"Free Contact 4","State":0,"Action":6,"Delay":5000} ], "Inputs":[ {"ID":1,"Name":"Input 1","State":0,"S0Counter":0}, {"ID":2,"Name":"Input 2","State":0,"S0Counter":0} ]}</code><br />
<br />
= Extended MQTT flex JSON config examples =<br />
<br />
== Default NETIO MQTT-flex configuration ==<br />
This example demonstrates setup for connection to public <code>broker.hivemq.com</code>, measurement reporting and output control.<br />
<br />
The device cabe be controlled via <code>netio/${DEVICE_NAME}/output/1/action topic</code> by sending standard NETIO action values:<br />
* 0 - OFF<br />
* 1 - ON<br />
* 2 - SHORT OFF<br />
* 3 - SHORT ON<br />
* 4 - TOGGLE<br />
* 5 - NO ACTION.<br />
<br />
The device report measurements:<br />
<br />
* Output state - every 15 minutes or by change<br />
* Voltage [V]- every 5 minutes or by change of 1 V<br />
* Current [mA]- every 5 minutes or by change of 50 mA<br />
* Load(Power) [W]- every 5 minutes or by change of 10 W<br />
* Energy(Consumption) [Wh]- every 15 minutes or by change of 1Wh<br />
* True Power Factor (TPF) [-]- every 5 minutes or by change of 0.02<br />
* Frequency [Hz]- every 1 hour or by change of 0.1 Hz<br />
<br />
For register all values, you can use wildcard <code>netio/${DEVICE_NAME}/output/1/#</code><br />
<br />
{<br />
"config":{<br />
"broker":{<br />
"url":"broker.hivemq.com",<br />
"protocol":"mqtt",<br />
"port":1883,<br />
"ssl":false,<br />
"type":"generic",<br />
"username":"",<br />
"password":"",<br />
"clientid":"moje${DEVICE_NAME}${DEVICE_MAC}",<br />
"keepalive":30<br />
},<br />
"subscribe":[<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/action",<br />
"qos":0,<br />
"target":"OUTPUTS/1/ACTION",<br />
"action":"${payload}"<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/switch",<br />
"qos":0,<br />
"target":"OUTPUTS/1/ACTION",<br />
"action":4<br />
}<br />
],<br />
"publish":[<br />
{<br />
"topic":"netio/${DEVICE_MAC}/output/1/state",<br />
"qos":0,<br />
"retain":true,<br />
"payload":"${OUTPUTS/1/STATE}",<br />
"events":[<br />
{<br />
"type":"change",<br />
"source":"OUTPUTS/1/STATE"<br />
},<br />
{<br />
"type":"timer",<br />
"period":900<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/voltage",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/VOLTAGE}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":300<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/VOLTAGE",<br />
"delta":1<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/current",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/CURRENT}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":300<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/CURRENT",<br />
"delta":50<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/load",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/LOAD}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":300<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/LOAD",<br />
"delta":10<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/energy",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/ENERGY}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":900<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/ENERGY",<br />
"delta":1<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/tpf",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/POWER_FACTOR}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":900<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/POWER_FACTOR",<br />
"delta":0.02<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/frequency",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/FREQUENCY}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":3600<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/FREQUENCY",<br />
"delta":0.1<br />
}<br />
]<br />
}<br />
]<br />
}<br />
}</div>
Tbezstarosta
https://wiki.netio-products.com/index.php?title=MQTT-flex&diff=1089
MQTT-flex
2026-03-17T15:06:20Z
<p>Tbezstarosta: /* TEMPERATURE */</p>
<hr />
<div>The MQTT-flex version of the MQTT protocol can be configured in detail thanks to the “flex” extension.<br />
<br />
https://www.netio-products.com/en/glossary/mqtt-flex <br />
<br />
<b>Why MQTT-flex</b> <br><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.<br />
<br />
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.<br />
<br />
===Supported devices:===<br />
* PowerCable MQTT 101x <br><br />
* PowerCable REST 101x <br><br />
* PowerPDU 4PS <br><br />
* PowerPDU 4KS <br><br />
* PowerPDU 8QS <br><br />
* PowerDIN 4PZ <br><br />
* PowerBOX 3Px <br><br />
* PowerBOX 4Kx <br><br />
<br />
<b>FW version:</b> <br><br />
>2.2.1<br />
<br />
===Not supported NETIO devices:===<br />
* PowerPDU 4C <br><br />
* NETIO 4 <br><br />
* NETIO 4All <br><br />
<br />
= Simple MQTT-flex configuration + explanation =<br />
<br />
''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.''<br />
<br />
{<br />
"config":{<br />
"broker":{<br />
"url":"broker.hivemq.com",<br />
"protocol":"mqtt",<br />
"port":1883,<br />
"ssl":false,<br />
"type":"generic",<br />
"username":"freedom",<br />
"password":"peace|LOVE|empathy4ALL"<br />
},<br />
"subscribe":[{<br />
"topic":"netio/${DEVICE_NAME}/output/1/action",<br />
"qos":0,<br />
"target":"OUTPUTS/1/ACTION",<br />
"action":"${payload}"<br />
}<br />
],<br />
"publish":[{<br />
"topic":"netio/${DEVICE_NAME}/output/1/state",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/STATE}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":"1000"<br />
}<br />
]<br />
}<br />
]<br />
}<br />
}<br />
=== Client Configuration (broker section) ===<br />
Put here MQTT client connection setup<br />
<br />
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>. <br />
<br />
"broker":{<br />
"url":"broker.hivemq.com",<br />
"protocol":"mqtt",<br />
"port":1883,<br />
"ssl":false,<br />
"type":"generic",<br />
"username":"freedom",<br />
"password":"peace|LOVE|empathy4ALL"<br />
},<br />
<br />
=== Device Control (subscribe section) ===<br />
Put here array of topics where to subscribe<br />
<br />
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> <br />
<br />
"subscribe":[{<br />
"topic":"netio/${DEVICE_NAME}/output/1/action",<br />
"qos":0,<br />
"target":"OUTPUTS/1/ACTION",<br />
"action":"${payload}"<br />
}<br />
],<br />
<br />
=== Output State monitoring (publish section) ===<br />
Put here array of topics where to publish.<br />
<br />
Device send every <b>1000 s</b> message to topic <b></b> with <b>QOS 0</b>, <b>retain true</b> information with <b>output 1 state</b><br />
<br />
"publish":[{<br />
"topic":"netio/${DEVICE_NAME}/output/1/state",<br />
"qos":0,<br />
"retain":true,<br />
"payload":"${OUTPUTS/1/STATE}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":"1000"<br />
}<br />
]<br />
}<br />
]<br />
<br />
= Config sections =<br />
<br />
== Broker ==<br />
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 />
<br /><br />
=== Attributes table overview ===<br />
{| class="wikitable"<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Item<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Presence<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Possible Values<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Description<br />
! style="font-weight:bold; background-color:#9b9b9b;" | JSON Config Usage<br />
|-<br />
| style="background-color:#efefef;" | url<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | MQTT broker URL<br />
| style="background-color:#efefef;" | "url":"broker.hivemq.com"<br />
|-<br />
| style="background-color:#efefef;" | port<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | 1 - 65535<br />
| style="background-color:#efefef;" | MQTT broker port<br />
| style="background-color:#efefef;" | "port":1883<br />
|-<br />
| style="background-color:#efefef;" | protocol<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | protocol spec - mqtt<br />
| style="background-color:#efefef;" | "protocol": "mqtt"<br />
|-<br />
| style="background-color:#efefef;" | ssl<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | true, false<br />
| style="background-color:#efefef;" | Use SSL crypted communication selector<br />
| style="background-color:#efefef;" | "ssl":false<br />
|-<br />
| style="background-color:#efefef;" | type<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | generic<br />
| style="background-color:#efefef;" | Communication/setup type option<br />
| style="background-color:#efefef;" | "type":"generic"<br />
|-<br />
| style="background-color:#efefef;" | username<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | regexp+len<br />
| style="background-color:#efefef;" | Credentials for MQTT broker. Max. 128 characters (since FW 3.2.4).<br />
| style="background-color:#efefef;" | "username":"freedom"<br />
|-<br />
| style="background-color:#efefef;" | password<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | regexp+len<br />
| style="background-color:#efefef;" | Credentials for MQTT broker. Max. 256 characters (since FW 3.2.4).<br />
| style="background-color:#efefef;" | "password":"peace|LOVE|empathy4ALL"<br />
|-<br />
| style="background-color:#efefef;" | clientid<br />
| style="background-color:#efefef;" | optional<br />
| style="background-color:#efefef;" | regexp+len<br />
| style="background-color:#efefef;" | MQTT clientid. Max. 128 characters (since FW 3.2.4). Variables ${DEVICE_MAC} or ${DEVICE_NAME} can be used<br />
| style="background-color:#efefef;" | "clientid":"myEcoTable01"<br />
|-<br />
| style="background-color:#efefef;" | keepalive<br />
| style="background-color:#efefef;" | optional<br />
| style="background-color:#efefef;" | 1 - 65535<br />
| style="background-color:#efefef;" | MQTT keep alive period in seconds<br />
| style="background-color:#efefef;" | "keepalive":90<br />
|}<br />
<br />
Note 1: <b>clientid</b> attribute is <b>mandatory for MQTT(s)</b> communication. When not configured, random ID will be generated.<br />
<br />
Note 2: To proper communication with MS Azure - it is necessary to set up IoT Hub to use TLS 1.2<br />
<br />
See section "TLS 1.2 enforcement available in select regions" in following guidelines https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-tls-support<br />
<br />
=== Examples ===<br />
==== Standard setup ====<br />
<br />
<br />
==== Security (SSL / TLS) secured setup ====<br />
You can enable MQTTs by using the encrypted port <b>8883</b> + <b>"ssl":true</b>.<br />
<br />
==== Variables used setup ====<br />
<br />
== Subscribe ==<br />
=== Hints to usage ===<br />
When receive message in <b><i>topic</b></i> do <b><i>action</b></i> on <b><i>target</b></i>.<br />
<br />
<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>.<br />
<br />
=== Attributes table overview ===<br />
{| class="wikitable"<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Item<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Presence<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Possible Values<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Description<br />
! style="font-weight:bold; background-color:#9b9b9b;" | JSON Config Usage<br />
|-<br />
| style="background-color:#efefef;" | topic<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | see table below<br />
| style="background-color:#efefef;" | specification of the topic, which MQTT-flex device listens from broker and act accordingly. Max. 128 characters. The "#" can be used since FW 3.2.4 - see note under this table.<br />
| style="background-color:#efefef;" | "topic":"netio/${DEVICE_NAME}/output/1/action"<br />
|-<br />
| style="background-color:#efefef;" | qos<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | 0, 1 or 2<br />
| 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}<br />
| style="background-color:#efefef;" | "qos":0<br />
|-<br />
| style="background-color:#efefef;" | target<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | internal definition of action, which can be performed above the specified output<br />
| style="background-color:#efefef;" | "target":"OUTPUTS/1/ACTION"<br />
|-<br />
| style="background-color:#efefef;" | action<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | a payload or a value the action attribute needs to have passed to<br />
| style="background-color:#efefef;" | "action":"${payload}"<br />
|-<br />
| style="background-color:#efefef;" | actiondef<sup>Not supported yet</sup><br />
| style="background-color:#efefef;" | optional<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
|-<br />
| style="background-color:#efefef;" | json<sup>Not supported yet</sup><br />
| style="background-color:#efefef;" | optional<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
|}<br />
<br />
Note: The "#" wildcard can be used in subscribe topic definition. The multi-level wildcard character MUST be specified either on its own or following a topic level separator. In either case it MUST be the last character specified in the Topic.<br />
<br />
For example, if a Device subscribes to “devices/{device_id}/messages/devicebound/#”, it would receive messages published using these topic names:<br />
<br />
“devices/{device_id}/messages/devicebound/”<br />
<br />
“devices/{device_id}/messages/devicebound/{property_bag}”<br />
<br />
This should be usefull for use with MS Azure - IoT hub.<br />
<br />
=== MQTT Subscribe as event to trigger action <sup><code>FW 4.0.0+</code></sup> ===<br />
<br />
This feature allow to subscribe to specific MQTT topic and pass payload to Rules or MQTT-flex as event.<br />
<br />
target: <code>PROTOCOLS/MQTT/EVENT</code><br />
<br />
"subscribe": [<br />
{<br />
"action": "${payload}",<br />
"qos": 0,<br />
"target": "PROTOCOLS/MQTT/EVENT",<br />
"topic": "broker/12345/MQTT_EVENT/"<br />
}<br />
]<br />
<br />
=== Examples ===<br />
==== Toggle output with standard payload ==== <br />
==== Toggle output with custom payload ==== <br />
==== Subscribe to more than one topic ====<br />
==== Trigger Rule and MQTT publish from MQTT subscribe <sup><code>FW 4.0.0+</code></sup> ====<br />
This example show Request response implementation in MQTT and toggle action made by Rules.<br />
<br />
When message with payload <code>getValues</code> is published to topic <code>broker/gv90018g/COMMAND</code> MQTT flex will create an event with name <code>PROTOCOLS/MQTT/EVENT</code> (fixed name cannot be changed) and value <code>getValues</code>. On this event will act all events and conditions set in MQTT-flex and Rules which are set to listening to change on <code>PROTOCOLS/MQTT/EVENT</code> and equals to value <code>getValues</code>. See <b>bold</b> marked parameters in example configuration below. <br />
<br />
Once the triggered action is done it is needed to reset MQTT channel to <code>OK</code> status becaus event are reacting only to change. If the channel is not reset the next even would not be triggered.<br />
<br />
<b>Rules Configuration:</b><br />
{<br />
"conditions": {<br />
<b>"PROTOCOLS/MQTT/EVENT": "getValues"</b><br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 4<br />
}<br />
}<br />
<br />
<b>MQTT Configuration:</b><br />
{<br />
"broker":{<br />
"clientid":"netio${DEVICE_SN}",<br />
"keepalive":30,<br />
"password":"abcdefghijk",<br />
"port":8883,<br />
"protocol":"mqtt",<br />
"ssl":true,<br />
"type":"generic",<br />
"url":"broker.cloud.netio.eu",<br />
"username":"gv90018g"<br />
},<br />
"groupEvents":[<br />
{<br />
"events":[<br />
{<br />
<b>"source":"PROTOCOLS/MQTT/EVENT",<br />
"type":"change",<br />
"value":"getValues"</b><br />
}<br />
],<br />
"appliedTopics":[<br />
"broker/gv90018g/OUTPUTS/1/STATE",<br />
<b>"broker/gv90018g/COMMAND"</b><br />
]<br />
}<br />
],<br />
"publish":[<br />
{<br />
"payload":"${OUTPUTS/1/STATE}",<br />
"qos":0,<br />
"retain":true,<br />
"topic":"broker/gv90018g/OUTPUTS/1/STATE"<br />
},<br />
{<br />
"payload":"OK",<br />
"qos":0,<br />
"retain":true,<br />
"topic":"broker/gv90018g/COMMAND"<br />
}<br />
],<br />
"subscribe":[<br />
{<br />
"action":"${payload}",<br />
"qos":0,<br />
<b>"target":"PROTOCOLS/MQTT/EVENT"</b>,<br />
"topic":"broker/gv90018g/COMMAND"<br />
}<br />
]<br />
}<br />
<br />
<br />
<br />
Subscribe topic payload values specification for control of the output:<br />
<br />
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)<br />
<br />
== Publish ==<br />
<br />
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)<br />
<br />
=== Hints to usage ===<br />
When <b><i>event</b></i> send message with <b><i>payload</b></i> to <b><i>topic</b></i>.<br />
<br />
=== Attributes table overview ===<br />
{| class="wikitable"<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Item<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Presence<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Possible Values<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Description<br />
! style="font-weight:bold; background-color:#9b9b9b;" | JSON Config Usage<br />
|-<br />
| style="background-color:#efefef;" | topic<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | see table below<br />
| style="background-color:#efefef;" | definition of the topic, how it is registered towards MQTT broker. Max. 128 characters. <br />
| style="background-color:#efefef;" | "topic":"netio/${DEVICE_NAME}/output/1/load"<br />
|-<br />
| style="background-color:#efefef;" | qos<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | see table below<br />
| 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}<br />
| style="background-color:#efefef;" | <br />
|-<br />
| style="background-color:#efefef;" | retain<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | boolean: true or false<br />
| 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}<br />
| style="background-color:#efefef;" | "retain":true<br />
|-<br />
| style="background-color:#efefef;" | payload<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | see table below<br />
| style="background-color:#efefef;" | definition of the payload, what is send to the MQTT broker.<br />
| style="background-color:#efefef;" | "payload":"${OUTPUTS/1/STATE}"<br />
|-<br />
| style="background-color:#efefef;" | events<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | see table below<br />
| style="background-color:#efefef;" | definition of events used for triggering sending of data via mqtt (change, delta, timer)<br />
| style="background-color:#efefef;" | <br />
|-<br />
| style="background-color:#efefef;" | type<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" |<br />
|-<br />
| style="background-color:#efefef;" | source<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" |<br />
|-<br />
| style="background-color:#efefef;" | delta<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" |<br />
|-<br />
| style="background-color:#efefef;" | period<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" |<br />
| style="background-color:#efefef;" |<br />
|-<br />
| style="background-color:#efefef;" | payloaddef<sup>Not supported yet</sup><br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" |<br />
|}<br />
<br />
=== Examples ===<br />
==== Publish energy periodically (event timer) ==== <br />
==== Publish current on change (delta) ==== <br />
==== Publish output state ====<br />
==== Publish to more than one topic with different events ====<br />
<br />
= Target / Source =<br />
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.<br />
<br />
* <b>source</b> - specifies from where the value will be read (specifies the source of data for payload, change detection, delta calculation)<br />
* <b>target</b> - specifies where the data should be sent or command applied (e.g. specifies the target for ACTION)<br />
<br />
=== INPUT / OUTPUT (Target) selection ===<br />
<br />
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.<br />
<br />
# At first specify if requested variable is from/for INPUT or OUTPUT using keywords <b>"OUTPUTS"</b> or <b>"INPUTS"</b> .<br />
# Add <b>"/"</b> separator<br />
# Specify the number of INPUT/OUTPUT to <b>1</b>(or TOTAL for summary statistics if available)<br />
# Add <b>"/"</b> separator<br />
# Specify requested variable or command<br />
<br />
<b>Note:</b> Not all of OUTPUTS/INPUTS support all variables. Available variables are closely connected with the device functions and I/O features.<br />
<br />
<b>Note2:</b> INPUTS available only on NETIO PowerDIN 4PZ<br />
<br />
=== Examples: ===<br />
<br />
adressing controll of output 3<br />
OUTPUTS/3/ACTION<br />
getting voltage on output 1<br />
OUTPUTS/1/VOLTAGE<br />
getting state of input 1<br />
INPUTS/1/STATE<br />
getting temperature [C] - sensor connected of input 1<br />
INPUTS/1/TEMP<br />
getting temperature [F] - sensor connected of input 2<br />
INPUTS/2/TEMPF<br />
getting humidity [%] - sensor connected of input 2<br />
INPUTS/2/HUMIDITY<br />
<br />
= Group Events<sup><code>FW 4.0.0+</code></sup> =<br />
Group events are smart way how to keep configuration simple. It is not replacement of publish section specification but it is extension to trigger group of different topics to be published on the same event.<br />
<br />
See the example below. There is specific event on status change on every output and additionally the device sends periodic status every 60 seconds.<br />
<br />
{<br />
"broker": {<br />
"clientid": "netio${DEVICE_SN}",<br />
"keepalive": 30,<br />
"password": "",<br />
"port": 1883,<br />
"protocol": "mqtt",<br />
"ssl": false,<br />
"type": "generic",<br />
"url": "broker.hivemq.com",<br />
"username": ""<br />
},<br />
<b>"groupEvents": [<br />
{<br />
"events":[<br />
{<br />
"period": 60,<br />
"type": "timer"<br />
}<br />
],<br />
"appliedTopics":[<br />
"devices/${DEVICE_NAME}/output/1/state",<br />
"devices/${DEVICE_NAME}/output/2/state"<br />
]<br />
}<br />
],</b><br />
"publish": [<br />
{<br />
"events": [<br />
{<br />
"source": "OUTPUTS/1/STATE",<br />
"type": "change"<br />
}<br />
],<br />
"payload": "${OUTPUTS/1/STATE}",<br />
"qos": 0,<br />
"retain": false,<br />
<b> "topic": "devices/${DEVICE_NAME}/output/1/state"</b><br />
},{<br />
"events": [<br />
{<br />
"source": "OUTPUTS/2/STATE",<br />
"type": "change"<br />
}<br />
],<br />
"payload": "${OUTPUTS/2/STATE}",<br />
"qos": 0,<br />
"retain": false,<br />
<b> "topic": "devices/${DEVICE_NAME}/output/2/state"</b><br />
}<br />
]<br />
}<br />
<br />
= Variables =<br />
In some parameters is nescessary to use variables to get current state and measurements. <b>Variables are separated in two categories:</b><br />
<br />
* Target/Source variables<br />
* Payload Topic variables<br />
<br />
== Target Source Variables ==<br />
<br />
The list of available variables for each <br />
<br />
=== OUTPUTS variables ===<br />
==== VOLTAGE ====<br />
Unit: <code>V</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Present RMS voltage on output 1 is ${OUTPUTS/1/VOLTAGE}"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/VOLTAGE}"</code><br />
<br />
==== CURRENT ====<br />
Unit: <code>mA</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Present RMS current on output 1 is ${OUTPUTS/1/CURRENT}"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/CURRENT}"</code><br />
<br />
==== POWER_FACTOR ====<br />
Unit: <code>[-]</code><br />
<br />
Type: float (2 decimals)<br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"True Power Factor on output 1 is ${OUTPUTS/1/POWER_FACTOR}"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/POWER_FACTOR}"</code><br />
<br />
==== LOAD ====<br />
Unit: <code>W</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Present load on output 1 is ${OUTPUTS/1/LOAD}W"</code><br />
<br />
Example 2: <code>"payload":"Device's load connected to output 1 is ${OUTPUTS/1/LOAD}W"</code><br />
<br />
Example 3: <code>"source":"${OUTPUTS/1/LOAD}"</code><br />
<br />
==== STATE ====<br />
Type: bool(integer) - <code>0</code> or <code>1</code><br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Present output 1 state is ${OUTPUTS/1/STATE}"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/STATE}"</code><br />
<br />
==== ACTION ====<br />
Type: integer<br />
<br />
Possible actions:<br />
* <code>0</code> - set state OFF<br />
* <code>1</code> - set state ON<br />
* <code>2</code> - short OFF (restart)<br />
* <code>3</code> - short ON<br />
* <code>4</code> - toggle (switch)<br />
* <code>5</code> - no change<br />
<br />
Allowed in: <code>"target"</code><br />
<br />
Example: <code>"target":"OUTPUTS/1/ACTION"</code><br />
<br />
==== DELAY [ms] ====<br />
==== NAME ====<br />
==== FREQUENCY ====<br />
Unit: <code>Hz</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example: <code>"payload":"Frequency in power grid is ${OUTPUTS/1/ENERGY}Hz"</code><br />
<br />
==== ENERGY ====<br />
Energy consumed by an device connected to NETIO device output.<br />
<br />
Unit: <code>Wh</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Consumed energy on output 1 is ${OUTPUTS/1/ENERGY}Wh"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/ENERGY}"</code><br />
<br />
==== REVERSE_ENERGY ====<br />
Energy delivered back to grid. For example from solar system connected to NETIO device output.<br />
<br />
Unit: <code>Wh</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Delivered energy on output 1 is ${OUTPUTS/1/REVERSE_ENERGY}Wh"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/REVERSE_ENERGY}"</code><br />
<br />
<br />
==== ENERGY_START ====<br />
Date when the counters ENERGY and REVERSE_ENERGY have been resetted by user.<br />
<br />
Unit: <code>unix timestamp</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code><br />
<br />
Example 1: <code>"payload":"Energy measured since ${OUTPUTS/1/ENERGY_START} unix time"</code><br />
<br />
Example 2: <code>"payload":"${OUTPUTS/1/ENERGY_START}"</code> is output payload <code>1567654639</code><br />
<br />
==== ENERGY_START_FMT ====<br />
Date when the counters ENERGY and REVERSE_ENERGY have been resetted by user.<br />
<br />
Unit: <code>fmt date format</code><br />
<br />
Type: string <br />
<br />
Allowed in: <code>"payload"</code><br />
<br />
Example 1: <code>"payload":"Energy measured since ${OUTPUTS/1/ENERGY_START}"</code><br />
<br />
Example 2: <code>"payload":"${OUTPUTS/1/ENERGY_START_FMT}"</code> is output payload <code>2019-09-05T03:37:19+00:00</code><br />
<br />
==== ENERGY_NR ====<br />
Non-resettable counter of Energy consumed by an device connected to NETIO device output.<br />
<br />
Unit: <code>Wh</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Consumed energy on output 1 is ${OUTPUTS/1/ENERGY_NR}Wh"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/ENERGY_NR}"</code><br />
<br />
==== REVERSE_ENERGY_NR ====<br />
Non-resettable counter of Energy delivered back to grid. For example from solar system connected to NETIO device output.<br />
<br />
Unit: <code>Wh</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Delivered energy on output 1 is ${OUTPUTS/1/REVERSE_ENERGY_NR}Wh"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/REVERSE_ENERGY_NR}"</code><br />
<br />
<br />
<br />
==== TOTALs - for use with devices having more than 1 measured output ====<br />
<br />
* OUTPUTS/TOTAL/ENERGY<br />
* OUTPUTS/TOTAL/LOAD<br />
* OUTPUTS/TOTAL/CURRENT<br />
* OUTPUTS/TOTAL/VOLTAGE<br />
* OUTPUTS/TOTAL/POWER_FACTOR<br />
* OUTPUTS/TOTAL/FREQUENCY<br />
* OUTPUTS/TOTAL/PHASE<br />
* OUTPUTS/TOTAL/REVERSE_ENERGY<br />
* OUTPUTS/TOTAL/ENERGY_NR<br />
* OUTPUTS/TOTAL/REVERSE_ENERGY_NR<br />
* OUTPUTS/TOTAL/ENERGY_START<br />
* OUTPUTS/TOTAL/ENERGY_START_FMT<br />
<br />
<br />
==== REST_JSON ====<br />
Allow use of NETIO JSON structure to control outputs.<br />
<br />
Type: string / JSON<br />
<br />
Allowed in: <code>"target"</code> for Subscribe section<br />
<br />
Example: <code>"target": "REST_JSON"</code><br />
<br />
The payload is JSON structure identical to NETIO JSON API M2M Protocol (documentation available at https://www.netio-products.com/files/NETIO-M2M-API-Protocol-JSON.pdf). You can control one or multiple outputs.<br />
<br />
Payload example 1 - Toggle output 1: <code>{"Outputs":[{"ID": 1,"Action": 4}]}</code><br />
<br />
Payload example 2 - Turn output 1 OFF and output 3 ON: <code>{"Outputs":[{"ID":1,"Action":0},{"ID":3,"Action":1}]}</code><br />
<br />
=== INPUT variables ===<br />
==== STATE ====<br />
Type: bool(integer) - <code>0</code> or <code>1</code><br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Present input 1 state is ${INPUTS/1/STATE}"</code><br />
<br />
Example 2: <code>"source":"${INPUTS/1/STATE}"</code><br />
<br />
==== S0 ====<br />
S0 Counter value<br />
Unit: <code>-</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Input 1 S0 Counter value is ${INPUTS/1/S0}impulses"</code><br />
<br />
Example 2: <code>"source":"${INPUTS/1/S0}"</code><br />
<br />
==== TEMPERATURE ====<br />
Temperature measurement in Celsius, Fahrenheit<br />
*In case of a disconnected sensor or a malfunction, the return value is 999<br />
Unit: <code> [C], [F] </code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Input 1 Temperature value in degree of Celsius is ${INPUTS/1/TEMP} [C] "</code><br />
<br />
Example 2: <code>"source":"${INPUTS/1/TEMP}"</code><br />
<br />
Example 3: <code>"payload":"Input 1 Temperature value in degree of Fahrenheit is ${INPUTS/1/TEMPF} [F] "</code><br />
<br />
Example 4: <code>"source":"${INPUTS/1/TEMPF}"</code><br />
<br />
==== HUMIDITY ====<br />
Relative Humidity measurement <br />
Unit: <code> [%]</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Input 1 Humidity value is ${INPUTS/1/HUMIDITY} %"</code><br />
<br />
Example 2: <code>"source":"${INPUTS/1/HUMIDITY}"</code><br />
<br />
== Payload/topic variables ==<br />
<br />
=== DEVICE_NAME ===<br />
Can be used in: "payload", "topic"<br />
<br />
Example 1: <code>"payload":"${DEVICE_NAME}"</code><br />
<br />
Example 2: <code>"topic":"netio/${DEVICE_NAME}/output/1/action"</code><br />
<br />
=== DEVICE_MAC ===<br />
Can be used in: "payload", "topic"<br />
<br />
Example 1: <code>"payload":"${DEVICE_MAC}"</code><br />
<br />
Example 2: <code>"topic":"netio/${DEVICE_MAC}/output/1/action"</code><br />
<br />
=== UTC_TIME <sup><code>FW 4.0.0+</code></sup>===<br />
<br />
send unix timestamp of devices actual time<br />
<br />
Can be used in: "payload"<br />
<br />
Example 1: <code>"payload": "${UTC_TIME}"</code><br />
<br />
=== UPTIME <sup>Not yet implemented</sup> ===<br />
<br />
=== PAYLOAD ===<br />
Can be used in: "action"<br />
<br />
Example: <code>"action":"${PAYLOAD}"</code><br />
<br />
=== OUTPUT_ID <sup>Not yet implemented</sup>===<br />
<br />
=== WIFI_SIGNAL<sup>Not yet implemented</sup> ===<br />
<br />
=== OUTPUTS_STATUS ===<br />
Provide complete outputs status and measurement if supported.<br />
<br />
Type: string / JSON<br />
<br />
Allowed in: <code>"payload"</code> for Publish section<br />
<br />
Example: <code>"payload":"${OUTPUTS_STATUS}"</code><br />
<br />
Payload example: <code>{ "GlobalMeasure":{"Voltage":236,"TotalCurrent":72,"TotalLoad":11,"TotalEnergy":167,"OverallPowerFactor":0.64,"Frequency":50.07,"Phase":-36.86,"EnergyStart":"2020-06-30T17:04:48+01:00"}, "Outputs":[ {"ID":1,"Name":"Power output 1","State":1,"Action":6,"Delay":2020,"Current":72,"PowerFactor":0.64,"Phase":-36.86,"Energy":139,"ReverseEnergy":0,"Load":11}, {"ID":2,"Name":"Power output 2","State":1,"Action":6,"Delay":2020,"Current":0,"PowerFactor":1.00,"Phase":0.00,"Energy":27,"ReverseEnergy":0,"Load":0}, {"ID":3,"Name":"Free Contact 3","State":1,"Action":6,"Delay":2020}, {"ID":4,"Name":"Free Contact 4","State":1,"Action":6,"Delay":2020} ]}</code><br />
<br />
=== INPUTS_STATUS ===<br />
Provide complete inputs status if supported. Since FW 3.0.0<br />
<br />
Type: string / JSON<br />
<br />
Allowed in: <code>"payload"</code> for Publish section<br />
<br />
Example: <code>"payload":"${INPUTS_STATUS}"</code><br />
<br />
Payload example: <code>{ "Inputs":[ {"ID":1,"Name":"Input 1","State":0,"S0Counter":0}, {"ID":2,"Name":"Input 2","State":0,"S0Counter":0} ]}</code><br />
<br />
=== INOUT_STATUS ===<br />
Provide complete inputs and output status and measurement if supported. Since FW 3.0.0<br />
<br />
Type: string / JSON<br />
<br />
Allowed in: <code>"payload"</code> for Publish section<br />
<br />
Example: <code>"payload":"${INOUT_STATUS}"</code><br />
<br />
Payload example: <code>{ "GlobalMeasure":{"Voltage":238,"TotalCurrent":105,"TotalLoad":17,"TotalEnergy":1451,"OverallPowerFactor":0.67,"Frequency":50.03,"Phase":-33.67,"EnergyStart":"2020-06-30T17:04:48+01:00"}, "Outputs":[ {"ID":1,"Name":"Power output 1","State":0,"Action":6,"Delay":5000,"Current":0,"PowerFactor":1.00,"Phase":0.00,"Energy":701,"ReverseEnergy":0,"Load":0}, {"ID":2,"Name":"Power output 2","State":1,"Action":6,"Delay":5000,"Current":105,"PowerFactor":0.65,"Phase":-33.67,"Energy":750,"ReverseEnergy":0,"Load":17}, {"ID":3,"Name":"Free Contact 3","State":1,"Action":6,"Delay":5000}, {"ID":4,"Name":"Free Contact 4","State":0,"Action":6,"Delay":5000} ], "Inputs":[ {"ID":1,"Name":"Input 1","State":0,"S0Counter":0}, {"ID":2,"Name":"Input 2","State":0,"S0Counter":0} ]}</code><br />
<br />
= Extended MQTT flex JSON config examples =<br />
<br />
== Default NETIO MQTT-flex configuration ==<br />
This example demonstrates setup for connection to public <code>broker.hivemq.com</code>, measurement reporting and output control.<br />
<br />
The device cabe be controlled via <code>netio/${DEVICE_NAME}/output/1/action topic</code> by sending standard NETIO action values:<br />
* 0 - OFF<br />
* 1 - ON<br />
* 2 - SHORT OFF<br />
* 3 - SHORT ON<br />
* 4 - TOGGLE<br />
* 5 - NO ACTION.<br />
<br />
The device report measurements:<br />
<br />
* Output state - every 15 minutes or by change<br />
* Voltage [V]- every 5 minutes or by change of 1 V<br />
* Current [mA]- every 5 minutes or by change of 50 mA<br />
* Load(Power) [W]- every 5 minutes or by change of 10 W<br />
* Energy(Consumption) [Wh]- every 15 minutes or by change of 1Wh<br />
* True Power Factor (TPF) [-]- every 5 minutes or by change of 0.02<br />
* Frequency [Hz]- every 1 hour or by change of 0.1 Hz<br />
<br />
For register all values, you can use wildcard <code>netio/${DEVICE_NAME}/output/1/#</code><br />
<br />
{<br />
"config":{<br />
"broker":{<br />
"url":"broker.hivemq.com",<br />
"protocol":"mqtt",<br />
"port":1883,<br />
"ssl":false,<br />
"type":"generic",<br />
"username":"",<br />
"password":"",<br />
"clientid":"moje${DEVICE_NAME}${DEVICE_MAC}",<br />
"keepalive":30<br />
},<br />
"subscribe":[<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/action",<br />
"qos":0,<br />
"target":"OUTPUTS/1/ACTION",<br />
"action":"${payload}"<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/switch",<br />
"qos":0,<br />
"target":"OUTPUTS/1/ACTION",<br />
"action":4<br />
}<br />
],<br />
"publish":[<br />
{<br />
"topic":"netio/${DEVICE_MAC}/output/1/state",<br />
"qos":0,<br />
"retain":true,<br />
"payload":"${OUTPUTS/1/STATE}",<br />
"events":[<br />
{<br />
"type":"change",<br />
"source":"OUTPUTS/1/STATE"<br />
},<br />
{<br />
"type":"timer",<br />
"period":900<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/voltage",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/VOLTAGE}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":300<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/VOLTAGE",<br />
"delta":1<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/current",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/CURRENT}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":300<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/CURRENT",<br />
"delta":50<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/load",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/LOAD}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":300<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/LOAD",<br />
"delta":10<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/energy",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/ENERGY}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":900<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/ENERGY",<br />
"delta":1<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/tpf",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/POWER_FACTOR}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":900<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/POWER_FACTOR",<br />
"delta":0.02<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/frequency",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/FREQUENCY}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":3600<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/FREQUENCY",<br />
"delta":0.1<br />
}<br />
]<br />
}<br />
]<br />
}<br />
}</div>
Tbezstarosta
https://wiki.netio-products.com/index.php?title=MQTT-flex&diff=1088
MQTT-flex
2026-03-17T15:06:03Z
<p>Tbezstarosta: /* TEMPERATURE */</p>
<hr />
<div>The MQTT-flex version of the MQTT protocol can be configured in detail thanks to the “flex” extension.<br />
<br />
https://www.netio-products.com/en/glossary/mqtt-flex <br />
<br />
<b>Why MQTT-flex</b> <br><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.<br />
<br />
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.<br />
<br />
===Supported devices:===<br />
* PowerCable MQTT 101x <br><br />
* PowerCable REST 101x <br><br />
* PowerPDU 4PS <br><br />
* PowerPDU 4KS <br><br />
* PowerPDU 8QS <br><br />
* PowerDIN 4PZ <br><br />
* PowerBOX 3Px <br><br />
* PowerBOX 4Kx <br><br />
<br />
<b>FW version:</b> <br><br />
>2.2.1<br />
<br />
===Not supported NETIO devices:===<br />
* PowerPDU 4C <br><br />
* NETIO 4 <br><br />
* NETIO 4All <br><br />
<br />
= Simple MQTT-flex configuration + explanation =<br />
<br />
''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.''<br />
<br />
{<br />
"config":{<br />
"broker":{<br />
"url":"broker.hivemq.com",<br />
"protocol":"mqtt",<br />
"port":1883,<br />
"ssl":false,<br />
"type":"generic",<br />
"username":"freedom",<br />
"password":"peace|LOVE|empathy4ALL"<br />
},<br />
"subscribe":[{<br />
"topic":"netio/${DEVICE_NAME}/output/1/action",<br />
"qos":0,<br />
"target":"OUTPUTS/1/ACTION",<br />
"action":"${payload}"<br />
}<br />
],<br />
"publish":[{<br />
"topic":"netio/${DEVICE_NAME}/output/1/state",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/STATE}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":"1000"<br />
}<br />
]<br />
}<br />
]<br />
}<br />
}<br />
=== Client Configuration (broker section) ===<br />
Put here MQTT client connection setup<br />
<br />
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>. <br />
<br />
"broker":{<br />
"url":"broker.hivemq.com",<br />
"protocol":"mqtt",<br />
"port":1883,<br />
"ssl":false,<br />
"type":"generic",<br />
"username":"freedom",<br />
"password":"peace|LOVE|empathy4ALL"<br />
},<br />
<br />
=== Device Control (subscribe section) ===<br />
Put here array of topics where to subscribe<br />
<br />
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> <br />
<br />
"subscribe":[{<br />
"topic":"netio/${DEVICE_NAME}/output/1/action",<br />
"qos":0,<br />
"target":"OUTPUTS/1/ACTION",<br />
"action":"${payload}"<br />
}<br />
],<br />
<br />
=== Output State monitoring (publish section) ===<br />
Put here array of topics where to publish.<br />
<br />
Device send every <b>1000 s</b> message to topic <b></b> with <b>QOS 0</b>, <b>retain true</b> information with <b>output 1 state</b><br />
<br />
"publish":[{<br />
"topic":"netio/${DEVICE_NAME}/output/1/state",<br />
"qos":0,<br />
"retain":true,<br />
"payload":"${OUTPUTS/1/STATE}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":"1000"<br />
}<br />
]<br />
}<br />
]<br />
<br />
= Config sections =<br />
<br />
== Broker ==<br />
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 />
<br /><br />
=== Attributes table overview ===<br />
{| class="wikitable"<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Item<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Presence<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Possible Values<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Description<br />
! style="font-weight:bold; background-color:#9b9b9b;" | JSON Config Usage<br />
|-<br />
| style="background-color:#efefef;" | url<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | MQTT broker URL<br />
| style="background-color:#efefef;" | "url":"broker.hivemq.com"<br />
|-<br />
| style="background-color:#efefef;" | port<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | 1 - 65535<br />
| style="background-color:#efefef;" | MQTT broker port<br />
| style="background-color:#efefef;" | "port":1883<br />
|-<br />
| style="background-color:#efefef;" | protocol<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | protocol spec - mqtt<br />
| style="background-color:#efefef;" | "protocol": "mqtt"<br />
|-<br />
| style="background-color:#efefef;" | ssl<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | true, false<br />
| style="background-color:#efefef;" | Use SSL crypted communication selector<br />
| style="background-color:#efefef;" | "ssl":false<br />
|-<br />
| style="background-color:#efefef;" | type<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | generic<br />
| style="background-color:#efefef;" | Communication/setup type option<br />
| style="background-color:#efefef;" | "type":"generic"<br />
|-<br />
| style="background-color:#efefef;" | username<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | regexp+len<br />
| style="background-color:#efefef;" | Credentials for MQTT broker. Max. 128 characters (since FW 3.2.4).<br />
| style="background-color:#efefef;" | "username":"freedom"<br />
|-<br />
| style="background-color:#efefef;" | password<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | regexp+len<br />
| style="background-color:#efefef;" | Credentials for MQTT broker. Max. 256 characters (since FW 3.2.4).<br />
| style="background-color:#efefef;" | "password":"peace|LOVE|empathy4ALL"<br />
|-<br />
| style="background-color:#efefef;" | clientid<br />
| style="background-color:#efefef;" | optional<br />
| style="background-color:#efefef;" | regexp+len<br />
| style="background-color:#efefef;" | MQTT clientid. Max. 128 characters (since FW 3.2.4). Variables ${DEVICE_MAC} or ${DEVICE_NAME} can be used<br />
| style="background-color:#efefef;" | "clientid":"myEcoTable01"<br />
|-<br />
| style="background-color:#efefef;" | keepalive<br />
| style="background-color:#efefef;" | optional<br />
| style="background-color:#efefef;" | 1 - 65535<br />
| style="background-color:#efefef;" | MQTT keep alive period in seconds<br />
| style="background-color:#efefef;" | "keepalive":90<br />
|}<br />
<br />
Note 1: <b>clientid</b> attribute is <b>mandatory for MQTT(s)</b> communication. When not configured, random ID will be generated.<br />
<br />
Note 2: To proper communication with MS Azure - it is necessary to set up IoT Hub to use TLS 1.2<br />
<br />
See section "TLS 1.2 enforcement available in select regions" in following guidelines https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-tls-support<br />
<br />
=== Examples ===<br />
==== Standard setup ====<br />
<br />
<br />
==== Security (SSL / TLS) secured setup ====<br />
You can enable MQTTs by using the encrypted port <b>8883</b> + <b>"ssl":true</b>.<br />
<br />
==== Variables used setup ====<br />
<br />
== Subscribe ==<br />
=== Hints to usage ===<br />
When receive message in <b><i>topic</b></i> do <b><i>action</b></i> on <b><i>target</b></i>.<br />
<br />
<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>.<br />
<br />
=== Attributes table overview ===<br />
{| class="wikitable"<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Item<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Presence<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Possible Values<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Description<br />
! style="font-weight:bold; background-color:#9b9b9b;" | JSON Config Usage<br />
|-<br />
| style="background-color:#efefef;" | topic<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | see table below<br />
| style="background-color:#efefef;" | specification of the topic, which MQTT-flex device listens from broker and act accordingly. Max. 128 characters. The "#" can be used since FW 3.2.4 - see note under this table.<br />
| style="background-color:#efefef;" | "topic":"netio/${DEVICE_NAME}/output/1/action"<br />
|-<br />
| style="background-color:#efefef;" | qos<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | 0, 1 or 2<br />
| 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}<br />
| style="background-color:#efefef;" | "qos":0<br />
|-<br />
| style="background-color:#efefef;" | target<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | internal definition of action, which can be performed above the specified output<br />
| style="background-color:#efefef;" | "target":"OUTPUTS/1/ACTION"<br />
|-<br />
| style="background-color:#efefef;" | action<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | a payload or a value the action attribute needs to have passed to<br />
| style="background-color:#efefef;" | "action":"${payload}"<br />
|-<br />
| style="background-color:#efefef;" | actiondef<sup>Not supported yet</sup><br />
| style="background-color:#efefef;" | optional<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
|-<br />
| style="background-color:#efefef;" | json<sup>Not supported yet</sup><br />
| style="background-color:#efefef;" | optional<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
|}<br />
<br />
Note: The "#" wildcard can be used in subscribe topic definition. The multi-level wildcard character MUST be specified either on its own or following a topic level separator. In either case it MUST be the last character specified in the Topic.<br />
<br />
For example, if a Device subscribes to “devices/{device_id}/messages/devicebound/#”, it would receive messages published using these topic names:<br />
<br />
“devices/{device_id}/messages/devicebound/”<br />
<br />
“devices/{device_id}/messages/devicebound/{property_bag}”<br />
<br />
This should be usefull for use with MS Azure - IoT hub.<br />
<br />
=== MQTT Subscribe as event to trigger action <sup><code>FW 4.0.0+</code></sup> ===<br />
<br />
This feature allow to subscribe to specific MQTT topic and pass payload to Rules or MQTT-flex as event.<br />
<br />
target: <code>PROTOCOLS/MQTT/EVENT</code><br />
<br />
"subscribe": [<br />
{<br />
"action": "${payload}",<br />
"qos": 0,<br />
"target": "PROTOCOLS/MQTT/EVENT",<br />
"topic": "broker/12345/MQTT_EVENT/"<br />
}<br />
]<br />
<br />
=== Examples ===<br />
==== Toggle output with standard payload ==== <br />
==== Toggle output with custom payload ==== <br />
==== Subscribe to more than one topic ====<br />
==== Trigger Rule and MQTT publish from MQTT subscribe <sup><code>FW 4.0.0+</code></sup> ====<br />
This example show Request response implementation in MQTT and toggle action made by Rules.<br />
<br />
When message with payload <code>getValues</code> is published to topic <code>broker/gv90018g/COMMAND</code> MQTT flex will create an event with name <code>PROTOCOLS/MQTT/EVENT</code> (fixed name cannot be changed) and value <code>getValues</code>. On this event will act all events and conditions set in MQTT-flex and Rules which are set to listening to change on <code>PROTOCOLS/MQTT/EVENT</code> and equals to value <code>getValues</code>. See <b>bold</b> marked parameters in example configuration below. <br />
<br />
Once the triggered action is done it is needed to reset MQTT channel to <code>OK</code> status becaus event are reacting only to change. If the channel is not reset the next even would not be triggered.<br />
<br />
<b>Rules Configuration:</b><br />
{<br />
"conditions": {<br />
<b>"PROTOCOLS/MQTT/EVENT": "getValues"</b><br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 4<br />
}<br />
}<br />
<br />
<b>MQTT Configuration:</b><br />
{<br />
"broker":{<br />
"clientid":"netio${DEVICE_SN}",<br />
"keepalive":30,<br />
"password":"abcdefghijk",<br />
"port":8883,<br />
"protocol":"mqtt",<br />
"ssl":true,<br />
"type":"generic",<br />
"url":"broker.cloud.netio.eu",<br />
"username":"gv90018g"<br />
},<br />
"groupEvents":[<br />
{<br />
"events":[<br />
{<br />
<b>"source":"PROTOCOLS/MQTT/EVENT",<br />
"type":"change",<br />
"value":"getValues"</b><br />
}<br />
],<br />
"appliedTopics":[<br />
"broker/gv90018g/OUTPUTS/1/STATE",<br />
<b>"broker/gv90018g/COMMAND"</b><br />
]<br />
}<br />
],<br />
"publish":[<br />
{<br />
"payload":"${OUTPUTS/1/STATE}",<br />
"qos":0,<br />
"retain":true,<br />
"topic":"broker/gv90018g/OUTPUTS/1/STATE"<br />
},<br />
{<br />
"payload":"OK",<br />
"qos":0,<br />
"retain":true,<br />
"topic":"broker/gv90018g/COMMAND"<br />
}<br />
],<br />
"subscribe":[<br />
{<br />
"action":"${payload}",<br />
"qos":0,<br />
<b>"target":"PROTOCOLS/MQTT/EVENT"</b>,<br />
"topic":"broker/gv90018g/COMMAND"<br />
}<br />
]<br />
}<br />
<br />
<br />
<br />
Subscribe topic payload values specification for control of the output:<br />
<br />
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)<br />
<br />
== Publish ==<br />
<br />
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)<br />
<br />
=== Hints to usage ===<br />
When <b><i>event</b></i> send message with <b><i>payload</b></i> to <b><i>topic</b></i>.<br />
<br />
=== Attributes table overview ===<br />
{| class="wikitable"<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Item<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Presence<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Possible Values<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Description<br />
! style="font-weight:bold; background-color:#9b9b9b;" | JSON Config Usage<br />
|-<br />
| style="background-color:#efefef;" | topic<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | see table below<br />
| style="background-color:#efefef;" | definition of the topic, how it is registered towards MQTT broker. Max. 128 characters. <br />
| style="background-color:#efefef;" | "topic":"netio/${DEVICE_NAME}/output/1/load"<br />
|-<br />
| style="background-color:#efefef;" | qos<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | see table below<br />
| 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}<br />
| style="background-color:#efefef;" | <br />
|-<br />
| style="background-color:#efefef;" | retain<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | boolean: true or false<br />
| 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}<br />
| style="background-color:#efefef;" | "retain":true<br />
|-<br />
| style="background-color:#efefef;" | payload<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | see table below<br />
| style="background-color:#efefef;" | definition of the payload, what is send to the MQTT broker.<br />
| style="background-color:#efefef;" | "payload":"${OUTPUTS/1/STATE}"<br />
|-<br />
| style="background-color:#efefef;" | events<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | see table below<br />
| style="background-color:#efefef;" | definition of events used for triggering sending of data via mqtt (change, delta, timer)<br />
| style="background-color:#efefef;" | <br />
|-<br />
| style="background-color:#efefef;" | type<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" |<br />
|-<br />
| style="background-color:#efefef;" | source<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" |<br />
|-<br />
| style="background-color:#efefef;" | delta<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" |<br />
|-<br />
| style="background-color:#efefef;" | period<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" |<br />
| style="background-color:#efefef;" |<br />
|-<br />
| style="background-color:#efefef;" | payloaddef<sup>Not supported yet</sup><br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" |<br />
|}<br />
<br />
=== Examples ===<br />
==== Publish energy periodically (event timer) ==== <br />
==== Publish current on change (delta) ==== <br />
==== Publish output state ====<br />
==== Publish to more than one topic with different events ====<br />
<br />
= Target / Source =<br />
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.<br />
<br />
* <b>source</b> - specifies from where the value will be read (specifies the source of data for payload, change detection, delta calculation)<br />
* <b>target</b> - specifies where the data should be sent or command applied (e.g. specifies the target for ACTION)<br />
<br />
=== INPUT / OUTPUT (Target) selection ===<br />
<br />
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.<br />
<br />
# At first specify if requested variable is from/for INPUT or OUTPUT using keywords <b>"OUTPUTS"</b> or <b>"INPUTS"</b> .<br />
# Add <b>"/"</b> separator<br />
# Specify the number of INPUT/OUTPUT to <b>1</b>(or TOTAL for summary statistics if available)<br />
# Add <b>"/"</b> separator<br />
# Specify requested variable or command<br />
<br />
<b>Note:</b> Not all of OUTPUTS/INPUTS support all variables. Available variables are closely connected with the device functions and I/O features.<br />
<br />
<b>Note2:</b> INPUTS available only on NETIO PowerDIN 4PZ<br />
<br />
=== Examples: ===<br />
<br />
adressing controll of output 3<br />
OUTPUTS/3/ACTION<br />
getting voltage on output 1<br />
OUTPUTS/1/VOLTAGE<br />
getting state of input 1<br />
INPUTS/1/STATE<br />
getting temperature [C] - sensor connected of input 1<br />
INPUTS/1/TEMP<br />
getting temperature [F] - sensor connected of input 2<br />
INPUTS/2/TEMPF<br />
getting humidity [%] - sensor connected of input 2<br />
INPUTS/2/HUMIDITY<br />
<br />
= Group Events<sup><code>FW 4.0.0+</code></sup> =<br />
Group events are smart way how to keep configuration simple. It is not replacement of publish section specification but it is extension to trigger group of different topics to be published on the same event.<br />
<br />
See the example below. There is specific event on status change on every output and additionally the device sends periodic status every 60 seconds.<br />
<br />
{<br />
"broker": {<br />
"clientid": "netio${DEVICE_SN}",<br />
"keepalive": 30,<br />
"password": "",<br />
"port": 1883,<br />
"protocol": "mqtt",<br />
"ssl": false,<br />
"type": "generic",<br />
"url": "broker.hivemq.com",<br />
"username": ""<br />
},<br />
<b>"groupEvents": [<br />
{<br />
"events":[<br />
{<br />
"period": 60,<br />
"type": "timer"<br />
}<br />
],<br />
"appliedTopics":[<br />
"devices/${DEVICE_NAME}/output/1/state",<br />
"devices/${DEVICE_NAME}/output/2/state"<br />
]<br />
}<br />
],</b><br />
"publish": [<br />
{<br />
"events": [<br />
{<br />
"source": "OUTPUTS/1/STATE",<br />
"type": "change"<br />
}<br />
],<br />
"payload": "${OUTPUTS/1/STATE}",<br />
"qos": 0,<br />
"retain": false,<br />
<b> "topic": "devices/${DEVICE_NAME}/output/1/state"</b><br />
},{<br />
"events": [<br />
{<br />
"source": "OUTPUTS/2/STATE",<br />
"type": "change"<br />
}<br />
],<br />
"payload": "${OUTPUTS/2/STATE}",<br />
"qos": 0,<br />
"retain": false,<br />
<b> "topic": "devices/${DEVICE_NAME}/output/2/state"</b><br />
}<br />
]<br />
}<br />
<br />
= Variables =<br />
In some parameters is nescessary to use variables to get current state and measurements. <b>Variables are separated in two categories:</b><br />
<br />
* Target/Source variables<br />
* Payload Topic variables<br />
<br />
== Target Source Variables ==<br />
<br />
The list of available variables for each <br />
<br />
=== OUTPUTS variables ===<br />
==== VOLTAGE ====<br />
Unit: <code>V</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Present RMS voltage on output 1 is ${OUTPUTS/1/VOLTAGE}"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/VOLTAGE}"</code><br />
<br />
==== CURRENT ====<br />
Unit: <code>mA</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Present RMS current on output 1 is ${OUTPUTS/1/CURRENT}"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/CURRENT}"</code><br />
<br />
==== POWER_FACTOR ====<br />
Unit: <code>[-]</code><br />
<br />
Type: float (2 decimals)<br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"True Power Factor on output 1 is ${OUTPUTS/1/POWER_FACTOR}"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/POWER_FACTOR}"</code><br />
<br />
==== LOAD ====<br />
Unit: <code>W</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Present load on output 1 is ${OUTPUTS/1/LOAD}W"</code><br />
<br />
Example 2: <code>"payload":"Device's load connected to output 1 is ${OUTPUTS/1/LOAD}W"</code><br />
<br />
Example 3: <code>"source":"${OUTPUTS/1/LOAD}"</code><br />
<br />
==== STATE ====<br />
Type: bool(integer) - <code>0</code> or <code>1</code><br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Present output 1 state is ${OUTPUTS/1/STATE}"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/STATE}"</code><br />
<br />
==== ACTION ====<br />
Type: integer<br />
<br />
Possible actions:<br />
* <code>0</code> - set state OFF<br />
* <code>1</code> - set state ON<br />
* <code>2</code> - short OFF (restart)<br />
* <code>3</code> - short ON<br />
* <code>4</code> - toggle (switch)<br />
* <code>5</code> - no change<br />
<br />
Allowed in: <code>"target"</code><br />
<br />
Example: <code>"target":"OUTPUTS/1/ACTION"</code><br />
<br />
==== DELAY [ms] ====<br />
==== NAME ====<br />
==== FREQUENCY ====<br />
Unit: <code>Hz</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example: <code>"payload":"Frequency in power grid is ${OUTPUTS/1/ENERGY}Hz"</code><br />
<br />
==== ENERGY ====<br />
Energy consumed by an device connected to NETIO device output.<br />
<br />
Unit: <code>Wh</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Consumed energy on output 1 is ${OUTPUTS/1/ENERGY}Wh"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/ENERGY}"</code><br />
<br />
==== REVERSE_ENERGY ====<br />
Energy delivered back to grid. For example from solar system connected to NETIO device output.<br />
<br />
Unit: <code>Wh</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Delivered energy on output 1 is ${OUTPUTS/1/REVERSE_ENERGY}Wh"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/REVERSE_ENERGY}"</code><br />
<br />
<br />
==== ENERGY_START ====<br />
Date when the counters ENERGY and REVERSE_ENERGY have been resetted by user.<br />
<br />
Unit: <code>unix timestamp</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code><br />
<br />
Example 1: <code>"payload":"Energy measured since ${OUTPUTS/1/ENERGY_START} unix time"</code><br />
<br />
Example 2: <code>"payload":"${OUTPUTS/1/ENERGY_START}"</code> is output payload <code>1567654639</code><br />
<br />
==== ENERGY_START_FMT ====<br />
Date when the counters ENERGY and REVERSE_ENERGY have been resetted by user.<br />
<br />
Unit: <code>fmt date format</code><br />
<br />
Type: string <br />
<br />
Allowed in: <code>"payload"</code><br />
<br />
Example 1: <code>"payload":"Energy measured since ${OUTPUTS/1/ENERGY_START}"</code><br />
<br />
Example 2: <code>"payload":"${OUTPUTS/1/ENERGY_START_FMT}"</code> is output payload <code>2019-09-05T03:37:19+00:00</code><br />
<br />
==== ENERGY_NR ====<br />
Non-resettable counter of Energy consumed by an device connected to NETIO device output.<br />
<br />
Unit: <code>Wh</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Consumed energy on output 1 is ${OUTPUTS/1/ENERGY_NR}Wh"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/ENERGY_NR}"</code><br />
<br />
==== REVERSE_ENERGY_NR ====<br />
Non-resettable counter of Energy delivered back to grid. For example from solar system connected to NETIO device output.<br />
<br />
Unit: <code>Wh</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Delivered energy on output 1 is ${OUTPUTS/1/REVERSE_ENERGY_NR}Wh"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/REVERSE_ENERGY_NR}"</code><br />
<br />
<br />
<br />
==== TOTALs - for use with devices having more than 1 measured output ====<br />
<br />
* OUTPUTS/TOTAL/ENERGY<br />
* OUTPUTS/TOTAL/LOAD<br />
* OUTPUTS/TOTAL/CURRENT<br />
* OUTPUTS/TOTAL/VOLTAGE<br />
* OUTPUTS/TOTAL/POWER_FACTOR<br />
* OUTPUTS/TOTAL/FREQUENCY<br />
* OUTPUTS/TOTAL/PHASE<br />
* OUTPUTS/TOTAL/REVERSE_ENERGY<br />
* OUTPUTS/TOTAL/ENERGY_NR<br />
* OUTPUTS/TOTAL/REVERSE_ENERGY_NR<br />
* OUTPUTS/TOTAL/ENERGY_START<br />
* OUTPUTS/TOTAL/ENERGY_START_FMT<br />
<br />
<br />
==== REST_JSON ====<br />
Allow use of NETIO JSON structure to control outputs.<br />
<br />
Type: string / JSON<br />
<br />
Allowed in: <code>"target"</code> for Subscribe section<br />
<br />
Example: <code>"target": "REST_JSON"</code><br />
<br />
The payload is JSON structure identical to NETIO JSON API M2M Protocol (documentation available at https://www.netio-products.com/files/NETIO-M2M-API-Protocol-JSON.pdf). You can control one or multiple outputs.<br />
<br />
Payload example 1 - Toggle output 1: <code>{"Outputs":[{"ID": 1,"Action": 4}]}</code><br />
<br />
Payload example 2 - Turn output 1 OFF and output 3 ON: <code>{"Outputs":[{"ID":1,"Action":0},{"ID":3,"Action":1}]}</code><br />
<br />
=== INPUT variables ===<br />
==== STATE ====<br />
Type: bool(integer) - <code>0</code> or <code>1</code><br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Present input 1 state is ${INPUTS/1/STATE}"</code><br />
<br />
Example 2: <code>"source":"${INPUTS/1/STATE}"</code><br />
<br />
==== S0 ====<br />
S0 Counter value<br />
Unit: <code>-</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Input 1 S0 Counter value is ${INPUTS/1/S0}impulses"</code><br />
<br />
Example 2: <code>"source":"${INPUTS/1/S0}"</code><br />
<br />
==== TEMPERATURE ====<br />
Temperature measurement in Celsius, Fahrenheit<br />
In case of a disconnected sensor or a malfunction, the return value is 999<br />
Unit: <code> [C], [F] </code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Input 1 Temperature value in degree of Celsius is ${INPUTS/1/TEMP} [C] "</code><br />
<br />
Example 2: <code>"source":"${INPUTS/1/TEMP}"</code><br />
<br />
Example 3: <code>"payload":"Input 1 Temperature value in degree of Fahrenheit is ${INPUTS/1/TEMPF} [F] "</code><br />
<br />
Example 4: <code>"source":"${INPUTS/1/TEMPF}"</code><br />
<br />
==== HUMIDITY ====<br />
Relative Humidity measurement <br />
Unit: <code> [%]</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Input 1 Humidity value is ${INPUTS/1/HUMIDITY} %"</code><br />
<br />
Example 2: <code>"source":"${INPUTS/1/HUMIDITY}"</code><br />
<br />
== Payload/topic variables ==<br />
<br />
=== DEVICE_NAME ===<br />
Can be used in: "payload", "topic"<br />
<br />
Example 1: <code>"payload":"${DEVICE_NAME}"</code><br />
<br />
Example 2: <code>"topic":"netio/${DEVICE_NAME}/output/1/action"</code><br />
<br />
=== DEVICE_MAC ===<br />
Can be used in: "payload", "topic"<br />
<br />
Example 1: <code>"payload":"${DEVICE_MAC}"</code><br />
<br />
Example 2: <code>"topic":"netio/${DEVICE_MAC}/output/1/action"</code><br />
<br />
=== UTC_TIME <sup><code>FW 4.0.0+</code></sup>===<br />
<br />
send unix timestamp of devices actual time<br />
<br />
Can be used in: "payload"<br />
<br />
Example 1: <code>"payload": "${UTC_TIME}"</code><br />
<br />
=== UPTIME <sup>Not yet implemented</sup> ===<br />
<br />
=== PAYLOAD ===<br />
Can be used in: "action"<br />
<br />
Example: <code>"action":"${PAYLOAD}"</code><br />
<br />
=== OUTPUT_ID <sup>Not yet implemented</sup>===<br />
<br />
=== WIFI_SIGNAL<sup>Not yet implemented</sup> ===<br />
<br />
=== OUTPUTS_STATUS ===<br />
Provide complete outputs status and measurement if supported.<br />
<br />
Type: string / JSON<br />
<br />
Allowed in: <code>"payload"</code> for Publish section<br />
<br />
Example: <code>"payload":"${OUTPUTS_STATUS}"</code><br />
<br />
Payload example: <code>{ "GlobalMeasure":{"Voltage":236,"TotalCurrent":72,"TotalLoad":11,"TotalEnergy":167,"OverallPowerFactor":0.64,"Frequency":50.07,"Phase":-36.86,"EnergyStart":"2020-06-30T17:04:48+01:00"}, "Outputs":[ {"ID":1,"Name":"Power output 1","State":1,"Action":6,"Delay":2020,"Current":72,"PowerFactor":0.64,"Phase":-36.86,"Energy":139,"ReverseEnergy":0,"Load":11}, {"ID":2,"Name":"Power output 2","State":1,"Action":6,"Delay":2020,"Current":0,"PowerFactor":1.00,"Phase":0.00,"Energy":27,"ReverseEnergy":0,"Load":0}, {"ID":3,"Name":"Free Contact 3","State":1,"Action":6,"Delay":2020}, {"ID":4,"Name":"Free Contact 4","State":1,"Action":6,"Delay":2020} ]}</code><br />
<br />
=== INPUTS_STATUS ===<br />
Provide complete inputs status if supported. Since FW 3.0.0<br />
<br />
Type: string / JSON<br />
<br />
Allowed in: <code>"payload"</code> for Publish section<br />
<br />
Example: <code>"payload":"${INPUTS_STATUS}"</code><br />
<br />
Payload example: <code>{ "Inputs":[ {"ID":1,"Name":"Input 1","State":0,"S0Counter":0}, {"ID":2,"Name":"Input 2","State":0,"S0Counter":0} ]}</code><br />
<br />
=== INOUT_STATUS ===<br />
Provide complete inputs and output status and measurement if supported. Since FW 3.0.0<br />
<br />
Type: string / JSON<br />
<br />
Allowed in: <code>"payload"</code> for Publish section<br />
<br />
Example: <code>"payload":"${INOUT_STATUS}"</code><br />
<br />
Payload example: <code>{ "GlobalMeasure":{"Voltage":238,"TotalCurrent":105,"TotalLoad":17,"TotalEnergy":1451,"OverallPowerFactor":0.67,"Frequency":50.03,"Phase":-33.67,"EnergyStart":"2020-06-30T17:04:48+01:00"}, "Outputs":[ {"ID":1,"Name":"Power output 1","State":0,"Action":6,"Delay":5000,"Current":0,"PowerFactor":1.00,"Phase":0.00,"Energy":701,"ReverseEnergy":0,"Load":0}, {"ID":2,"Name":"Power output 2","State":1,"Action":6,"Delay":5000,"Current":105,"PowerFactor":0.65,"Phase":-33.67,"Energy":750,"ReverseEnergy":0,"Load":17}, {"ID":3,"Name":"Free Contact 3","State":1,"Action":6,"Delay":5000}, {"ID":4,"Name":"Free Contact 4","State":0,"Action":6,"Delay":5000} ], "Inputs":[ {"ID":1,"Name":"Input 1","State":0,"S0Counter":0}, {"ID":2,"Name":"Input 2","State":0,"S0Counter":0} ]}</code><br />
<br />
= Extended MQTT flex JSON config examples =<br />
<br />
== Default NETIO MQTT-flex configuration ==<br />
This example demonstrates setup for connection to public <code>broker.hivemq.com</code>, measurement reporting and output control.<br />
<br />
The device cabe be controlled via <code>netio/${DEVICE_NAME}/output/1/action topic</code> by sending standard NETIO action values:<br />
* 0 - OFF<br />
* 1 - ON<br />
* 2 - SHORT OFF<br />
* 3 - SHORT ON<br />
* 4 - TOGGLE<br />
* 5 - NO ACTION.<br />
<br />
The device report measurements:<br />
<br />
* Output state - every 15 minutes or by change<br />
* Voltage [V]- every 5 minutes or by change of 1 V<br />
* Current [mA]- every 5 minutes or by change of 50 mA<br />
* Load(Power) [W]- every 5 minutes or by change of 10 W<br />
* Energy(Consumption) [Wh]- every 15 minutes or by change of 1Wh<br />
* True Power Factor (TPF) [-]- every 5 minutes or by change of 0.02<br />
* Frequency [Hz]- every 1 hour or by change of 0.1 Hz<br />
<br />
For register all values, you can use wildcard <code>netio/${DEVICE_NAME}/output/1/#</code><br />
<br />
{<br />
"config":{<br />
"broker":{<br />
"url":"broker.hivemq.com",<br />
"protocol":"mqtt",<br />
"port":1883,<br />
"ssl":false,<br />
"type":"generic",<br />
"username":"",<br />
"password":"",<br />
"clientid":"moje${DEVICE_NAME}${DEVICE_MAC}",<br />
"keepalive":30<br />
},<br />
"subscribe":[<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/action",<br />
"qos":0,<br />
"target":"OUTPUTS/1/ACTION",<br />
"action":"${payload}"<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/switch",<br />
"qos":0,<br />
"target":"OUTPUTS/1/ACTION",<br />
"action":4<br />
}<br />
],<br />
"publish":[<br />
{<br />
"topic":"netio/${DEVICE_MAC}/output/1/state",<br />
"qos":0,<br />
"retain":true,<br />
"payload":"${OUTPUTS/1/STATE}",<br />
"events":[<br />
{<br />
"type":"change",<br />
"source":"OUTPUTS/1/STATE"<br />
},<br />
{<br />
"type":"timer",<br />
"period":900<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/voltage",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/VOLTAGE}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":300<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/VOLTAGE",<br />
"delta":1<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/current",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/CURRENT}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":300<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/CURRENT",<br />
"delta":50<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/load",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/LOAD}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":300<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/LOAD",<br />
"delta":10<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/energy",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/ENERGY}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":900<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/ENERGY",<br />
"delta":1<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/tpf",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/POWER_FACTOR}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":900<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/POWER_FACTOR",<br />
"delta":0.02<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/frequency",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/FREQUENCY}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":3600<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/FREQUENCY",<br />
"delta":0.1<br />
}<br />
]<br />
}<br />
]<br />
}<br />
}</div>
Tbezstarosta
https://wiki.netio-products.com/index.php?title=MQTT-flex&diff=1087
MQTT-flex
2026-03-17T15:05:54Z
<p>Tbezstarosta: /* TEMPERATURE */</p>
<hr />
<div>The MQTT-flex version of the MQTT protocol can be configured in detail thanks to the “flex” extension.<br />
<br />
https://www.netio-products.com/en/glossary/mqtt-flex <br />
<br />
<b>Why MQTT-flex</b> <br><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.<br />
<br />
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.<br />
<br />
===Supported devices:===<br />
* PowerCable MQTT 101x <br><br />
* PowerCable REST 101x <br><br />
* PowerPDU 4PS <br><br />
* PowerPDU 4KS <br><br />
* PowerPDU 8QS <br><br />
* PowerDIN 4PZ <br><br />
* PowerBOX 3Px <br><br />
* PowerBOX 4Kx <br><br />
<br />
<b>FW version:</b> <br><br />
>2.2.1<br />
<br />
===Not supported NETIO devices:===<br />
* PowerPDU 4C <br><br />
* NETIO 4 <br><br />
* NETIO 4All <br><br />
<br />
= Simple MQTT-flex configuration + explanation =<br />
<br />
''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.''<br />
<br />
{<br />
"config":{<br />
"broker":{<br />
"url":"broker.hivemq.com",<br />
"protocol":"mqtt",<br />
"port":1883,<br />
"ssl":false,<br />
"type":"generic",<br />
"username":"freedom",<br />
"password":"peace|LOVE|empathy4ALL"<br />
},<br />
"subscribe":[{<br />
"topic":"netio/${DEVICE_NAME}/output/1/action",<br />
"qos":0,<br />
"target":"OUTPUTS/1/ACTION",<br />
"action":"${payload}"<br />
}<br />
],<br />
"publish":[{<br />
"topic":"netio/${DEVICE_NAME}/output/1/state",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/STATE}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":"1000"<br />
}<br />
]<br />
}<br />
]<br />
}<br />
}<br />
=== Client Configuration (broker section) ===<br />
Put here MQTT client connection setup<br />
<br />
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>. <br />
<br />
"broker":{<br />
"url":"broker.hivemq.com",<br />
"protocol":"mqtt",<br />
"port":1883,<br />
"ssl":false,<br />
"type":"generic",<br />
"username":"freedom",<br />
"password":"peace|LOVE|empathy4ALL"<br />
},<br />
<br />
=== Device Control (subscribe section) ===<br />
Put here array of topics where to subscribe<br />
<br />
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> <br />
<br />
"subscribe":[{<br />
"topic":"netio/${DEVICE_NAME}/output/1/action",<br />
"qos":0,<br />
"target":"OUTPUTS/1/ACTION",<br />
"action":"${payload}"<br />
}<br />
],<br />
<br />
=== Output State monitoring (publish section) ===<br />
Put here array of topics where to publish.<br />
<br />
Device send every <b>1000 s</b> message to topic <b></b> with <b>QOS 0</b>, <b>retain true</b> information with <b>output 1 state</b><br />
<br />
"publish":[{<br />
"topic":"netio/${DEVICE_NAME}/output/1/state",<br />
"qos":0,<br />
"retain":true,<br />
"payload":"${OUTPUTS/1/STATE}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":"1000"<br />
}<br />
]<br />
}<br />
]<br />
<br />
= Config sections =<br />
<br />
== Broker ==<br />
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 />
<br /><br />
=== Attributes table overview ===<br />
{| class="wikitable"<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Item<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Presence<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Possible Values<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Description<br />
! style="font-weight:bold; background-color:#9b9b9b;" | JSON Config Usage<br />
|-<br />
| style="background-color:#efefef;" | url<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | MQTT broker URL<br />
| style="background-color:#efefef;" | "url":"broker.hivemq.com"<br />
|-<br />
| style="background-color:#efefef;" | port<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | 1 - 65535<br />
| style="background-color:#efefef;" | MQTT broker port<br />
| style="background-color:#efefef;" | "port":1883<br />
|-<br />
| style="background-color:#efefef;" | protocol<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | protocol spec - mqtt<br />
| style="background-color:#efefef;" | "protocol": "mqtt"<br />
|-<br />
| style="background-color:#efefef;" | ssl<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | true, false<br />
| style="background-color:#efefef;" | Use SSL crypted communication selector<br />
| style="background-color:#efefef;" | "ssl":false<br />
|-<br />
| style="background-color:#efefef;" | type<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | generic<br />
| style="background-color:#efefef;" | Communication/setup type option<br />
| style="background-color:#efefef;" | "type":"generic"<br />
|-<br />
| style="background-color:#efefef;" | username<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | regexp+len<br />
| style="background-color:#efefef;" | Credentials for MQTT broker. Max. 128 characters (since FW 3.2.4).<br />
| style="background-color:#efefef;" | "username":"freedom"<br />
|-<br />
| style="background-color:#efefef;" | password<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | regexp+len<br />
| style="background-color:#efefef;" | Credentials for MQTT broker. Max. 256 characters (since FW 3.2.4).<br />
| style="background-color:#efefef;" | "password":"peace|LOVE|empathy4ALL"<br />
|-<br />
| style="background-color:#efefef;" | clientid<br />
| style="background-color:#efefef;" | optional<br />
| style="background-color:#efefef;" | regexp+len<br />
| style="background-color:#efefef;" | MQTT clientid. Max. 128 characters (since FW 3.2.4). Variables ${DEVICE_MAC} or ${DEVICE_NAME} can be used<br />
| style="background-color:#efefef;" | "clientid":"myEcoTable01"<br />
|-<br />
| style="background-color:#efefef;" | keepalive<br />
| style="background-color:#efefef;" | optional<br />
| style="background-color:#efefef;" | 1 - 65535<br />
| style="background-color:#efefef;" | MQTT keep alive period in seconds<br />
| style="background-color:#efefef;" | "keepalive":90<br />
|}<br />
<br />
Note 1: <b>clientid</b> attribute is <b>mandatory for MQTT(s)</b> communication. When not configured, random ID will be generated.<br />
<br />
Note 2: To proper communication with MS Azure - it is necessary to set up IoT Hub to use TLS 1.2<br />
<br />
See section "TLS 1.2 enforcement available in select regions" in following guidelines https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-tls-support<br />
<br />
=== Examples ===<br />
==== Standard setup ====<br />
<br />
<br />
==== Security (SSL / TLS) secured setup ====<br />
You can enable MQTTs by using the encrypted port <b>8883</b> + <b>"ssl":true</b>.<br />
<br />
==== Variables used setup ====<br />
<br />
== Subscribe ==<br />
=== Hints to usage ===<br />
When receive message in <b><i>topic</b></i> do <b><i>action</b></i> on <b><i>target</b></i>.<br />
<br />
<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>.<br />
<br />
=== Attributes table overview ===<br />
{| class="wikitable"<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Item<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Presence<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Possible Values<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Description<br />
! style="font-weight:bold; background-color:#9b9b9b;" | JSON Config Usage<br />
|-<br />
| style="background-color:#efefef;" | topic<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | see table below<br />
| style="background-color:#efefef;" | specification of the topic, which MQTT-flex device listens from broker and act accordingly. Max. 128 characters. The "#" can be used since FW 3.2.4 - see note under this table.<br />
| style="background-color:#efefef;" | "topic":"netio/${DEVICE_NAME}/output/1/action"<br />
|-<br />
| style="background-color:#efefef;" | qos<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | 0, 1 or 2<br />
| 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}<br />
| style="background-color:#efefef;" | "qos":0<br />
|-<br />
| style="background-color:#efefef;" | target<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | internal definition of action, which can be performed above the specified output<br />
| style="background-color:#efefef;" | "target":"OUTPUTS/1/ACTION"<br />
|-<br />
| style="background-color:#efefef;" | action<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | a payload or a value the action attribute needs to have passed to<br />
| style="background-color:#efefef;" | "action":"${payload}"<br />
|-<br />
| style="background-color:#efefef;" | actiondef<sup>Not supported yet</sup><br />
| style="background-color:#efefef;" | optional<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
|-<br />
| style="background-color:#efefef;" | json<sup>Not supported yet</sup><br />
| style="background-color:#efefef;" | optional<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
|}<br />
<br />
Note: The "#" wildcard can be used in subscribe topic definition. The multi-level wildcard character MUST be specified either on its own or following a topic level separator. In either case it MUST be the last character specified in the Topic.<br />
<br />
For example, if a Device subscribes to “devices/{device_id}/messages/devicebound/#”, it would receive messages published using these topic names:<br />
<br />
“devices/{device_id}/messages/devicebound/”<br />
<br />
“devices/{device_id}/messages/devicebound/{property_bag}”<br />
<br />
This should be usefull for use with MS Azure - IoT hub.<br />
<br />
=== MQTT Subscribe as event to trigger action <sup><code>FW 4.0.0+</code></sup> ===<br />
<br />
This feature allow to subscribe to specific MQTT topic and pass payload to Rules or MQTT-flex as event.<br />
<br />
target: <code>PROTOCOLS/MQTT/EVENT</code><br />
<br />
"subscribe": [<br />
{<br />
"action": "${payload}",<br />
"qos": 0,<br />
"target": "PROTOCOLS/MQTT/EVENT",<br />
"topic": "broker/12345/MQTT_EVENT/"<br />
}<br />
]<br />
<br />
=== Examples ===<br />
==== Toggle output with standard payload ==== <br />
==== Toggle output with custom payload ==== <br />
==== Subscribe to more than one topic ====<br />
==== Trigger Rule and MQTT publish from MQTT subscribe <sup><code>FW 4.0.0+</code></sup> ====<br />
This example show Request response implementation in MQTT and toggle action made by Rules.<br />
<br />
When message with payload <code>getValues</code> is published to topic <code>broker/gv90018g/COMMAND</code> MQTT flex will create an event with name <code>PROTOCOLS/MQTT/EVENT</code> (fixed name cannot be changed) and value <code>getValues</code>. On this event will act all events and conditions set in MQTT-flex and Rules which are set to listening to change on <code>PROTOCOLS/MQTT/EVENT</code> and equals to value <code>getValues</code>. See <b>bold</b> marked parameters in example configuration below. <br />
<br />
Once the triggered action is done it is needed to reset MQTT channel to <code>OK</code> status becaus event are reacting only to change. If the channel is not reset the next even would not be triggered.<br />
<br />
<b>Rules Configuration:</b><br />
{<br />
"conditions": {<br />
<b>"PROTOCOLS/MQTT/EVENT": "getValues"</b><br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 4<br />
}<br />
}<br />
<br />
<b>MQTT Configuration:</b><br />
{<br />
"broker":{<br />
"clientid":"netio${DEVICE_SN}",<br />
"keepalive":30,<br />
"password":"abcdefghijk",<br />
"port":8883,<br />
"protocol":"mqtt",<br />
"ssl":true,<br />
"type":"generic",<br />
"url":"broker.cloud.netio.eu",<br />
"username":"gv90018g"<br />
},<br />
"groupEvents":[<br />
{<br />
"events":[<br />
{<br />
<b>"source":"PROTOCOLS/MQTT/EVENT",<br />
"type":"change",<br />
"value":"getValues"</b><br />
}<br />
],<br />
"appliedTopics":[<br />
"broker/gv90018g/OUTPUTS/1/STATE",<br />
<b>"broker/gv90018g/COMMAND"</b><br />
]<br />
}<br />
],<br />
"publish":[<br />
{<br />
"payload":"${OUTPUTS/1/STATE}",<br />
"qos":0,<br />
"retain":true,<br />
"topic":"broker/gv90018g/OUTPUTS/1/STATE"<br />
},<br />
{<br />
"payload":"OK",<br />
"qos":0,<br />
"retain":true,<br />
"topic":"broker/gv90018g/COMMAND"<br />
}<br />
],<br />
"subscribe":[<br />
{<br />
"action":"${payload}",<br />
"qos":0,<br />
<b>"target":"PROTOCOLS/MQTT/EVENT"</b>,<br />
"topic":"broker/gv90018g/COMMAND"<br />
}<br />
]<br />
}<br />
<br />
<br />
<br />
Subscribe topic payload values specification for control of the output:<br />
<br />
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)<br />
<br />
== Publish ==<br />
<br />
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)<br />
<br />
=== Hints to usage ===<br />
When <b><i>event</b></i> send message with <b><i>payload</b></i> to <b><i>topic</b></i>.<br />
<br />
=== Attributes table overview ===<br />
{| class="wikitable"<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Item<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Presence<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Possible Values<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Description<br />
! style="font-weight:bold; background-color:#9b9b9b;" | JSON Config Usage<br />
|-<br />
| style="background-color:#efefef;" | topic<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | see table below<br />
| style="background-color:#efefef;" | definition of the topic, how it is registered towards MQTT broker. Max. 128 characters. <br />
| style="background-color:#efefef;" | "topic":"netio/${DEVICE_NAME}/output/1/load"<br />
|-<br />
| style="background-color:#efefef;" | qos<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | see table below<br />
| 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}<br />
| style="background-color:#efefef;" | <br />
|-<br />
| style="background-color:#efefef;" | retain<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | boolean: true or false<br />
| 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}<br />
| style="background-color:#efefef;" | "retain":true<br />
|-<br />
| style="background-color:#efefef;" | payload<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | see table below<br />
| style="background-color:#efefef;" | definition of the payload, what is send to the MQTT broker.<br />
| style="background-color:#efefef;" | "payload":"${OUTPUTS/1/STATE}"<br />
|-<br />
| style="background-color:#efefef;" | events<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | see table below<br />
| style="background-color:#efefef;" | definition of events used for triggering sending of data via mqtt (change, delta, timer)<br />
| style="background-color:#efefef;" | <br />
|-<br />
| style="background-color:#efefef;" | type<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" |<br />
|-<br />
| style="background-color:#efefef;" | source<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" |<br />
|-<br />
| style="background-color:#efefef;" | delta<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" |<br />
|-<br />
| style="background-color:#efefef;" | period<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" |<br />
| style="background-color:#efefef;" |<br />
|-<br />
| style="background-color:#efefef;" | payloaddef<sup>Not supported yet</sup><br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" |<br />
|}<br />
<br />
=== Examples ===<br />
==== Publish energy periodically (event timer) ==== <br />
==== Publish current on change (delta) ==== <br />
==== Publish output state ====<br />
==== Publish to more than one topic with different events ====<br />
<br />
= Target / Source =<br />
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.<br />
<br />
* <b>source</b> - specifies from where the value will be read (specifies the source of data for payload, change detection, delta calculation)<br />
* <b>target</b> - specifies where the data should be sent or command applied (e.g. specifies the target for ACTION)<br />
<br />
=== INPUT / OUTPUT (Target) selection ===<br />
<br />
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.<br />
<br />
# At first specify if requested variable is from/for INPUT or OUTPUT using keywords <b>"OUTPUTS"</b> or <b>"INPUTS"</b> .<br />
# Add <b>"/"</b> separator<br />
# Specify the number of INPUT/OUTPUT to <b>1</b>(or TOTAL for summary statistics if available)<br />
# Add <b>"/"</b> separator<br />
# Specify requested variable or command<br />
<br />
<b>Note:</b> Not all of OUTPUTS/INPUTS support all variables. Available variables are closely connected with the device functions and I/O features.<br />
<br />
<b>Note2:</b> INPUTS available only on NETIO PowerDIN 4PZ<br />
<br />
=== Examples: ===<br />
<br />
adressing controll of output 3<br />
OUTPUTS/3/ACTION<br />
getting voltage on output 1<br />
OUTPUTS/1/VOLTAGE<br />
getting state of input 1<br />
INPUTS/1/STATE<br />
getting temperature [C] - sensor connected of input 1<br />
INPUTS/1/TEMP<br />
getting temperature [F] - sensor connected of input 2<br />
INPUTS/2/TEMPF<br />
getting humidity [%] - sensor connected of input 2<br />
INPUTS/2/HUMIDITY<br />
<br />
= Group Events<sup><code>FW 4.0.0+</code></sup> =<br />
Group events are smart way how to keep configuration simple. It is not replacement of publish section specification but it is extension to trigger group of different topics to be published on the same event.<br />
<br />
See the example below. There is specific event on status change on every output and additionally the device sends periodic status every 60 seconds.<br />
<br />
{<br />
"broker": {<br />
"clientid": "netio${DEVICE_SN}",<br />
"keepalive": 30,<br />
"password": "",<br />
"port": 1883,<br />
"protocol": "mqtt",<br />
"ssl": false,<br />
"type": "generic",<br />
"url": "broker.hivemq.com",<br />
"username": ""<br />
},<br />
<b>"groupEvents": [<br />
{<br />
"events":[<br />
{<br />
"period": 60,<br />
"type": "timer"<br />
}<br />
],<br />
"appliedTopics":[<br />
"devices/${DEVICE_NAME}/output/1/state",<br />
"devices/${DEVICE_NAME}/output/2/state"<br />
]<br />
}<br />
],</b><br />
"publish": [<br />
{<br />
"events": [<br />
{<br />
"source": "OUTPUTS/1/STATE",<br />
"type": "change"<br />
}<br />
],<br />
"payload": "${OUTPUTS/1/STATE}",<br />
"qos": 0,<br />
"retain": false,<br />
<b> "topic": "devices/${DEVICE_NAME}/output/1/state"</b><br />
},{<br />
"events": [<br />
{<br />
"source": "OUTPUTS/2/STATE",<br />
"type": "change"<br />
}<br />
],<br />
"payload": "${OUTPUTS/2/STATE}",<br />
"qos": 0,<br />
"retain": false,<br />
<b> "topic": "devices/${DEVICE_NAME}/output/2/state"</b><br />
}<br />
]<br />
}<br />
<br />
= Variables =<br />
In some parameters is nescessary to use variables to get current state and measurements. <b>Variables are separated in two categories:</b><br />
<br />
* Target/Source variables<br />
* Payload Topic variables<br />
<br />
== Target Source Variables ==<br />
<br />
The list of available variables for each <br />
<br />
=== OUTPUTS variables ===<br />
==== VOLTAGE ====<br />
Unit: <code>V</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Present RMS voltage on output 1 is ${OUTPUTS/1/VOLTAGE}"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/VOLTAGE}"</code><br />
<br />
==== CURRENT ====<br />
Unit: <code>mA</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Present RMS current on output 1 is ${OUTPUTS/1/CURRENT}"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/CURRENT}"</code><br />
<br />
==== POWER_FACTOR ====<br />
Unit: <code>[-]</code><br />
<br />
Type: float (2 decimals)<br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"True Power Factor on output 1 is ${OUTPUTS/1/POWER_FACTOR}"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/POWER_FACTOR}"</code><br />
<br />
==== LOAD ====<br />
Unit: <code>W</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Present load on output 1 is ${OUTPUTS/1/LOAD}W"</code><br />
<br />
Example 2: <code>"payload":"Device's load connected to output 1 is ${OUTPUTS/1/LOAD}W"</code><br />
<br />
Example 3: <code>"source":"${OUTPUTS/1/LOAD}"</code><br />
<br />
==== STATE ====<br />
Type: bool(integer) - <code>0</code> or <code>1</code><br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Present output 1 state is ${OUTPUTS/1/STATE}"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/STATE}"</code><br />
<br />
==== ACTION ====<br />
Type: integer<br />
<br />
Possible actions:<br />
* <code>0</code> - set state OFF<br />
* <code>1</code> - set state ON<br />
* <code>2</code> - short OFF (restart)<br />
* <code>3</code> - short ON<br />
* <code>4</code> - toggle (switch)<br />
* <code>5</code> - no change<br />
<br />
Allowed in: <code>"target"</code><br />
<br />
Example: <code>"target":"OUTPUTS/1/ACTION"</code><br />
<br />
==== DELAY [ms] ====<br />
==== NAME ====<br />
==== FREQUENCY ====<br />
Unit: <code>Hz</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example: <code>"payload":"Frequency in power grid is ${OUTPUTS/1/ENERGY}Hz"</code><br />
<br />
==== ENERGY ====<br />
Energy consumed by an device connected to NETIO device output.<br />
<br />
Unit: <code>Wh</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Consumed energy on output 1 is ${OUTPUTS/1/ENERGY}Wh"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/ENERGY}"</code><br />
<br />
==== REVERSE_ENERGY ====<br />
Energy delivered back to grid. For example from solar system connected to NETIO device output.<br />
<br />
Unit: <code>Wh</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Delivered energy on output 1 is ${OUTPUTS/1/REVERSE_ENERGY}Wh"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/REVERSE_ENERGY}"</code><br />
<br />
<br />
==== ENERGY_START ====<br />
Date when the counters ENERGY and REVERSE_ENERGY have been resetted by user.<br />
<br />
Unit: <code>unix timestamp</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code><br />
<br />
Example 1: <code>"payload":"Energy measured since ${OUTPUTS/1/ENERGY_START} unix time"</code><br />
<br />
Example 2: <code>"payload":"${OUTPUTS/1/ENERGY_START}"</code> is output payload <code>1567654639</code><br />
<br />
==== ENERGY_START_FMT ====<br />
Date when the counters ENERGY and REVERSE_ENERGY have been resetted by user.<br />
<br />
Unit: <code>fmt date format</code><br />
<br />
Type: string <br />
<br />
Allowed in: <code>"payload"</code><br />
<br />
Example 1: <code>"payload":"Energy measured since ${OUTPUTS/1/ENERGY_START}"</code><br />
<br />
Example 2: <code>"payload":"${OUTPUTS/1/ENERGY_START_FMT}"</code> is output payload <code>2019-09-05T03:37:19+00:00</code><br />
<br />
==== ENERGY_NR ====<br />
Non-resettable counter of Energy consumed by an device connected to NETIO device output.<br />
<br />
Unit: <code>Wh</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Consumed energy on output 1 is ${OUTPUTS/1/ENERGY_NR}Wh"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/ENERGY_NR}"</code><br />
<br />
==== REVERSE_ENERGY_NR ====<br />
Non-resettable counter of Energy delivered back to grid. For example from solar system connected to NETIO device output.<br />
<br />
Unit: <code>Wh</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Delivered energy on output 1 is ${OUTPUTS/1/REVERSE_ENERGY_NR}Wh"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/REVERSE_ENERGY_NR}"</code><br />
<br />
<br />
<br />
==== TOTALs - for use with devices having more than 1 measured output ====<br />
<br />
* OUTPUTS/TOTAL/ENERGY<br />
* OUTPUTS/TOTAL/LOAD<br />
* OUTPUTS/TOTAL/CURRENT<br />
* OUTPUTS/TOTAL/VOLTAGE<br />
* OUTPUTS/TOTAL/POWER_FACTOR<br />
* OUTPUTS/TOTAL/FREQUENCY<br />
* OUTPUTS/TOTAL/PHASE<br />
* OUTPUTS/TOTAL/REVERSE_ENERGY<br />
* OUTPUTS/TOTAL/ENERGY_NR<br />
* OUTPUTS/TOTAL/REVERSE_ENERGY_NR<br />
* OUTPUTS/TOTAL/ENERGY_START<br />
* OUTPUTS/TOTAL/ENERGY_START_FMT<br />
<br />
<br />
==== REST_JSON ====<br />
Allow use of NETIO JSON structure to control outputs.<br />
<br />
Type: string / JSON<br />
<br />
Allowed in: <code>"target"</code> for Subscribe section<br />
<br />
Example: <code>"target": "REST_JSON"</code><br />
<br />
The payload is JSON structure identical to NETIO JSON API M2M Protocol (documentation available at https://www.netio-products.com/files/NETIO-M2M-API-Protocol-JSON.pdf). You can control one or multiple outputs.<br />
<br />
Payload example 1 - Toggle output 1: <code>{"Outputs":[{"ID": 1,"Action": 4}]}</code><br />
<br />
Payload example 2 - Turn output 1 OFF and output 3 ON: <code>{"Outputs":[{"ID":1,"Action":0},{"ID":3,"Action":1}]}</code><br />
<br />
=== INPUT variables ===<br />
==== STATE ====<br />
Type: bool(integer) - <code>0</code> or <code>1</code><br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Present input 1 state is ${INPUTS/1/STATE}"</code><br />
<br />
Example 2: <code>"source":"${INPUTS/1/STATE}"</code><br />
<br />
==== S0 ====<br />
S0 Counter value<br />
Unit: <code>-</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Input 1 S0 Counter value is ${INPUTS/1/S0}impulses"</code><br />
<br />
Example 2: <code>"source":"${INPUTS/1/S0}"</code><br />
<br />
==== TEMPERATURE ====<br />
Temperature measurement in Celsius, Fahrenheit<br />
* In case of a disconnected sensor or a malfunction, the return value is 999<br />
Unit: <code> [C], [F] </code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Input 1 Temperature value in degree of Celsius is ${INPUTS/1/TEMP} [C] "</code><br />
<br />
Example 2: <code>"source":"${INPUTS/1/TEMP}"</code><br />
<br />
Example 3: <code>"payload":"Input 1 Temperature value in degree of Fahrenheit is ${INPUTS/1/TEMPF} [F] "</code><br />
<br />
Example 4: <code>"source":"${INPUTS/1/TEMPF}"</code><br />
<br />
==== HUMIDITY ====<br />
Relative Humidity measurement <br />
Unit: <code> [%]</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Input 1 Humidity value is ${INPUTS/1/HUMIDITY} %"</code><br />
<br />
Example 2: <code>"source":"${INPUTS/1/HUMIDITY}"</code><br />
<br />
== Payload/topic variables ==<br />
<br />
=== DEVICE_NAME ===<br />
Can be used in: "payload", "topic"<br />
<br />
Example 1: <code>"payload":"${DEVICE_NAME}"</code><br />
<br />
Example 2: <code>"topic":"netio/${DEVICE_NAME}/output/1/action"</code><br />
<br />
=== DEVICE_MAC ===<br />
Can be used in: "payload", "topic"<br />
<br />
Example 1: <code>"payload":"${DEVICE_MAC}"</code><br />
<br />
Example 2: <code>"topic":"netio/${DEVICE_MAC}/output/1/action"</code><br />
<br />
=== UTC_TIME <sup><code>FW 4.0.0+</code></sup>===<br />
<br />
send unix timestamp of devices actual time<br />
<br />
Can be used in: "payload"<br />
<br />
Example 1: <code>"payload": "${UTC_TIME}"</code><br />
<br />
=== UPTIME <sup>Not yet implemented</sup> ===<br />
<br />
=== PAYLOAD ===<br />
Can be used in: "action"<br />
<br />
Example: <code>"action":"${PAYLOAD}"</code><br />
<br />
=== OUTPUT_ID <sup>Not yet implemented</sup>===<br />
<br />
=== WIFI_SIGNAL<sup>Not yet implemented</sup> ===<br />
<br />
=== OUTPUTS_STATUS ===<br />
Provide complete outputs status and measurement if supported.<br />
<br />
Type: string / JSON<br />
<br />
Allowed in: <code>"payload"</code> for Publish section<br />
<br />
Example: <code>"payload":"${OUTPUTS_STATUS}"</code><br />
<br />
Payload example: <code>{ "GlobalMeasure":{"Voltage":236,"TotalCurrent":72,"TotalLoad":11,"TotalEnergy":167,"OverallPowerFactor":0.64,"Frequency":50.07,"Phase":-36.86,"EnergyStart":"2020-06-30T17:04:48+01:00"}, "Outputs":[ {"ID":1,"Name":"Power output 1","State":1,"Action":6,"Delay":2020,"Current":72,"PowerFactor":0.64,"Phase":-36.86,"Energy":139,"ReverseEnergy":0,"Load":11}, {"ID":2,"Name":"Power output 2","State":1,"Action":6,"Delay":2020,"Current":0,"PowerFactor":1.00,"Phase":0.00,"Energy":27,"ReverseEnergy":0,"Load":0}, {"ID":3,"Name":"Free Contact 3","State":1,"Action":6,"Delay":2020}, {"ID":4,"Name":"Free Contact 4","State":1,"Action":6,"Delay":2020} ]}</code><br />
<br />
=== INPUTS_STATUS ===<br />
Provide complete inputs status if supported. Since FW 3.0.0<br />
<br />
Type: string / JSON<br />
<br />
Allowed in: <code>"payload"</code> for Publish section<br />
<br />
Example: <code>"payload":"${INPUTS_STATUS}"</code><br />
<br />
Payload example: <code>{ "Inputs":[ {"ID":1,"Name":"Input 1","State":0,"S0Counter":0}, {"ID":2,"Name":"Input 2","State":0,"S0Counter":0} ]}</code><br />
<br />
=== INOUT_STATUS ===<br />
Provide complete inputs and output status and measurement if supported. Since FW 3.0.0<br />
<br />
Type: string / JSON<br />
<br />
Allowed in: <code>"payload"</code> for Publish section<br />
<br />
Example: <code>"payload":"${INOUT_STATUS}"</code><br />
<br />
Payload example: <code>{ "GlobalMeasure":{"Voltage":238,"TotalCurrent":105,"TotalLoad":17,"TotalEnergy":1451,"OverallPowerFactor":0.67,"Frequency":50.03,"Phase":-33.67,"EnergyStart":"2020-06-30T17:04:48+01:00"}, "Outputs":[ {"ID":1,"Name":"Power output 1","State":0,"Action":6,"Delay":5000,"Current":0,"PowerFactor":1.00,"Phase":0.00,"Energy":701,"ReverseEnergy":0,"Load":0}, {"ID":2,"Name":"Power output 2","State":1,"Action":6,"Delay":5000,"Current":105,"PowerFactor":0.65,"Phase":-33.67,"Energy":750,"ReverseEnergy":0,"Load":17}, {"ID":3,"Name":"Free Contact 3","State":1,"Action":6,"Delay":5000}, {"ID":4,"Name":"Free Contact 4","State":0,"Action":6,"Delay":5000} ], "Inputs":[ {"ID":1,"Name":"Input 1","State":0,"S0Counter":0}, {"ID":2,"Name":"Input 2","State":0,"S0Counter":0} ]}</code><br />
<br />
= Extended MQTT flex JSON config examples =<br />
<br />
== Default NETIO MQTT-flex configuration ==<br />
This example demonstrates setup for connection to public <code>broker.hivemq.com</code>, measurement reporting and output control.<br />
<br />
The device cabe be controlled via <code>netio/${DEVICE_NAME}/output/1/action topic</code> by sending standard NETIO action values:<br />
* 0 - OFF<br />
* 1 - ON<br />
* 2 - SHORT OFF<br />
* 3 - SHORT ON<br />
* 4 - TOGGLE<br />
* 5 - NO ACTION.<br />
<br />
The device report measurements:<br />
<br />
* Output state - every 15 minutes or by change<br />
* Voltage [V]- every 5 minutes or by change of 1 V<br />
* Current [mA]- every 5 minutes or by change of 50 mA<br />
* Load(Power) [W]- every 5 minutes or by change of 10 W<br />
* Energy(Consumption) [Wh]- every 15 minutes or by change of 1Wh<br />
* True Power Factor (TPF) [-]- every 5 minutes or by change of 0.02<br />
* Frequency [Hz]- every 1 hour or by change of 0.1 Hz<br />
<br />
For register all values, you can use wildcard <code>netio/${DEVICE_NAME}/output/1/#</code><br />
<br />
{<br />
"config":{<br />
"broker":{<br />
"url":"broker.hivemq.com",<br />
"protocol":"mqtt",<br />
"port":1883,<br />
"ssl":false,<br />
"type":"generic",<br />
"username":"",<br />
"password":"",<br />
"clientid":"moje${DEVICE_NAME}${DEVICE_MAC}",<br />
"keepalive":30<br />
},<br />
"subscribe":[<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/action",<br />
"qos":0,<br />
"target":"OUTPUTS/1/ACTION",<br />
"action":"${payload}"<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/switch",<br />
"qos":0,<br />
"target":"OUTPUTS/1/ACTION",<br />
"action":4<br />
}<br />
],<br />
"publish":[<br />
{<br />
"topic":"netio/${DEVICE_MAC}/output/1/state",<br />
"qos":0,<br />
"retain":true,<br />
"payload":"${OUTPUTS/1/STATE}",<br />
"events":[<br />
{<br />
"type":"change",<br />
"source":"OUTPUTS/1/STATE"<br />
},<br />
{<br />
"type":"timer",<br />
"period":900<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/voltage",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/VOLTAGE}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":300<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/VOLTAGE",<br />
"delta":1<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/current",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/CURRENT}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":300<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/CURRENT",<br />
"delta":50<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/load",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/LOAD}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":300<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/LOAD",<br />
"delta":10<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/energy",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/ENERGY}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":900<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/ENERGY",<br />
"delta":1<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/tpf",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/POWER_FACTOR}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":900<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/POWER_FACTOR",<br />
"delta":0.02<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/frequency",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/FREQUENCY}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":3600<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/FREQUENCY",<br />
"delta":0.1<br />
}<br />
]<br />
}<br />
]<br />
}<br />
}</div>
Tbezstarosta
https://wiki.netio-products.com/index.php?title=MQTT-flex&diff=1086
MQTT-flex
2026-03-17T15:05:30Z
<p>Tbezstarosta: /* TEMPERATURE */</p>
<hr />
<div>The MQTT-flex version of the MQTT protocol can be configured in detail thanks to the “flex” extension.<br />
<br />
https://www.netio-products.com/en/glossary/mqtt-flex <br />
<br />
<b>Why MQTT-flex</b> <br><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.<br />
<br />
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.<br />
<br />
===Supported devices:===<br />
* PowerCable MQTT 101x <br><br />
* PowerCable REST 101x <br><br />
* PowerPDU 4PS <br><br />
* PowerPDU 4KS <br><br />
* PowerPDU 8QS <br><br />
* PowerDIN 4PZ <br><br />
* PowerBOX 3Px <br><br />
* PowerBOX 4Kx <br><br />
<br />
<b>FW version:</b> <br><br />
>2.2.1<br />
<br />
===Not supported NETIO devices:===<br />
* PowerPDU 4C <br><br />
* NETIO 4 <br><br />
* NETIO 4All <br><br />
<br />
= Simple MQTT-flex configuration + explanation =<br />
<br />
''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.''<br />
<br />
{<br />
"config":{<br />
"broker":{<br />
"url":"broker.hivemq.com",<br />
"protocol":"mqtt",<br />
"port":1883,<br />
"ssl":false,<br />
"type":"generic",<br />
"username":"freedom",<br />
"password":"peace|LOVE|empathy4ALL"<br />
},<br />
"subscribe":[{<br />
"topic":"netio/${DEVICE_NAME}/output/1/action",<br />
"qos":0,<br />
"target":"OUTPUTS/1/ACTION",<br />
"action":"${payload}"<br />
}<br />
],<br />
"publish":[{<br />
"topic":"netio/${DEVICE_NAME}/output/1/state",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/STATE}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":"1000"<br />
}<br />
]<br />
}<br />
]<br />
}<br />
}<br />
=== Client Configuration (broker section) ===<br />
Put here MQTT client connection setup<br />
<br />
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>. <br />
<br />
"broker":{<br />
"url":"broker.hivemq.com",<br />
"protocol":"mqtt",<br />
"port":1883,<br />
"ssl":false,<br />
"type":"generic",<br />
"username":"freedom",<br />
"password":"peace|LOVE|empathy4ALL"<br />
},<br />
<br />
=== Device Control (subscribe section) ===<br />
Put here array of topics where to subscribe<br />
<br />
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> <br />
<br />
"subscribe":[{<br />
"topic":"netio/${DEVICE_NAME}/output/1/action",<br />
"qos":0,<br />
"target":"OUTPUTS/1/ACTION",<br />
"action":"${payload}"<br />
}<br />
],<br />
<br />
=== Output State monitoring (publish section) ===<br />
Put here array of topics where to publish.<br />
<br />
Device send every <b>1000 s</b> message to topic <b></b> with <b>QOS 0</b>, <b>retain true</b> information with <b>output 1 state</b><br />
<br />
"publish":[{<br />
"topic":"netio/${DEVICE_NAME}/output/1/state",<br />
"qos":0,<br />
"retain":true,<br />
"payload":"${OUTPUTS/1/STATE}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":"1000"<br />
}<br />
]<br />
}<br />
]<br />
<br />
= Config sections =<br />
<br />
== Broker ==<br />
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 />
<br /><br />
=== Attributes table overview ===<br />
{| class="wikitable"<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Item<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Presence<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Possible Values<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Description<br />
! style="font-weight:bold; background-color:#9b9b9b;" | JSON Config Usage<br />
|-<br />
| style="background-color:#efefef;" | url<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | MQTT broker URL<br />
| style="background-color:#efefef;" | "url":"broker.hivemq.com"<br />
|-<br />
| style="background-color:#efefef;" | port<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | 1 - 65535<br />
| style="background-color:#efefef;" | MQTT broker port<br />
| style="background-color:#efefef;" | "port":1883<br />
|-<br />
| style="background-color:#efefef;" | protocol<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | protocol spec - mqtt<br />
| style="background-color:#efefef;" | "protocol": "mqtt"<br />
|-<br />
| style="background-color:#efefef;" | ssl<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | true, false<br />
| style="background-color:#efefef;" | Use SSL crypted communication selector<br />
| style="background-color:#efefef;" | "ssl":false<br />
|-<br />
| style="background-color:#efefef;" | type<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | generic<br />
| style="background-color:#efefef;" | Communication/setup type option<br />
| style="background-color:#efefef;" | "type":"generic"<br />
|-<br />
| style="background-color:#efefef;" | username<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | regexp+len<br />
| style="background-color:#efefef;" | Credentials for MQTT broker. Max. 128 characters (since FW 3.2.4).<br />
| style="background-color:#efefef;" | "username":"freedom"<br />
|-<br />
| style="background-color:#efefef;" | password<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | regexp+len<br />
| style="background-color:#efefef;" | Credentials for MQTT broker. Max. 256 characters (since FW 3.2.4).<br />
| style="background-color:#efefef;" | "password":"peace|LOVE|empathy4ALL"<br />
|-<br />
| style="background-color:#efefef;" | clientid<br />
| style="background-color:#efefef;" | optional<br />
| style="background-color:#efefef;" | regexp+len<br />
| style="background-color:#efefef;" | MQTT clientid. Max. 128 characters (since FW 3.2.4). Variables ${DEVICE_MAC} or ${DEVICE_NAME} can be used<br />
| style="background-color:#efefef;" | "clientid":"myEcoTable01"<br />
|-<br />
| style="background-color:#efefef;" | keepalive<br />
| style="background-color:#efefef;" | optional<br />
| style="background-color:#efefef;" | 1 - 65535<br />
| style="background-color:#efefef;" | MQTT keep alive period in seconds<br />
| style="background-color:#efefef;" | "keepalive":90<br />
|}<br />
<br />
Note 1: <b>clientid</b> attribute is <b>mandatory for MQTT(s)</b> communication. When not configured, random ID will be generated.<br />
<br />
Note 2: To proper communication with MS Azure - it is necessary to set up IoT Hub to use TLS 1.2<br />
<br />
See section "TLS 1.2 enforcement available in select regions" in following guidelines https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-tls-support<br />
<br />
=== Examples ===<br />
==== Standard setup ====<br />
<br />
<br />
==== Security (SSL / TLS) secured setup ====<br />
You can enable MQTTs by using the encrypted port <b>8883</b> + <b>"ssl":true</b>.<br />
<br />
==== Variables used setup ====<br />
<br />
== Subscribe ==<br />
=== Hints to usage ===<br />
When receive message in <b><i>topic</b></i> do <b><i>action</b></i> on <b><i>target</b></i>.<br />
<br />
<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>.<br />
<br />
=== Attributes table overview ===<br />
{| class="wikitable"<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Item<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Presence<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Possible Values<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Description<br />
! style="font-weight:bold; background-color:#9b9b9b;" | JSON Config Usage<br />
|-<br />
| style="background-color:#efefef;" | topic<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | see table below<br />
| style="background-color:#efefef;" | specification of the topic, which MQTT-flex device listens from broker and act accordingly. Max. 128 characters. The "#" can be used since FW 3.2.4 - see note under this table.<br />
| style="background-color:#efefef;" | "topic":"netio/${DEVICE_NAME}/output/1/action"<br />
|-<br />
| style="background-color:#efefef;" | qos<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | 0, 1 or 2<br />
| 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}<br />
| style="background-color:#efefef;" | "qos":0<br />
|-<br />
| style="background-color:#efefef;" | target<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | internal definition of action, which can be performed above the specified output<br />
| style="background-color:#efefef;" | "target":"OUTPUTS/1/ACTION"<br />
|-<br />
| style="background-color:#efefef;" | action<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | a payload or a value the action attribute needs to have passed to<br />
| style="background-color:#efefef;" | "action":"${payload}"<br />
|-<br />
| style="background-color:#efefef;" | actiondef<sup>Not supported yet</sup><br />
| style="background-color:#efefef;" | optional<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
|-<br />
| style="background-color:#efefef;" | json<sup>Not supported yet</sup><br />
| style="background-color:#efefef;" | optional<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
|}<br />
<br />
Note: The "#" wildcard can be used in subscribe topic definition. The multi-level wildcard character MUST be specified either on its own or following a topic level separator. In either case it MUST be the last character specified in the Topic.<br />
<br />
For example, if a Device subscribes to “devices/{device_id}/messages/devicebound/#”, it would receive messages published using these topic names:<br />
<br />
“devices/{device_id}/messages/devicebound/”<br />
<br />
“devices/{device_id}/messages/devicebound/{property_bag}”<br />
<br />
This should be usefull for use with MS Azure - IoT hub.<br />
<br />
=== MQTT Subscribe as event to trigger action <sup><code>FW 4.0.0+</code></sup> ===<br />
<br />
This feature allow to subscribe to specific MQTT topic and pass payload to Rules or MQTT-flex as event.<br />
<br />
target: <code>PROTOCOLS/MQTT/EVENT</code><br />
<br />
"subscribe": [<br />
{<br />
"action": "${payload}",<br />
"qos": 0,<br />
"target": "PROTOCOLS/MQTT/EVENT",<br />
"topic": "broker/12345/MQTT_EVENT/"<br />
}<br />
]<br />
<br />
=== Examples ===<br />
==== Toggle output with standard payload ==== <br />
==== Toggle output with custom payload ==== <br />
==== Subscribe to more than one topic ====<br />
==== Trigger Rule and MQTT publish from MQTT subscribe <sup><code>FW 4.0.0+</code></sup> ====<br />
This example show Request response implementation in MQTT and toggle action made by Rules.<br />
<br />
When message with payload <code>getValues</code> is published to topic <code>broker/gv90018g/COMMAND</code> MQTT flex will create an event with name <code>PROTOCOLS/MQTT/EVENT</code> (fixed name cannot be changed) and value <code>getValues</code>. On this event will act all events and conditions set in MQTT-flex and Rules which are set to listening to change on <code>PROTOCOLS/MQTT/EVENT</code> and equals to value <code>getValues</code>. See <b>bold</b> marked parameters in example configuration below. <br />
<br />
Once the triggered action is done it is needed to reset MQTT channel to <code>OK</code> status becaus event are reacting only to change. If the channel is not reset the next even would not be triggered.<br />
<br />
<b>Rules Configuration:</b><br />
{<br />
"conditions": {<br />
<b>"PROTOCOLS/MQTT/EVENT": "getValues"</b><br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 4<br />
}<br />
}<br />
<br />
<b>MQTT Configuration:</b><br />
{<br />
"broker":{<br />
"clientid":"netio${DEVICE_SN}",<br />
"keepalive":30,<br />
"password":"abcdefghijk",<br />
"port":8883,<br />
"protocol":"mqtt",<br />
"ssl":true,<br />
"type":"generic",<br />
"url":"broker.cloud.netio.eu",<br />
"username":"gv90018g"<br />
},<br />
"groupEvents":[<br />
{<br />
"events":[<br />
{<br />
<b>"source":"PROTOCOLS/MQTT/EVENT",<br />
"type":"change",<br />
"value":"getValues"</b><br />
}<br />
],<br />
"appliedTopics":[<br />
"broker/gv90018g/OUTPUTS/1/STATE",<br />
<b>"broker/gv90018g/COMMAND"</b><br />
]<br />
}<br />
],<br />
"publish":[<br />
{<br />
"payload":"${OUTPUTS/1/STATE}",<br />
"qos":0,<br />
"retain":true,<br />
"topic":"broker/gv90018g/OUTPUTS/1/STATE"<br />
},<br />
{<br />
"payload":"OK",<br />
"qos":0,<br />
"retain":true,<br />
"topic":"broker/gv90018g/COMMAND"<br />
}<br />
],<br />
"subscribe":[<br />
{<br />
"action":"${payload}",<br />
"qos":0,<br />
<b>"target":"PROTOCOLS/MQTT/EVENT"</b>,<br />
"topic":"broker/gv90018g/COMMAND"<br />
}<br />
]<br />
}<br />
<br />
<br />
<br />
Subscribe topic payload values specification for control of the output:<br />
<br />
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)<br />
<br />
== Publish ==<br />
<br />
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)<br />
<br />
=== Hints to usage ===<br />
When <b><i>event</b></i> send message with <b><i>payload</b></i> to <b><i>topic</b></i>.<br />
<br />
=== Attributes table overview ===<br />
{| class="wikitable"<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Item<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Presence<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Possible Values<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Description<br />
! style="font-weight:bold; background-color:#9b9b9b;" | JSON Config Usage<br />
|-<br />
| style="background-color:#efefef;" | topic<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | see table below<br />
| style="background-color:#efefef;" | definition of the topic, how it is registered towards MQTT broker. Max. 128 characters. <br />
| style="background-color:#efefef;" | "topic":"netio/${DEVICE_NAME}/output/1/load"<br />
|-<br />
| style="background-color:#efefef;" | qos<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | see table below<br />
| 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}<br />
| style="background-color:#efefef;" | <br />
|-<br />
| style="background-color:#efefef;" | retain<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | boolean: true or false<br />
| 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}<br />
| style="background-color:#efefef;" | "retain":true<br />
|-<br />
| style="background-color:#efefef;" | payload<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | see table below<br />
| style="background-color:#efefef;" | definition of the payload, what is send to the MQTT broker.<br />
| style="background-color:#efefef;" | "payload":"${OUTPUTS/1/STATE}"<br />
|-<br />
| style="background-color:#efefef;" | events<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | see table below<br />
| style="background-color:#efefef;" | definition of events used for triggering sending of data via mqtt (change, delta, timer)<br />
| style="background-color:#efefef;" | <br />
|-<br />
| style="background-color:#efefef;" | type<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" |<br />
|-<br />
| style="background-color:#efefef;" | source<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" |<br />
|-<br />
| style="background-color:#efefef;" | delta<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" |<br />
|-<br />
| style="background-color:#efefef;" | period<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" |<br />
| style="background-color:#efefef;" |<br />
|-<br />
| style="background-color:#efefef;" | payloaddef<sup>Not supported yet</sup><br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" |<br />
|}<br />
<br />
=== Examples ===<br />
==== Publish energy periodically (event timer) ==== <br />
==== Publish current on change (delta) ==== <br />
==== Publish output state ====<br />
==== Publish to more than one topic with different events ====<br />
<br />
= Target / Source =<br />
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.<br />
<br />
* <b>source</b> - specifies from where the value will be read (specifies the source of data for payload, change detection, delta calculation)<br />
* <b>target</b> - specifies where the data should be sent or command applied (e.g. specifies the target for ACTION)<br />
<br />
=== INPUT / OUTPUT (Target) selection ===<br />
<br />
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.<br />
<br />
# At first specify if requested variable is from/for INPUT or OUTPUT using keywords <b>"OUTPUTS"</b> or <b>"INPUTS"</b> .<br />
# Add <b>"/"</b> separator<br />
# Specify the number of INPUT/OUTPUT to <b>1</b>(or TOTAL for summary statistics if available)<br />
# Add <b>"/"</b> separator<br />
# Specify requested variable or command<br />
<br />
<b>Note:</b> Not all of OUTPUTS/INPUTS support all variables. Available variables are closely connected with the device functions and I/O features.<br />
<br />
<b>Note2:</b> INPUTS available only on NETIO PowerDIN 4PZ<br />
<br />
=== Examples: ===<br />
<br />
adressing controll of output 3<br />
OUTPUTS/3/ACTION<br />
getting voltage on output 1<br />
OUTPUTS/1/VOLTAGE<br />
getting state of input 1<br />
INPUTS/1/STATE<br />
getting temperature [C] - sensor connected of input 1<br />
INPUTS/1/TEMP<br />
getting temperature [F] - sensor connected of input 2<br />
INPUTS/2/TEMPF<br />
getting humidity [%] - sensor connected of input 2<br />
INPUTS/2/HUMIDITY<br />
<br />
= Group Events<sup><code>FW 4.0.0+</code></sup> =<br />
Group events are smart way how to keep configuration simple. It is not replacement of publish section specification but it is extension to trigger group of different topics to be published on the same event.<br />
<br />
See the example below. There is specific event on status change on every output and additionally the device sends periodic status every 60 seconds.<br />
<br />
{<br />
"broker": {<br />
"clientid": "netio${DEVICE_SN}",<br />
"keepalive": 30,<br />
"password": "",<br />
"port": 1883,<br />
"protocol": "mqtt",<br />
"ssl": false,<br />
"type": "generic",<br />
"url": "broker.hivemq.com",<br />
"username": ""<br />
},<br />
<b>"groupEvents": [<br />
{<br />
"events":[<br />
{<br />
"period": 60,<br />
"type": "timer"<br />
}<br />
],<br />
"appliedTopics":[<br />
"devices/${DEVICE_NAME}/output/1/state",<br />
"devices/${DEVICE_NAME}/output/2/state"<br />
]<br />
}<br />
],</b><br />
"publish": [<br />
{<br />
"events": [<br />
{<br />
"source": "OUTPUTS/1/STATE",<br />
"type": "change"<br />
}<br />
],<br />
"payload": "${OUTPUTS/1/STATE}",<br />
"qos": 0,<br />
"retain": false,<br />
<b> "topic": "devices/${DEVICE_NAME}/output/1/state"</b><br />
},{<br />
"events": [<br />
{<br />
"source": "OUTPUTS/2/STATE",<br />
"type": "change"<br />
}<br />
],<br />
"payload": "${OUTPUTS/2/STATE}",<br />
"qos": 0,<br />
"retain": false,<br />
<b> "topic": "devices/${DEVICE_NAME}/output/2/state"</b><br />
}<br />
]<br />
}<br />
<br />
= Variables =<br />
In some parameters is nescessary to use variables to get current state and measurements. <b>Variables are separated in two categories:</b><br />
<br />
* Target/Source variables<br />
* Payload Topic variables<br />
<br />
== Target Source Variables ==<br />
<br />
The list of available variables for each <br />
<br />
=== OUTPUTS variables ===<br />
==== VOLTAGE ====<br />
Unit: <code>V</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Present RMS voltage on output 1 is ${OUTPUTS/1/VOLTAGE}"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/VOLTAGE}"</code><br />
<br />
==== CURRENT ====<br />
Unit: <code>mA</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Present RMS current on output 1 is ${OUTPUTS/1/CURRENT}"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/CURRENT}"</code><br />
<br />
==== POWER_FACTOR ====<br />
Unit: <code>[-]</code><br />
<br />
Type: float (2 decimals)<br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"True Power Factor on output 1 is ${OUTPUTS/1/POWER_FACTOR}"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/POWER_FACTOR}"</code><br />
<br />
==== LOAD ====<br />
Unit: <code>W</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Present load on output 1 is ${OUTPUTS/1/LOAD}W"</code><br />
<br />
Example 2: <code>"payload":"Device's load connected to output 1 is ${OUTPUTS/1/LOAD}W"</code><br />
<br />
Example 3: <code>"source":"${OUTPUTS/1/LOAD}"</code><br />
<br />
==== STATE ====<br />
Type: bool(integer) - <code>0</code> or <code>1</code><br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Present output 1 state is ${OUTPUTS/1/STATE}"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/STATE}"</code><br />
<br />
==== ACTION ====<br />
Type: integer<br />
<br />
Possible actions:<br />
* <code>0</code> - set state OFF<br />
* <code>1</code> - set state ON<br />
* <code>2</code> - short OFF (restart)<br />
* <code>3</code> - short ON<br />
* <code>4</code> - toggle (switch)<br />
* <code>5</code> - no change<br />
<br />
Allowed in: <code>"target"</code><br />
<br />
Example: <code>"target":"OUTPUTS/1/ACTION"</code><br />
<br />
==== DELAY [ms] ====<br />
==== NAME ====<br />
==== FREQUENCY ====<br />
Unit: <code>Hz</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example: <code>"payload":"Frequency in power grid is ${OUTPUTS/1/ENERGY}Hz"</code><br />
<br />
==== ENERGY ====<br />
Energy consumed by an device connected to NETIO device output.<br />
<br />
Unit: <code>Wh</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Consumed energy on output 1 is ${OUTPUTS/1/ENERGY}Wh"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/ENERGY}"</code><br />
<br />
==== REVERSE_ENERGY ====<br />
Energy delivered back to grid. For example from solar system connected to NETIO device output.<br />
<br />
Unit: <code>Wh</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Delivered energy on output 1 is ${OUTPUTS/1/REVERSE_ENERGY}Wh"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/REVERSE_ENERGY}"</code><br />
<br />
<br />
==== ENERGY_START ====<br />
Date when the counters ENERGY and REVERSE_ENERGY have been resetted by user.<br />
<br />
Unit: <code>unix timestamp</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code><br />
<br />
Example 1: <code>"payload":"Energy measured since ${OUTPUTS/1/ENERGY_START} unix time"</code><br />
<br />
Example 2: <code>"payload":"${OUTPUTS/1/ENERGY_START}"</code> is output payload <code>1567654639</code><br />
<br />
==== ENERGY_START_FMT ====<br />
Date when the counters ENERGY and REVERSE_ENERGY have been resetted by user.<br />
<br />
Unit: <code>fmt date format</code><br />
<br />
Type: string <br />
<br />
Allowed in: <code>"payload"</code><br />
<br />
Example 1: <code>"payload":"Energy measured since ${OUTPUTS/1/ENERGY_START}"</code><br />
<br />
Example 2: <code>"payload":"${OUTPUTS/1/ENERGY_START_FMT}"</code> is output payload <code>2019-09-05T03:37:19+00:00</code><br />
<br />
==== ENERGY_NR ====<br />
Non-resettable counter of Energy consumed by an device connected to NETIO device output.<br />
<br />
Unit: <code>Wh</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Consumed energy on output 1 is ${OUTPUTS/1/ENERGY_NR}Wh"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/ENERGY_NR}"</code><br />
<br />
==== REVERSE_ENERGY_NR ====<br />
Non-resettable counter of Energy delivered back to grid. For example from solar system connected to NETIO device output.<br />
<br />
Unit: <code>Wh</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Delivered energy on output 1 is ${OUTPUTS/1/REVERSE_ENERGY_NR}Wh"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/REVERSE_ENERGY_NR}"</code><br />
<br />
<br />
<br />
==== TOTALs - for use with devices having more than 1 measured output ====<br />
<br />
* OUTPUTS/TOTAL/ENERGY<br />
* OUTPUTS/TOTAL/LOAD<br />
* OUTPUTS/TOTAL/CURRENT<br />
* OUTPUTS/TOTAL/VOLTAGE<br />
* OUTPUTS/TOTAL/POWER_FACTOR<br />
* OUTPUTS/TOTAL/FREQUENCY<br />
* OUTPUTS/TOTAL/PHASE<br />
* OUTPUTS/TOTAL/REVERSE_ENERGY<br />
* OUTPUTS/TOTAL/ENERGY_NR<br />
* OUTPUTS/TOTAL/REVERSE_ENERGY_NR<br />
* OUTPUTS/TOTAL/ENERGY_START<br />
* OUTPUTS/TOTAL/ENERGY_START_FMT<br />
<br />
<br />
==== REST_JSON ====<br />
Allow use of NETIO JSON structure to control outputs.<br />
<br />
Type: string / JSON<br />
<br />
Allowed in: <code>"target"</code> for Subscribe section<br />
<br />
Example: <code>"target": "REST_JSON"</code><br />
<br />
The payload is JSON structure identical to NETIO JSON API M2M Protocol (documentation available at https://www.netio-products.com/files/NETIO-M2M-API-Protocol-JSON.pdf). You can control one or multiple outputs.<br />
<br />
Payload example 1 - Toggle output 1: <code>{"Outputs":[{"ID": 1,"Action": 4}]}</code><br />
<br />
Payload example 2 - Turn output 1 OFF and output 3 ON: <code>{"Outputs":[{"ID":1,"Action":0},{"ID":3,"Action":1}]}</code><br />
<br />
=== INPUT variables ===<br />
==== STATE ====<br />
Type: bool(integer) - <code>0</code> or <code>1</code><br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Present input 1 state is ${INPUTS/1/STATE}"</code><br />
<br />
Example 2: <code>"source":"${INPUTS/1/STATE}"</code><br />
<br />
==== S0 ====<br />
S0 Counter value<br />
Unit: <code>-</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Input 1 S0 Counter value is ${INPUTS/1/S0}impulses"</code><br />
<br />
Example 2: <code>"source":"${INPUTS/1/S0}"</code><br />
<br />
==== TEMPERATURE ====<br />
Temperature measurement in Celsius, Fahrenheit<br />
* In case of a disconnected sensor or a malfunction, the return value is <strong>999<strong> *<br />
Unit: <code> [C], [F] </code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Input 1 Temperature value in degree of Celsius is ${INPUTS/1/TEMP} [C] "</code><br />
<br />
Example 2: <code>"source":"${INPUTS/1/TEMP}"</code><br />
<br />
Example 3: <code>"payload":"Input 1 Temperature value in degree of Fahrenheit is ${INPUTS/1/TEMPF} [F] "</code><br />
<br />
Example 4: <code>"source":"${INPUTS/1/TEMPF}"</code><br />
<br />
==== HUMIDITY ====<br />
Relative Humidity measurement <br />
Unit: <code> [%]</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Input 1 Humidity value is ${INPUTS/1/HUMIDITY} %"</code><br />
<br />
Example 2: <code>"source":"${INPUTS/1/HUMIDITY}"</code><br />
<br />
== Payload/topic variables ==<br />
<br />
=== DEVICE_NAME ===<br />
Can be used in: "payload", "topic"<br />
<br />
Example 1: <code>"payload":"${DEVICE_NAME}"</code><br />
<br />
Example 2: <code>"topic":"netio/${DEVICE_NAME}/output/1/action"</code><br />
<br />
=== DEVICE_MAC ===<br />
Can be used in: "payload", "topic"<br />
<br />
Example 1: <code>"payload":"${DEVICE_MAC}"</code><br />
<br />
Example 2: <code>"topic":"netio/${DEVICE_MAC}/output/1/action"</code><br />
<br />
=== UTC_TIME <sup><code>FW 4.0.0+</code></sup>===<br />
<br />
send unix timestamp of devices actual time<br />
<br />
Can be used in: "payload"<br />
<br />
Example 1: <code>"payload": "${UTC_TIME}"</code><br />
<br />
=== UPTIME <sup>Not yet implemented</sup> ===<br />
<br />
=== PAYLOAD ===<br />
Can be used in: "action"<br />
<br />
Example: <code>"action":"${PAYLOAD}"</code><br />
<br />
=== OUTPUT_ID <sup>Not yet implemented</sup>===<br />
<br />
=== WIFI_SIGNAL<sup>Not yet implemented</sup> ===<br />
<br />
=== OUTPUTS_STATUS ===<br />
Provide complete outputs status and measurement if supported.<br />
<br />
Type: string / JSON<br />
<br />
Allowed in: <code>"payload"</code> for Publish section<br />
<br />
Example: <code>"payload":"${OUTPUTS_STATUS}"</code><br />
<br />
Payload example: <code>{ "GlobalMeasure":{"Voltage":236,"TotalCurrent":72,"TotalLoad":11,"TotalEnergy":167,"OverallPowerFactor":0.64,"Frequency":50.07,"Phase":-36.86,"EnergyStart":"2020-06-30T17:04:48+01:00"}, "Outputs":[ {"ID":1,"Name":"Power output 1","State":1,"Action":6,"Delay":2020,"Current":72,"PowerFactor":0.64,"Phase":-36.86,"Energy":139,"ReverseEnergy":0,"Load":11}, {"ID":2,"Name":"Power output 2","State":1,"Action":6,"Delay":2020,"Current":0,"PowerFactor":1.00,"Phase":0.00,"Energy":27,"ReverseEnergy":0,"Load":0}, {"ID":3,"Name":"Free Contact 3","State":1,"Action":6,"Delay":2020}, {"ID":4,"Name":"Free Contact 4","State":1,"Action":6,"Delay":2020} ]}</code><br />
<br />
=== INPUTS_STATUS ===<br />
Provide complete inputs status if supported. Since FW 3.0.0<br />
<br />
Type: string / JSON<br />
<br />
Allowed in: <code>"payload"</code> for Publish section<br />
<br />
Example: <code>"payload":"${INPUTS_STATUS}"</code><br />
<br />
Payload example: <code>{ "Inputs":[ {"ID":1,"Name":"Input 1","State":0,"S0Counter":0}, {"ID":2,"Name":"Input 2","State":0,"S0Counter":0} ]}</code><br />
<br />
=== INOUT_STATUS ===<br />
Provide complete inputs and output status and measurement if supported. Since FW 3.0.0<br />
<br />
Type: string / JSON<br />
<br />
Allowed in: <code>"payload"</code> for Publish section<br />
<br />
Example: <code>"payload":"${INOUT_STATUS}"</code><br />
<br />
Payload example: <code>{ "GlobalMeasure":{"Voltage":238,"TotalCurrent":105,"TotalLoad":17,"TotalEnergy":1451,"OverallPowerFactor":0.67,"Frequency":50.03,"Phase":-33.67,"EnergyStart":"2020-06-30T17:04:48+01:00"}, "Outputs":[ {"ID":1,"Name":"Power output 1","State":0,"Action":6,"Delay":5000,"Current":0,"PowerFactor":1.00,"Phase":0.00,"Energy":701,"ReverseEnergy":0,"Load":0}, {"ID":2,"Name":"Power output 2","State":1,"Action":6,"Delay":5000,"Current":105,"PowerFactor":0.65,"Phase":-33.67,"Energy":750,"ReverseEnergy":0,"Load":17}, {"ID":3,"Name":"Free Contact 3","State":1,"Action":6,"Delay":5000}, {"ID":4,"Name":"Free Contact 4","State":0,"Action":6,"Delay":5000} ], "Inputs":[ {"ID":1,"Name":"Input 1","State":0,"S0Counter":0}, {"ID":2,"Name":"Input 2","State":0,"S0Counter":0} ]}</code><br />
<br />
= Extended MQTT flex JSON config examples =<br />
<br />
== Default NETIO MQTT-flex configuration ==<br />
This example demonstrates setup for connection to public <code>broker.hivemq.com</code>, measurement reporting and output control.<br />
<br />
The device cabe be controlled via <code>netio/${DEVICE_NAME}/output/1/action topic</code> by sending standard NETIO action values:<br />
* 0 - OFF<br />
* 1 - ON<br />
* 2 - SHORT OFF<br />
* 3 - SHORT ON<br />
* 4 - TOGGLE<br />
* 5 - NO ACTION.<br />
<br />
The device report measurements:<br />
<br />
* Output state - every 15 minutes or by change<br />
* Voltage [V]- every 5 minutes or by change of 1 V<br />
* Current [mA]- every 5 minutes or by change of 50 mA<br />
* Load(Power) [W]- every 5 minutes or by change of 10 W<br />
* Energy(Consumption) [Wh]- every 15 minutes or by change of 1Wh<br />
* True Power Factor (TPF) [-]- every 5 minutes or by change of 0.02<br />
* Frequency [Hz]- every 1 hour or by change of 0.1 Hz<br />
<br />
For register all values, you can use wildcard <code>netio/${DEVICE_NAME}/output/1/#</code><br />
<br />
{<br />
"config":{<br />
"broker":{<br />
"url":"broker.hivemq.com",<br />
"protocol":"mqtt",<br />
"port":1883,<br />
"ssl":false,<br />
"type":"generic",<br />
"username":"",<br />
"password":"",<br />
"clientid":"moje${DEVICE_NAME}${DEVICE_MAC}",<br />
"keepalive":30<br />
},<br />
"subscribe":[<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/action",<br />
"qos":0,<br />
"target":"OUTPUTS/1/ACTION",<br />
"action":"${payload}"<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/switch",<br />
"qos":0,<br />
"target":"OUTPUTS/1/ACTION",<br />
"action":4<br />
}<br />
],<br />
"publish":[<br />
{<br />
"topic":"netio/${DEVICE_MAC}/output/1/state",<br />
"qos":0,<br />
"retain":true,<br />
"payload":"${OUTPUTS/1/STATE}",<br />
"events":[<br />
{<br />
"type":"change",<br />
"source":"OUTPUTS/1/STATE"<br />
},<br />
{<br />
"type":"timer",<br />
"period":900<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/voltage",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/VOLTAGE}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":300<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/VOLTAGE",<br />
"delta":1<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/current",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/CURRENT}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":300<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/CURRENT",<br />
"delta":50<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/load",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/LOAD}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":300<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/LOAD",<br />
"delta":10<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/energy",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/ENERGY}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":900<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/ENERGY",<br />
"delta":1<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/tpf",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/POWER_FACTOR}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":900<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/POWER_FACTOR",<br />
"delta":0.02<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/frequency",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/FREQUENCY}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":3600<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/FREQUENCY",<br />
"delta":0.1<br />
}<br />
]<br />
}<br />
]<br />
}<br />
}</div>
Tbezstarosta
https://wiki.netio-products.com/index.php?title=MQTT-flex&diff=1085
MQTT-flex
2026-03-17T15:03:36Z
<p>Tbezstarosta: /* TEMPERATURE */</p>
<hr />
<div>The MQTT-flex version of the MQTT protocol can be configured in detail thanks to the “flex” extension.<br />
<br />
https://www.netio-products.com/en/glossary/mqtt-flex <br />
<br />
<b>Why MQTT-flex</b> <br><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.<br />
<br />
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.<br />
<br />
===Supported devices:===<br />
* PowerCable MQTT 101x <br><br />
* PowerCable REST 101x <br><br />
* PowerPDU 4PS <br><br />
* PowerPDU 4KS <br><br />
* PowerPDU 8QS <br><br />
* PowerDIN 4PZ <br><br />
* PowerBOX 3Px <br><br />
* PowerBOX 4Kx <br><br />
<br />
<b>FW version:</b> <br><br />
>2.2.1<br />
<br />
===Not supported NETIO devices:===<br />
* PowerPDU 4C <br><br />
* NETIO 4 <br><br />
* NETIO 4All <br><br />
<br />
= Simple MQTT-flex configuration + explanation =<br />
<br />
''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.''<br />
<br />
{<br />
"config":{<br />
"broker":{<br />
"url":"broker.hivemq.com",<br />
"protocol":"mqtt",<br />
"port":1883,<br />
"ssl":false,<br />
"type":"generic",<br />
"username":"freedom",<br />
"password":"peace|LOVE|empathy4ALL"<br />
},<br />
"subscribe":[{<br />
"topic":"netio/${DEVICE_NAME}/output/1/action",<br />
"qos":0,<br />
"target":"OUTPUTS/1/ACTION",<br />
"action":"${payload}"<br />
}<br />
],<br />
"publish":[{<br />
"topic":"netio/${DEVICE_NAME}/output/1/state",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/STATE}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":"1000"<br />
}<br />
]<br />
}<br />
]<br />
}<br />
}<br />
=== Client Configuration (broker section) ===<br />
Put here MQTT client connection setup<br />
<br />
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>. <br />
<br />
"broker":{<br />
"url":"broker.hivemq.com",<br />
"protocol":"mqtt",<br />
"port":1883,<br />
"ssl":false,<br />
"type":"generic",<br />
"username":"freedom",<br />
"password":"peace|LOVE|empathy4ALL"<br />
},<br />
<br />
=== Device Control (subscribe section) ===<br />
Put here array of topics where to subscribe<br />
<br />
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> <br />
<br />
"subscribe":[{<br />
"topic":"netio/${DEVICE_NAME}/output/1/action",<br />
"qos":0,<br />
"target":"OUTPUTS/1/ACTION",<br />
"action":"${payload}"<br />
}<br />
],<br />
<br />
=== Output State monitoring (publish section) ===<br />
Put here array of topics where to publish.<br />
<br />
Device send every <b>1000 s</b> message to topic <b></b> with <b>QOS 0</b>, <b>retain true</b> information with <b>output 1 state</b><br />
<br />
"publish":[{<br />
"topic":"netio/${DEVICE_NAME}/output/1/state",<br />
"qos":0,<br />
"retain":true,<br />
"payload":"${OUTPUTS/1/STATE}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":"1000"<br />
}<br />
]<br />
}<br />
]<br />
<br />
= Config sections =<br />
<br />
== Broker ==<br />
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 />
<br /><br />
=== Attributes table overview ===<br />
{| class="wikitable"<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Item<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Presence<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Possible Values<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Description<br />
! style="font-weight:bold; background-color:#9b9b9b;" | JSON Config Usage<br />
|-<br />
| style="background-color:#efefef;" | url<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | MQTT broker URL<br />
| style="background-color:#efefef;" | "url":"broker.hivemq.com"<br />
|-<br />
| style="background-color:#efefef;" | port<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | 1 - 65535<br />
| style="background-color:#efefef;" | MQTT broker port<br />
| style="background-color:#efefef;" | "port":1883<br />
|-<br />
| style="background-color:#efefef;" | protocol<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | protocol spec - mqtt<br />
| style="background-color:#efefef;" | "protocol": "mqtt"<br />
|-<br />
| style="background-color:#efefef;" | ssl<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | true, false<br />
| style="background-color:#efefef;" | Use SSL crypted communication selector<br />
| style="background-color:#efefef;" | "ssl":false<br />
|-<br />
| style="background-color:#efefef;" | type<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | generic<br />
| style="background-color:#efefef;" | Communication/setup type option<br />
| style="background-color:#efefef;" | "type":"generic"<br />
|-<br />
| style="background-color:#efefef;" | username<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | regexp+len<br />
| style="background-color:#efefef;" | Credentials for MQTT broker. Max. 128 characters (since FW 3.2.4).<br />
| style="background-color:#efefef;" | "username":"freedom"<br />
|-<br />
| style="background-color:#efefef;" | password<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | regexp+len<br />
| style="background-color:#efefef;" | Credentials for MQTT broker. Max. 256 characters (since FW 3.2.4).<br />
| style="background-color:#efefef;" | "password":"peace|LOVE|empathy4ALL"<br />
|-<br />
| style="background-color:#efefef;" | clientid<br />
| style="background-color:#efefef;" | optional<br />
| style="background-color:#efefef;" | regexp+len<br />
| style="background-color:#efefef;" | MQTT clientid. Max. 128 characters (since FW 3.2.4). Variables ${DEVICE_MAC} or ${DEVICE_NAME} can be used<br />
| style="background-color:#efefef;" | "clientid":"myEcoTable01"<br />
|-<br />
| style="background-color:#efefef;" | keepalive<br />
| style="background-color:#efefef;" | optional<br />
| style="background-color:#efefef;" | 1 - 65535<br />
| style="background-color:#efefef;" | MQTT keep alive period in seconds<br />
| style="background-color:#efefef;" | "keepalive":90<br />
|}<br />
<br />
Note 1: <b>clientid</b> attribute is <b>mandatory for MQTT(s)</b> communication. When not configured, random ID will be generated.<br />
<br />
Note 2: To proper communication with MS Azure - it is necessary to set up IoT Hub to use TLS 1.2<br />
<br />
See section "TLS 1.2 enforcement available in select regions" in following guidelines https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-tls-support<br />
<br />
=== Examples ===<br />
==== Standard setup ====<br />
<br />
<br />
==== Security (SSL / TLS) secured setup ====<br />
You can enable MQTTs by using the encrypted port <b>8883</b> + <b>"ssl":true</b>.<br />
<br />
==== Variables used setup ====<br />
<br />
== Subscribe ==<br />
=== Hints to usage ===<br />
When receive message in <b><i>topic</b></i> do <b><i>action</b></i> on <b><i>target</b></i>.<br />
<br />
<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>.<br />
<br />
=== Attributes table overview ===<br />
{| class="wikitable"<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Item<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Presence<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Possible Values<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Description<br />
! style="font-weight:bold; background-color:#9b9b9b;" | JSON Config Usage<br />
|-<br />
| style="background-color:#efefef;" | topic<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | see table below<br />
| style="background-color:#efefef;" | specification of the topic, which MQTT-flex device listens from broker and act accordingly. Max. 128 characters. The "#" can be used since FW 3.2.4 - see note under this table.<br />
| style="background-color:#efefef;" | "topic":"netio/${DEVICE_NAME}/output/1/action"<br />
|-<br />
| style="background-color:#efefef;" | qos<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | 0, 1 or 2<br />
| 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}<br />
| style="background-color:#efefef;" | "qos":0<br />
|-<br />
| style="background-color:#efefef;" | target<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | internal definition of action, which can be performed above the specified output<br />
| style="background-color:#efefef;" | "target":"OUTPUTS/1/ACTION"<br />
|-<br />
| style="background-color:#efefef;" | action<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | a payload or a value the action attribute needs to have passed to<br />
| style="background-color:#efefef;" | "action":"${payload}"<br />
|-<br />
| style="background-color:#efefef;" | actiondef<sup>Not supported yet</sup><br />
| style="background-color:#efefef;" | optional<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
|-<br />
| style="background-color:#efefef;" | json<sup>Not supported yet</sup><br />
| style="background-color:#efefef;" | optional<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
|}<br />
<br />
Note: The "#" wildcard can be used in subscribe topic definition. The multi-level wildcard character MUST be specified either on its own or following a topic level separator. In either case it MUST be the last character specified in the Topic.<br />
<br />
For example, if a Device subscribes to “devices/{device_id}/messages/devicebound/#”, it would receive messages published using these topic names:<br />
<br />
“devices/{device_id}/messages/devicebound/”<br />
<br />
“devices/{device_id}/messages/devicebound/{property_bag}”<br />
<br />
This should be usefull for use with MS Azure - IoT hub.<br />
<br />
=== MQTT Subscribe as event to trigger action <sup><code>FW 4.0.0+</code></sup> ===<br />
<br />
This feature allow to subscribe to specific MQTT topic and pass payload to Rules or MQTT-flex as event.<br />
<br />
target: <code>PROTOCOLS/MQTT/EVENT</code><br />
<br />
"subscribe": [<br />
{<br />
"action": "${payload}",<br />
"qos": 0,<br />
"target": "PROTOCOLS/MQTT/EVENT",<br />
"topic": "broker/12345/MQTT_EVENT/"<br />
}<br />
]<br />
<br />
=== Examples ===<br />
==== Toggle output with standard payload ==== <br />
==== Toggle output with custom payload ==== <br />
==== Subscribe to more than one topic ====<br />
==== Trigger Rule and MQTT publish from MQTT subscribe <sup><code>FW 4.0.0+</code></sup> ====<br />
This example show Request response implementation in MQTT and toggle action made by Rules.<br />
<br />
When message with payload <code>getValues</code> is published to topic <code>broker/gv90018g/COMMAND</code> MQTT flex will create an event with name <code>PROTOCOLS/MQTT/EVENT</code> (fixed name cannot be changed) and value <code>getValues</code>. On this event will act all events and conditions set in MQTT-flex and Rules which are set to listening to change on <code>PROTOCOLS/MQTT/EVENT</code> and equals to value <code>getValues</code>. See <b>bold</b> marked parameters in example configuration below. <br />
<br />
Once the triggered action is done it is needed to reset MQTT channel to <code>OK</code> status becaus event are reacting only to change. If the channel is not reset the next even would not be triggered.<br />
<br />
<b>Rules Configuration:</b><br />
{<br />
"conditions": {<br />
<b>"PROTOCOLS/MQTT/EVENT": "getValues"</b><br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 4<br />
}<br />
}<br />
<br />
<b>MQTT Configuration:</b><br />
{<br />
"broker":{<br />
"clientid":"netio${DEVICE_SN}",<br />
"keepalive":30,<br />
"password":"abcdefghijk",<br />
"port":8883,<br />
"protocol":"mqtt",<br />
"ssl":true,<br />
"type":"generic",<br />
"url":"broker.cloud.netio.eu",<br />
"username":"gv90018g"<br />
},<br />
"groupEvents":[<br />
{<br />
"events":[<br />
{<br />
<b>"source":"PROTOCOLS/MQTT/EVENT",<br />
"type":"change",<br />
"value":"getValues"</b><br />
}<br />
],<br />
"appliedTopics":[<br />
"broker/gv90018g/OUTPUTS/1/STATE",<br />
<b>"broker/gv90018g/COMMAND"</b><br />
]<br />
}<br />
],<br />
"publish":[<br />
{<br />
"payload":"${OUTPUTS/1/STATE}",<br />
"qos":0,<br />
"retain":true,<br />
"topic":"broker/gv90018g/OUTPUTS/1/STATE"<br />
},<br />
{<br />
"payload":"OK",<br />
"qos":0,<br />
"retain":true,<br />
"topic":"broker/gv90018g/COMMAND"<br />
}<br />
],<br />
"subscribe":[<br />
{<br />
"action":"${payload}",<br />
"qos":0,<br />
<b>"target":"PROTOCOLS/MQTT/EVENT"</b>,<br />
"topic":"broker/gv90018g/COMMAND"<br />
}<br />
]<br />
}<br />
<br />
<br />
<br />
Subscribe topic payload values specification for control of the output:<br />
<br />
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)<br />
<br />
== Publish ==<br />
<br />
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)<br />
<br />
=== Hints to usage ===<br />
When <b><i>event</b></i> send message with <b><i>payload</b></i> to <b><i>topic</b></i>.<br />
<br />
=== Attributes table overview ===<br />
{| class="wikitable"<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Item<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Presence<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Possible Values<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Description<br />
! style="font-weight:bold; background-color:#9b9b9b;" | JSON Config Usage<br />
|-<br />
| style="background-color:#efefef;" | topic<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | see table below<br />
| style="background-color:#efefef;" | definition of the topic, how it is registered towards MQTT broker. Max. 128 characters. <br />
| style="background-color:#efefef;" | "topic":"netio/${DEVICE_NAME}/output/1/load"<br />
|-<br />
| style="background-color:#efefef;" | qos<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | see table below<br />
| 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}<br />
| style="background-color:#efefef;" | <br />
|-<br />
| style="background-color:#efefef;" | retain<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | boolean: true or false<br />
| 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}<br />
| style="background-color:#efefef;" | "retain":true<br />
|-<br />
| style="background-color:#efefef;" | payload<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | see table below<br />
| style="background-color:#efefef;" | definition of the payload, what is send to the MQTT broker.<br />
| style="background-color:#efefef;" | "payload":"${OUTPUTS/1/STATE}"<br />
|-<br />
| style="background-color:#efefef;" | events<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | see table below<br />
| style="background-color:#efefef;" | definition of events used for triggering sending of data via mqtt (change, delta, timer)<br />
| style="background-color:#efefef;" | <br />
|-<br />
| style="background-color:#efefef;" | type<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" |<br />
|-<br />
| style="background-color:#efefef;" | source<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" |<br />
|-<br />
| style="background-color:#efefef;" | delta<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" |<br />
|-<br />
| style="background-color:#efefef;" | period<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" |<br />
| style="background-color:#efefef;" |<br />
|-<br />
| style="background-color:#efefef;" | payloaddef<sup>Not supported yet</sup><br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" |<br />
|}<br />
<br />
=== Examples ===<br />
==== Publish energy periodically (event timer) ==== <br />
==== Publish current on change (delta) ==== <br />
==== Publish output state ====<br />
==== Publish to more than one topic with different events ====<br />
<br />
= Target / Source =<br />
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.<br />
<br />
* <b>source</b> - specifies from where the value will be read (specifies the source of data for payload, change detection, delta calculation)<br />
* <b>target</b> - specifies where the data should be sent or command applied (e.g. specifies the target for ACTION)<br />
<br />
=== INPUT / OUTPUT (Target) selection ===<br />
<br />
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.<br />
<br />
# At first specify if requested variable is from/for INPUT or OUTPUT using keywords <b>"OUTPUTS"</b> or <b>"INPUTS"</b> .<br />
# Add <b>"/"</b> separator<br />
# Specify the number of INPUT/OUTPUT to <b>1</b>(or TOTAL for summary statistics if available)<br />
# Add <b>"/"</b> separator<br />
# Specify requested variable or command<br />
<br />
<b>Note:</b> Not all of OUTPUTS/INPUTS support all variables. Available variables are closely connected with the device functions and I/O features.<br />
<br />
<b>Note2:</b> INPUTS available only on NETIO PowerDIN 4PZ<br />
<br />
=== Examples: ===<br />
<br />
adressing controll of output 3<br />
OUTPUTS/3/ACTION<br />
getting voltage on output 1<br />
OUTPUTS/1/VOLTAGE<br />
getting state of input 1<br />
INPUTS/1/STATE<br />
getting temperature [C] - sensor connected of input 1<br />
INPUTS/1/TEMP<br />
getting temperature [F] - sensor connected of input 2<br />
INPUTS/2/TEMPF<br />
getting humidity [%] - sensor connected of input 2<br />
INPUTS/2/HUMIDITY<br />
<br />
= Group Events<sup><code>FW 4.0.0+</code></sup> =<br />
Group events are smart way how to keep configuration simple. It is not replacement of publish section specification but it is extension to trigger group of different topics to be published on the same event.<br />
<br />
See the example below. There is specific event on status change on every output and additionally the device sends periodic status every 60 seconds.<br />
<br />
{<br />
"broker": {<br />
"clientid": "netio${DEVICE_SN}",<br />
"keepalive": 30,<br />
"password": "",<br />
"port": 1883,<br />
"protocol": "mqtt",<br />
"ssl": false,<br />
"type": "generic",<br />
"url": "broker.hivemq.com",<br />
"username": ""<br />
},<br />
<b>"groupEvents": [<br />
{<br />
"events":[<br />
{<br />
"period": 60,<br />
"type": "timer"<br />
}<br />
],<br />
"appliedTopics":[<br />
"devices/${DEVICE_NAME}/output/1/state",<br />
"devices/${DEVICE_NAME}/output/2/state"<br />
]<br />
}<br />
],</b><br />
"publish": [<br />
{<br />
"events": [<br />
{<br />
"source": "OUTPUTS/1/STATE",<br />
"type": "change"<br />
}<br />
],<br />
"payload": "${OUTPUTS/1/STATE}",<br />
"qos": 0,<br />
"retain": false,<br />
<b> "topic": "devices/${DEVICE_NAME}/output/1/state"</b><br />
},{<br />
"events": [<br />
{<br />
"source": "OUTPUTS/2/STATE",<br />
"type": "change"<br />
}<br />
],<br />
"payload": "${OUTPUTS/2/STATE}",<br />
"qos": 0,<br />
"retain": false,<br />
<b> "topic": "devices/${DEVICE_NAME}/output/2/state"</b><br />
}<br />
]<br />
}<br />
<br />
= Variables =<br />
In some parameters is nescessary to use variables to get current state and measurements. <b>Variables are separated in two categories:</b><br />
<br />
* Target/Source variables<br />
* Payload Topic variables<br />
<br />
== Target Source Variables ==<br />
<br />
The list of available variables for each <br />
<br />
=== OUTPUTS variables ===<br />
==== VOLTAGE ====<br />
Unit: <code>V</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Present RMS voltage on output 1 is ${OUTPUTS/1/VOLTAGE}"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/VOLTAGE}"</code><br />
<br />
==== CURRENT ====<br />
Unit: <code>mA</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Present RMS current on output 1 is ${OUTPUTS/1/CURRENT}"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/CURRENT}"</code><br />
<br />
==== POWER_FACTOR ====<br />
Unit: <code>[-]</code><br />
<br />
Type: float (2 decimals)<br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"True Power Factor on output 1 is ${OUTPUTS/1/POWER_FACTOR}"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/POWER_FACTOR}"</code><br />
<br />
==== LOAD ====<br />
Unit: <code>W</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Present load on output 1 is ${OUTPUTS/1/LOAD}W"</code><br />
<br />
Example 2: <code>"payload":"Device's load connected to output 1 is ${OUTPUTS/1/LOAD}W"</code><br />
<br />
Example 3: <code>"source":"${OUTPUTS/1/LOAD}"</code><br />
<br />
==== STATE ====<br />
Type: bool(integer) - <code>0</code> or <code>1</code><br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Present output 1 state is ${OUTPUTS/1/STATE}"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/STATE}"</code><br />
<br />
==== ACTION ====<br />
Type: integer<br />
<br />
Possible actions:<br />
* <code>0</code> - set state OFF<br />
* <code>1</code> - set state ON<br />
* <code>2</code> - short OFF (restart)<br />
* <code>3</code> - short ON<br />
* <code>4</code> - toggle (switch)<br />
* <code>5</code> - no change<br />
<br />
Allowed in: <code>"target"</code><br />
<br />
Example: <code>"target":"OUTPUTS/1/ACTION"</code><br />
<br />
==== DELAY [ms] ====<br />
==== NAME ====<br />
==== FREQUENCY ====<br />
Unit: <code>Hz</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example: <code>"payload":"Frequency in power grid is ${OUTPUTS/1/ENERGY}Hz"</code><br />
<br />
==== ENERGY ====<br />
Energy consumed by an device connected to NETIO device output.<br />
<br />
Unit: <code>Wh</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Consumed energy on output 1 is ${OUTPUTS/1/ENERGY}Wh"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/ENERGY}"</code><br />
<br />
==== REVERSE_ENERGY ====<br />
Energy delivered back to grid. For example from solar system connected to NETIO device output.<br />
<br />
Unit: <code>Wh</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Delivered energy on output 1 is ${OUTPUTS/1/REVERSE_ENERGY}Wh"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/REVERSE_ENERGY}"</code><br />
<br />
<br />
==== ENERGY_START ====<br />
Date when the counters ENERGY and REVERSE_ENERGY have been resetted by user.<br />
<br />
Unit: <code>unix timestamp</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code><br />
<br />
Example 1: <code>"payload":"Energy measured since ${OUTPUTS/1/ENERGY_START} unix time"</code><br />
<br />
Example 2: <code>"payload":"${OUTPUTS/1/ENERGY_START}"</code> is output payload <code>1567654639</code><br />
<br />
==== ENERGY_START_FMT ====<br />
Date when the counters ENERGY and REVERSE_ENERGY have been resetted by user.<br />
<br />
Unit: <code>fmt date format</code><br />
<br />
Type: string <br />
<br />
Allowed in: <code>"payload"</code><br />
<br />
Example 1: <code>"payload":"Energy measured since ${OUTPUTS/1/ENERGY_START}"</code><br />
<br />
Example 2: <code>"payload":"${OUTPUTS/1/ENERGY_START_FMT}"</code> is output payload <code>2019-09-05T03:37:19+00:00</code><br />
<br />
==== ENERGY_NR ====<br />
Non-resettable counter of Energy consumed by an device connected to NETIO device output.<br />
<br />
Unit: <code>Wh</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Consumed energy on output 1 is ${OUTPUTS/1/ENERGY_NR}Wh"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/ENERGY_NR}"</code><br />
<br />
==== REVERSE_ENERGY_NR ====<br />
Non-resettable counter of Energy delivered back to grid. For example from solar system connected to NETIO device output.<br />
<br />
Unit: <code>Wh</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Delivered energy on output 1 is ${OUTPUTS/1/REVERSE_ENERGY_NR}Wh"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/REVERSE_ENERGY_NR}"</code><br />
<br />
<br />
<br />
==== TOTALs - for use with devices having more than 1 measured output ====<br />
<br />
* OUTPUTS/TOTAL/ENERGY<br />
* OUTPUTS/TOTAL/LOAD<br />
* OUTPUTS/TOTAL/CURRENT<br />
* OUTPUTS/TOTAL/VOLTAGE<br />
* OUTPUTS/TOTAL/POWER_FACTOR<br />
* OUTPUTS/TOTAL/FREQUENCY<br />
* OUTPUTS/TOTAL/PHASE<br />
* OUTPUTS/TOTAL/REVERSE_ENERGY<br />
* OUTPUTS/TOTAL/ENERGY_NR<br />
* OUTPUTS/TOTAL/REVERSE_ENERGY_NR<br />
* OUTPUTS/TOTAL/ENERGY_START<br />
* OUTPUTS/TOTAL/ENERGY_START_FMT<br />
<br />
<br />
==== REST_JSON ====<br />
Allow use of NETIO JSON structure to control outputs.<br />
<br />
Type: string / JSON<br />
<br />
Allowed in: <code>"target"</code> for Subscribe section<br />
<br />
Example: <code>"target": "REST_JSON"</code><br />
<br />
The payload is JSON structure identical to NETIO JSON API M2M Protocol (documentation available at https://www.netio-products.com/files/NETIO-M2M-API-Protocol-JSON.pdf). You can control one or multiple outputs.<br />
<br />
Payload example 1 - Toggle output 1: <code>{"Outputs":[{"ID": 1,"Action": 4}]}</code><br />
<br />
Payload example 2 - Turn output 1 OFF and output 3 ON: <code>{"Outputs":[{"ID":1,"Action":0},{"ID":3,"Action":1}]}</code><br />
<br />
=== INPUT variables ===<br />
==== STATE ====<br />
Type: bool(integer) - <code>0</code> or <code>1</code><br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Present input 1 state is ${INPUTS/1/STATE}"</code><br />
<br />
Example 2: <code>"source":"${INPUTS/1/STATE}"</code><br />
<br />
==== S0 ====<br />
S0 Counter value<br />
Unit: <code>-</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Input 1 S0 Counter value is ${INPUTS/1/S0}impulses"</code><br />
<br />
Example 2: <code>"source":"${INPUTS/1/S0}"</code><br />
<br />
==== TEMPERATURE ====<br />
Temperature measurement in Celsius, Fahrenheit<br />
** In case of a disconnected sensor or a malfunction, the return value is 999 **<br />
Unit: <code> [C], [F] </code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Input 1 Temperature value in degree of Celsius is ${INPUTS/1/TEMP} [C] "</code><br />
<br />
Example 2: <code>"source":"${INPUTS/1/TEMP}"</code><br />
<br />
Example 3: <code>"payload":"Input 1 Temperature value in degree of Fahrenheit is ${INPUTS/1/TEMPF} [F] "</code><br />
<br />
Example 4: <code>"source":"${INPUTS/1/TEMPF}"</code><br />
<br />
==== HUMIDITY ====<br />
Relative Humidity measurement <br />
Unit: <code> [%]</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Input 1 Humidity value is ${INPUTS/1/HUMIDITY} %"</code><br />
<br />
Example 2: <code>"source":"${INPUTS/1/HUMIDITY}"</code><br />
<br />
== Payload/topic variables ==<br />
<br />
=== DEVICE_NAME ===<br />
Can be used in: "payload", "topic"<br />
<br />
Example 1: <code>"payload":"${DEVICE_NAME}"</code><br />
<br />
Example 2: <code>"topic":"netio/${DEVICE_NAME}/output/1/action"</code><br />
<br />
=== DEVICE_MAC ===<br />
Can be used in: "payload", "topic"<br />
<br />
Example 1: <code>"payload":"${DEVICE_MAC}"</code><br />
<br />
Example 2: <code>"topic":"netio/${DEVICE_MAC}/output/1/action"</code><br />
<br />
=== UTC_TIME <sup><code>FW 4.0.0+</code></sup>===<br />
<br />
send unix timestamp of devices actual time<br />
<br />
Can be used in: "payload"<br />
<br />
Example 1: <code>"payload": "${UTC_TIME}"</code><br />
<br />
=== UPTIME <sup>Not yet implemented</sup> ===<br />
<br />
=== PAYLOAD ===<br />
Can be used in: "action"<br />
<br />
Example: <code>"action":"${PAYLOAD}"</code><br />
<br />
=== OUTPUT_ID <sup>Not yet implemented</sup>===<br />
<br />
=== WIFI_SIGNAL<sup>Not yet implemented</sup> ===<br />
<br />
=== OUTPUTS_STATUS ===<br />
Provide complete outputs status and measurement if supported.<br />
<br />
Type: string / JSON<br />
<br />
Allowed in: <code>"payload"</code> for Publish section<br />
<br />
Example: <code>"payload":"${OUTPUTS_STATUS}"</code><br />
<br />
Payload example: <code>{ "GlobalMeasure":{"Voltage":236,"TotalCurrent":72,"TotalLoad":11,"TotalEnergy":167,"OverallPowerFactor":0.64,"Frequency":50.07,"Phase":-36.86,"EnergyStart":"2020-06-30T17:04:48+01:00"}, "Outputs":[ {"ID":1,"Name":"Power output 1","State":1,"Action":6,"Delay":2020,"Current":72,"PowerFactor":0.64,"Phase":-36.86,"Energy":139,"ReverseEnergy":0,"Load":11}, {"ID":2,"Name":"Power output 2","State":1,"Action":6,"Delay":2020,"Current":0,"PowerFactor":1.00,"Phase":0.00,"Energy":27,"ReverseEnergy":0,"Load":0}, {"ID":3,"Name":"Free Contact 3","State":1,"Action":6,"Delay":2020}, {"ID":4,"Name":"Free Contact 4","State":1,"Action":6,"Delay":2020} ]}</code><br />
<br />
=== INPUTS_STATUS ===<br />
Provide complete inputs status if supported. Since FW 3.0.0<br />
<br />
Type: string / JSON<br />
<br />
Allowed in: <code>"payload"</code> for Publish section<br />
<br />
Example: <code>"payload":"${INPUTS_STATUS}"</code><br />
<br />
Payload example: <code>{ "Inputs":[ {"ID":1,"Name":"Input 1","State":0,"S0Counter":0}, {"ID":2,"Name":"Input 2","State":0,"S0Counter":0} ]}</code><br />
<br />
=== INOUT_STATUS ===<br />
Provide complete inputs and output status and measurement if supported. Since FW 3.0.0<br />
<br />
Type: string / JSON<br />
<br />
Allowed in: <code>"payload"</code> for Publish section<br />
<br />
Example: <code>"payload":"${INOUT_STATUS}"</code><br />
<br />
Payload example: <code>{ "GlobalMeasure":{"Voltage":238,"TotalCurrent":105,"TotalLoad":17,"TotalEnergy":1451,"OverallPowerFactor":0.67,"Frequency":50.03,"Phase":-33.67,"EnergyStart":"2020-06-30T17:04:48+01:00"}, "Outputs":[ {"ID":1,"Name":"Power output 1","State":0,"Action":6,"Delay":5000,"Current":0,"PowerFactor":1.00,"Phase":0.00,"Energy":701,"ReverseEnergy":0,"Load":0}, {"ID":2,"Name":"Power output 2","State":1,"Action":6,"Delay":5000,"Current":105,"PowerFactor":0.65,"Phase":-33.67,"Energy":750,"ReverseEnergy":0,"Load":17}, {"ID":3,"Name":"Free Contact 3","State":1,"Action":6,"Delay":5000}, {"ID":4,"Name":"Free Contact 4","State":0,"Action":6,"Delay":5000} ], "Inputs":[ {"ID":1,"Name":"Input 1","State":0,"S0Counter":0}, {"ID":2,"Name":"Input 2","State":0,"S0Counter":0} ]}</code><br />
<br />
= Extended MQTT flex JSON config examples =<br />
<br />
== Default NETIO MQTT-flex configuration ==<br />
This example demonstrates setup for connection to public <code>broker.hivemq.com</code>, measurement reporting and output control.<br />
<br />
The device cabe be controlled via <code>netio/${DEVICE_NAME}/output/1/action topic</code> by sending standard NETIO action values:<br />
* 0 - OFF<br />
* 1 - ON<br />
* 2 - SHORT OFF<br />
* 3 - SHORT ON<br />
* 4 - TOGGLE<br />
* 5 - NO ACTION.<br />
<br />
The device report measurements:<br />
<br />
* Output state - every 15 minutes or by change<br />
* Voltage [V]- every 5 minutes or by change of 1 V<br />
* Current [mA]- every 5 minutes or by change of 50 mA<br />
* Load(Power) [W]- every 5 minutes or by change of 10 W<br />
* Energy(Consumption) [Wh]- every 15 minutes or by change of 1Wh<br />
* True Power Factor (TPF) [-]- every 5 minutes or by change of 0.02<br />
* Frequency [Hz]- every 1 hour or by change of 0.1 Hz<br />
<br />
For register all values, you can use wildcard <code>netio/${DEVICE_NAME}/output/1/#</code><br />
<br />
{<br />
"config":{<br />
"broker":{<br />
"url":"broker.hivemq.com",<br />
"protocol":"mqtt",<br />
"port":1883,<br />
"ssl":false,<br />
"type":"generic",<br />
"username":"",<br />
"password":"",<br />
"clientid":"moje${DEVICE_NAME}${DEVICE_MAC}",<br />
"keepalive":30<br />
},<br />
"subscribe":[<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/action",<br />
"qos":0,<br />
"target":"OUTPUTS/1/ACTION",<br />
"action":"${payload}"<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/switch",<br />
"qos":0,<br />
"target":"OUTPUTS/1/ACTION",<br />
"action":4<br />
}<br />
],<br />
"publish":[<br />
{<br />
"topic":"netio/${DEVICE_MAC}/output/1/state",<br />
"qos":0,<br />
"retain":true,<br />
"payload":"${OUTPUTS/1/STATE}",<br />
"events":[<br />
{<br />
"type":"change",<br />
"source":"OUTPUTS/1/STATE"<br />
},<br />
{<br />
"type":"timer",<br />
"period":900<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/voltage",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/VOLTAGE}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":300<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/VOLTAGE",<br />
"delta":1<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/current",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/CURRENT}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":300<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/CURRENT",<br />
"delta":50<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/load",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/LOAD}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":300<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/LOAD",<br />
"delta":10<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/energy",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/ENERGY}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":900<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/ENERGY",<br />
"delta":1<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/tpf",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/POWER_FACTOR}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":900<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/POWER_FACTOR",<br />
"delta":0.02<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/frequency",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/FREQUENCY}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":3600<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/FREQUENCY",<br />
"delta":0.1<br />
}<br />
]<br />
}<br />
]<br />
}<br />
}</div>
Tbezstarosta
https://wiki.netio-products.com/index.php?title=MQTT-flex&diff=1084
MQTT-flex
2026-03-17T14:58:31Z
<p>Tbezstarosta: /* Examples: */</p>
<hr />
<div>The MQTT-flex version of the MQTT protocol can be configured in detail thanks to the “flex” extension.<br />
<br />
https://www.netio-products.com/en/glossary/mqtt-flex <br />
<br />
<b>Why MQTT-flex</b> <br><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.<br />
<br />
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.<br />
<br />
===Supported devices:===<br />
* PowerCable MQTT 101x <br><br />
* PowerCable REST 101x <br><br />
* PowerPDU 4PS <br><br />
* PowerPDU 4KS <br><br />
* PowerPDU 8QS <br><br />
* PowerDIN 4PZ <br><br />
* PowerBOX 3Px <br><br />
* PowerBOX 4Kx <br><br />
<br />
<b>FW version:</b> <br><br />
>2.2.1<br />
<br />
===Not supported NETIO devices:===<br />
* PowerPDU 4C <br><br />
* NETIO 4 <br><br />
* NETIO 4All <br><br />
<br />
= Simple MQTT-flex configuration + explanation =<br />
<br />
''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.''<br />
<br />
{<br />
"config":{<br />
"broker":{<br />
"url":"broker.hivemq.com",<br />
"protocol":"mqtt",<br />
"port":1883,<br />
"ssl":false,<br />
"type":"generic",<br />
"username":"freedom",<br />
"password":"peace|LOVE|empathy4ALL"<br />
},<br />
"subscribe":[{<br />
"topic":"netio/${DEVICE_NAME}/output/1/action",<br />
"qos":0,<br />
"target":"OUTPUTS/1/ACTION",<br />
"action":"${payload}"<br />
}<br />
],<br />
"publish":[{<br />
"topic":"netio/${DEVICE_NAME}/output/1/state",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/STATE}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":"1000"<br />
}<br />
]<br />
}<br />
]<br />
}<br />
}<br />
=== Client Configuration (broker section) ===<br />
Put here MQTT client connection setup<br />
<br />
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>. <br />
<br />
"broker":{<br />
"url":"broker.hivemq.com",<br />
"protocol":"mqtt",<br />
"port":1883,<br />
"ssl":false,<br />
"type":"generic",<br />
"username":"freedom",<br />
"password":"peace|LOVE|empathy4ALL"<br />
},<br />
<br />
=== Device Control (subscribe section) ===<br />
Put here array of topics where to subscribe<br />
<br />
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> <br />
<br />
"subscribe":[{<br />
"topic":"netio/${DEVICE_NAME}/output/1/action",<br />
"qos":0,<br />
"target":"OUTPUTS/1/ACTION",<br />
"action":"${payload}"<br />
}<br />
],<br />
<br />
=== Output State monitoring (publish section) ===<br />
Put here array of topics where to publish.<br />
<br />
Device send every <b>1000 s</b> message to topic <b></b> with <b>QOS 0</b>, <b>retain true</b> information with <b>output 1 state</b><br />
<br />
"publish":[{<br />
"topic":"netio/${DEVICE_NAME}/output/1/state",<br />
"qos":0,<br />
"retain":true,<br />
"payload":"${OUTPUTS/1/STATE}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":"1000"<br />
}<br />
]<br />
}<br />
]<br />
<br />
= Config sections =<br />
<br />
== Broker ==<br />
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 />
<br /><br />
=== Attributes table overview ===<br />
{| class="wikitable"<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Item<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Presence<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Possible Values<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Description<br />
! style="font-weight:bold; background-color:#9b9b9b;" | JSON Config Usage<br />
|-<br />
| style="background-color:#efefef;" | url<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | MQTT broker URL<br />
| style="background-color:#efefef;" | "url":"broker.hivemq.com"<br />
|-<br />
| style="background-color:#efefef;" | port<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | 1 - 65535<br />
| style="background-color:#efefef;" | MQTT broker port<br />
| style="background-color:#efefef;" | "port":1883<br />
|-<br />
| style="background-color:#efefef;" | protocol<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | protocol spec - mqtt<br />
| style="background-color:#efefef;" | "protocol": "mqtt"<br />
|-<br />
| style="background-color:#efefef;" | ssl<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | true, false<br />
| style="background-color:#efefef;" | Use SSL crypted communication selector<br />
| style="background-color:#efefef;" | "ssl":false<br />
|-<br />
| style="background-color:#efefef;" | type<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | generic<br />
| style="background-color:#efefef;" | Communication/setup type option<br />
| style="background-color:#efefef;" | "type":"generic"<br />
|-<br />
| style="background-color:#efefef;" | username<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | regexp+len<br />
| style="background-color:#efefef;" | Credentials for MQTT broker. Max. 128 characters (since FW 3.2.4).<br />
| style="background-color:#efefef;" | "username":"freedom"<br />
|-<br />
| style="background-color:#efefef;" | password<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | regexp+len<br />
| style="background-color:#efefef;" | Credentials for MQTT broker. Max. 256 characters (since FW 3.2.4).<br />
| style="background-color:#efefef;" | "password":"peace|LOVE|empathy4ALL"<br />
|-<br />
| style="background-color:#efefef;" | clientid<br />
| style="background-color:#efefef;" | optional<br />
| style="background-color:#efefef;" | regexp+len<br />
| style="background-color:#efefef;" | MQTT clientid. Max. 128 characters (since FW 3.2.4). Variables ${DEVICE_MAC} or ${DEVICE_NAME} can be used<br />
| style="background-color:#efefef;" | "clientid":"myEcoTable01"<br />
|-<br />
| style="background-color:#efefef;" | keepalive<br />
| style="background-color:#efefef;" | optional<br />
| style="background-color:#efefef;" | 1 - 65535<br />
| style="background-color:#efefef;" | MQTT keep alive period in seconds<br />
| style="background-color:#efefef;" | "keepalive":90<br />
|}<br />
<br />
Note 1: <b>clientid</b> attribute is <b>mandatory for MQTT(s)</b> communication. When not configured, random ID will be generated.<br />
<br />
Note 2: To proper communication with MS Azure - it is necessary to set up IoT Hub to use TLS 1.2<br />
<br />
See section "TLS 1.2 enforcement available in select regions" in following guidelines https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-tls-support<br />
<br />
=== Examples ===<br />
==== Standard setup ====<br />
<br />
<br />
==== Security (SSL / TLS) secured setup ====<br />
You can enable MQTTs by using the encrypted port <b>8883</b> + <b>"ssl":true</b>.<br />
<br />
==== Variables used setup ====<br />
<br />
== Subscribe ==<br />
=== Hints to usage ===<br />
When receive message in <b><i>topic</b></i> do <b><i>action</b></i> on <b><i>target</b></i>.<br />
<br />
<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>.<br />
<br />
=== Attributes table overview ===<br />
{| class="wikitable"<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Item<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Presence<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Possible Values<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Description<br />
! style="font-weight:bold; background-color:#9b9b9b;" | JSON Config Usage<br />
|-<br />
| style="background-color:#efefef;" | topic<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | see table below<br />
| style="background-color:#efefef;" | specification of the topic, which MQTT-flex device listens from broker and act accordingly. Max. 128 characters. The "#" can be used since FW 3.2.4 - see note under this table.<br />
| style="background-color:#efefef;" | "topic":"netio/${DEVICE_NAME}/output/1/action"<br />
|-<br />
| style="background-color:#efefef;" | qos<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | 0, 1 or 2<br />
| 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}<br />
| style="background-color:#efefef;" | "qos":0<br />
|-<br />
| style="background-color:#efefef;" | target<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | internal definition of action, which can be performed above the specified output<br />
| style="background-color:#efefef;" | "target":"OUTPUTS/1/ACTION"<br />
|-<br />
| style="background-color:#efefef;" | action<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | a payload or a value the action attribute needs to have passed to<br />
| style="background-color:#efefef;" | "action":"${payload}"<br />
|-<br />
| style="background-color:#efefef;" | actiondef<sup>Not supported yet</sup><br />
| style="background-color:#efefef;" | optional<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
|-<br />
| style="background-color:#efefef;" | json<sup>Not supported yet</sup><br />
| style="background-color:#efefef;" | optional<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
|}<br />
<br />
Note: The "#" wildcard can be used in subscribe topic definition. The multi-level wildcard character MUST be specified either on its own or following a topic level separator. In either case it MUST be the last character specified in the Topic.<br />
<br />
For example, if a Device subscribes to “devices/{device_id}/messages/devicebound/#”, it would receive messages published using these topic names:<br />
<br />
“devices/{device_id}/messages/devicebound/”<br />
<br />
“devices/{device_id}/messages/devicebound/{property_bag}”<br />
<br />
This should be usefull for use with MS Azure - IoT hub.<br />
<br />
=== MQTT Subscribe as event to trigger action <sup><code>FW 4.0.0+</code></sup> ===<br />
<br />
This feature allow to subscribe to specific MQTT topic and pass payload to Rules or MQTT-flex as event.<br />
<br />
target: <code>PROTOCOLS/MQTT/EVENT</code><br />
<br />
"subscribe": [<br />
{<br />
"action": "${payload}",<br />
"qos": 0,<br />
"target": "PROTOCOLS/MQTT/EVENT",<br />
"topic": "broker/12345/MQTT_EVENT/"<br />
}<br />
]<br />
<br />
=== Examples ===<br />
==== Toggle output with standard payload ==== <br />
==== Toggle output with custom payload ==== <br />
==== Subscribe to more than one topic ====<br />
==== Trigger Rule and MQTT publish from MQTT subscribe <sup><code>FW 4.0.0+</code></sup> ====<br />
This example show Request response implementation in MQTT and toggle action made by Rules.<br />
<br />
When message with payload <code>getValues</code> is published to topic <code>broker/gv90018g/COMMAND</code> MQTT flex will create an event with name <code>PROTOCOLS/MQTT/EVENT</code> (fixed name cannot be changed) and value <code>getValues</code>. On this event will act all events and conditions set in MQTT-flex and Rules which are set to listening to change on <code>PROTOCOLS/MQTT/EVENT</code> and equals to value <code>getValues</code>. See <b>bold</b> marked parameters in example configuration below. <br />
<br />
Once the triggered action is done it is needed to reset MQTT channel to <code>OK</code> status becaus event are reacting only to change. If the channel is not reset the next even would not be triggered.<br />
<br />
<b>Rules Configuration:</b><br />
{<br />
"conditions": {<br />
<b>"PROTOCOLS/MQTT/EVENT": "getValues"</b><br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 4<br />
}<br />
}<br />
<br />
<b>MQTT Configuration:</b><br />
{<br />
"broker":{<br />
"clientid":"netio${DEVICE_SN}",<br />
"keepalive":30,<br />
"password":"abcdefghijk",<br />
"port":8883,<br />
"protocol":"mqtt",<br />
"ssl":true,<br />
"type":"generic",<br />
"url":"broker.cloud.netio.eu",<br />
"username":"gv90018g"<br />
},<br />
"groupEvents":[<br />
{<br />
"events":[<br />
{<br />
<b>"source":"PROTOCOLS/MQTT/EVENT",<br />
"type":"change",<br />
"value":"getValues"</b><br />
}<br />
],<br />
"appliedTopics":[<br />
"broker/gv90018g/OUTPUTS/1/STATE",<br />
<b>"broker/gv90018g/COMMAND"</b><br />
]<br />
}<br />
],<br />
"publish":[<br />
{<br />
"payload":"${OUTPUTS/1/STATE}",<br />
"qos":0,<br />
"retain":true,<br />
"topic":"broker/gv90018g/OUTPUTS/1/STATE"<br />
},<br />
{<br />
"payload":"OK",<br />
"qos":0,<br />
"retain":true,<br />
"topic":"broker/gv90018g/COMMAND"<br />
}<br />
],<br />
"subscribe":[<br />
{<br />
"action":"${payload}",<br />
"qos":0,<br />
<b>"target":"PROTOCOLS/MQTT/EVENT"</b>,<br />
"topic":"broker/gv90018g/COMMAND"<br />
}<br />
]<br />
}<br />
<br />
<br />
<br />
Subscribe topic payload values specification for control of the output:<br />
<br />
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)<br />
<br />
== Publish ==<br />
<br />
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)<br />
<br />
=== Hints to usage ===<br />
When <b><i>event</b></i> send message with <b><i>payload</b></i> to <b><i>topic</b></i>.<br />
<br />
=== Attributes table overview ===<br />
{| class="wikitable"<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Item<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Presence<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Possible Values<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Description<br />
! style="font-weight:bold; background-color:#9b9b9b;" | JSON Config Usage<br />
|-<br />
| style="background-color:#efefef;" | topic<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | see table below<br />
| style="background-color:#efefef;" | definition of the topic, how it is registered towards MQTT broker. Max. 128 characters. <br />
| style="background-color:#efefef;" | "topic":"netio/${DEVICE_NAME}/output/1/load"<br />
|-<br />
| style="background-color:#efefef;" | qos<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | see table below<br />
| 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}<br />
| style="background-color:#efefef;" | <br />
|-<br />
| style="background-color:#efefef;" | retain<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | boolean: true or false<br />
| 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}<br />
| style="background-color:#efefef;" | "retain":true<br />
|-<br />
| style="background-color:#efefef;" | payload<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | see table below<br />
| style="background-color:#efefef;" | definition of the payload, what is send to the MQTT broker.<br />
| style="background-color:#efefef;" | "payload":"${OUTPUTS/1/STATE}"<br />
|-<br />
| style="background-color:#efefef;" | events<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | see table below<br />
| style="background-color:#efefef;" | definition of events used for triggering sending of data via mqtt (change, delta, timer)<br />
| style="background-color:#efefef;" | <br />
|-<br />
| style="background-color:#efefef;" | type<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" |<br />
|-<br />
| style="background-color:#efefef;" | source<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" |<br />
|-<br />
| style="background-color:#efefef;" | delta<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" |<br />
|-<br />
| style="background-color:#efefef;" | period<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" |<br />
| style="background-color:#efefef;" |<br />
|-<br />
| style="background-color:#efefef;" | payloaddef<sup>Not supported yet</sup><br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" |<br />
|}<br />
<br />
=== Examples ===<br />
==== Publish energy periodically (event timer) ==== <br />
==== Publish current on change (delta) ==== <br />
==== Publish output state ====<br />
==== Publish to more than one topic with different events ====<br />
<br />
= Target / Source =<br />
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.<br />
<br />
* <b>source</b> - specifies from where the value will be read (specifies the source of data for payload, change detection, delta calculation)<br />
* <b>target</b> - specifies where the data should be sent or command applied (e.g. specifies the target for ACTION)<br />
<br />
=== INPUT / OUTPUT (Target) selection ===<br />
<br />
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.<br />
<br />
# At first specify if requested variable is from/for INPUT or OUTPUT using keywords <b>"OUTPUTS"</b> or <b>"INPUTS"</b> .<br />
# Add <b>"/"</b> separator<br />
# Specify the number of INPUT/OUTPUT to <b>1</b>(or TOTAL for summary statistics if available)<br />
# Add <b>"/"</b> separator<br />
# Specify requested variable or command<br />
<br />
<b>Note:</b> Not all of OUTPUTS/INPUTS support all variables. Available variables are closely connected with the device functions and I/O features.<br />
<br />
<b>Note2:</b> INPUTS available only on NETIO PowerDIN 4PZ<br />
<br />
=== Examples: ===<br />
<br />
adressing controll of output 3<br />
OUTPUTS/3/ACTION<br />
getting voltage on output 1<br />
OUTPUTS/1/VOLTAGE<br />
getting state of input 1<br />
INPUTS/1/STATE<br />
getting temperature [C] - sensor connected of input 1<br />
INPUTS/1/TEMP<br />
getting temperature [F] - sensor connected of input 2<br />
INPUTS/2/TEMPF<br />
getting humidity [%] - sensor connected of input 2<br />
INPUTS/2/HUMIDITY<br />
<br />
= Group Events<sup><code>FW 4.0.0+</code></sup> =<br />
Group events are smart way how to keep configuration simple. It is not replacement of publish section specification but it is extension to trigger group of different topics to be published on the same event.<br />
<br />
See the example below. There is specific event on status change on every output and additionally the device sends periodic status every 60 seconds.<br />
<br />
{<br />
"broker": {<br />
"clientid": "netio${DEVICE_SN}",<br />
"keepalive": 30,<br />
"password": "",<br />
"port": 1883,<br />
"protocol": "mqtt",<br />
"ssl": false,<br />
"type": "generic",<br />
"url": "broker.hivemq.com",<br />
"username": ""<br />
},<br />
<b>"groupEvents": [<br />
{<br />
"events":[<br />
{<br />
"period": 60,<br />
"type": "timer"<br />
}<br />
],<br />
"appliedTopics":[<br />
"devices/${DEVICE_NAME}/output/1/state",<br />
"devices/${DEVICE_NAME}/output/2/state"<br />
]<br />
}<br />
],</b><br />
"publish": [<br />
{<br />
"events": [<br />
{<br />
"source": "OUTPUTS/1/STATE",<br />
"type": "change"<br />
}<br />
],<br />
"payload": "${OUTPUTS/1/STATE}",<br />
"qos": 0,<br />
"retain": false,<br />
<b> "topic": "devices/${DEVICE_NAME}/output/1/state"</b><br />
},{<br />
"events": [<br />
{<br />
"source": "OUTPUTS/2/STATE",<br />
"type": "change"<br />
}<br />
],<br />
"payload": "${OUTPUTS/2/STATE}",<br />
"qos": 0,<br />
"retain": false,<br />
<b> "topic": "devices/${DEVICE_NAME}/output/2/state"</b><br />
}<br />
]<br />
}<br />
<br />
= Variables =<br />
In some parameters is nescessary to use variables to get current state and measurements. <b>Variables are separated in two categories:</b><br />
<br />
* Target/Source variables<br />
* Payload Topic variables<br />
<br />
== Target Source Variables ==<br />
<br />
The list of available variables for each <br />
<br />
=== OUTPUTS variables ===<br />
==== VOLTAGE ====<br />
Unit: <code>V</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Present RMS voltage on output 1 is ${OUTPUTS/1/VOLTAGE}"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/VOLTAGE}"</code><br />
<br />
==== CURRENT ====<br />
Unit: <code>mA</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Present RMS current on output 1 is ${OUTPUTS/1/CURRENT}"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/CURRENT}"</code><br />
<br />
==== POWER_FACTOR ====<br />
Unit: <code>[-]</code><br />
<br />
Type: float (2 decimals)<br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"True Power Factor on output 1 is ${OUTPUTS/1/POWER_FACTOR}"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/POWER_FACTOR}"</code><br />
<br />
==== LOAD ====<br />
Unit: <code>W</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Present load on output 1 is ${OUTPUTS/1/LOAD}W"</code><br />
<br />
Example 2: <code>"payload":"Device's load connected to output 1 is ${OUTPUTS/1/LOAD}W"</code><br />
<br />
Example 3: <code>"source":"${OUTPUTS/1/LOAD}"</code><br />
<br />
==== STATE ====<br />
Type: bool(integer) - <code>0</code> or <code>1</code><br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Present output 1 state is ${OUTPUTS/1/STATE}"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/STATE}"</code><br />
<br />
==== ACTION ====<br />
Type: integer<br />
<br />
Possible actions:<br />
* <code>0</code> - set state OFF<br />
* <code>1</code> - set state ON<br />
* <code>2</code> - short OFF (restart)<br />
* <code>3</code> - short ON<br />
* <code>4</code> - toggle (switch)<br />
* <code>5</code> - no change<br />
<br />
Allowed in: <code>"target"</code><br />
<br />
Example: <code>"target":"OUTPUTS/1/ACTION"</code><br />
<br />
==== DELAY [ms] ====<br />
==== NAME ====<br />
==== FREQUENCY ====<br />
Unit: <code>Hz</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example: <code>"payload":"Frequency in power grid is ${OUTPUTS/1/ENERGY}Hz"</code><br />
<br />
==== ENERGY ====<br />
Energy consumed by an device connected to NETIO device output.<br />
<br />
Unit: <code>Wh</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Consumed energy on output 1 is ${OUTPUTS/1/ENERGY}Wh"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/ENERGY}"</code><br />
<br />
==== REVERSE_ENERGY ====<br />
Energy delivered back to grid. For example from solar system connected to NETIO device output.<br />
<br />
Unit: <code>Wh</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Delivered energy on output 1 is ${OUTPUTS/1/REVERSE_ENERGY}Wh"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/REVERSE_ENERGY}"</code><br />
<br />
<br />
==== ENERGY_START ====<br />
Date when the counters ENERGY and REVERSE_ENERGY have been resetted by user.<br />
<br />
Unit: <code>unix timestamp</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code><br />
<br />
Example 1: <code>"payload":"Energy measured since ${OUTPUTS/1/ENERGY_START} unix time"</code><br />
<br />
Example 2: <code>"payload":"${OUTPUTS/1/ENERGY_START}"</code> is output payload <code>1567654639</code><br />
<br />
==== ENERGY_START_FMT ====<br />
Date when the counters ENERGY and REVERSE_ENERGY have been resetted by user.<br />
<br />
Unit: <code>fmt date format</code><br />
<br />
Type: string <br />
<br />
Allowed in: <code>"payload"</code><br />
<br />
Example 1: <code>"payload":"Energy measured since ${OUTPUTS/1/ENERGY_START}"</code><br />
<br />
Example 2: <code>"payload":"${OUTPUTS/1/ENERGY_START_FMT}"</code> is output payload <code>2019-09-05T03:37:19+00:00</code><br />
<br />
==== ENERGY_NR ====<br />
Non-resettable counter of Energy consumed by an device connected to NETIO device output.<br />
<br />
Unit: <code>Wh</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Consumed energy on output 1 is ${OUTPUTS/1/ENERGY_NR}Wh"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/ENERGY_NR}"</code><br />
<br />
==== REVERSE_ENERGY_NR ====<br />
Non-resettable counter of Energy delivered back to grid. For example from solar system connected to NETIO device output.<br />
<br />
Unit: <code>Wh</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Delivered energy on output 1 is ${OUTPUTS/1/REVERSE_ENERGY_NR}Wh"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/REVERSE_ENERGY_NR}"</code><br />
<br />
<br />
<br />
==== TOTALs - for use with devices having more than 1 measured output ====<br />
<br />
* OUTPUTS/TOTAL/ENERGY<br />
* OUTPUTS/TOTAL/LOAD<br />
* OUTPUTS/TOTAL/CURRENT<br />
* OUTPUTS/TOTAL/VOLTAGE<br />
* OUTPUTS/TOTAL/POWER_FACTOR<br />
* OUTPUTS/TOTAL/FREQUENCY<br />
* OUTPUTS/TOTAL/PHASE<br />
* OUTPUTS/TOTAL/REVERSE_ENERGY<br />
* OUTPUTS/TOTAL/ENERGY_NR<br />
* OUTPUTS/TOTAL/REVERSE_ENERGY_NR<br />
* OUTPUTS/TOTAL/ENERGY_START<br />
* OUTPUTS/TOTAL/ENERGY_START_FMT<br />
<br />
<br />
==== REST_JSON ====<br />
Allow use of NETIO JSON structure to control outputs.<br />
<br />
Type: string / JSON<br />
<br />
Allowed in: <code>"target"</code> for Subscribe section<br />
<br />
Example: <code>"target": "REST_JSON"</code><br />
<br />
The payload is JSON structure identical to NETIO JSON API M2M Protocol (documentation available at https://www.netio-products.com/files/NETIO-M2M-API-Protocol-JSON.pdf). You can control one or multiple outputs.<br />
<br />
Payload example 1 - Toggle output 1: <code>{"Outputs":[{"ID": 1,"Action": 4}]}</code><br />
<br />
Payload example 2 - Turn output 1 OFF and output 3 ON: <code>{"Outputs":[{"ID":1,"Action":0},{"ID":3,"Action":1}]}</code><br />
<br />
=== INPUT variables ===<br />
==== STATE ====<br />
Type: bool(integer) - <code>0</code> or <code>1</code><br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Present input 1 state is ${INPUTS/1/STATE}"</code><br />
<br />
Example 2: <code>"source":"${INPUTS/1/STATE}"</code><br />
<br />
==== S0 ====<br />
S0 Counter value<br />
Unit: <code>-</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Input 1 S0 Counter value is ${INPUTS/1/S0}impulses"</code><br />
<br />
Example 2: <code>"source":"${INPUTS/1/S0}"</code><br />
<br />
==== TEMPERATURE ====<br />
Temperature measurement in Celsius, Fahrenheit<br />
Unit: <code> [C], [F] </code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Input 1 Temperature value in degree of Celsius is ${INPUTS/1/TEMP} [C] "</code><br />
<br />
Example 2: <code>"source":"${INPUTS/1/TEMP}"</code><br />
<br />
<br />
Example 3: <code>"payload":"Input 1 Temperature value in degree of Fahrenheit is ${INPUTS/1/TEMPF} [F] "</code><br />
<br />
Example 4: <code>"source":"${INPUTS/1/TEMPF}"</code><br />
<br />
==== HUMIDITY ====<br />
Relative Humidity measurement <br />
Unit: <code> [%]</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Input 1 Humidity value is ${INPUTS/1/HUMIDITY} %"</code><br />
<br />
Example 2: <code>"source":"${INPUTS/1/HUMIDITY}"</code><br />
<br />
== Payload/topic variables ==<br />
<br />
=== DEVICE_NAME ===<br />
Can be used in: "payload", "topic"<br />
<br />
Example 1: <code>"payload":"${DEVICE_NAME}"</code><br />
<br />
Example 2: <code>"topic":"netio/${DEVICE_NAME}/output/1/action"</code><br />
<br />
=== DEVICE_MAC ===<br />
Can be used in: "payload", "topic"<br />
<br />
Example 1: <code>"payload":"${DEVICE_MAC}"</code><br />
<br />
Example 2: <code>"topic":"netio/${DEVICE_MAC}/output/1/action"</code><br />
<br />
=== UTC_TIME <sup><code>FW 4.0.0+</code></sup>===<br />
<br />
send unix timestamp of devices actual time<br />
<br />
Can be used in: "payload"<br />
<br />
Example 1: <code>"payload": "${UTC_TIME}"</code><br />
<br />
=== UPTIME <sup>Not yet implemented</sup> ===<br />
<br />
=== PAYLOAD ===<br />
Can be used in: "action"<br />
<br />
Example: <code>"action":"${PAYLOAD}"</code><br />
<br />
=== OUTPUT_ID <sup>Not yet implemented</sup>===<br />
<br />
=== WIFI_SIGNAL<sup>Not yet implemented</sup> ===<br />
<br />
=== OUTPUTS_STATUS ===<br />
Provide complete outputs status and measurement if supported.<br />
<br />
Type: string / JSON<br />
<br />
Allowed in: <code>"payload"</code> for Publish section<br />
<br />
Example: <code>"payload":"${OUTPUTS_STATUS}"</code><br />
<br />
Payload example: <code>{ "GlobalMeasure":{"Voltage":236,"TotalCurrent":72,"TotalLoad":11,"TotalEnergy":167,"OverallPowerFactor":0.64,"Frequency":50.07,"Phase":-36.86,"EnergyStart":"2020-06-30T17:04:48+01:00"}, "Outputs":[ {"ID":1,"Name":"Power output 1","State":1,"Action":6,"Delay":2020,"Current":72,"PowerFactor":0.64,"Phase":-36.86,"Energy":139,"ReverseEnergy":0,"Load":11}, {"ID":2,"Name":"Power output 2","State":1,"Action":6,"Delay":2020,"Current":0,"PowerFactor":1.00,"Phase":0.00,"Energy":27,"ReverseEnergy":0,"Load":0}, {"ID":3,"Name":"Free Contact 3","State":1,"Action":6,"Delay":2020}, {"ID":4,"Name":"Free Contact 4","State":1,"Action":6,"Delay":2020} ]}</code><br />
<br />
=== INPUTS_STATUS ===<br />
Provide complete inputs status if supported. Since FW 3.0.0<br />
<br />
Type: string / JSON<br />
<br />
Allowed in: <code>"payload"</code> for Publish section<br />
<br />
Example: <code>"payload":"${INPUTS_STATUS}"</code><br />
<br />
Payload example: <code>{ "Inputs":[ {"ID":1,"Name":"Input 1","State":0,"S0Counter":0}, {"ID":2,"Name":"Input 2","State":0,"S0Counter":0} ]}</code><br />
<br />
=== INOUT_STATUS ===<br />
Provide complete inputs and output status and measurement if supported. Since FW 3.0.0<br />
<br />
Type: string / JSON<br />
<br />
Allowed in: <code>"payload"</code> for Publish section<br />
<br />
Example: <code>"payload":"${INOUT_STATUS}"</code><br />
<br />
Payload example: <code>{ "GlobalMeasure":{"Voltage":238,"TotalCurrent":105,"TotalLoad":17,"TotalEnergy":1451,"OverallPowerFactor":0.67,"Frequency":50.03,"Phase":-33.67,"EnergyStart":"2020-06-30T17:04:48+01:00"}, "Outputs":[ {"ID":1,"Name":"Power output 1","State":0,"Action":6,"Delay":5000,"Current":0,"PowerFactor":1.00,"Phase":0.00,"Energy":701,"ReverseEnergy":0,"Load":0}, {"ID":2,"Name":"Power output 2","State":1,"Action":6,"Delay":5000,"Current":105,"PowerFactor":0.65,"Phase":-33.67,"Energy":750,"ReverseEnergy":0,"Load":17}, {"ID":3,"Name":"Free Contact 3","State":1,"Action":6,"Delay":5000}, {"ID":4,"Name":"Free Contact 4","State":0,"Action":6,"Delay":5000} ], "Inputs":[ {"ID":1,"Name":"Input 1","State":0,"S0Counter":0}, {"ID":2,"Name":"Input 2","State":0,"S0Counter":0} ]}</code><br />
<br />
= Extended MQTT flex JSON config examples =<br />
<br />
== Default NETIO MQTT-flex configuration ==<br />
This example demonstrates setup for connection to public <code>broker.hivemq.com</code>, measurement reporting and output control.<br />
<br />
The device cabe be controlled via <code>netio/${DEVICE_NAME}/output/1/action topic</code> by sending standard NETIO action values:<br />
* 0 - OFF<br />
* 1 - ON<br />
* 2 - SHORT OFF<br />
* 3 - SHORT ON<br />
* 4 - TOGGLE<br />
* 5 - NO ACTION.<br />
<br />
The device report measurements:<br />
<br />
* Output state - every 15 minutes or by change<br />
* Voltage [V]- every 5 minutes or by change of 1 V<br />
* Current [mA]- every 5 minutes or by change of 50 mA<br />
* Load(Power) [W]- every 5 minutes or by change of 10 W<br />
* Energy(Consumption) [Wh]- every 15 minutes or by change of 1Wh<br />
* True Power Factor (TPF) [-]- every 5 minutes or by change of 0.02<br />
* Frequency [Hz]- every 1 hour or by change of 0.1 Hz<br />
<br />
For register all values, you can use wildcard <code>netio/${DEVICE_NAME}/output/1/#</code><br />
<br />
{<br />
"config":{<br />
"broker":{<br />
"url":"broker.hivemq.com",<br />
"protocol":"mqtt",<br />
"port":1883,<br />
"ssl":false,<br />
"type":"generic",<br />
"username":"",<br />
"password":"",<br />
"clientid":"moje${DEVICE_NAME}${DEVICE_MAC}",<br />
"keepalive":30<br />
},<br />
"subscribe":[<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/action",<br />
"qos":0,<br />
"target":"OUTPUTS/1/ACTION",<br />
"action":"${payload}"<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/switch",<br />
"qos":0,<br />
"target":"OUTPUTS/1/ACTION",<br />
"action":4<br />
}<br />
],<br />
"publish":[<br />
{<br />
"topic":"netio/${DEVICE_MAC}/output/1/state",<br />
"qos":0,<br />
"retain":true,<br />
"payload":"${OUTPUTS/1/STATE}",<br />
"events":[<br />
{<br />
"type":"change",<br />
"source":"OUTPUTS/1/STATE"<br />
},<br />
{<br />
"type":"timer",<br />
"period":900<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/voltage",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/VOLTAGE}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":300<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/VOLTAGE",<br />
"delta":1<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/current",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/CURRENT}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":300<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/CURRENT",<br />
"delta":50<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/load",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/LOAD}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":300<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/LOAD",<br />
"delta":10<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/energy",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/ENERGY}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":900<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/ENERGY",<br />
"delta":1<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/tpf",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/POWER_FACTOR}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":900<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/POWER_FACTOR",<br />
"delta":0.02<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/frequency",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/FREQUENCY}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":3600<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/FREQUENCY",<br />
"delta":0.1<br />
}<br />
]<br />
}<br />
]<br />
}<br />
}</div>
Tbezstarosta
https://wiki.netio-products.com/index.php?title=MQTT-flex&diff=1083
MQTT-flex
2026-03-17T14:56:19Z
<p>Tbezstarosta: /* HUMIDITY */</p>
<hr />
<div>The MQTT-flex version of the MQTT protocol can be configured in detail thanks to the “flex” extension.<br />
<br />
https://www.netio-products.com/en/glossary/mqtt-flex <br />
<br />
<b>Why MQTT-flex</b> <br><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.<br />
<br />
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.<br />
<br />
===Supported devices:===<br />
* PowerCable MQTT 101x <br><br />
* PowerCable REST 101x <br><br />
* PowerPDU 4PS <br><br />
* PowerPDU 4KS <br><br />
* PowerPDU 8QS <br><br />
* PowerDIN 4PZ <br><br />
* PowerBOX 3Px <br><br />
* PowerBOX 4Kx <br><br />
<br />
<b>FW version:</b> <br><br />
>2.2.1<br />
<br />
===Not supported NETIO devices:===<br />
* PowerPDU 4C <br><br />
* NETIO 4 <br><br />
* NETIO 4All <br><br />
<br />
= Simple MQTT-flex configuration + explanation =<br />
<br />
''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.''<br />
<br />
{<br />
"config":{<br />
"broker":{<br />
"url":"broker.hivemq.com",<br />
"protocol":"mqtt",<br />
"port":1883,<br />
"ssl":false,<br />
"type":"generic",<br />
"username":"freedom",<br />
"password":"peace|LOVE|empathy4ALL"<br />
},<br />
"subscribe":[{<br />
"topic":"netio/${DEVICE_NAME}/output/1/action",<br />
"qos":0,<br />
"target":"OUTPUTS/1/ACTION",<br />
"action":"${payload}"<br />
}<br />
],<br />
"publish":[{<br />
"topic":"netio/${DEVICE_NAME}/output/1/state",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/STATE}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":"1000"<br />
}<br />
]<br />
}<br />
]<br />
}<br />
}<br />
=== Client Configuration (broker section) ===<br />
Put here MQTT client connection setup<br />
<br />
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>. <br />
<br />
"broker":{<br />
"url":"broker.hivemq.com",<br />
"protocol":"mqtt",<br />
"port":1883,<br />
"ssl":false,<br />
"type":"generic",<br />
"username":"freedom",<br />
"password":"peace|LOVE|empathy4ALL"<br />
},<br />
<br />
=== Device Control (subscribe section) ===<br />
Put here array of topics where to subscribe<br />
<br />
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> <br />
<br />
"subscribe":[{<br />
"topic":"netio/${DEVICE_NAME}/output/1/action",<br />
"qos":0,<br />
"target":"OUTPUTS/1/ACTION",<br />
"action":"${payload}"<br />
}<br />
],<br />
<br />
=== Output State monitoring (publish section) ===<br />
Put here array of topics where to publish.<br />
<br />
Device send every <b>1000 s</b> message to topic <b></b> with <b>QOS 0</b>, <b>retain true</b> information with <b>output 1 state</b><br />
<br />
"publish":[{<br />
"topic":"netio/${DEVICE_NAME}/output/1/state",<br />
"qos":0,<br />
"retain":true,<br />
"payload":"${OUTPUTS/1/STATE}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":"1000"<br />
}<br />
]<br />
}<br />
]<br />
<br />
= Config sections =<br />
<br />
== Broker ==<br />
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 />
<br /><br />
=== Attributes table overview ===<br />
{| class="wikitable"<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Item<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Presence<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Possible Values<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Description<br />
! style="font-weight:bold; background-color:#9b9b9b;" | JSON Config Usage<br />
|-<br />
| style="background-color:#efefef;" | url<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | MQTT broker URL<br />
| style="background-color:#efefef;" | "url":"broker.hivemq.com"<br />
|-<br />
| style="background-color:#efefef;" | port<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | 1 - 65535<br />
| style="background-color:#efefef;" | MQTT broker port<br />
| style="background-color:#efefef;" | "port":1883<br />
|-<br />
| style="background-color:#efefef;" | protocol<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | protocol spec - mqtt<br />
| style="background-color:#efefef;" | "protocol": "mqtt"<br />
|-<br />
| style="background-color:#efefef;" | ssl<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | true, false<br />
| style="background-color:#efefef;" | Use SSL crypted communication selector<br />
| style="background-color:#efefef;" | "ssl":false<br />
|-<br />
| style="background-color:#efefef;" | type<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | generic<br />
| style="background-color:#efefef;" | Communication/setup type option<br />
| style="background-color:#efefef;" | "type":"generic"<br />
|-<br />
| style="background-color:#efefef;" | username<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | regexp+len<br />
| style="background-color:#efefef;" | Credentials for MQTT broker. Max. 128 characters (since FW 3.2.4).<br />
| style="background-color:#efefef;" | "username":"freedom"<br />
|-<br />
| style="background-color:#efefef;" | password<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | regexp+len<br />
| style="background-color:#efefef;" | Credentials for MQTT broker. Max. 256 characters (since FW 3.2.4).<br />
| style="background-color:#efefef;" | "password":"peace|LOVE|empathy4ALL"<br />
|-<br />
| style="background-color:#efefef;" | clientid<br />
| style="background-color:#efefef;" | optional<br />
| style="background-color:#efefef;" | regexp+len<br />
| style="background-color:#efefef;" | MQTT clientid. Max. 128 characters (since FW 3.2.4). Variables ${DEVICE_MAC} or ${DEVICE_NAME} can be used<br />
| style="background-color:#efefef;" | "clientid":"myEcoTable01"<br />
|-<br />
| style="background-color:#efefef;" | keepalive<br />
| style="background-color:#efefef;" | optional<br />
| style="background-color:#efefef;" | 1 - 65535<br />
| style="background-color:#efefef;" | MQTT keep alive period in seconds<br />
| style="background-color:#efefef;" | "keepalive":90<br />
|}<br />
<br />
Note 1: <b>clientid</b> attribute is <b>mandatory for MQTT(s)</b> communication. When not configured, random ID will be generated.<br />
<br />
Note 2: To proper communication with MS Azure - it is necessary to set up IoT Hub to use TLS 1.2<br />
<br />
See section "TLS 1.2 enforcement available in select regions" in following guidelines https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-tls-support<br />
<br />
=== Examples ===<br />
==== Standard setup ====<br />
<br />
<br />
==== Security (SSL / TLS) secured setup ====<br />
You can enable MQTTs by using the encrypted port <b>8883</b> + <b>"ssl":true</b>.<br />
<br />
==== Variables used setup ====<br />
<br />
== Subscribe ==<br />
=== Hints to usage ===<br />
When receive message in <b><i>topic</b></i> do <b><i>action</b></i> on <b><i>target</b></i>.<br />
<br />
<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>.<br />
<br />
=== Attributes table overview ===<br />
{| class="wikitable"<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Item<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Presence<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Possible Values<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Description<br />
! style="font-weight:bold; background-color:#9b9b9b;" | JSON Config Usage<br />
|-<br />
| style="background-color:#efefef;" | topic<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | see table below<br />
| style="background-color:#efefef;" | specification of the topic, which MQTT-flex device listens from broker and act accordingly. Max. 128 characters. The "#" can be used since FW 3.2.4 - see note under this table.<br />
| style="background-color:#efefef;" | "topic":"netio/${DEVICE_NAME}/output/1/action"<br />
|-<br />
| style="background-color:#efefef;" | qos<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | 0, 1 or 2<br />
| 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}<br />
| style="background-color:#efefef;" | "qos":0<br />
|-<br />
| style="background-color:#efefef;" | target<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | internal definition of action, which can be performed above the specified output<br />
| style="background-color:#efefef;" | "target":"OUTPUTS/1/ACTION"<br />
|-<br />
| style="background-color:#efefef;" | action<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | a payload or a value the action attribute needs to have passed to<br />
| style="background-color:#efefef;" | "action":"${payload}"<br />
|-<br />
| style="background-color:#efefef;" | actiondef<sup>Not supported yet</sup><br />
| style="background-color:#efefef;" | optional<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
|-<br />
| style="background-color:#efefef;" | json<sup>Not supported yet</sup><br />
| style="background-color:#efefef;" | optional<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
|}<br />
<br />
Note: The "#" wildcard can be used in subscribe topic definition. The multi-level wildcard character MUST be specified either on its own or following a topic level separator. In either case it MUST be the last character specified in the Topic.<br />
<br />
For example, if a Device subscribes to “devices/{device_id}/messages/devicebound/#”, it would receive messages published using these topic names:<br />
<br />
“devices/{device_id}/messages/devicebound/”<br />
<br />
“devices/{device_id}/messages/devicebound/{property_bag}”<br />
<br />
This should be usefull for use with MS Azure - IoT hub.<br />
<br />
=== MQTT Subscribe as event to trigger action <sup><code>FW 4.0.0+</code></sup> ===<br />
<br />
This feature allow to subscribe to specific MQTT topic and pass payload to Rules or MQTT-flex as event.<br />
<br />
target: <code>PROTOCOLS/MQTT/EVENT</code><br />
<br />
"subscribe": [<br />
{<br />
"action": "${payload}",<br />
"qos": 0,<br />
"target": "PROTOCOLS/MQTT/EVENT",<br />
"topic": "broker/12345/MQTT_EVENT/"<br />
}<br />
]<br />
<br />
=== Examples ===<br />
==== Toggle output with standard payload ==== <br />
==== Toggle output with custom payload ==== <br />
==== Subscribe to more than one topic ====<br />
==== Trigger Rule and MQTT publish from MQTT subscribe <sup><code>FW 4.0.0+</code></sup> ====<br />
This example show Request response implementation in MQTT and toggle action made by Rules.<br />
<br />
When message with payload <code>getValues</code> is published to topic <code>broker/gv90018g/COMMAND</code> MQTT flex will create an event with name <code>PROTOCOLS/MQTT/EVENT</code> (fixed name cannot be changed) and value <code>getValues</code>. On this event will act all events and conditions set in MQTT-flex and Rules which are set to listening to change on <code>PROTOCOLS/MQTT/EVENT</code> and equals to value <code>getValues</code>. See <b>bold</b> marked parameters in example configuration below. <br />
<br />
Once the triggered action is done it is needed to reset MQTT channel to <code>OK</code> status becaus event are reacting only to change. If the channel is not reset the next even would not be triggered.<br />
<br />
<b>Rules Configuration:</b><br />
{<br />
"conditions": {<br />
<b>"PROTOCOLS/MQTT/EVENT": "getValues"</b><br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 4<br />
}<br />
}<br />
<br />
<b>MQTT Configuration:</b><br />
{<br />
"broker":{<br />
"clientid":"netio${DEVICE_SN}",<br />
"keepalive":30,<br />
"password":"abcdefghijk",<br />
"port":8883,<br />
"protocol":"mqtt",<br />
"ssl":true,<br />
"type":"generic",<br />
"url":"broker.cloud.netio.eu",<br />
"username":"gv90018g"<br />
},<br />
"groupEvents":[<br />
{<br />
"events":[<br />
{<br />
<b>"source":"PROTOCOLS/MQTT/EVENT",<br />
"type":"change",<br />
"value":"getValues"</b><br />
}<br />
],<br />
"appliedTopics":[<br />
"broker/gv90018g/OUTPUTS/1/STATE",<br />
<b>"broker/gv90018g/COMMAND"</b><br />
]<br />
}<br />
],<br />
"publish":[<br />
{<br />
"payload":"${OUTPUTS/1/STATE}",<br />
"qos":0,<br />
"retain":true,<br />
"topic":"broker/gv90018g/OUTPUTS/1/STATE"<br />
},<br />
{<br />
"payload":"OK",<br />
"qos":0,<br />
"retain":true,<br />
"topic":"broker/gv90018g/COMMAND"<br />
}<br />
],<br />
"subscribe":[<br />
{<br />
"action":"${payload}",<br />
"qos":0,<br />
<b>"target":"PROTOCOLS/MQTT/EVENT"</b>,<br />
"topic":"broker/gv90018g/COMMAND"<br />
}<br />
]<br />
}<br />
<br />
<br />
<br />
Subscribe topic payload values specification for control of the output:<br />
<br />
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)<br />
<br />
== Publish ==<br />
<br />
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)<br />
<br />
=== Hints to usage ===<br />
When <b><i>event</b></i> send message with <b><i>payload</b></i> to <b><i>topic</b></i>.<br />
<br />
=== Attributes table overview ===<br />
{| class="wikitable"<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Item<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Presence<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Possible Values<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Description<br />
! style="font-weight:bold; background-color:#9b9b9b;" | JSON Config Usage<br />
|-<br />
| style="background-color:#efefef;" | topic<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | see table below<br />
| style="background-color:#efefef;" | definition of the topic, how it is registered towards MQTT broker. Max. 128 characters. <br />
| style="background-color:#efefef;" | "topic":"netio/${DEVICE_NAME}/output/1/load"<br />
|-<br />
| style="background-color:#efefef;" | qos<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | see table below<br />
| 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}<br />
| style="background-color:#efefef;" | <br />
|-<br />
| style="background-color:#efefef;" | retain<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | boolean: true or false<br />
| 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}<br />
| style="background-color:#efefef;" | "retain":true<br />
|-<br />
| style="background-color:#efefef;" | payload<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | see table below<br />
| style="background-color:#efefef;" | definition of the payload, what is send to the MQTT broker.<br />
| style="background-color:#efefef;" | "payload":"${OUTPUTS/1/STATE}"<br />
|-<br />
| style="background-color:#efefef;" | events<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | see table below<br />
| style="background-color:#efefef;" | definition of events used for triggering sending of data via mqtt (change, delta, timer)<br />
| style="background-color:#efefef;" | <br />
|-<br />
| style="background-color:#efefef;" | type<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" |<br />
|-<br />
| style="background-color:#efefef;" | source<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" |<br />
|-<br />
| style="background-color:#efefef;" | delta<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" |<br />
|-<br />
| style="background-color:#efefef;" | period<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" |<br />
| style="background-color:#efefef;" |<br />
|-<br />
| style="background-color:#efefef;" | payloaddef<sup>Not supported yet</sup><br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" |<br />
|}<br />
<br />
=== Examples ===<br />
==== Publish energy periodically (event timer) ==== <br />
==== Publish current on change (delta) ==== <br />
==== Publish output state ====<br />
==== Publish to more than one topic with different events ====<br />
<br />
= Target / Source =<br />
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.<br />
<br />
* <b>source</b> - specifies from where the value will be read (specifies the source of data for payload, change detection, delta calculation)<br />
* <b>target</b> - specifies where the data should be sent or command applied (e.g. specifies the target for ACTION)<br />
<br />
=== INPUT / OUTPUT (Target) selection ===<br />
<br />
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.<br />
<br />
# At first specify if requested variable is from/for INPUT or OUTPUT using keywords <b>"OUTPUTS"</b> or <b>"INPUTS"</b> .<br />
# Add <b>"/"</b> separator<br />
# Specify the number of INPUT/OUTPUT to <b>1</b>(or TOTAL for summary statistics if available)<br />
# Add <b>"/"</b> separator<br />
# Specify requested variable or command<br />
<br />
<b>Note:</b> Not all of OUTPUTS/INPUTS support all variables. Available variables are closely connected with the device functions and I/O features.<br />
<br />
<b>Note2:</b> INPUTS available only on NETIO PowerDIN 4PZ<br />
<br />
=== Examples: ===<br />
<br />
adressing controll of output 3<br />
OUTPUTS/3/ACTION<br />
getting voltage on output 1<br />
OUTPUTS/1/VOLTAGE<br />
getting state of input 1<br />
INPUTS/1/STATE<br />
<br />
= Group Events<sup><code>FW 4.0.0+</code></sup> =<br />
Group events are smart way how to keep configuration simple. It is not replacement of publish section specification but it is extension to trigger group of different topics to be published on the same event.<br />
<br />
See the example below. There is specific event on status change on every output and additionally the device sends periodic status every 60 seconds.<br />
<br />
{<br />
"broker": {<br />
"clientid": "netio${DEVICE_SN}",<br />
"keepalive": 30,<br />
"password": "",<br />
"port": 1883,<br />
"protocol": "mqtt",<br />
"ssl": false,<br />
"type": "generic",<br />
"url": "broker.hivemq.com",<br />
"username": ""<br />
},<br />
<b>"groupEvents": [<br />
{<br />
"events":[<br />
{<br />
"period": 60,<br />
"type": "timer"<br />
}<br />
],<br />
"appliedTopics":[<br />
"devices/${DEVICE_NAME}/output/1/state",<br />
"devices/${DEVICE_NAME}/output/2/state"<br />
]<br />
}<br />
],</b><br />
"publish": [<br />
{<br />
"events": [<br />
{<br />
"source": "OUTPUTS/1/STATE",<br />
"type": "change"<br />
}<br />
],<br />
"payload": "${OUTPUTS/1/STATE}",<br />
"qos": 0,<br />
"retain": false,<br />
<b> "topic": "devices/${DEVICE_NAME}/output/1/state"</b><br />
},{<br />
"events": [<br />
{<br />
"source": "OUTPUTS/2/STATE",<br />
"type": "change"<br />
}<br />
],<br />
"payload": "${OUTPUTS/2/STATE}",<br />
"qos": 0,<br />
"retain": false,<br />
<b> "topic": "devices/${DEVICE_NAME}/output/2/state"</b><br />
}<br />
]<br />
}<br />
<br />
= Variables =<br />
In some parameters is nescessary to use variables to get current state and measurements. <b>Variables are separated in two categories:</b><br />
<br />
* Target/Source variables<br />
* Payload Topic variables<br />
<br />
== Target Source Variables ==<br />
<br />
The list of available variables for each <br />
<br />
=== OUTPUTS variables ===<br />
==== VOLTAGE ====<br />
Unit: <code>V</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Present RMS voltage on output 1 is ${OUTPUTS/1/VOLTAGE}"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/VOLTAGE}"</code><br />
<br />
==== CURRENT ====<br />
Unit: <code>mA</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Present RMS current on output 1 is ${OUTPUTS/1/CURRENT}"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/CURRENT}"</code><br />
<br />
==== POWER_FACTOR ====<br />
Unit: <code>[-]</code><br />
<br />
Type: float (2 decimals)<br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"True Power Factor on output 1 is ${OUTPUTS/1/POWER_FACTOR}"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/POWER_FACTOR}"</code><br />
<br />
==== LOAD ====<br />
Unit: <code>W</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Present load on output 1 is ${OUTPUTS/1/LOAD}W"</code><br />
<br />
Example 2: <code>"payload":"Device's load connected to output 1 is ${OUTPUTS/1/LOAD}W"</code><br />
<br />
Example 3: <code>"source":"${OUTPUTS/1/LOAD}"</code><br />
<br />
==== STATE ====<br />
Type: bool(integer) - <code>0</code> or <code>1</code><br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Present output 1 state is ${OUTPUTS/1/STATE}"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/STATE}"</code><br />
<br />
==== ACTION ====<br />
Type: integer<br />
<br />
Possible actions:<br />
* <code>0</code> - set state OFF<br />
* <code>1</code> - set state ON<br />
* <code>2</code> - short OFF (restart)<br />
* <code>3</code> - short ON<br />
* <code>4</code> - toggle (switch)<br />
* <code>5</code> - no change<br />
<br />
Allowed in: <code>"target"</code><br />
<br />
Example: <code>"target":"OUTPUTS/1/ACTION"</code><br />
<br />
==== DELAY [ms] ====<br />
==== NAME ====<br />
==== FREQUENCY ====<br />
Unit: <code>Hz</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example: <code>"payload":"Frequency in power grid is ${OUTPUTS/1/ENERGY}Hz"</code><br />
<br />
==== ENERGY ====<br />
Energy consumed by an device connected to NETIO device output.<br />
<br />
Unit: <code>Wh</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Consumed energy on output 1 is ${OUTPUTS/1/ENERGY}Wh"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/ENERGY}"</code><br />
<br />
==== REVERSE_ENERGY ====<br />
Energy delivered back to grid. For example from solar system connected to NETIO device output.<br />
<br />
Unit: <code>Wh</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Delivered energy on output 1 is ${OUTPUTS/1/REVERSE_ENERGY}Wh"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/REVERSE_ENERGY}"</code><br />
<br />
<br />
==== ENERGY_START ====<br />
Date when the counters ENERGY and REVERSE_ENERGY have been resetted by user.<br />
<br />
Unit: <code>unix timestamp</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code><br />
<br />
Example 1: <code>"payload":"Energy measured since ${OUTPUTS/1/ENERGY_START} unix time"</code><br />
<br />
Example 2: <code>"payload":"${OUTPUTS/1/ENERGY_START}"</code> is output payload <code>1567654639</code><br />
<br />
==== ENERGY_START_FMT ====<br />
Date when the counters ENERGY and REVERSE_ENERGY have been resetted by user.<br />
<br />
Unit: <code>fmt date format</code><br />
<br />
Type: string <br />
<br />
Allowed in: <code>"payload"</code><br />
<br />
Example 1: <code>"payload":"Energy measured since ${OUTPUTS/1/ENERGY_START}"</code><br />
<br />
Example 2: <code>"payload":"${OUTPUTS/1/ENERGY_START_FMT}"</code> is output payload <code>2019-09-05T03:37:19+00:00</code><br />
<br />
==== ENERGY_NR ====<br />
Non-resettable counter of Energy consumed by an device connected to NETIO device output.<br />
<br />
Unit: <code>Wh</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Consumed energy on output 1 is ${OUTPUTS/1/ENERGY_NR}Wh"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/ENERGY_NR}"</code><br />
<br />
==== REVERSE_ENERGY_NR ====<br />
Non-resettable counter of Energy delivered back to grid. For example from solar system connected to NETIO device output.<br />
<br />
Unit: <code>Wh</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Delivered energy on output 1 is ${OUTPUTS/1/REVERSE_ENERGY_NR}Wh"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/REVERSE_ENERGY_NR}"</code><br />
<br />
<br />
<br />
==== TOTALs - for use with devices having more than 1 measured output ====<br />
<br />
* OUTPUTS/TOTAL/ENERGY<br />
* OUTPUTS/TOTAL/LOAD<br />
* OUTPUTS/TOTAL/CURRENT<br />
* OUTPUTS/TOTAL/VOLTAGE<br />
* OUTPUTS/TOTAL/POWER_FACTOR<br />
* OUTPUTS/TOTAL/FREQUENCY<br />
* OUTPUTS/TOTAL/PHASE<br />
* OUTPUTS/TOTAL/REVERSE_ENERGY<br />
* OUTPUTS/TOTAL/ENERGY_NR<br />
* OUTPUTS/TOTAL/REVERSE_ENERGY_NR<br />
* OUTPUTS/TOTAL/ENERGY_START<br />
* OUTPUTS/TOTAL/ENERGY_START_FMT<br />
<br />
<br />
==== REST_JSON ====<br />
Allow use of NETIO JSON structure to control outputs.<br />
<br />
Type: string / JSON<br />
<br />
Allowed in: <code>"target"</code> for Subscribe section<br />
<br />
Example: <code>"target": "REST_JSON"</code><br />
<br />
The payload is JSON structure identical to NETIO JSON API M2M Protocol (documentation available at https://www.netio-products.com/files/NETIO-M2M-API-Protocol-JSON.pdf). You can control one or multiple outputs.<br />
<br />
Payload example 1 - Toggle output 1: <code>{"Outputs":[{"ID": 1,"Action": 4}]}</code><br />
<br />
Payload example 2 - Turn output 1 OFF and output 3 ON: <code>{"Outputs":[{"ID":1,"Action":0},{"ID":3,"Action":1}]}</code><br />
<br />
=== INPUT variables ===<br />
==== STATE ====<br />
Type: bool(integer) - <code>0</code> or <code>1</code><br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Present input 1 state is ${INPUTS/1/STATE}"</code><br />
<br />
Example 2: <code>"source":"${INPUTS/1/STATE}"</code><br />
<br />
==== S0 ====<br />
S0 Counter value<br />
Unit: <code>-</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Input 1 S0 Counter value is ${INPUTS/1/S0}impulses"</code><br />
<br />
Example 2: <code>"source":"${INPUTS/1/S0}"</code><br />
<br />
==== TEMPERATURE ====<br />
Temperature measurement in Celsius, Fahrenheit<br />
Unit: <code> [C], [F] </code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Input 1 Temperature value in degree of Celsius is ${INPUTS/1/TEMP} [C] "</code><br />
<br />
Example 2: <code>"source":"${INPUTS/1/TEMP}"</code><br />
<br />
<br />
Example 3: <code>"payload":"Input 1 Temperature value in degree of Fahrenheit is ${INPUTS/1/TEMPF} [F] "</code><br />
<br />
Example 4: <code>"source":"${INPUTS/1/TEMPF}"</code><br />
<br />
==== HUMIDITY ====<br />
Relative Humidity measurement <br />
Unit: <code> [%]</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Input 1 Humidity value is ${INPUTS/1/HUMIDITY} %"</code><br />
<br />
Example 2: <code>"source":"${INPUTS/1/HUMIDITY}"</code><br />
<br />
== Payload/topic variables ==<br />
<br />
=== DEVICE_NAME ===<br />
Can be used in: "payload", "topic"<br />
<br />
Example 1: <code>"payload":"${DEVICE_NAME}"</code><br />
<br />
Example 2: <code>"topic":"netio/${DEVICE_NAME}/output/1/action"</code><br />
<br />
=== DEVICE_MAC ===<br />
Can be used in: "payload", "topic"<br />
<br />
Example 1: <code>"payload":"${DEVICE_MAC}"</code><br />
<br />
Example 2: <code>"topic":"netio/${DEVICE_MAC}/output/1/action"</code><br />
<br />
=== UTC_TIME <sup><code>FW 4.0.0+</code></sup>===<br />
<br />
send unix timestamp of devices actual time<br />
<br />
Can be used in: "payload"<br />
<br />
Example 1: <code>"payload": "${UTC_TIME}"</code><br />
<br />
=== UPTIME <sup>Not yet implemented</sup> ===<br />
<br />
=== PAYLOAD ===<br />
Can be used in: "action"<br />
<br />
Example: <code>"action":"${PAYLOAD}"</code><br />
<br />
=== OUTPUT_ID <sup>Not yet implemented</sup>===<br />
<br />
=== WIFI_SIGNAL<sup>Not yet implemented</sup> ===<br />
<br />
=== OUTPUTS_STATUS ===<br />
Provide complete outputs status and measurement if supported.<br />
<br />
Type: string / JSON<br />
<br />
Allowed in: <code>"payload"</code> for Publish section<br />
<br />
Example: <code>"payload":"${OUTPUTS_STATUS}"</code><br />
<br />
Payload example: <code>{ "GlobalMeasure":{"Voltage":236,"TotalCurrent":72,"TotalLoad":11,"TotalEnergy":167,"OverallPowerFactor":0.64,"Frequency":50.07,"Phase":-36.86,"EnergyStart":"2020-06-30T17:04:48+01:00"}, "Outputs":[ {"ID":1,"Name":"Power output 1","State":1,"Action":6,"Delay":2020,"Current":72,"PowerFactor":0.64,"Phase":-36.86,"Energy":139,"ReverseEnergy":0,"Load":11}, {"ID":2,"Name":"Power output 2","State":1,"Action":6,"Delay":2020,"Current":0,"PowerFactor":1.00,"Phase":0.00,"Energy":27,"ReverseEnergy":0,"Load":0}, {"ID":3,"Name":"Free Contact 3","State":1,"Action":6,"Delay":2020}, {"ID":4,"Name":"Free Contact 4","State":1,"Action":6,"Delay":2020} ]}</code><br />
<br />
=== INPUTS_STATUS ===<br />
Provide complete inputs status if supported. Since FW 3.0.0<br />
<br />
Type: string / JSON<br />
<br />
Allowed in: <code>"payload"</code> for Publish section<br />
<br />
Example: <code>"payload":"${INPUTS_STATUS}"</code><br />
<br />
Payload example: <code>{ "Inputs":[ {"ID":1,"Name":"Input 1","State":0,"S0Counter":0}, {"ID":2,"Name":"Input 2","State":0,"S0Counter":0} ]}</code><br />
<br />
=== INOUT_STATUS ===<br />
Provide complete inputs and output status and measurement if supported. Since FW 3.0.0<br />
<br />
Type: string / JSON<br />
<br />
Allowed in: <code>"payload"</code> for Publish section<br />
<br />
Example: <code>"payload":"${INOUT_STATUS}"</code><br />
<br />
Payload example: <code>{ "GlobalMeasure":{"Voltage":238,"TotalCurrent":105,"TotalLoad":17,"TotalEnergy":1451,"OverallPowerFactor":0.67,"Frequency":50.03,"Phase":-33.67,"EnergyStart":"2020-06-30T17:04:48+01:00"}, "Outputs":[ {"ID":1,"Name":"Power output 1","State":0,"Action":6,"Delay":5000,"Current":0,"PowerFactor":1.00,"Phase":0.00,"Energy":701,"ReverseEnergy":0,"Load":0}, {"ID":2,"Name":"Power output 2","State":1,"Action":6,"Delay":5000,"Current":105,"PowerFactor":0.65,"Phase":-33.67,"Energy":750,"ReverseEnergy":0,"Load":17}, {"ID":3,"Name":"Free Contact 3","State":1,"Action":6,"Delay":5000}, {"ID":4,"Name":"Free Contact 4","State":0,"Action":6,"Delay":5000} ], "Inputs":[ {"ID":1,"Name":"Input 1","State":0,"S0Counter":0}, {"ID":2,"Name":"Input 2","State":0,"S0Counter":0} ]}</code><br />
<br />
= Extended MQTT flex JSON config examples =<br />
<br />
== Default NETIO MQTT-flex configuration ==<br />
This example demonstrates setup for connection to public <code>broker.hivemq.com</code>, measurement reporting and output control.<br />
<br />
The device cabe be controlled via <code>netio/${DEVICE_NAME}/output/1/action topic</code> by sending standard NETIO action values:<br />
* 0 - OFF<br />
* 1 - ON<br />
* 2 - SHORT OFF<br />
* 3 - SHORT ON<br />
* 4 - TOGGLE<br />
* 5 - NO ACTION.<br />
<br />
The device report measurements:<br />
<br />
* Output state - every 15 minutes or by change<br />
* Voltage [V]- every 5 minutes or by change of 1 V<br />
* Current [mA]- every 5 minutes or by change of 50 mA<br />
* Load(Power) [W]- every 5 minutes or by change of 10 W<br />
* Energy(Consumption) [Wh]- every 15 minutes or by change of 1Wh<br />
* True Power Factor (TPF) [-]- every 5 minutes or by change of 0.02<br />
* Frequency [Hz]- every 1 hour or by change of 0.1 Hz<br />
<br />
For register all values, you can use wildcard <code>netio/${DEVICE_NAME}/output/1/#</code><br />
<br />
{<br />
"config":{<br />
"broker":{<br />
"url":"broker.hivemq.com",<br />
"protocol":"mqtt",<br />
"port":1883,<br />
"ssl":false,<br />
"type":"generic",<br />
"username":"",<br />
"password":"",<br />
"clientid":"moje${DEVICE_NAME}${DEVICE_MAC}",<br />
"keepalive":30<br />
},<br />
"subscribe":[<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/action",<br />
"qos":0,<br />
"target":"OUTPUTS/1/ACTION",<br />
"action":"${payload}"<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/switch",<br />
"qos":0,<br />
"target":"OUTPUTS/1/ACTION",<br />
"action":4<br />
}<br />
],<br />
"publish":[<br />
{<br />
"topic":"netio/${DEVICE_MAC}/output/1/state",<br />
"qos":0,<br />
"retain":true,<br />
"payload":"${OUTPUTS/1/STATE}",<br />
"events":[<br />
{<br />
"type":"change",<br />
"source":"OUTPUTS/1/STATE"<br />
},<br />
{<br />
"type":"timer",<br />
"period":900<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/voltage",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/VOLTAGE}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":300<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/VOLTAGE",<br />
"delta":1<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/current",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/CURRENT}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":300<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/CURRENT",<br />
"delta":50<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/load",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/LOAD}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":300<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/LOAD",<br />
"delta":10<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/energy",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/ENERGY}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":900<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/ENERGY",<br />
"delta":1<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/tpf",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/POWER_FACTOR}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":900<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/POWER_FACTOR",<br />
"delta":0.02<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/frequency",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/FREQUENCY}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":3600<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/FREQUENCY",<br />
"delta":0.1<br />
}<br />
]<br />
}<br />
]<br />
}<br />
}</div>
Tbezstarosta
https://wiki.netio-products.com/index.php?title=MQTT-flex&diff=1082
MQTT-flex
2026-03-17T14:55:59Z
<p>Tbezstarosta: /* TEMPERATURE */</p>
<hr />
<div>The MQTT-flex version of the MQTT protocol can be configured in detail thanks to the “flex” extension.<br />
<br />
https://www.netio-products.com/en/glossary/mqtt-flex <br />
<br />
<b>Why MQTT-flex</b> <br><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.<br />
<br />
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.<br />
<br />
===Supported devices:===<br />
* PowerCable MQTT 101x <br><br />
* PowerCable REST 101x <br><br />
* PowerPDU 4PS <br><br />
* PowerPDU 4KS <br><br />
* PowerPDU 8QS <br><br />
* PowerDIN 4PZ <br><br />
* PowerBOX 3Px <br><br />
* PowerBOX 4Kx <br><br />
<br />
<b>FW version:</b> <br><br />
>2.2.1<br />
<br />
===Not supported NETIO devices:===<br />
* PowerPDU 4C <br><br />
* NETIO 4 <br><br />
* NETIO 4All <br><br />
<br />
= Simple MQTT-flex configuration + explanation =<br />
<br />
''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.''<br />
<br />
{<br />
"config":{<br />
"broker":{<br />
"url":"broker.hivemq.com",<br />
"protocol":"mqtt",<br />
"port":1883,<br />
"ssl":false,<br />
"type":"generic",<br />
"username":"freedom",<br />
"password":"peace|LOVE|empathy4ALL"<br />
},<br />
"subscribe":[{<br />
"topic":"netio/${DEVICE_NAME}/output/1/action",<br />
"qos":0,<br />
"target":"OUTPUTS/1/ACTION",<br />
"action":"${payload}"<br />
}<br />
],<br />
"publish":[{<br />
"topic":"netio/${DEVICE_NAME}/output/1/state",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/STATE}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":"1000"<br />
}<br />
]<br />
}<br />
]<br />
}<br />
}<br />
=== Client Configuration (broker section) ===<br />
Put here MQTT client connection setup<br />
<br />
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>. <br />
<br />
"broker":{<br />
"url":"broker.hivemq.com",<br />
"protocol":"mqtt",<br />
"port":1883,<br />
"ssl":false,<br />
"type":"generic",<br />
"username":"freedom",<br />
"password":"peace|LOVE|empathy4ALL"<br />
},<br />
<br />
=== Device Control (subscribe section) ===<br />
Put here array of topics where to subscribe<br />
<br />
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> <br />
<br />
"subscribe":[{<br />
"topic":"netio/${DEVICE_NAME}/output/1/action",<br />
"qos":0,<br />
"target":"OUTPUTS/1/ACTION",<br />
"action":"${payload}"<br />
}<br />
],<br />
<br />
=== Output State monitoring (publish section) ===<br />
Put here array of topics where to publish.<br />
<br />
Device send every <b>1000 s</b> message to topic <b></b> with <b>QOS 0</b>, <b>retain true</b> information with <b>output 1 state</b><br />
<br />
"publish":[{<br />
"topic":"netio/${DEVICE_NAME}/output/1/state",<br />
"qos":0,<br />
"retain":true,<br />
"payload":"${OUTPUTS/1/STATE}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":"1000"<br />
}<br />
]<br />
}<br />
]<br />
<br />
= Config sections =<br />
<br />
== Broker ==<br />
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 />
<br /><br />
=== Attributes table overview ===<br />
{| class="wikitable"<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Item<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Presence<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Possible Values<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Description<br />
! style="font-weight:bold; background-color:#9b9b9b;" | JSON Config Usage<br />
|-<br />
| style="background-color:#efefef;" | url<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | MQTT broker URL<br />
| style="background-color:#efefef;" | "url":"broker.hivemq.com"<br />
|-<br />
| style="background-color:#efefef;" | port<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | 1 - 65535<br />
| style="background-color:#efefef;" | MQTT broker port<br />
| style="background-color:#efefef;" | "port":1883<br />
|-<br />
| style="background-color:#efefef;" | protocol<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | protocol spec - mqtt<br />
| style="background-color:#efefef;" | "protocol": "mqtt"<br />
|-<br />
| style="background-color:#efefef;" | ssl<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | true, false<br />
| style="background-color:#efefef;" | Use SSL crypted communication selector<br />
| style="background-color:#efefef;" | "ssl":false<br />
|-<br />
| style="background-color:#efefef;" | type<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | generic<br />
| style="background-color:#efefef;" | Communication/setup type option<br />
| style="background-color:#efefef;" | "type":"generic"<br />
|-<br />
| style="background-color:#efefef;" | username<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | regexp+len<br />
| style="background-color:#efefef;" | Credentials for MQTT broker. Max. 128 characters (since FW 3.2.4).<br />
| style="background-color:#efefef;" | "username":"freedom"<br />
|-<br />
| style="background-color:#efefef;" | password<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | regexp+len<br />
| style="background-color:#efefef;" | Credentials for MQTT broker. Max. 256 characters (since FW 3.2.4).<br />
| style="background-color:#efefef;" | "password":"peace|LOVE|empathy4ALL"<br />
|-<br />
| style="background-color:#efefef;" | clientid<br />
| style="background-color:#efefef;" | optional<br />
| style="background-color:#efefef;" | regexp+len<br />
| style="background-color:#efefef;" | MQTT clientid. Max. 128 characters (since FW 3.2.4). Variables ${DEVICE_MAC} or ${DEVICE_NAME} can be used<br />
| style="background-color:#efefef;" | "clientid":"myEcoTable01"<br />
|-<br />
| style="background-color:#efefef;" | keepalive<br />
| style="background-color:#efefef;" | optional<br />
| style="background-color:#efefef;" | 1 - 65535<br />
| style="background-color:#efefef;" | MQTT keep alive period in seconds<br />
| style="background-color:#efefef;" | "keepalive":90<br />
|}<br />
<br />
Note 1: <b>clientid</b> attribute is <b>mandatory for MQTT(s)</b> communication. When not configured, random ID will be generated.<br />
<br />
Note 2: To proper communication with MS Azure - it is necessary to set up IoT Hub to use TLS 1.2<br />
<br />
See section "TLS 1.2 enforcement available in select regions" in following guidelines https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-tls-support<br />
<br />
=== Examples ===<br />
==== Standard setup ====<br />
<br />
<br />
==== Security (SSL / TLS) secured setup ====<br />
You can enable MQTTs by using the encrypted port <b>8883</b> + <b>"ssl":true</b>.<br />
<br />
==== Variables used setup ====<br />
<br />
== Subscribe ==<br />
=== Hints to usage ===<br />
When receive message in <b><i>topic</b></i> do <b><i>action</b></i> on <b><i>target</b></i>.<br />
<br />
<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>.<br />
<br />
=== Attributes table overview ===<br />
{| class="wikitable"<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Item<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Presence<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Possible Values<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Description<br />
! style="font-weight:bold; background-color:#9b9b9b;" | JSON Config Usage<br />
|-<br />
| style="background-color:#efefef;" | topic<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | see table below<br />
| style="background-color:#efefef;" | specification of the topic, which MQTT-flex device listens from broker and act accordingly. Max. 128 characters. The "#" can be used since FW 3.2.4 - see note under this table.<br />
| style="background-color:#efefef;" | "topic":"netio/${DEVICE_NAME}/output/1/action"<br />
|-<br />
| style="background-color:#efefef;" | qos<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | 0, 1 or 2<br />
| 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}<br />
| style="background-color:#efefef;" | "qos":0<br />
|-<br />
| style="background-color:#efefef;" | target<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | internal definition of action, which can be performed above the specified output<br />
| style="background-color:#efefef;" | "target":"OUTPUTS/1/ACTION"<br />
|-<br />
| style="background-color:#efefef;" | action<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | a payload or a value the action attribute needs to have passed to<br />
| style="background-color:#efefef;" | "action":"${payload}"<br />
|-<br />
| style="background-color:#efefef;" | actiondef<sup>Not supported yet</sup><br />
| style="background-color:#efefef;" | optional<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
|-<br />
| style="background-color:#efefef;" | json<sup>Not supported yet</sup><br />
| style="background-color:#efefef;" | optional<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
|}<br />
<br />
Note: The "#" wildcard can be used in subscribe topic definition. The multi-level wildcard character MUST be specified either on its own or following a topic level separator. In either case it MUST be the last character specified in the Topic.<br />
<br />
For example, if a Device subscribes to “devices/{device_id}/messages/devicebound/#”, it would receive messages published using these topic names:<br />
<br />
“devices/{device_id}/messages/devicebound/”<br />
<br />
“devices/{device_id}/messages/devicebound/{property_bag}”<br />
<br />
This should be usefull for use with MS Azure - IoT hub.<br />
<br />
=== MQTT Subscribe as event to trigger action <sup><code>FW 4.0.0+</code></sup> ===<br />
<br />
This feature allow to subscribe to specific MQTT topic and pass payload to Rules or MQTT-flex as event.<br />
<br />
target: <code>PROTOCOLS/MQTT/EVENT</code><br />
<br />
"subscribe": [<br />
{<br />
"action": "${payload}",<br />
"qos": 0,<br />
"target": "PROTOCOLS/MQTT/EVENT",<br />
"topic": "broker/12345/MQTT_EVENT/"<br />
}<br />
]<br />
<br />
=== Examples ===<br />
==== Toggle output with standard payload ==== <br />
==== Toggle output with custom payload ==== <br />
==== Subscribe to more than one topic ====<br />
==== Trigger Rule and MQTT publish from MQTT subscribe <sup><code>FW 4.0.0+</code></sup> ====<br />
This example show Request response implementation in MQTT and toggle action made by Rules.<br />
<br />
When message with payload <code>getValues</code> is published to topic <code>broker/gv90018g/COMMAND</code> MQTT flex will create an event with name <code>PROTOCOLS/MQTT/EVENT</code> (fixed name cannot be changed) and value <code>getValues</code>. On this event will act all events and conditions set in MQTT-flex and Rules which are set to listening to change on <code>PROTOCOLS/MQTT/EVENT</code> and equals to value <code>getValues</code>. See <b>bold</b> marked parameters in example configuration below. <br />
<br />
Once the triggered action is done it is needed to reset MQTT channel to <code>OK</code> status becaus event are reacting only to change. If the channel is not reset the next even would not be triggered.<br />
<br />
<b>Rules Configuration:</b><br />
{<br />
"conditions": {<br />
<b>"PROTOCOLS/MQTT/EVENT": "getValues"</b><br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 4<br />
}<br />
}<br />
<br />
<b>MQTT Configuration:</b><br />
{<br />
"broker":{<br />
"clientid":"netio${DEVICE_SN}",<br />
"keepalive":30,<br />
"password":"abcdefghijk",<br />
"port":8883,<br />
"protocol":"mqtt",<br />
"ssl":true,<br />
"type":"generic",<br />
"url":"broker.cloud.netio.eu",<br />
"username":"gv90018g"<br />
},<br />
"groupEvents":[<br />
{<br />
"events":[<br />
{<br />
<b>"source":"PROTOCOLS/MQTT/EVENT",<br />
"type":"change",<br />
"value":"getValues"</b><br />
}<br />
],<br />
"appliedTopics":[<br />
"broker/gv90018g/OUTPUTS/1/STATE",<br />
<b>"broker/gv90018g/COMMAND"</b><br />
]<br />
}<br />
],<br />
"publish":[<br />
{<br />
"payload":"${OUTPUTS/1/STATE}",<br />
"qos":0,<br />
"retain":true,<br />
"topic":"broker/gv90018g/OUTPUTS/1/STATE"<br />
},<br />
{<br />
"payload":"OK",<br />
"qos":0,<br />
"retain":true,<br />
"topic":"broker/gv90018g/COMMAND"<br />
}<br />
],<br />
"subscribe":[<br />
{<br />
"action":"${payload}",<br />
"qos":0,<br />
<b>"target":"PROTOCOLS/MQTT/EVENT"</b>,<br />
"topic":"broker/gv90018g/COMMAND"<br />
}<br />
]<br />
}<br />
<br />
<br />
<br />
Subscribe topic payload values specification for control of the output:<br />
<br />
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)<br />
<br />
== Publish ==<br />
<br />
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)<br />
<br />
=== Hints to usage ===<br />
When <b><i>event</b></i> send message with <b><i>payload</b></i> to <b><i>topic</b></i>.<br />
<br />
=== Attributes table overview ===<br />
{| class="wikitable"<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Item<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Presence<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Possible Values<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Description<br />
! style="font-weight:bold; background-color:#9b9b9b;" | JSON Config Usage<br />
|-<br />
| style="background-color:#efefef;" | topic<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | see table below<br />
| style="background-color:#efefef;" | definition of the topic, how it is registered towards MQTT broker. Max. 128 characters. <br />
| style="background-color:#efefef;" | "topic":"netio/${DEVICE_NAME}/output/1/load"<br />
|-<br />
| style="background-color:#efefef;" | qos<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | see table below<br />
| 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}<br />
| style="background-color:#efefef;" | <br />
|-<br />
| style="background-color:#efefef;" | retain<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | boolean: true or false<br />
| 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}<br />
| style="background-color:#efefef;" | "retain":true<br />
|-<br />
| style="background-color:#efefef;" | payload<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | see table below<br />
| style="background-color:#efefef;" | definition of the payload, what is send to the MQTT broker.<br />
| style="background-color:#efefef;" | "payload":"${OUTPUTS/1/STATE}"<br />
|-<br />
| style="background-color:#efefef;" | events<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | see table below<br />
| style="background-color:#efefef;" | definition of events used for triggering sending of data via mqtt (change, delta, timer)<br />
| style="background-color:#efefef;" | <br />
|-<br />
| style="background-color:#efefef;" | type<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" |<br />
|-<br />
| style="background-color:#efefef;" | source<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" |<br />
|-<br />
| style="background-color:#efefef;" | delta<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" |<br />
|-<br />
| style="background-color:#efefef;" | period<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" |<br />
| style="background-color:#efefef;" |<br />
|-<br />
| style="background-color:#efefef;" | payloaddef<sup>Not supported yet</sup><br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" |<br />
|}<br />
<br />
=== Examples ===<br />
==== Publish energy periodically (event timer) ==== <br />
==== Publish current on change (delta) ==== <br />
==== Publish output state ====<br />
==== Publish to more than one topic with different events ====<br />
<br />
= Target / Source =<br />
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.<br />
<br />
* <b>source</b> - specifies from where the value will be read (specifies the source of data for payload, change detection, delta calculation)<br />
* <b>target</b> - specifies where the data should be sent or command applied (e.g. specifies the target for ACTION)<br />
<br />
=== INPUT / OUTPUT (Target) selection ===<br />
<br />
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.<br />
<br />
# At first specify if requested variable is from/for INPUT or OUTPUT using keywords <b>"OUTPUTS"</b> or <b>"INPUTS"</b> .<br />
# Add <b>"/"</b> separator<br />
# Specify the number of INPUT/OUTPUT to <b>1</b>(or TOTAL for summary statistics if available)<br />
# Add <b>"/"</b> separator<br />
# Specify requested variable or command<br />
<br />
<b>Note:</b> Not all of OUTPUTS/INPUTS support all variables. Available variables are closely connected with the device functions and I/O features.<br />
<br />
<b>Note2:</b> INPUTS available only on NETIO PowerDIN 4PZ<br />
<br />
=== Examples: ===<br />
<br />
adressing controll of output 3<br />
OUTPUTS/3/ACTION<br />
getting voltage on output 1<br />
OUTPUTS/1/VOLTAGE<br />
getting state of input 1<br />
INPUTS/1/STATE<br />
<br />
= Group Events<sup><code>FW 4.0.0+</code></sup> =<br />
Group events are smart way how to keep configuration simple. It is not replacement of publish section specification but it is extension to trigger group of different topics to be published on the same event.<br />
<br />
See the example below. There is specific event on status change on every output and additionally the device sends periodic status every 60 seconds.<br />
<br />
{<br />
"broker": {<br />
"clientid": "netio${DEVICE_SN}",<br />
"keepalive": 30,<br />
"password": "",<br />
"port": 1883,<br />
"protocol": "mqtt",<br />
"ssl": false,<br />
"type": "generic",<br />
"url": "broker.hivemq.com",<br />
"username": ""<br />
},<br />
<b>"groupEvents": [<br />
{<br />
"events":[<br />
{<br />
"period": 60,<br />
"type": "timer"<br />
}<br />
],<br />
"appliedTopics":[<br />
"devices/${DEVICE_NAME}/output/1/state",<br />
"devices/${DEVICE_NAME}/output/2/state"<br />
]<br />
}<br />
],</b><br />
"publish": [<br />
{<br />
"events": [<br />
{<br />
"source": "OUTPUTS/1/STATE",<br />
"type": "change"<br />
}<br />
],<br />
"payload": "${OUTPUTS/1/STATE}",<br />
"qos": 0,<br />
"retain": false,<br />
<b> "topic": "devices/${DEVICE_NAME}/output/1/state"</b><br />
},{<br />
"events": [<br />
{<br />
"source": "OUTPUTS/2/STATE",<br />
"type": "change"<br />
}<br />
],<br />
"payload": "${OUTPUTS/2/STATE}",<br />
"qos": 0,<br />
"retain": false,<br />
<b> "topic": "devices/${DEVICE_NAME}/output/2/state"</b><br />
}<br />
]<br />
}<br />
<br />
= Variables =<br />
In some parameters is nescessary to use variables to get current state and measurements. <b>Variables are separated in two categories:</b><br />
<br />
* Target/Source variables<br />
* Payload Topic variables<br />
<br />
== Target Source Variables ==<br />
<br />
The list of available variables for each <br />
<br />
=== OUTPUTS variables ===<br />
==== VOLTAGE ====<br />
Unit: <code>V</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Present RMS voltage on output 1 is ${OUTPUTS/1/VOLTAGE}"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/VOLTAGE}"</code><br />
<br />
==== CURRENT ====<br />
Unit: <code>mA</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Present RMS current on output 1 is ${OUTPUTS/1/CURRENT}"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/CURRENT}"</code><br />
<br />
==== POWER_FACTOR ====<br />
Unit: <code>[-]</code><br />
<br />
Type: float (2 decimals)<br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"True Power Factor on output 1 is ${OUTPUTS/1/POWER_FACTOR}"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/POWER_FACTOR}"</code><br />
<br />
==== LOAD ====<br />
Unit: <code>W</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Present load on output 1 is ${OUTPUTS/1/LOAD}W"</code><br />
<br />
Example 2: <code>"payload":"Device's load connected to output 1 is ${OUTPUTS/1/LOAD}W"</code><br />
<br />
Example 3: <code>"source":"${OUTPUTS/1/LOAD}"</code><br />
<br />
==== STATE ====<br />
Type: bool(integer) - <code>0</code> or <code>1</code><br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Present output 1 state is ${OUTPUTS/1/STATE}"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/STATE}"</code><br />
<br />
==== ACTION ====<br />
Type: integer<br />
<br />
Possible actions:<br />
* <code>0</code> - set state OFF<br />
* <code>1</code> - set state ON<br />
* <code>2</code> - short OFF (restart)<br />
* <code>3</code> - short ON<br />
* <code>4</code> - toggle (switch)<br />
* <code>5</code> - no change<br />
<br />
Allowed in: <code>"target"</code><br />
<br />
Example: <code>"target":"OUTPUTS/1/ACTION"</code><br />
<br />
==== DELAY [ms] ====<br />
==== NAME ====<br />
==== FREQUENCY ====<br />
Unit: <code>Hz</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example: <code>"payload":"Frequency in power grid is ${OUTPUTS/1/ENERGY}Hz"</code><br />
<br />
==== ENERGY ====<br />
Energy consumed by an device connected to NETIO device output.<br />
<br />
Unit: <code>Wh</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Consumed energy on output 1 is ${OUTPUTS/1/ENERGY}Wh"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/ENERGY}"</code><br />
<br />
==== REVERSE_ENERGY ====<br />
Energy delivered back to grid. For example from solar system connected to NETIO device output.<br />
<br />
Unit: <code>Wh</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Delivered energy on output 1 is ${OUTPUTS/1/REVERSE_ENERGY}Wh"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/REVERSE_ENERGY}"</code><br />
<br />
<br />
==== ENERGY_START ====<br />
Date when the counters ENERGY and REVERSE_ENERGY have been resetted by user.<br />
<br />
Unit: <code>unix timestamp</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code><br />
<br />
Example 1: <code>"payload":"Energy measured since ${OUTPUTS/1/ENERGY_START} unix time"</code><br />
<br />
Example 2: <code>"payload":"${OUTPUTS/1/ENERGY_START}"</code> is output payload <code>1567654639</code><br />
<br />
==== ENERGY_START_FMT ====<br />
Date when the counters ENERGY and REVERSE_ENERGY have been resetted by user.<br />
<br />
Unit: <code>fmt date format</code><br />
<br />
Type: string <br />
<br />
Allowed in: <code>"payload"</code><br />
<br />
Example 1: <code>"payload":"Energy measured since ${OUTPUTS/1/ENERGY_START}"</code><br />
<br />
Example 2: <code>"payload":"${OUTPUTS/1/ENERGY_START_FMT}"</code> is output payload <code>2019-09-05T03:37:19+00:00</code><br />
<br />
==== ENERGY_NR ====<br />
Non-resettable counter of Energy consumed by an device connected to NETIO device output.<br />
<br />
Unit: <code>Wh</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Consumed energy on output 1 is ${OUTPUTS/1/ENERGY_NR}Wh"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/ENERGY_NR}"</code><br />
<br />
==== REVERSE_ENERGY_NR ====<br />
Non-resettable counter of Energy delivered back to grid. For example from solar system connected to NETIO device output.<br />
<br />
Unit: <code>Wh</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Delivered energy on output 1 is ${OUTPUTS/1/REVERSE_ENERGY_NR}Wh"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/REVERSE_ENERGY_NR}"</code><br />
<br />
<br />
<br />
==== TOTALs - for use with devices having more than 1 measured output ====<br />
<br />
* OUTPUTS/TOTAL/ENERGY<br />
* OUTPUTS/TOTAL/LOAD<br />
* OUTPUTS/TOTAL/CURRENT<br />
* OUTPUTS/TOTAL/VOLTAGE<br />
* OUTPUTS/TOTAL/POWER_FACTOR<br />
* OUTPUTS/TOTAL/FREQUENCY<br />
* OUTPUTS/TOTAL/PHASE<br />
* OUTPUTS/TOTAL/REVERSE_ENERGY<br />
* OUTPUTS/TOTAL/ENERGY_NR<br />
* OUTPUTS/TOTAL/REVERSE_ENERGY_NR<br />
* OUTPUTS/TOTAL/ENERGY_START<br />
* OUTPUTS/TOTAL/ENERGY_START_FMT<br />
<br />
<br />
==== REST_JSON ====<br />
Allow use of NETIO JSON structure to control outputs.<br />
<br />
Type: string / JSON<br />
<br />
Allowed in: <code>"target"</code> for Subscribe section<br />
<br />
Example: <code>"target": "REST_JSON"</code><br />
<br />
The payload is JSON structure identical to NETIO JSON API M2M Protocol (documentation available at https://www.netio-products.com/files/NETIO-M2M-API-Protocol-JSON.pdf). You can control one or multiple outputs.<br />
<br />
Payload example 1 - Toggle output 1: <code>{"Outputs":[{"ID": 1,"Action": 4}]}</code><br />
<br />
Payload example 2 - Turn output 1 OFF and output 3 ON: <code>{"Outputs":[{"ID":1,"Action":0},{"ID":3,"Action":1}]}</code><br />
<br />
=== INPUT variables ===<br />
==== STATE ====<br />
Type: bool(integer) - <code>0</code> or <code>1</code><br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Present input 1 state is ${INPUTS/1/STATE}"</code><br />
<br />
Example 2: <code>"source":"${INPUTS/1/STATE}"</code><br />
<br />
==== S0 ====<br />
S0 Counter value<br />
Unit: <code>-</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Input 1 S0 Counter value is ${INPUTS/1/S0}impulses"</code><br />
<br />
Example 2: <code>"source":"${INPUTS/1/S0}"</code><br />
<br />
==== TEMPERATURE ====<br />
Temperature measurement in Celsius, Fahrenheit<br />
Unit: <code> [C], [F] </code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Input 1 Temperature value in degree of Celsius is ${INPUTS/1/TEMP} [C] "</code><br />
<br />
Example 2: <code>"source":"${INPUTS/1/TEMP}"</code><br />
<br />
<br />
Example 3: <code>"payload":"Input 1 Temperature value in degree of Fahrenheit is ${INPUTS/1/TEMPF} [F] "</code><br />
<br />
Example 4: <code>"source":"${INPUTS/1/TEMPF}"</code><br />
<br />
==== HUMIDITY ====<br />
Relative Humidity measurement in[%]<br />
Unit: <code>-</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Input 1 Humidity value is ${INPUTS/1/HUMIDITY} %"</code><br />
<br />
Example 2: <code>"source":"${INPUTS/1/HUMIDITY}"</code><br />
<br />
== Payload/topic variables ==<br />
<br />
=== DEVICE_NAME ===<br />
Can be used in: "payload", "topic"<br />
<br />
Example 1: <code>"payload":"${DEVICE_NAME}"</code><br />
<br />
Example 2: <code>"topic":"netio/${DEVICE_NAME}/output/1/action"</code><br />
<br />
=== DEVICE_MAC ===<br />
Can be used in: "payload", "topic"<br />
<br />
Example 1: <code>"payload":"${DEVICE_MAC}"</code><br />
<br />
Example 2: <code>"topic":"netio/${DEVICE_MAC}/output/1/action"</code><br />
<br />
=== UTC_TIME <sup><code>FW 4.0.0+</code></sup>===<br />
<br />
send unix timestamp of devices actual time<br />
<br />
Can be used in: "payload"<br />
<br />
Example 1: <code>"payload": "${UTC_TIME}"</code><br />
<br />
=== UPTIME <sup>Not yet implemented</sup> ===<br />
<br />
=== PAYLOAD ===<br />
Can be used in: "action"<br />
<br />
Example: <code>"action":"${PAYLOAD}"</code><br />
<br />
=== OUTPUT_ID <sup>Not yet implemented</sup>===<br />
<br />
=== WIFI_SIGNAL<sup>Not yet implemented</sup> ===<br />
<br />
=== OUTPUTS_STATUS ===<br />
Provide complete outputs status and measurement if supported.<br />
<br />
Type: string / JSON<br />
<br />
Allowed in: <code>"payload"</code> for Publish section<br />
<br />
Example: <code>"payload":"${OUTPUTS_STATUS}"</code><br />
<br />
Payload example: <code>{ "GlobalMeasure":{"Voltage":236,"TotalCurrent":72,"TotalLoad":11,"TotalEnergy":167,"OverallPowerFactor":0.64,"Frequency":50.07,"Phase":-36.86,"EnergyStart":"2020-06-30T17:04:48+01:00"}, "Outputs":[ {"ID":1,"Name":"Power output 1","State":1,"Action":6,"Delay":2020,"Current":72,"PowerFactor":0.64,"Phase":-36.86,"Energy":139,"ReverseEnergy":0,"Load":11}, {"ID":2,"Name":"Power output 2","State":1,"Action":6,"Delay":2020,"Current":0,"PowerFactor":1.00,"Phase":0.00,"Energy":27,"ReverseEnergy":0,"Load":0}, {"ID":3,"Name":"Free Contact 3","State":1,"Action":6,"Delay":2020}, {"ID":4,"Name":"Free Contact 4","State":1,"Action":6,"Delay":2020} ]}</code><br />
<br />
=== INPUTS_STATUS ===<br />
Provide complete inputs status if supported. Since FW 3.0.0<br />
<br />
Type: string / JSON<br />
<br />
Allowed in: <code>"payload"</code> for Publish section<br />
<br />
Example: <code>"payload":"${INPUTS_STATUS}"</code><br />
<br />
Payload example: <code>{ "Inputs":[ {"ID":1,"Name":"Input 1","State":0,"S0Counter":0}, {"ID":2,"Name":"Input 2","State":0,"S0Counter":0} ]}</code><br />
<br />
=== INOUT_STATUS ===<br />
Provide complete inputs and output status and measurement if supported. Since FW 3.0.0<br />
<br />
Type: string / JSON<br />
<br />
Allowed in: <code>"payload"</code> for Publish section<br />
<br />
Example: <code>"payload":"${INOUT_STATUS}"</code><br />
<br />
Payload example: <code>{ "GlobalMeasure":{"Voltage":238,"TotalCurrent":105,"TotalLoad":17,"TotalEnergy":1451,"OverallPowerFactor":0.67,"Frequency":50.03,"Phase":-33.67,"EnergyStart":"2020-06-30T17:04:48+01:00"}, "Outputs":[ {"ID":1,"Name":"Power output 1","State":0,"Action":6,"Delay":5000,"Current":0,"PowerFactor":1.00,"Phase":0.00,"Energy":701,"ReverseEnergy":0,"Load":0}, {"ID":2,"Name":"Power output 2","State":1,"Action":6,"Delay":5000,"Current":105,"PowerFactor":0.65,"Phase":-33.67,"Energy":750,"ReverseEnergy":0,"Load":17}, {"ID":3,"Name":"Free Contact 3","State":1,"Action":6,"Delay":5000}, {"ID":4,"Name":"Free Contact 4","State":0,"Action":6,"Delay":5000} ], "Inputs":[ {"ID":1,"Name":"Input 1","State":0,"S0Counter":0}, {"ID":2,"Name":"Input 2","State":0,"S0Counter":0} ]}</code><br />
<br />
= Extended MQTT flex JSON config examples =<br />
<br />
== Default NETIO MQTT-flex configuration ==<br />
This example demonstrates setup for connection to public <code>broker.hivemq.com</code>, measurement reporting and output control.<br />
<br />
The device cabe be controlled via <code>netio/${DEVICE_NAME}/output/1/action topic</code> by sending standard NETIO action values:<br />
* 0 - OFF<br />
* 1 - ON<br />
* 2 - SHORT OFF<br />
* 3 - SHORT ON<br />
* 4 - TOGGLE<br />
* 5 - NO ACTION.<br />
<br />
The device report measurements:<br />
<br />
* Output state - every 15 minutes or by change<br />
* Voltage [V]- every 5 minutes or by change of 1 V<br />
* Current [mA]- every 5 minutes or by change of 50 mA<br />
* Load(Power) [W]- every 5 minutes or by change of 10 W<br />
* Energy(Consumption) [Wh]- every 15 minutes or by change of 1Wh<br />
* True Power Factor (TPF) [-]- every 5 minutes or by change of 0.02<br />
* Frequency [Hz]- every 1 hour or by change of 0.1 Hz<br />
<br />
For register all values, you can use wildcard <code>netio/${DEVICE_NAME}/output/1/#</code><br />
<br />
{<br />
"config":{<br />
"broker":{<br />
"url":"broker.hivemq.com",<br />
"protocol":"mqtt",<br />
"port":1883,<br />
"ssl":false,<br />
"type":"generic",<br />
"username":"",<br />
"password":"",<br />
"clientid":"moje${DEVICE_NAME}${DEVICE_MAC}",<br />
"keepalive":30<br />
},<br />
"subscribe":[<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/action",<br />
"qos":0,<br />
"target":"OUTPUTS/1/ACTION",<br />
"action":"${payload}"<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/switch",<br />
"qos":0,<br />
"target":"OUTPUTS/1/ACTION",<br />
"action":4<br />
}<br />
],<br />
"publish":[<br />
{<br />
"topic":"netio/${DEVICE_MAC}/output/1/state",<br />
"qos":0,<br />
"retain":true,<br />
"payload":"${OUTPUTS/1/STATE}",<br />
"events":[<br />
{<br />
"type":"change",<br />
"source":"OUTPUTS/1/STATE"<br />
},<br />
{<br />
"type":"timer",<br />
"period":900<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/voltage",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/VOLTAGE}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":300<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/VOLTAGE",<br />
"delta":1<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/current",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/CURRENT}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":300<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/CURRENT",<br />
"delta":50<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/load",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/LOAD}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":300<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/LOAD",<br />
"delta":10<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/energy",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/ENERGY}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":900<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/ENERGY",<br />
"delta":1<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/tpf",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/POWER_FACTOR}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":900<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/POWER_FACTOR",<br />
"delta":0.02<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/frequency",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/FREQUENCY}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":3600<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/FREQUENCY",<br />
"delta":0.1<br />
}<br />
]<br />
}<br />
]<br />
}<br />
}</div>
Tbezstarosta
https://wiki.netio-products.com/index.php?title=MQTT-flex&diff=1081
MQTT-flex
2026-03-17T14:55:18Z
<p>Tbezstarosta: /* TEMPERATURE */</p>
<hr />
<div>The MQTT-flex version of the MQTT protocol can be configured in detail thanks to the “flex” extension.<br />
<br />
https://www.netio-products.com/en/glossary/mqtt-flex <br />
<br />
<b>Why MQTT-flex</b> <br><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.<br />
<br />
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.<br />
<br />
===Supported devices:===<br />
* PowerCable MQTT 101x <br><br />
* PowerCable REST 101x <br><br />
* PowerPDU 4PS <br><br />
* PowerPDU 4KS <br><br />
* PowerPDU 8QS <br><br />
* PowerDIN 4PZ <br><br />
* PowerBOX 3Px <br><br />
* PowerBOX 4Kx <br><br />
<br />
<b>FW version:</b> <br><br />
>2.2.1<br />
<br />
===Not supported NETIO devices:===<br />
* PowerPDU 4C <br><br />
* NETIO 4 <br><br />
* NETIO 4All <br><br />
<br />
= Simple MQTT-flex configuration + explanation =<br />
<br />
''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.''<br />
<br />
{<br />
"config":{<br />
"broker":{<br />
"url":"broker.hivemq.com",<br />
"protocol":"mqtt",<br />
"port":1883,<br />
"ssl":false,<br />
"type":"generic",<br />
"username":"freedom",<br />
"password":"peace|LOVE|empathy4ALL"<br />
},<br />
"subscribe":[{<br />
"topic":"netio/${DEVICE_NAME}/output/1/action",<br />
"qos":0,<br />
"target":"OUTPUTS/1/ACTION",<br />
"action":"${payload}"<br />
}<br />
],<br />
"publish":[{<br />
"topic":"netio/${DEVICE_NAME}/output/1/state",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/STATE}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":"1000"<br />
}<br />
]<br />
}<br />
]<br />
}<br />
}<br />
=== Client Configuration (broker section) ===<br />
Put here MQTT client connection setup<br />
<br />
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>. <br />
<br />
"broker":{<br />
"url":"broker.hivemq.com",<br />
"protocol":"mqtt",<br />
"port":1883,<br />
"ssl":false,<br />
"type":"generic",<br />
"username":"freedom",<br />
"password":"peace|LOVE|empathy4ALL"<br />
},<br />
<br />
=== Device Control (subscribe section) ===<br />
Put here array of topics where to subscribe<br />
<br />
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> <br />
<br />
"subscribe":[{<br />
"topic":"netio/${DEVICE_NAME}/output/1/action",<br />
"qos":0,<br />
"target":"OUTPUTS/1/ACTION",<br />
"action":"${payload}"<br />
}<br />
],<br />
<br />
=== Output State monitoring (publish section) ===<br />
Put here array of topics where to publish.<br />
<br />
Device send every <b>1000 s</b> message to topic <b></b> with <b>QOS 0</b>, <b>retain true</b> information with <b>output 1 state</b><br />
<br />
"publish":[{<br />
"topic":"netio/${DEVICE_NAME}/output/1/state",<br />
"qos":0,<br />
"retain":true,<br />
"payload":"${OUTPUTS/1/STATE}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":"1000"<br />
}<br />
]<br />
}<br />
]<br />
<br />
= Config sections =<br />
<br />
== Broker ==<br />
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 />
<br /><br />
=== Attributes table overview ===<br />
{| class="wikitable"<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Item<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Presence<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Possible Values<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Description<br />
! style="font-weight:bold; background-color:#9b9b9b;" | JSON Config Usage<br />
|-<br />
| style="background-color:#efefef;" | url<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | MQTT broker URL<br />
| style="background-color:#efefef;" | "url":"broker.hivemq.com"<br />
|-<br />
| style="background-color:#efefef;" | port<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | 1 - 65535<br />
| style="background-color:#efefef;" | MQTT broker port<br />
| style="background-color:#efefef;" | "port":1883<br />
|-<br />
| style="background-color:#efefef;" | protocol<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | protocol spec - mqtt<br />
| style="background-color:#efefef;" | "protocol": "mqtt"<br />
|-<br />
| style="background-color:#efefef;" | ssl<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | true, false<br />
| style="background-color:#efefef;" | Use SSL crypted communication selector<br />
| style="background-color:#efefef;" | "ssl":false<br />
|-<br />
| style="background-color:#efefef;" | type<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | generic<br />
| style="background-color:#efefef;" | Communication/setup type option<br />
| style="background-color:#efefef;" | "type":"generic"<br />
|-<br />
| style="background-color:#efefef;" | username<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | regexp+len<br />
| style="background-color:#efefef;" | Credentials for MQTT broker. Max. 128 characters (since FW 3.2.4).<br />
| style="background-color:#efefef;" | "username":"freedom"<br />
|-<br />
| style="background-color:#efefef;" | password<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | regexp+len<br />
| style="background-color:#efefef;" | Credentials for MQTT broker. Max. 256 characters (since FW 3.2.4).<br />
| style="background-color:#efefef;" | "password":"peace|LOVE|empathy4ALL"<br />
|-<br />
| style="background-color:#efefef;" | clientid<br />
| style="background-color:#efefef;" | optional<br />
| style="background-color:#efefef;" | regexp+len<br />
| style="background-color:#efefef;" | MQTT clientid. Max. 128 characters (since FW 3.2.4). Variables ${DEVICE_MAC} or ${DEVICE_NAME} can be used<br />
| style="background-color:#efefef;" | "clientid":"myEcoTable01"<br />
|-<br />
| style="background-color:#efefef;" | keepalive<br />
| style="background-color:#efefef;" | optional<br />
| style="background-color:#efefef;" | 1 - 65535<br />
| style="background-color:#efefef;" | MQTT keep alive period in seconds<br />
| style="background-color:#efefef;" | "keepalive":90<br />
|}<br />
<br />
Note 1: <b>clientid</b> attribute is <b>mandatory for MQTT(s)</b> communication. When not configured, random ID will be generated.<br />
<br />
Note 2: To proper communication with MS Azure - it is necessary to set up IoT Hub to use TLS 1.2<br />
<br />
See section "TLS 1.2 enforcement available in select regions" in following guidelines https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-tls-support<br />
<br />
=== Examples ===<br />
==== Standard setup ====<br />
<br />
<br />
==== Security (SSL / TLS) secured setup ====<br />
You can enable MQTTs by using the encrypted port <b>8883</b> + <b>"ssl":true</b>.<br />
<br />
==== Variables used setup ====<br />
<br />
== Subscribe ==<br />
=== Hints to usage ===<br />
When receive message in <b><i>topic</b></i> do <b><i>action</b></i> on <b><i>target</b></i>.<br />
<br />
<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>.<br />
<br />
=== Attributes table overview ===<br />
{| class="wikitable"<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Item<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Presence<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Possible Values<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Description<br />
! style="font-weight:bold; background-color:#9b9b9b;" | JSON Config Usage<br />
|-<br />
| style="background-color:#efefef;" | topic<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | see table below<br />
| style="background-color:#efefef;" | specification of the topic, which MQTT-flex device listens from broker and act accordingly. Max. 128 characters. The "#" can be used since FW 3.2.4 - see note under this table.<br />
| style="background-color:#efefef;" | "topic":"netio/${DEVICE_NAME}/output/1/action"<br />
|-<br />
| style="background-color:#efefef;" | qos<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | 0, 1 or 2<br />
| 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}<br />
| style="background-color:#efefef;" | "qos":0<br />
|-<br />
| style="background-color:#efefef;" | target<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | internal definition of action, which can be performed above the specified output<br />
| style="background-color:#efefef;" | "target":"OUTPUTS/1/ACTION"<br />
|-<br />
| style="background-color:#efefef;" | action<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | a payload or a value the action attribute needs to have passed to<br />
| style="background-color:#efefef;" | "action":"${payload}"<br />
|-<br />
| style="background-color:#efefef;" | actiondef<sup>Not supported yet</sup><br />
| style="background-color:#efefef;" | optional<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
|-<br />
| style="background-color:#efefef;" | json<sup>Not supported yet</sup><br />
| style="background-color:#efefef;" | optional<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
|}<br />
<br />
Note: The "#" wildcard can be used in subscribe topic definition. The multi-level wildcard character MUST be specified either on its own or following a topic level separator. In either case it MUST be the last character specified in the Topic.<br />
<br />
For example, if a Device subscribes to “devices/{device_id}/messages/devicebound/#”, it would receive messages published using these topic names:<br />
<br />
“devices/{device_id}/messages/devicebound/”<br />
<br />
“devices/{device_id}/messages/devicebound/{property_bag}”<br />
<br />
This should be usefull for use with MS Azure - IoT hub.<br />
<br />
=== MQTT Subscribe as event to trigger action <sup><code>FW 4.0.0+</code></sup> ===<br />
<br />
This feature allow to subscribe to specific MQTT topic and pass payload to Rules or MQTT-flex as event.<br />
<br />
target: <code>PROTOCOLS/MQTT/EVENT</code><br />
<br />
"subscribe": [<br />
{<br />
"action": "${payload}",<br />
"qos": 0,<br />
"target": "PROTOCOLS/MQTT/EVENT",<br />
"topic": "broker/12345/MQTT_EVENT/"<br />
}<br />
]<br />
<br />
=== Examples ===<br />
==== Toggle output with standard payload ==== <br />
==== Toggle output with custom payload ==== <br />
==== Subscribe to more than one topic ====<br />
==== Trigger Rule and MQTT publish from MQTT subscribe <sup><code>FW 4.0.0+</code></sup> ====<br />
This example show Request response implementation in MQTT and toggle action made by Rules.<br />
<br />
When message with payload <code>getValues</code> is published to topic <code>broker/gv90018g/COMMAND</code> MQTT flex will create an event with name <code>PROTOCOLS/MQTT/EVENT</code> (fixed name cannot be changed) and value <code>getValues</code>. On this event will act all events and conditions set in MQTT-flex and Rules which are set to listening to change on <code>PROTOCOLS/MQTT/EVENT</code> and equals to value <code>getValues</code>. See <b>bold</b> marked parameters in example configuration below. <br />
<br />
Once the triggered action is done it is needed to reset MQTT channel to <code>OK</code> status becaus event are reacting only to change. If the channel is not reset the next even would not be triggered.<br />
<br />
<b>Rules Configuration:</b><br />
{<br />
"conditions": {<br />
<b>"PROTOCOLS/MQTT/EVENT": "getValues"</b><br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 4<br />
}<br />
}<br />
<br />
<b>MQTT Configuration:</b><br />
{<br />
"broker":{<br />
"clientid":"netio${DEVICE_SN}",<br />
"keepalive":30,<br />
"password":"abcdefghijk",<br />
"port":8883,<br />
"protocol":"mqtt",<br />
"ssl":true,<br />
"type":"generic",<br />
"url":"broker.cloud.netio.eu",<br />
"username":"gv90018g"<br />
},<br />
"groupEvents":[<br />
{<br />
"events":[<br />
{<br />
<b>"source":"PROTOCOLS/MQTT/EVENT",<br />
"type":"change",<br />
"value":"getValues"</b><br />
}<br />
],<br />
"appliedTopics":[<br />
"broker/gv90018g/OUTPUTS/1/STATE",<br />
<b>"broker/gv90018g/COMMAND"</b><br />
]<br />
}<br />
],<br />
"publish":[<br />
{<br />
"payload":"${OUTPUTS/1/STATE}",<br />
"qos":0,<br />
"retain":true,<br />
"topic":"broker/gv90018g/OUTPUTS/1/STATE"<br />
},<br />
{<br />
"payload":"OK",<br />
"qos":0,<br />
"retain":true,<br />
"topic":"broker/gv90018g/COMMAND"<br />
}<br />
],<br />
"subscribe":[<br />
{<br />
"action":"${payload}",<br />
"qos":0,<br />
<b>"target":"PROTOCOLS/MQTT/EVENT"</b>,<br />
"topic":"broker/gv90018g/COMMAND"<br />
}<br />
]<br />
}<br />
<br />
<br />
<br />
Subscribe topic payload values specification for control of the output:<br />
<br />
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)<br />
<br />
== Publish ==<br />
<br />
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)<br />
<br />
=== Hints to usage ===<br />
When <b><i>event</b></i> send message with <b><i>payload</b></i> to <b><i>topic</b></i>.<br />
<br />
=== Attributes table overview ===<br />
{| class="wikitable"<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Item<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Presence<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Possible Values<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Description<br />
! style="font-weight:bold; background-color:#9b9b9b;" | JSON Config Usage<br />
|-<br />
| style="background-color:#efefef;" | topic<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | see table below<br />
| style="background-color:#efefef;" | definition of the topic, how it is registered towards MQTT broker. Max. 128 characters. <br />
| style="background-color:#efefef;" | "topic":"netio/${DEVICE_NAME}/output/1/load"<br />
|-<br />
| style="background-color:#efefef;" | qos<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | see table below<br />
| 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}<br />
| style="background-color:#efefef;" | <br />
|-<br />
| style="background-color:#efefef;" | retain<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | boolean: true or false<br />
| 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}<br />
| style="background-color:#efefef;" | "retain":true<br />
|-<br />
| style="background-color:#efefef;" | payload<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | see table below<br />
| style="background-color:#efefef;" | definition of the payload, what is send to the MQTT broker.<br />
| style="background-color:#efefef;" | "payload":"${OUTPUTS/1/STATE}"<br />
|-<br />
| style="background-color:#efefef;" | events<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | see table below<br />
| style="background-color:#efefef;" | definition of events used for triggering sending of data via mqtt (change, delta, timer)<br />
| style="background-color:#efefef;" | <br />
|-<br />
| style="background-color:#efefef;" | type<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" |<br />
|-<br />
| style="background-color:#efefef;" | source<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" |<br />
|-<br />
| style="background-color:#efefef;" | delta<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" |<br />
|-<br />
| style="background-color:#efefef;" | period<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" |<br />
| style="background-color:#efefef;" |<br />
|-<br />
| style="background-color:#efefef;" | payloaddef<sup>Not supported yet</sup><br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" |<br />
|}<br />
<br />
=== Examples ===<br />
==== Publish energy periodically (event timer) ==== <br />
==== Publish current on change (delta) ==== <br />
==== Publish output state ====<br />
==== Publish to more than one topic with different events ====<br />
<br />
= Target / Source =<br />
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.<br />
<br />
* <b>source</b> - specifies from where the value will be read (specifies the source of data for payload, change detection, delta calculation)<br />
* <b>target</b> - specifies where the data should be sent or command applied (e.g. specifies the target for ACTION)<br />
<br />
=== INPUT / OUTPUT (Target) selection ===<br />
<br />
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.<br />
<br />
# At first specify if requested variable is from/for INPUT or OUTPUT using keywords <b>"OUTPUTS"</b> or <b>"INPUTS"</b> .<br />
# Add <b>"/"</b> separator<br />
# Specify the number of INPUT/OUTPUT to <b>1</b>(or TOTAL for summary statistics if available)<br />
# Add <b>"/"</b> separator<br />
# Specify requested variable or command<br />
<br />
<b>Note:</b> Not all of OUTPUTS/INPUTS support all variables. Available variables are closely connected with the device functions and I/O features.<br />
<br />
<b>Note2:</b> INPUTS available only on NETIO PowerDIN 4PZ<br />
<br />
=== Examples: ===<br />
<br />
adressing controll of output 3<br />
OUTPUTS/3/ACTION<br />
getting voltage on output 1<br />
OUTPUTS/1/VOLTAGE<br />
getting state of input 1<br />
INPUTS/1/STATE<br />
<br />
= Group Events<sup><code>FW 4.0.0+</code></sup> =<br />
Group events are smart way how to keep configuration simple. It is not replacement of publish section specification but it is extension to trigger group of different topics to be published on the same event.<br />
<br />
See the example below. There is specific event on status change on every output and additionally the device sends periodic status every 60 seconds.<br />
<br />
{<br />
"broker": {<br />
"clientid": "netio${DEVICE_SN}",<br />
"keepalive": 30,<br />
"password": "",<br />
"port": 1883,<br />
"protocol": "mqtt",<br />
"ssl": false,<br />
"type": "generic",<br />
"url": "broker.hivemq.com",<br />
"username": ""<br />
},<br />
<b>"groupEvents": [<br />
{<br />
"events":[<br />
{<br />
"period": 60,<br />
"type": "timer"<br />
}<br />
],<br />
"appliedTopics":[<br />
"devices/${DEVICE_NAME}/output/1/state",<br />
"devices/${DEVICE_NAME}/output/2/state"<br />
]<br />
}<br />
],</b><br />
"publish": [<br />
{<br />
"events": [<br />
{<br />
"source": "OUTPUTS/1/STATE",<br />
"type": "change"<br />
}<br />
],<br />
"payload": "${OUTPUTS/1/STATE}",<br />
"qos": 0,<br />
"retain": false,<br />
<b> "topic": "devices/${DEVICE_NAME}/output/1/state"</b><br />
},{<br />
"events": [<br />
{<br />
"source": "OUTPUTS/2/STATE",<br />
"type": "change"<br />
}<br />
],<br />
"payload": "${OUTPUTS/2/STATE}",<br />
"qos": 0,<br />
"retain": false,<br />
<b> "topic": "devices/${DEVICE_NAME}/output/2/state"</b><br />
}<br />
]<br />
}<br />
<br />
= Variables =<br />
In some parameters is nescessary to use variables to get current state and measurements. <b>Variables are separated in two categories:</b><br />
<br />
* Target/Source variables<br />
* Payload Topic variables<br />
<br />
== Target Source Variables ==<br />
<br />
The list of available variables for each <br />
<br />
=== OUTPUTS variables ===<br />
==== VOLTAGE ====<br />
Unit: <code>V</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Present RMS voltage on output 1 is ${OUTPUTS/1/VOLTAGE}"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/VOLTAGE}"</code><br />
<br />
==== CURRENT ====<br />
Unit: <code>mA</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Present RMS current on output 1 is ${OUTPUTS/1/CURRENT}"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/CURRENT}"</code><br />
<br />
==== POWER_FACTOR ====<br />
Unit: <code>[-]</code><br />
<br />
Type: float (2 decimals)<br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"True Power Factor on output 1 is ${OUTPUTS/1/POWER_FACTOR}"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/POWER_FACTOR}"</code><br />
<br />
==== LOAD ====<br />
Unit: <code>W</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Present load on output 1 is ${OUTPUTS/1/LOAD}W"</code><br />
<br />
Example 2: <code>"payload":"Device's load connected to output 1 is ${OUTPUTS/1/LOAD}W"</code><br />
<br />
Example 3: <code>"source":"${OUTPUTS/1/LOAD}"</code><br />
<br />
==== STATE ====<br />
Type: bool(integer) - <code>0</code> or <code>1</code><br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Present output 1 state is ${OUTPUTS/1/STATE}"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/STATE}"</code><br />
<br />
==== ACTION ====<br />
Type: integer<br />
<br />
Possible actions:<br />
* <code>0</code> - set state OFF<br />
* <code>1</code> - set state ON<br />
* <code>2</code> - short OFF (restart)<br />
* <code>3</code> - short ON<br />
* <code>4</code> - toggle (switch)<br />
* <code>5</code> - no change<br />
<br />
Allowed in: <code>"target"</code><br />
<br />
Example: <code>"target":"OUTPUTS/1/ACTION"</code><br />
<br />
==== DELAY [ms] ====<br />
==== NAME ====<br />
==== FREQUENCY ====<br />
Unit: <code>Hz</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example: <code>"payload":"Frequency in power grid is ${OUTPUTS/1/ENERGY}Hz"</code><br />
<br />
==== ENERGY ====<br />
Energy consumed by an device connected to NETIO device output.<br />
<br />
Unit: <code>Wh</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Consumed energy on output 1 is ${OUTPUTS/1/ENERGY}Wh"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/ENERGY}"</code><br />
<br />
==== REVERSE_ENERGY ====<br />
Energy delivered back to grid. For example from solar system connected to NETIO device output.<br />
<br />
Unit: <code>Wh</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Delivered energy on output 1 is ${OUTPUTS/1/REVERSE_ENERGY}Wh"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/REVERSE_ENERGY}"</code><br />
<br />
<br />
==== ENERGY_START ====<br />
Date when the counters ENERGY and REVERSE_ENERGY have been resetted by user.<br />
<br />
Unit: <code>unix timestamp</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code><br />
<br />
Example 1: <code>"payload":"Energy measured since ${OUTPUTS/1/ENERGY_START} unix time"</code><br />
<br />
Example 2: <code>"payload":"${OUTPUTS/1/ENERGY_START}"</code> is output payload <code>1567654639</code><br />
<br />
==== ENERGY_START_FMT ====<br />
Date when the counters ENERGY and REVERSE_ENERGY have been resetted by user.<br />
<br />
Unit: <code>fmt date format</code><br />
<br />
Type: string <br />
<br />
Allowed in: <code>"payload"</code><br />
<br />
Example 1: <code>"payload":"Energy measured since ${OUTPUTS/1/ENERGY_START}"</code><br />
<br />
Example 2: <code>"payload":"${OUTPUTS/1/ENERGY_START_FMT}"</code> is output payload <code>2019-09-05T03:37:19+00:00</code><br />
<br />
==== ENERGY_NR ====<br />
Non-resettable counter of Energy consumed by an device connected to NETIO device output.<br />
<br />
Unit: <code>Wh</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Consumed energy on output 1 is ${OUTPUTS/1/ENERGY_NR}Wh"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/ENERGY_NR}"</code><br />
<br />
==== REVERSE_ENERGY_NR ====<br />
Non-resettable counter of Energy delivered back to grid. For example from solar system connected to NETIO device output.<br />
<br />
Unit: <code>Wh</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Delivered energy on output 1 is ${OUTPUTS/1/REVERSE_ENERGY_NR}Wh"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/REVERSE_ENERGY_NR}"</code><br />
<br />
<br />
<br />
==== TOTALs - for use with devices having more than 1 measured output ====<br />
<br />
* OUTPUTS/TOTAL/ENERGY<br />
* OUTPUTS/TOTAL/LOAD<br />
* OUTPUTS/TOTAL/CURRENT<br />
* OUTPUTS/TOTAL/VOLTAGE<br />
* OUTPUTS/TOTAL/POWER_FACTOR<br />
* OUTPUTS/TOTAL/FREQUENCY<br />
* OUTPUTS/TOTAL/PHASE<br />
* OUTPUTS/TOTAL/REVERSE_ENERGY<br />
* OUTPUTS/TOTAL/ENERGY_NR<br />
* OUTPUTS/TOTAL/REVERSE_ENERGY_NR<br />
* OUTPUTS/TOTAL/ENERGY_START<br />
* OUTPUTS/TOTAL/ENERGY_START_FMT<br />
<br />
<br />
==== REST_JSON ====<br />
Allow use of NETIO JSON structure to control outputs.<br />
<br />
Type: string / JSON<br />
<br />
Allowed in: <code>"target"</code> for Subscribe section<br />
<br />
Example: <code>"target": "REST_JSON"</code><br />
<br />
The payload is JSON structure identical to NETIO JSON API M2M Protocol (documentation available at https://www.netio-products.com/files/NETIO-M2M-API-Protocol-JSON.pdf). You can control one or multiple outputs.<br />
<br />
Payload example 1 - Toggle output 1: <code>{"Outputs":[{"ID": 1,"Action": 4}]}</code><br />
<br />
Payload example 2 - Turn output 1 OFF and output 3 ON: <code>{"Outputs":[{"ID":1,"Action":0},{"ID":3,"Action":1}]}</code><br />
<br />
=== INPUT variables ===<br />
==== STATE ====<br />
Type: bool(integer) - <code>0</code> or <code>1</code><br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Present input 1 state is ${INPUTS/1/STATE}"</code><br />
<br />
Example 2: <code>"source":"${INPUTS/1/STATE}"</code><br />
<br />
==== S0 ====<br />
S0 Counter value<br />
Unit: <code>-</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Input 1 S0 Counter value is ${INPUTS/1/S0}impulses"</code><br />
<br />
Example 2: <code>"source":"${INPUTS/1/S0}"</code><br />
<br />
==== TEMPERATURE ====<br />
Temperature measurement in Celsius, Fahrenheit<br />
Unit: <code>-</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Input 1 Temperature value in degree of Celsius is ${INPUTS/1/TEMP} [C] "</code><br />
<br />
Example 2: <code>"source":"${INPUTS/1/TEMP}"</code><br />
<br />
<br />
Example 3: <code>"payload":"Input 1 Temperature value in degree of Fahrenheit is ${INPUTS/1/TEMPF} [F] "</code><br />
<br />
Example 4: <code>"source":"${INPUTS/1/TEMPF}"</code><br />
<br />
==== HUMIDITY ====<br />
Relative Humidity measurement in[%]<br />
Unit: <code>-</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Input 1 Humidity value is ${INPUTS/1/HUMIDITY} %"</code><br />
<br />
Example 2: <code>"source":"${INPUTS/1/HUMIDITY}"</code><br />
<br />
== Payload/topic variables ==<br />
<br />
=== DEVICE_NAME ===<br />
Can be used in: "payload", "topic"<br />
<br />
Example 1: <code>"payload":"${DEVICE_NAME}"</code><br />
<br />
Example 2: <code>"topic":"netio/${DEVICE_NAME}/output/1/action"</code><br />
<br />
=== DEVICE_MAC ===<br />
Can be used in: "payload", "topic"<br />
<br />
Example 1: <code>"payload":"${DEVICE_MAC}"</code><br />
<br />
Example 2: <code>"topic":"netio/${DEVICE_MAC}/output/1/action"</code><br />
<br />
=== UTC_TIME <sup><code>FW 4.0.0+</code></sup>===<br />
<br />
send unix timestamp of devices actual time<br />
<br />
Can be used in: "payload"<br />
<br />
Example 1: <code>"payload": "${UTC_TIME}"</code><br />
<br />
=== UPTIME <sup>Not yet implemented</sup> ===<br />
<br />
=== PAYLOAD ===<br />
Can be used in: "action"<br />
<br />
Example: <code>"action":"${PAYLOAD}"</code><br />
<br />
=== OUTPUT_ID <sup>Not yet implemented</sup>===<br />
<br />
=== WIFI_SIGNAL<sup>Not yet implemented</sup> ===<br />
<br />
=== OUTPUTS_STATUS ===<br />
Provide complete outputs status and measurement if supported.<br />
<br />
Type: string / JSON<br />
<br />
Allowed in: <code>"payload"</code> for Publish section<br />
<br />
Example: <code>"payload":"${OUTPUTS_STATUS}"</code><br />
<br />
Payload example: <code>{ "GlobalMeasure":{"Voltage":236,"TotalCurrent":72,"TotalLoad":11,"TotalEnergy":167,"OverallPowerFactor":0.64,"Frequency":50.07,"Phase":-36.86,"EnergyStart":"2020-06-30T17:04:48+01:00"}, "Outputs":[ {"ID":1,"Name":"Power output 1","State":1,"Action":6,"Delay":2020,"Current":72,"PowerFactor":0.64,"Phase":-36.86,"Energy":139,"ReverseEnergy":0,"Load":11}, {"ID":2,"Name":"Power output 2","State":1,"Action":6,"Delay":2020,"Current":0,"PowerFactor":1.00,"Phase":0.00,"Energy":27,"ReverseEnergy":0,"Load":0}, {"ID":3,"Name":"Free Contact 3","State":1,"Action":6,"Delay":2020}, {"ID":4,"Name":"Free Contact 4","State":1,"Action":6,"Delay":2020} ]}</code><br />
<br />
=== INPUTS_STATUS ===<br />
Provide complete inputs status if supported. Since FW 3.0.0<br />
<br />
Type: string / JSON<br />
<br />
Allowed in: <code>"payload"</code> for Publish section<br />
<br />
Example: <code>"payload":"${INPUTS_STATUS}"</code><br />
<br />
Payload example: <code>{ "Inputs":[ {"ID":1,"Name":"Input 1","State":0,"S0Counter":0}, {"ID":2,"Name":"Input 2","State":0,"S0Counter":0} ]}</code><br />
<br />
=== INOUT_STATUS ===<br />
Provide complete inputs and output status and measurement if supported. Since FW 3.0.0<br />
<br />
Type: string / JSON<br />
<br />
Allowed in: <code>"payload"</code> for Publish section<br />
<br />
Example: <code>"payload":"${INOUT_STATUS}"</code><br />
<br />
Payload example: <code>{ "GlobalMeasure":{"Voltage":238,"TotalCurrent":105,"TotalLoad":17,"TotalEnergy":1451,"OverallPowerFactor":0.67,"Frequency":50.03,"Phase":-33.67,"EnergyStart":"2020-06-30T17:04:48+01:00"}, "Outputs":[ {"ID":1,"Name":"Power output 1","State":0,"Action":6,"Delay":5000,"Current":0,"PowerFactor":1.00,"Phase":0.00,"Energy":701,"ReverseEnergy":0,"Load":0}, {"ID":2,"Name":"Power output 2","State":1,"Action":6,"Delay":5000,"Current":105,"PowerFactor":0.65,"Phase":-33.67,"Energy":750,"ReverseEnergy":0,"Load":17}, {"ID":3,"Name":"Free Contact 3","State":1,"Action":6,"Delay":5000}, {"ID":4,"Name":"Free Contact 4","State":0,"Action":6,"Delay":5000} ], "Inputs":[ {"ID":1,"Name":"Input 1","State":0,"S0Counter":0}, {"ID":2,"Name":"Input 2","State":0,"S0Counter":0} ]}</code><br />
<br />
= Extended MQTT flex JSON config examples =<br />
<br />
== Default NETIO MQTT-flex configuration ==<br />
This example demonstrates setup for connection to public <code>broker.hivemq.com</code>, measurement reporting and output control.<br />
<br />
The device cabe be controlled via <code>netio/${DEVICE_NAME}/output/1/action topic</code> by sending standard NETIO action values:<br />
* 0 - OFF<br />
* 1 - ON<br />
* 2 - SHORT OFF<br />
* 3 - SHORT ON<br />
* 4 - TOGGLE<br />
* 5 - NO ACTION.<br />
<br />
The device report measurements:<br />
<br />
* Output state - every 15 minutes or by change<br />
* Voltage [V]- every 5 minutes or by change of 1 V<br />
* Current [mA]- every 5 minutes or by change of 50 mA<br />
* Load(Power) [W]- every 5 minutes or by change of 10 W<br />
* Energy(Consumption) [Wh]- every 15 minutes or by change of 1Wh<br />
* True Power Factor (TPF) [-]- every 5 minutes or by change of 0.02<br />
* Frequency [Hz]- every 1 hour or by change of 0.1 Hz<br />
<br />
For register all values, you can use wildcard <code>netio/${DEVICE_NAME}/output/1/#</code><br />
<br />
{<br />
"config":{<br />
"broker":{<br />
"url":"broker.hivemq.com",<br />
"protocol":"mqtt",<br />
"port":1883,<br />
"ssl":false,<br />
"type":"generic",<br />
"username":"",<br />
"password":"",<br />
"clientid":"moje${DEVICE_NAME}${DEVICE_MAC}",<br />
"keepalive":30<br />
},<br />
"subscribe":[<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/action",<br />
"qos":0,<br />
"target":"OUTPUTS/1/ACTION",<br />
"action":"${payload}"<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/switch",<br />
"qos":0,<br />
"target":"OUTPUTS/1/ACTION",<br />
"action":4<br />
}<br />
],<br />
"publish":[<br />
{<br />
"topic":"netio/${DEVICE_MAC}/output/1/state",<br />
"qos":0,<br />
"retain":true,<br />
"payload":"${OUTPUTS/1/STATE}",<br />
"events":[<br />
{<br />
"type":"change",<br />
"source":"OUTPUTS/1/STATE"<br />
},<br />
{<br />
"type":"timer",<br />
"period":900<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/voltage",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/VOLTAGE}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":300<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/VOLTAGE",<br />
"delta":1<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/current",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/CURRENT}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":300<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/CURRENT",<br />
"delta":50<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/load",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/LOAD}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":300<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/LOAD",<br />
"delta":10<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/energy",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/ENERGY}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":900<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/ENERGY",<br />
"delta":1<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/tpf",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/POWER_FACTOR}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":900<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/POWER_FACTOR",<br />
"delta":0.02<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/frequency",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/FREQUENCY}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":3600<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/FREQUENCY",<br />
"delta":0.1<br />
}<br />
]<br />
}<br />
]<br />
}<br />
}</div>
Tbezstarosta
https://wiki.netio-products.com/index.php?title=MQTT-flex&diff=1080
MQTT-flex
2026-03-17T14:54:57Z
<p>Tbezstarosta: /* INPUT variables */</p>
<hr />
<div>The MQTT-flex version of the MQTT protocol can be configured in detail thanks to the “flex” extension.<br />
<br />
https://www.netio-products.com/en/glossary/mqtt-flex <br />
<br />
<b>Why MQTT-flex</b> <br><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.<br />
<br />
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.<br />
<br />
===Supported devices:===<br />
* PowerCable MQTT 101x <br><br />
* PowerCable REST 101x <br><br />
* PowerPDU 4PS <br><br />
* PowerPDU 4KS <br><br />
* PowerPDU 8QS <br><br />
* PowerDIN 4PZ <br><br />
* PowerBOX 3Px <br><br />
* PowerBOX 4Kx <br><br />
<br />
<b>FW version:</b> <br><br />
>2.2.1<br />
<br />
===Not supported NETIO devices:===<br />
* PowerPDU 4C <br><br />
* NETIO 4 <br><br />
* NETIO 4All <br><br />
<br />
= Simple MQTT-flex configuration + explanation =<br />
<br />
''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.''<br />
<br />
{<br />
"config":{<br />
"broker":{<br />
"url":"broker.hivemq.com",<br />
"protocol":"mqtt",<br />
"port":1883,<br />
"ssl":false,<br />
"type":"generic",<br />
"username":"freedom",<br />
"password":"peace|LOVE|empathy4ALL"<br />
},<br />
"subscribe":[{<br />
"topic":"netio/${DEVICE_NAME}/output/1/action",<br />
"qos":0,<br />
"target":"OUTPUTS/1/ACTION",<br />
"action":"${payload}"<br />
}<br />
],<br />
"publish":[{<br />
"topic":"netio/${DEVICE_NAME}/output/1/state",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/STATE}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":"1000"<br />
}<br />
]<br />
}<br />
]<br />
}<br />
}<br />
=== Client Configuration (broker section) ===<br />
Put here MQTT client connection setup<br />
<br />
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>. <br />
<br />
"broker":{<br />
"url":"broker.hivemq.com",<br />
"protocol":"mqtt",<br />
"port":1883,<br />
"ssl":false,<br />
"type":"generic",<br />
"username":"freedom",<br />
"password":"peace|LOVE|empathy4ALL"<br />
},<br />
<br />
=== Device Control (subscribe section) ===<br />
Put here array of topics where to subscribe<br />
<br />
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> <br />
<br />
"subscribe":[{<br />
"topic":"netio/${DEVICE_NAME}/output/1/action",<br />
"qos":0,<br />
"target":"OUTPUTS/1/ACTION",<br />
"action":"${payload}"<br />
}<br />
],<br />
<br />
=== Output State monitoring (publish section) ===<br />
Put here array of topics where to publish.<br />
<br />
Device send every <b>1000 s</b> message to topic <b></b> with <b>QOS 0</b>, <b>retain true</b> information with <b>output 1 state</b><br />
<br />
"publish":[{<br />
"topic":"netio/${DEVICE_NAME}/output/1/state",<br />
"qos":0,<br />
"retain":true,<br />
"payload":"${OUTPUTS/1/STATE}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":"1000"<br />
}<br />
]<br />
}<br />
]<br />
<br />
= Config sections =<br />
<br />
== Broker ==<br />
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 />
<br /><br />
=== Attributes table overview ===<br />
{| class="wikitable"<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Item<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Presence<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Possible Values<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Description<br />
! style="font-weight:bold; background-color:#9b9b9b;" | JSON Config Usage<br />
|-<br />
| style="background-color:#efefef;" | url<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | MQTT broker URL<br />
| style="background-color:#efefef;" | "url":"broker.hivemq.com"<br />
|-<br />
| style="background-color:#efefef;" | port<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | 1 - 65535<br />
| style="background-color:#efefef;" | MQTT broker port<br />
| style="background-color:#efefef;" | "port":1883<br />
|-<br />
| style="background-color:#efefef;" | protocol<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | protocol spec - mqtt<br />
| style="background-color:#efefef;" | "protocol": "mqtt"<br />
|-<br />
| style="background-color:#efefef;" | ssl<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | true, false<br />
| style="background-color:#efefef;" | Use SSL crypted communication selector<br />
| style="background-color:#efefef;" | "ssl":false<br />
|-<br />
| style="background-color:#efefef;" | type<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | generic<br />
| style="background-color:#efefef;" | Communication/setup type option<br />
| style="background-color:#efefef;" | "type":"generic"<br />
|-<br />
| style="background-color:#efefef;" | username<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | regexp+len<br />
| style="background-color:#efefef;" | Credentials for MQTT broker. Max. 128 characters (since FW 3.2.4).<br />
| style="background-color:#efefef;" | "username":"freedom"<br />
|-<br />
| style="background-color:#efefef;" | password<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | regexp+len<br />
| style="background-color:#efefef;" | Credentials for MQTT broker. Max. 256 characters (since FW 3.2.4).<br />
| style="background-color:#efefef;" | "password":"peace|LOVE|empathy4ALL"<br />
|-<br />
| style="background-color:#efefef;" | clientid<br />
| style="background-color:#efefef;" | optional<br />
| style="background-color:#efefef;" | regexp+len<br />
| style="background-color:#efefef;" | MQTT clientid. Max. 128 characters (since FW 3.2.4). Variables ${DEVICE_MAC} or ${DEVICE_NAME} can be used<br />
| style="background-color:#efefef;" | "clientid":"myEcoTable01"<br />
|-<br />
| style="background-color:#efefef;" | keepalive<br />
| style="background-color:#efefef;" | optional<br />
| style="background-color:#efefef;" | 1 - 65535<br />
| style="background-color:#efefef;" | MQTT keep alive period in seconds<br />
| style="background-color:#efefef;" | "keepalive":90<br />
|}<br />
<br />
Note 1: <b>clientid</b> attribute is <b>mandatory for MQTT(s)</b> communication. When not configured, random ID will be generated.<br />
<br />
Note 2: To proper communication with MS Azure - it is necessary to set up IoT Hub to use TLS 1.2<br />
<br />
See section "TLS 1.2 enforcement available in select regions" in following guidelines https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-tls-support<br />
<br />
=== Examples ===<br />
==== Standard setup ====<br />
<br />
<br />
==== Security (SSL / TLS) secured setup ====<br />
You can enable MQTTs by using the encrypted port <b>8883</b> + <b>"ssl":true</b>.<br />
<br />
==== Variables used setup ====<br />
<br />
== Subscribe ==<br />
=== Hints to usage ===<br />
When receive message in <b><i>topic</b></i> do <b><i>action</b></i> on <b><i>target</b></i>.<br />
<br />
<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>.<br />
<br />
=== Attributes table overview ===<br />
{| class="wikitable"<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Item<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Presence<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Possible Values<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Description<br />
! style="font-weight:bold; background-color:#9b9b9b;" | JSON Config Usage<br />
|-<br />
| style="background-color:#efefef;" | topic<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | see table below<br />
| style="background-color:#efefef;" | specification of the topic, which MQTT-flex device listens from broker and act accordingly. Max. 128 characters. The "#" can be used since FW 3.2.4 - see note under this table.<br />
| style="background-color:#efefef;" | "topic":"netio/${DEVICE_NAME}/output/1/action"<br />
|-<br />
| style="background-color:#efefef;" | qos<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | 0, 1 or 2<br />
| 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}<br />
| style="background-color:#efefef;" | "qos":0<br />
|-<br />
| style="background-color:#efefef;" | target<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | internal definition of action, which can be performed above the specified output<br />
| style="background-color:#efefef;" | "target":"OUTPUTS/1/ACTION"<br />
|-<br />
| style="background-color:#efefef;" | action<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | a payload or a value the action attribute needs to have passed to<br />
| style="background-color:#efefef;" | "action":"${payload}"<br />
|-<br />
| style="background-color:#efefef;" | actiondef<sup>Not supported yet</sup><br />
| style="background-color:#efefef;" | optional<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
|-<br />
| style="background-color:#efefef;" | json<sup>Not supported yet</sup><br />
| style="background-color:#efefef;" | optional<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
|}<br />
<br />
Note: The "#" wildcard can be used in subscribe topic definition. The multi-level wildcard character MUST be specified either on its own or following a topic level separator. In either case it MUST be the last character specified in the Topic.<br />
<br />
For example, if a Device subscribes to “devices/{device_id}/messages/devicebound/#”, it would receive messages published using these topic names:<br />
<br />
“devices/{device_id}/messages/devicebound/”<br />
<br />
“devices/{device_id}/messages/devicebound/{property_bag}”<br />
<br />
This should be usefull for use with MS Azure - IoT hub.<br />
<br />
=== MQTT Subscribe as event to trigger action <sup><code>FW 4.0.0+</code></sup> ===<br />
<br />
This feature allow to subscribe to specific MQTT topic and pass payload to Rules or MQTT-flex as event.<br />
<br />
target: <code>PROTOCOLS/MQTT/EVENT</code><br />
<br />
"subscribe": [<br />
{<br />
"action": "${payload}",<br />
"qos": 0,<br />
"target": "PROTOCOLS/MQTT/EVENT",<br />
"topic": "broker/12345/MQTT_EVENT/"<br />
}<br />
]<br />
<br />
=== Examples ===<br />
==== Toggle output with standard payload ==== <br />
==== Toggle output with custom payload ==== <br />
==== Subscribe to more than one topic ====<br />
==== Trigger Rule and MQTT publish from MQTT subscribe <sup><code>FW 4.0.0+</code></sup> ====<br />
This example show Request response implementation in MQTT and toggle action made by Rules.<br />
<br />
When message with payload <code>getValues</code> is published to topic <code>broker/gv90018g/COMMAND</code> MQTT flex will create an event with name <code>PROTOCOLS/MQTT/EVENT</code> (fixed name cannot be changed) and value <code>getValues</code>. On this event will act all events and conditions set in MQTT-flex and Rules which are set to listening to change on <code>PROTOCOLS/MQTT/EVENT</code> and equals to value <code>getValues</code>. See <b>bold</b> marked parameters in example configuration below. <br />
<br />
Once the triggered action is done it is needed to reset MQTT channel to <code>OK</code> status becaus event are reacting only to change. If the channel is not reset the next even would not be triggered.<br />
<br />
<b>Rules Configuration:</b><br />
{<br />
"conditions": {<br />
<b>"PROTOCOLS/MQTT/EVENT": "getValues"</b><br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 4<br />
}<br />
}<br />
<br />
<b>MQTT Configuration:</b><br />
{<br />
"broker":{<br />
"clientid":"netio${DEVICE_SN}",<br />
"keepalive":30,<br />
"password":"abcdefghijk",<br />
"port":8883,<br />
"protocol":"mqtt",<br />
"ssl":true,<br />
"type":"generic",<br />
"url":"broker.cloud.netio.eu",<br />
"username":"gv90018g"<br />
},<br />
"groupEvents":[<br />
{<br />
"events":[<br />
{<br />
<b>"source":"PROTOCOLS/MQTT/EVENT",<br />
"type":"change",<br />
"value":"getValues"</b><br />
}<br />
],<br />
"appliedTopics":[<br />
"broker/gv90018g/OUTPUTS/1/STATE",<br />
<b>"broker/gv90018g/COMMAND"</b><br />
]<br />
}<br />
],<br />
"publish":[<br />
{<br />
"payload":"${OUTPUTS/1/STATE}",<br />
"qos":0,<br />
"retain":true,<br />
"topic":"broker/gv90018g/OUTPUTS/1/STATE"<br />
},<br />
{<br />
"payload":"OK",<br />
"qos":0,<br />
"retain":true,<br />
"topic":"broker/gv90018g/COMMAND"<br />
}<br />
],<br />
"subscribe":[<br />
{<br />
"action":"${payload}",<br />
"qos":0,<br />
<b>"target":"PROTOCOLS/MQTT/EVENT"</b>,<br />
"topic":"broker/gv90018g/COMMAND"<br />
}<br />
]<br />
}<br />
<br />
<br />
<br />
Subscribe topic payload values specification for control of the output:<br />
<br />
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)<br />
<br />
== Publish ==<br />
<br />
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)<br />
<br />
=== Hints to usage ===<br />
When <b><i>event</b></i> send message with <b><i>payload</b></i> to <b><i>topic</b></i>.<br />
<br />
=== Attributes table overview ===<br />
{| class="wikitable"<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Item<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Presence<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Possible Values<br />
! style="font-weight:bold; background-color:#9b9b9b;" | Description<br />
! style="font-weight:bold; background-color:#9b9b9b;" | JSON Config Usage<br />
|-<br />
| style="background-color:#efefef;" | topic<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | see table below<br />
| style="background-color:#efefef;" | definition of the topic, how it is registered towards MQTT broker. Max. 128 characters. <br />
| style="background-color:#efefef;" | "topic":"netio/${DEVICE_NAME}/output/1/load"<br />
|-<br />
| style="background-color:#efefef;" | qos<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | see table below<br />
| 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}<br />
| style="background-color:#efefef;" | <br />
|-<br />
| style="background-color:#efefef;" | retain<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | boolean: true or false<br />
| 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}<br />
| style="background-color:#efefef;" | "retain":true<br />
|-<br />
| style="background-color:#efefef;" | payload<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | see table below<br />
| style="background-color:#efefef;" | definition of the payload, what is send to the MQTT broker.<br />
| style="background-color:#efefef;" | "payload":"${OUTPUTS/1/STATE}"<br />
|-<br />
| style="background-color:#efefef;" | events<br />
| style="background-color:#efefef;" | mandatory<br />
| style="background-color:#efefef;" | see table below<br />
| style="background-color:#efefef;" | definition of events used for triggering sending of data via mqtt (change, delta, timer)<br />
| style="background-color:#efefef;" | <br />
|-<br />
| style="background-color:#efefef;" | type<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" |<br />
|-<br />
| style="background-color:#efefef;" | source<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" |<br />
|-<br />
| style="background-color:#efefef;" | delta<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" |<br />
|-<br />
| style="background-color:#efefef;" | period<br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" |<br />
| style="background-color:#efefef;" |<br />
|-<br />
| style="background-color:#efefef;" | payloaddef<sup>Not supported yet</sup><br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" | <br />
| style="background-color:#efefef;" |<br />
|}<br />
<br />
=== Examples ===<br />
==== Publish energy periodically (event timer) ==== <br />
==== Publish current on change (delta) ==== <br />
==== Publish output state ====<br />
==== Publish to more than one topic with different events ====<br />
<br />
= Target / Source =<br />
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.<br />
<br />
* <b>source</b> - specifies from where the value will be read (specifies the source of data for payload, change detection, delta calculation)<br />
* <b>target</b> - specifies where the data should be sent or command applied (e.g. specifies the target for ACTION)<br />
<br />
=== INPUT / OUTPUT (Target) selection ===<br />
<br />
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.<br />
<br />
# At first specify if requested variable is from/for INPUT or OUTPUT using keywords <b>"OUTPUTS"</b> or <b>"INPUTS"</b> .<br />
# Add <b>"/"</b> separator<br />
# Specify the number of INPUT/OUTPUT to <b>1</b>(or TOTAL for summary statistics if available)<br />
# Add <b>"/"</b> separator<br />
# Specify requested variable or command<br />
<br />
<b>Note:</b> Not all of OUTPUTS/INPUTS support all variables. Available variables are closely connected with the device functions and I/O features.<br />
<br />
<b>Note2:</b> INPUTS available only on NETIO PowerDIN 4PZ<br />
<br />
=== Examples: ===<br />
<br />
adressing controll of output 3<br />
OUTPUTS/3/ACTION<br />
getting voltage on output 1<br />
OUTPUTS/1/VOLTAGE<br />
getting state of input 1<br />
INPUTS/1/STATE<br />
<br />
= Group Events<sup><code>FW 4.0.0+</code></sup> =<br />
Group events are smart way how to keep configuration simple. It is not replacement of publish section specification but it is extension to trigger group of different topics to be published on the same event.<br />
<br />
See the example below. There is specific event on status change on every output and additionally the device sends periodic status every 60 seconds.<br />
<br />
{<br />
"broker": {<br />
"clientid": "netio${DEVICE_SN}",<br />
"keepalive": 30,<br />
"password": "",<br />
"port": 1883,<br />
"protocol": "mqtt",<br />
"ssl": false,<br />
"type": "generic",<br />
"url": "broker.hivemq.com",<br />
"username": ""<br />
},<br />
<b>"groupEvents": [<br />
{<br />
"events":[<br />
{<br />
"period": 60,<br />
"type": "timer"<br />
}<br />
],<br />
"appliedTopics":[<br />
"devices/${DEVICE_NAME}/output/1/state",<br />
"devices/${DEVICE_NAME}/output/2/state"<br />
]<br />
}<br />
],</b><br />
"publish": [<br />
{<br />
"events": [<br />
{<br />
"source": "OUTPUTS/1/STATE",<br />
"type": "change"<br />
}<br />
],<br />
"payload": "${OUTPUTS/1/STATE}",<br />
"qos": 0,<br />
"retain": false,<br />
<b> "topic": "devices/${DEVICE_NAME}/output/1/state"</b><br />
},{<br />
"events": [<br />
{<br />
"source": "OUTPUTS/2/STATE",<br />
"type": "change"<br />
}<br />
],<br />
"payload": "${OUTPUTS/2/STATE}",<br />
"qos": 0,<br />
"retain": false,<br />
<b> "topic": "devices/${DEVICE_NAME}/output/2/state"</b><br />
}<br />
]<br />
}<br />
<br />
= Variables =<br />
In some parameters is nescessary to use variables to get current state and measurements. <b>Variables are separated in two categories:</b><br />
<br />
* Target/Source variables<br />
* Payload Topic variables<br />
<br />
== Target Source Variables ==<br />
<br />
The list of available variables for each <br />
<br />
=== OUTPUTS variables ===<br />
==== VOLTAGE ====<br />
Unit: <code>V</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Present RMS voltage on output 1 is ${OUTPUTS/1/VOLTAGE}"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/VOLTAGE}"</code><br />
<br />
==== CURRENT ====<br />
Unit: <code>mA</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Present RMS current on output 1 is ${OUTPUTS/1/CURRENT}"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/CURRENT}"</code><br />
<br />
==== POWER_FACTOR ====<br />
Unit: <code>[-]</code><br />
<br />
Type: float (2 decimals)<br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"True Power Factor on output 1 is ${OUTPUTS/1/POWER_FACTOR}"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/POWER_FACTOR}"</code><br />
<br />
==== LOAD ====<br />
Unit: <code>W</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Present load on output 1 is ${OUTPUTS/1/LOAD}W"</code><br />
<br />
Example 2: <code>"payload":"Device's load connected to output 1 is ${OUTPUTS/1/LOAD}W"</code><br />
<br />
Example 3: <code>"source":"${OUTPUTS/1/LOAD}"</code><br />
<br />
==== STATE ====<br />
Type: bool(integer) - <code>0</code> or <code>1</code><br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Present output 1 state is ${OUTPUTS/1/STATE}"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/STATE}"</code><br />
<br />
==== ACTION ====<br />
Type: integer<br />
<br />
Possible actions:<br />
* <code>0</code> - set state OFF<br />
* <code>1</code> - set state ON<br />
* <code>2</code> - short OFF (restart)<br />
* <code>3</code> - short ON<br />
* <code>4</code> - toggle (switch)<br />
* <code>5</code> - no change<br />
<br />
Allowed in: <code>"target"</code><br />
<br />
Example: <code>"target":"OUTPUTS/1/ACTION"</code><br />
<br />
==== DELAY [ms] ====<br />
==== NAME ====<br />
==== FREQUENCY ====<br />
Unit: <code>Hz</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example: <code>"payload":"Frequency in power grid is ${OUTPUTS/1/ENERGY}Hz"</code><br />
<br />
==== ENERGY ====<br />
Energy consumed by an device connected to NETIO device output.<br />
<br />
Unit: <code>Wh</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Consumed energy on output 1 is ${OUTPUTS/1/ENERGY}Wh"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/ENERGY}"</code><br />
<br />
==== REVERSE_ENERGY ====<br />
Energy delivered back to grid. For example from solar system connected to NETIO device output.<br />
<br />
Unit: <code>Wh</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Delivered energy on output 1 is ${OUTPUTS/1/REVERSE_ENERGY}Wh"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/REVERSE_ENERGY}"</code><br />
<br />
<br />
==== ENERGY_START ====<br />
Date when the counters ENERGY and REVERSE_ENERGY have been resetted by user.<br />
<br />
Unit: <code>unix timestamp</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code><br />
<br />
Example 1: <code>"payload":"Energy measured since ${OUTPUTS/1/ENERGY_START} unix time"</code><br />
<br />
Example 2: <code>"payload":"${OUTPUTS/1/ENERGY_START}"</code> is output payload <code>1567654639</code><br />
<br />
==== ENERGY_START_FMT ====<br />
Date when the counters ENERGY and REVERSE_ENERGY have been resetted by user.<br />
<br />
Unit: <code>fmt date format</code><br />
<br />
Type: string <br />
<br />
Allowed in: <code>"payload"</code><br />
<br />
Example 1: <code>"payload":"Energy measured since ${OUTPUTS/1/ENERGY_START}"</code><br />
<br />
Example 2: <code>"payload":"${OUTPUTS/1/ENERGY_START_FMT}"</code> is output payload <code>2019-09-05T03:37:19+00:00</code><br />
<br />
==== ENERGY_NR ====<br />
Non-resettable counter of Energy consumed by an device connected to NETIO device output.<br />
<br />
Unit: <code>Wh</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Consumed energy on output 1 is ${OUTPUTS/1/ENERGY_NR}Wh"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/ENERGY_NR}"</code><br />
<br />
==== REVERSE_ENERGY_NR ====<br />
Non-resettable counter of Energy delivered back to grid. For example from solar system connected to NETIO device output.<br />
<br />
Unit: <code>Wh</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Delivered energy on output 1 is ${OUTPUTS/1/REVERSE_ENERGY_NR}Wh"</code><br />
<br />
Example 2: <code>"source":"${OUTPUTS/1/REVERSE_ENERGY_NR}"</code><br />
<br />
<br />
<br />
==== TOTALs - for use with devices having more than 1 measured output ====<br />
<br />
* OUTPUTS/TOTAL/ENERGY<br />
* OUTPUTS/TOTAL/LOAD<br />
* OUTPUTS/TOTAL/CURRENT<br />
* OUTPUTS/TOTAL/VOLTAGE<br />
* OUTPUTS/TOTAL/POWER_FACTOR<br />
* OUTPUTS/TOTAL/FREQUENCY<br />
* OUTPUTS/TOTAL/PHASE<br />
* OUTPUTS/TOTAL/REVERSE_ENERGY<br />
* OUTPUTS/TOTAL/ENERGY_NR<br />
* OUTPUTS/TOTAL/REVERSE_ENERGY_NR<br />
* OUTPUTS/TOTAL/ENERGY_START<br />
* OUTPUTS/TOTAL/ENERGY_START_FMT<br />
<br />
<br />
==== REST_JSON ====<br />
Allow use of NETIO JSON structure to control outputs.<br />
<br />
Type: string / JSON<br />
<br />
Allowed in: <code>"target"</code> for Subscribe section<br />
<br />
Example: <code>"target": "REST_JSON"</code><br />
<br />
The payload is JSON structure identical to NETIO JSON API M2M Protocol (documentation available at https://www.netio-products.com/files/NETIO-M2M-API-Protocol-JSON.pdf). You can control one or multiple outputs.<br />
<br />
Payload example 1 - Toggle output 1: <code>{"Outputs":[{"ID": 1,"Action": 4}]}</code><br />
<br />
Payload example 2 - Turn output 1 OFF and output 3 ON: <code>{"Outputs":[{"ID":1,"Action":0},{"ID":3,"Action":1}]}</code><br />
<br />
=== INPUT variables ===<br />
==== STATE ====<br />
Type: bool(integer) - <code>0</code> or <code>1</code><br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Present input 1 state is ${INPUTS/1/STATE}"</code><br />
<br />
Example 2: <code>"source":"${INPUTS/1/STATE}"</code><br />
<br />
==== S0 ====<br />
S0 Counter value<br />
Unit: <code>-</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Input 1 S0 Counter value is ${INPUTS/1/S0}impulses"</code><br />
<br />
Example 2: <code>"source":"${INPUTS/1/S0}"</code><br />
<br />
==== TEMPERATURE ====<br />
Temperature measurement in Celsius, Fahrenheit<br />
Unit: <code>-</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Input 1 Temperature value in degree of Celsius value is ${INPUTS/1/TEMP} [C] "</code><br />
<br />
Example 2: <code>"source":"${INPUTS/1/TEMP}"</code><br />
<br />
<br />
Example 3: <code>"payload":"Input 1 Temperature value in degree of Fahrenheit is ${INPUTS/1/TEMPF} [F] "</code><br />
<br />
Example 4: <code>"source":"${INPUTS/1/TEMPF}"</code><br />
<br />
==== HUMIDITY ====<br />
Relative Humidity measurement in[%]<br />
Unit: <code>-</code><br />
<br />
Type: integer <br />
<br />
Allowed in: <code>"payload"</code> <code>"source"</code><br />
<br />
Example 1: <code>"payload":"Input 1 Humidity value is ${INPUTS/1/HUMIDITY} %"</code><br />
<br />
Example 2: <code>"source":"${INPUTS/1/HUMIDITY}"</code><br />
<br />
== Payload/topic variables ==<br />
<br />
=== DEVICE_NAME ===<br />
Can be used in: "payload", "topic"<br />
<br />
Example 1: <code>"payload":"${DEVICE_NAME}"</code><br />
<br />
Example 2: <code>"topic":"netio/${DEVICE_NAME}/output/1/action"</code><br />
<br />
=== DEVICE_MAC ===<br />
Can be used in: "payload", "topic"<br />
<br />
Example 1: <code>"payload":"${DEVICE_MAC}"</code><br />
<br />
Example 2: <code>"topic":"netio/${DEVICE_MAC}/output/1/action"</code><br />
<br />
=== UTC_TIME <sup><code>FW 4.0.0+</code></sup>===<br />
<br />
send unix timestamp of devices actual time<br />
<br />
Can be used in: "payload"<br />
<br />
Example 1: <code>"payload": "${UTC_TIME}"</code><br />
<br />
=== UPTIME <sup>Not yet implemented</sup> ===<br />
<br />
=== PAYLOAD ===<br />
Can be used in: "action"<br />
<br />
Example: <code>"action":"${PAYLOAD}"</code><br />
<br />
=== OUTPUT_ID <sup>Not yet implemented</sup>===<br />
<br />
=== WIFI_SIGNAL<sup>Not yet implemented</sup> ===<br />
<br />
=== OUTPUTS_STATUS ===<br />
Provide complete outputs status and measurement if supported.<br />
<br />
Type: string / JSON<br />
<br />
Allowed in: <code>"payload"</code> for Publish section<br />
<br />
Example: <code>"payload":"${OUTPUTS_STATUS}"</code><br />
<br />
Payload example: <code>{ "GlobalMeasure":{"Voltage":236,"TotalCurrent":72,"TotalLoad":11,"TotalEnergy":167,"OverallPowerFactor":0.64,"Frequency":50.07,"Phase":-36.86,"EnergyStart":"2020-06-30T17:04:48+01:00"}, "Outputs":[ {"ID":1,"Name":"Power output 1","State":1,"Action":6,"Delay":2020,"Current":72,"PowerFactor":0.64,"Phase":-36.86,"Energy":139,"ReverseEnergy":0,"Load":11}, {"ID":2,"Name":"Power output 2","State":1,"Action":6,"Delay":2020,"Current":0,"PowerFactor":1.00,"Phase":0.00,"Energy":27,"ReverseEnergy":0,"Load":0}, {"ID":3,"Name":"Free Contact 3","State":1,"Action":6,"Delay":2020}, {"ID":4,"Name":"Free Contact 4","State":1,"Action":6,"Delay":2020} ]}</code><br />
<br />
=== INPUTS_STATUS ===<br />
Provide complete inputs status if supported. Since FW 3.0.0<br />
<br />
Type: string / JSON<br />
<br />
Allowed in: <code>"payload"</code> for Publish section<br />
<br />
Example: <code>"payload":"${INPUTS_STATUS}"</code><br />
<br />
Payload example: <code>{ "Inputs":[ {"ID":1,"Name":"Input 1","State":0,"S0Counter":0}, {"ID":2,"Name":"Input 2","State":0,"S0Counter":0} ]}</code><br />
<br />
=== INOUT_STATUS ===<br />
Provide complete inputs and output status and measurement if supported. Since FW 3.0.0<br />
<br />
Type: string / JSON<br />
<br />
Allowed in: <code>"payload"</code> for Publish section<br />
<br />
Example: <code>"payload":"${INOUT_STATUS}"</code><br />
<br />
Payload example: <code>{ "GlobalMeasure":{"Voltage":238,"TotalCurrent":105,"TotalLoad":17,"TotalEnergy":1451,"OverallPowerFactor":0.67,"Frequency":50.03,"Phase":-33.67,"EnergyStart":"2020-06-30T17:04:48+01:00"}, "Outputs":[ {"ID":1,"Name":"Power output 1","State":0,"Action":6,"Delay":5000,"Current":0,"PowerFactor":1.00,"Phase":0.00,"Energy":701,"ReverseEnergy":0,"Load":0}, {"ID":2,"Name":"Power output 2","State":1,"Action":6,"Delay":5000,"Current":105,"PowerFactor":0.65,"Phase":-33.67,"Energy":750,"ReverseEnergy":0,"Load":17}, {"ID":3,"Name":"Free Contact 3","State":1,"Action":6,"Delay":5000}, {"ID":4,"Name":"Free Contact 4","State":0,"Action":6,"Delay":5000} ], "Inputs":[ {"ID":1,"Name":"Input 1","State":0,"S0Counter":0}, {"ID":2,"Name":"Input 2","State":0,"S0Counter":0} ]}</code><br />
<br />
= Extended MQTT flex JSON config examples =<br />
<br />
== Default NETIO MQTT-flex configuration ==<br />
This example demonstrates setup for connection to public <code>broker.hivemq.com</code>, measurement reporting and output control.<br />
<br />
The device cabe be controlled via <code>netio/${DEVICE_NAME}/output/1/action topic</code> by sending standard NETIO action values:<br />
* 0 - OFF<br />
* 1 - ON<br />
* 2 - SHORT OFF<br />
* 3 - SHORT ON<br />
* 4 - TOGGLE<br />
* 5 - NO ACTION.<br />
<br />
The device report measurements:<br />
<br />
* Output state - every 15 minutes or by change<br />
* Voltage [V]- every 5 minutes or by change of 1 V<br />
* Current [mA]- every 5 minutes or by change of 50 mA<br />
* Load(Power) [W]- every 5 minutes or by change of 10 W<br />
* Energy(Consumption) [Wh]- every 15 minutes or by change of 1Wh<br />
* True Power Factor (TPF) [-]- every 5 minutes or by change of 0.02<br />
* Frequency [Hz]- every 1 hour or by change of 0.1 Hz<br />
<br />
For register all values, you can use wildcard <code>netio/${DEVICE_NAME}/output/1/#</code><br />
<br />
{<br />
"config":{<br />
"broker":{<br />
"url":"broker.hivemq.com",<br />
"protocol":"mqtt",<br />
"port":1883,<br />
"ssl":false,<br />
"type":"generic",<br />
"username":"",<br />
"password":"",<br />
"clientid":"moje${DEVICE_NAME}${DEVICE_MAC}",<br />
"keepalive":30<br />
},<br />
"subscribe":[<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/action",<br />
"qos":0,<br />
"target":"OUTPUTS/1/ACTION",<br />
"action":"${payload}"<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/switch",<br />
"qos":0,<br />
"target":"OUTPUTS/1/ACTION",<br />
"action":4<br />
}<br />
],<br />
"publish":[<br />
{<br />
"topic":"netio/${DEVICE_MAC}/output/1/state",<br />
"qos":0,<br />
"retain":true,<br />
"payload":"${OUTPUTS/1/STATE}",<br />
"events":[<br />
{<br />
"type":"change",<br />
"source":"OUTPUTS/1/STATE"<br />
},<br />
{<br />
"type":"timer",<br />
"period":900<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/voltage",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/VOLTAGE}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":300<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/VOLTAGE",<br />
"delta":1<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/current",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/CURRENT}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":300<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/CURRENT",<br />
"delta":50<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/load",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/LOAD}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":300<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/LOAD",<br />
"delta":10<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/energy",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/ENERGY}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":900<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/ENERGY",<br />
"delta":1<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/tpf",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/POWER_FACTOR}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":900<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/POWER_FACTOR",<br />
"delta":0.02<br />
}<br />
]<br />
},<br />
{<br />
"topic":"netio/${DEVICE_NAME}/output/1/frequency",<br />
"qos":0,<br />
"retain":false,<br />
"payload":"${OUTPUTS/1/FREQUENCY}",<br />
"events":[<br />
{<br />
"type":"timer",<br />
"period":3600<br />
},<br />
{<br />
"type":"delta",<br />
"source":"OUTPUTS/1/FREQUENCY",<br />
"delta":0.1<br />
}<br />
]<br />
}<br />
]<br />
}<br />
}</div>
Tbezstarosta
https://wiki.netio-products.com/index.php?title=HTTPs_details&diff=1079
HTTPs details
2025-08-13T08:42:19Z
<p>Tbezstarosta: </p>
<hr />
<div><br /><br />
<h1>HTTPS (Hypertext Transfer Protocol Secure)</h1> HTTPs is the secure version of HTTP, the protocol used for communication between a web browser or application and a web server or device. HTTPS adds a layer of encryption using TLS (Transport Layer Security), which protects the data transmitted over the network.<br />
<b>Why Use HTTPs with NETIO Power Devices?</b><br />
<br /><br />
NETIO devices often operate in environments where they are remotely controlled or monitored, sometimes even over public or shared networks. Using HTTPS ensures that communication between your application and the NETIO device remains private and secure, even if someone intercepts the network traffic.<br />
<br /><br />
<br /><br />
<h2>How to enable HTTPs on NETIO Device</h2><br />
All NETIO devices running on <b><u>FW 5.0.X</b></u> can be configure the way to support HTTPs communication. HTTPs option is available via Setting/ Security. Port 443 is pre-defined, but can be changed. HTTPs configuration port is shared with M2M API protocols setup. NETIO devices support HTTPs using a self-signed certificate by default. This allows you to use secure connections immediately, even in isolated or internal networks. For production environments or public access, is recommended to upload a certificate from a trusted Certificate Authority (CA). This ensures proper validation and avoids browser or client warnings.<br />
<br />
<br /><br />
[[File:NETIO_4PZ_HTTPs.png |Https setup]]<br />
<br /><br />
<br />
<h2>TLS Versions and Cipher Suites Supported by NETIO</h2><br />
<br />
NETIO power devices support encrypted HTTPS communication using the TLS (Transport Layer Security) protocol. TLS ensures confidentiality, integrity, and authentication when accessing the device’s web interface or APIs (e.g., JSON/XML REST API).<br />
<br />
<br />
<br />
<u><b>Supported TLS Versions.:</b></u><br />
<br />
**TLS 1.0 and TLS 1.1 – (Deprecated for security reasons)<br />
**TLS 1.2 (<b>Supported</b>) (minimum secure standard and should always be used).Legacy TLS versions are disabled by default for security.<br />
**TLS 1.3 – Not supported at the moment* (future development under investigation)<br />
<br />
<br />
NETIO firmware supports multiple cipher suites using <b>RSA</b> or <b>ECDHE</b> (Elliptic Curve Diffie-Hellman Ephemeral) key exchange, combined with AES encryption (GCM/CCM) modes. There is a list of supported TLS cipher suites and key types that NETIO devices accept when establishing a secure HTTPS connection.<br />
<br /><br />
<br />
<br />
<u><b>Key Types used during the TLS handshake:</b></u><br />
**ecc_prime256v1 – elliptic curve (ECDSA) key, 256-bit (NIST P-256)<br />
**ecc_secp384r1 – stronger ECC key, 384-bit<br />
**ecc_secp521r1 – even stronger ECC key, 521-bit<br />
**rsa_1024 / rsa_2048 / rsa_3072 / rsa_4096 – RSA keys of corresponding lengths<br />
<br />
<br />
<u><b>Cipher Suite – a specific combination of algorithms used to encrypt the TLS connection:</b></u><br />
**ECDHE – key exchange algorithm (supports forward secrecy)<br />
**ECDSA – digital certificate based on ECC key (e.g., prime256v1)<br />
**AES_256_GCM – symmetric encryption (AES 256-bit, Galois/Counter Mode)<br />
**SHA384 – hashing algorithm used for integrity checks<br />
<br />
<br />
List of combinations tested with NETIO device<br />
<table style="border-collapse: collapse; width: 97.80949%;" border="1"><br />
<tr><br />
<td style="width: 8.687943%;"><br />
<p style="font-weight: 400;">&nbsp;<strong>-&gt; ecc_prime256v1</strong>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</p><br />
<ul><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</li><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_CCM</li><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_CCM</li><br />
</ul><br />
</td><br />
<td style="width: 20.451527%;" width="269"><br />
<p style="font-weight: 400;"><strong>-&gt; ecc_secp384r1</strong>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</p><br />
<ul><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_CCM</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_CCM</span></li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p style="font-weight: 400;"><strong>-&gt; ecc_secp521r1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</strong></p><br />
<ul><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_CCM:</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_CCM</span></li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p></p><br />
</td><br />
</tr><br />
<tr><br />
<td style="width: 8.687943%;"><br />
<p style="font-weight: 400;"><strong>-&gt; rsa_1024</strong></p><br />
<ul><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_CCM</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_CCM</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_SHA</li><br />
<li style="font-weight: 400;"><span style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_SHA</span></li><br />
</ul><br />
</td><br />
<td style="width: 20.451527%;"><br />
<p style="font-weight: 400;">-<strong>&gt; rsa_2048</strong></p><br />
<ul><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_SHA</span></li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p>-<strong>&gt; rsa_3072</strong></p><br />
<ul><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_SHA</li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p style="font-weight: 400;"><strong>-&gt; rsa_4096</strong></p><br />
<ul><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_CCM</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_CCM</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_SHA</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_SHA</span></li><br />
</ul><br />
</td><br />
</tr><br />
</table><br />
<br />
<br />
<h1>Secure M2M API Access via HTTPs</h1><br />
<br />
NETIO devices support secure communication over HTTPS to protect API access to power sockets and configuration interfaces. This is essential when integrating NETIO devices with 3th party systems. M2M API Machine protocols setup uses the same port as being setup at configuration setting. <br />
Device provide access to various machine-readable APIs, such as:<br />
**JSON API<br />
**XML API<br />
**MQTTs (optional for some models)<br />
**URL<br />
<br />
As HTTPS is enabled, all communication with these APIs is encrypted using TLS (Transport Layer Security). This ensures that authentication tokens, control commands (e.g., socket ON/OFF), and monitoring data cannot be intercepted or altered.<br />
<br />
<b>Here is an examples of turning socket 1 ON using the JSON API over HTTPS:</b><br />
<br /><br />
<em>curl -k netio_user:netio_password -d '{"Outputs":[{"ID":1,"Action":1}]}' -H "Content-Type: application/json" -X POST https://192.168.105.160:81/netio.json</em><br />
<br /><br />
**(**Replace netio_user & netio_password with proper JSON API password)<br />
<br />
<br />
<b>Here is an example of turning socket 1 ON using URL over HTTPS:</b><br />
<br /><br />
<em>https://192.168.1.100/netio.json?pass=netio123&output1=1"</em><br />
<br /><br />
**(**Replace netio123 with your actual API password)<br />
<br />
<br />
<b> API Performance testing </b><br />
<br/><br />
In internal NETIO testing on PowerPDU 4KS device (see below), various cipher suites and elliptic curves were evaluated for performance during secure HTTPS communication with the JSON and WebSocket APIs. <br />
<br />
<br />
<table border="1" cellspacing="0" cellpadding="5"><br />
<tr><br />
<th>&nbsp;</th><br />
<th>Response time Web Socket [s]</th><br />
<th>Response time JSON [s]</th><br />
</tr><br />
<tr><br />
<td colspan="3"><strong>ecc_prime256v1</strong></td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</td><br />
<td style="text-align: center;">5.7</td><br />
<td style="text-align: center;">6.0</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_CCM</td><br />
<td style="text-align: center;">5.9</td><br />
<td style="text-align: center;">5.6</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</td><br />
<td style="text-align: center;">5.8</td><br />
<td style="text-align: center;">5.7</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_CCM</td><br />
<td style="text-align: center;">6.1</td><br />
<td style="text-align: center;">6.2</td><br />
</tr><br />
<tr><br />
<td colspan="3"><strong>ecc_secp384r1</strong></td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</td><br />
<td style="text-align: center;">6.4</td><br />
<td style="text-align: center;">6.3</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_CCM</td><br />
<td style="text-align: center;">6.3</td><br />
<td style="text-align: center;">6.2</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</td><br />
<td style="text-align: center;">6.2</td><br />
<td style="text-align: center;">6.2</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_CCM</td><br />
<td style="text-align: center;">6.5</td><br />
<td style="text-align: center;">6.3</td><br />
</tr><br />
<tr><br />
<td colspan="3"><strong>ecc_secp521r1</strong></td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</td><br />
<td style="text-align: center;">6.5</td><br />
<td style="text-align: center;">6.4</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_CCM</td><br />
<td style="text-align: center;">6.6</td><br />
<td style="text-align: center;">6.5</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</td><br />
<td style="text-align: center;">6.7</td><br />
<td style="text-align: center;">6.3</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_CCM</td><br />
<td style="text-align: center;">6.6</td><br />
<td style="text-align: center;">6.5</td><br />
</tr><br />
</table><br />
<br />
<p>* values are valid for ethernet connection only<br /><br />
<p>** values can differentiate on WiFi connection</p></div>
Tbezstarosta
https://wiki.netio-products.com/index.php?title=HTTPs_details&diff=1078
HTTPs details
2025-08-13T08:41:32Z
<p>Tbezstarosta: </p>
<hr />
<div><br /><br />
<h1>HTTPS (Hypertext Transfer Protocol Secure)</h1> HTTPs is the secure version of HTTP, the protocol used for communication between a web browser or application and a web server or device. HTTPS adds a layer of encryption using TLS (Transport Layer Security), which protects the data transmitted over the network.<br />
<b>Why Use HTTPs with NETIO Power Devices?</b><br />
<br /><br />
NETIO devices often operate in environments where they are remotely controlled or monitored, sometimes even over public or shared networks. Using HTTPS ensures that communication between your application and the NETIO device remains private and secure, even if someone intercepts the network traffic.<br />
<br /><br />
<br /><br />
<h2>How to enable HTTPs on NETIO Device</h2><br />
All NETIO devices running on <b><u>FW 5.0.X</b></u> can be configure the way to support HTTPs communication. HTTPs option is available via Setting/ Security. Port 443 is pre-defined, but can be changed. HTTPs configuration port is shared with M2M API protocols setup. NETIO devices support HTTPs using a self-signed certificate by default. This allows you to use secure connections immediately, even in isolated or internal networks. For production environments or public access, is recommended to upload a certificate from a trusted Certificate Authority (CA). This ensures proper validation and avoids browser or client warnings.<br />
<br />
<br /><br />
[[File:NETIO_4PZ_HTTPs.png |Https setup]]<br />
<br /><br />
<br />
<h2>TLS Versions and Cipher Suites Supported by NETIO</h2><br />
<br />
NETIO power devices support encrypted HTTPS communication using the TLS (Transport Layer Security) protocol. TLS ensures confidentiality, integrity, and authentication when accessing the device’s web interface or APIs (e.g., JSON/XML REST API).<br />
<br />
<br />
<br />
<u><b>Supported TLS Versions.:</b></u><br />
<br />
**TLS 1.0 and TLS 1.1 – (Deprecated for security reasons)<br />
**TLS 1.2 (<b>Supported</b>) (minimum secure standard and should always be used).Legacy TLS versions are disabled by default for security.<br />
**TLS 1.3 – Not supported at the moment* (future development under investigation)<br />
<br />
<br />
NETIO firmware supports multiple cipher suites using <b>RSA</b> or <b>ECDHE</b> (Elliptic Curve Diffie-Hellman Ephemeral) key exchange, combined with AES encryption (GCM/CCM) modes. There is a list of supported TLS cipher suites and key types that NETIO devices accept when establishing a secure HTTPS connection.<br />
<br /><br />
<br />
<br />
<u><b>Key Types used during the TLS handshake:</b></u><br />
**ecc_prime256v1 – elliptic curve (ECDSA) key, 256-bit (NIST P-256)<br />
**ecc_secp384r1 – stronger ECC key, 384-bit<br />
**ecc_secp521r1 – even stronger ECC key, 521-bit<br />
**rsa_1024 / rsa_2048 / rsa_3072 / rsa_4096 – RSA keys of corresponding lengths<br />
<br />
<br />
<u><b>Cipher Suite – a specific combination of algorithms used to encrypt the TLS connection:</b></u><br />
**ECDHE – key exchange algorithm (supports forward secrecy)<br />
**ECDSA – digital certificate based on ECC key (e.g., prime256v1)<br />
**AES_256_GCM – symmetric encryption (AES 256-bit, Galois/Counter Mode)<br />
**SHA384 – hashing algorithm used for integrity checks<br />
<br />
<br />
List of combinations tested with NETIO device<br />
<table style="border-collapse: collapse; width: 97.80949%;" border="1"><br />
<tr><br />
<td style="width: 8.687943%;"><br />
<p style="font-weight: 400;">&nbsp;<strong>-&gt; ecc_prime256v1</strong>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</p><br />
<ul><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</li><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_CCM</li><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_CCM</li><br />
</ul><br />
</td><br />
<td style="width: 20.451527%;" width="269"><br />
<p style="font-weight: 400;"><strong>-&gt; ecc_secp384r1</strong>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</p><br />
<ul><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_CCM</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_CCM</span></li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p style="font-weight: 400;"><strong>-&gt; ecc_secp521r1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</strong></p><br />
<ul><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_CCM:</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_CCM</span></li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p></p><br />
</td><br />
</tr><br />
<tr><br />
<td style="width: 8.687943%;"><br />
<p style="font-weight: 400;"><strong>-&gt; rsa_1024</strong></p><br />
<ul><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_CCM</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_CCM</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_SHA</li><br />
<li style="font-weight: 400;"><span style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_SHA</span></li><br />
</ul><br />
</td><br />
<td style="width: 20.451527%;"><br />
<p style="font-weight: 400;">-<strong>&gt; rsa_2048</strong></p><br />
<ul><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_SHA</span></li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p>-<strong>&gt; rsa_3072</strong></p><br />
<ul><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_SHA</li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p style="font-weight: 400;"><strong>-&gt; rsa_4096</strong></p><br />
<ul><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_CCM</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_CCM</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_SHA</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_SHA</span></li><br />
</ul><br />
</td><br />
</tr><br />
</table><br />
<br />
<br />
<h1>Secure M2M API Access via HTTPs</h1><br />
<br />
NETIO devices support secure communication over HTTPS to protect API access to power sockets and configuration interfaces. This is essential when integrating NETIO devices with 3th party systems. M2M API Machine protocols setup uses the same port as being setup at configuration setting. <br />
Device provide access to various machine-readable APIs, such as:<br />
**JSON API<br />
**XML API<br />
**MQTTs (optional for some models)<br />
**URL<br />
<br />
As HTTPS is enabled, all communication with these APIs is encrypted using TLS (Transport Layer Security). This ensures that authentication tokens, control commands (e.g., socket ON/OFF), and monitoring data cannot be intercepted or altered.<br />
<br />
<b>Here is an examples of turning socket 1 ON using the JSON API over HTTPS:</b><br />
<br /><br />
<em>curl -k netio_user:netio_password -d '{"Outputs":[{"ID":1,"Action":1}]}' -H "Content-Type: application/json" -X POST https://192.168.105.160:81/netio.json</em><br />
<br /><br />
**(**Replace netio_user & netio_password with proper JSON API password)<br />
<br />
<br />
<b>Here is an example of turning socket 1 ON using URL over HTTPS:</b><br />
<br /><br />
<em>https://192.168.1.100/netio.json?pass=netio123&output1=1"</em><br />
<br /><br />
**(**Replace netio123 with your actual API password)<br />
<br />
<br />
<b> API Performance testing </b><br />
<br/><br />
In internal NETIO testing on PowerPDU 4KS device (see below), various cipher suites and elliptic curves were evaluated for performance during secure HTTPS communication with the JSON and WebSocket APIs. Prime256v1 (NIST P-256) is recommended for best performance and compatibility. <br />
<br />
<br />
<table border="1" cellspacing="0" cellpadding="5"><br />
<tr><br />
<th>&nbsp;</th><br />
<th>Response time Web Socket [s]</th><br />
<th>Response time JSON [s]</th><br />
</tr><br />
<tr><br />
<td colspan="3"><strong>ecc_prime256v1</strong></td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</td><br />
<td style="text-align: center;">5.7</td><br />
<td style="text-align: center;">6.0</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_CCM</td><br />
<td style="text-align: center;">5.9</td><br />
<td style="text-align: center;">5.6</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</td><br />
<td style="text-align: center;">5.8</td><br />
<td style="text-align: center;">5.7</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_CCM</td><br />
<td style="text-align: center;">6.1</td><br />
<td style="text-align: center;">6.2</td><br />
</tr><br />
<tr><br />
<td colspan="3"><strong>ecc_secp384r1</strong></td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</td><br />
<td style="text-align: center;">6.4</td><br />
<td style="text-align: center;">6.3</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_CCM</td><br />
<td style="text-align: center;">6.3</td><br />
<td style="text-align: center;">6.2</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</td><br />
<td style="text-align: center;">6.2</td><br />
<td style="text-align: center;">6.2</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_CCM</td><br />
<td style="text-align: center;">6.5</td><br />
<td style="text-align: center;">6.3</td><br />
</tr><br />
<tr><br />
<td colspan="3"><strong>ecc_secp521r1</strong></td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</td><br />
<td style="text-align: center;">6.5</td><br />
<td style="text-align: center;">6.4</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_CCM</td><br />
<td style="text-align: center;">6.6</td><br />
<td style="text-align: center;">6.5</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</td><br />
<td style="text-align: center;">6.7</td><br />
<td style="text-align: center;">6.3</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_CCM</td><br />
<td style="text-align: center;">6.6</td><br />
<td style="text-align: center;">6.5</td><br />
</tr><br />
</table><br />
<br />
<p>* values are valid for ethernet connection only<br /><br />
<p>** values can differentiate on WiFi connection</p></div>
Tbezstarosta
https://wiki.netio-products.com/index.php?title=HTTPs_details&diff=1077
HTTPs details
2025-08-13T08:39:37Z
<p>Tbezstarosta: </p>
<hr />
<div><br /><br />
<h1>HTTPS (Hypertext Transfer Protocol Secure)</h1> HTTPs is the secure version of HTTP, the protocol used for communication between a web browser or application and a web server or device. HTTPS adds a layer of encryption using TLS (Transport Layer Security), which protects the data transmitted over the network.<br />
<b>Why Use HTTPs with NETIO Power Devices?</b><br />
<br /><br />
NETIO devices often operate in environments where they are remotely controlled or monitored, sometimes even over public or shared networks. Using HTTPS ensures that communication between your application and the NETIO device remains private and secure, even if someone intercepts the network traffic.<br />
<br /><br />
<br /><br />
<h2>How to enable HTTPs on NETIO Device</h2><br />
All NETIO devices running on <b><u>FW 5.0.X</b></u> can be configure the way to support HTTPs communication. HTTPs option is available via Setting/ Security. Port 443 is pre-defined, but can be changed. HTTPs configuration port is shared with M2M API protocols setup. NETIO devices support HTTPs using a self-signed certificate by default. This allows you to use secure connections immediately, even in isolated or internal networks. For production environments or public access, is recommended to upload a certificate from a trusted Certificate Authority (CA). This ensures proper validation and avoids browser or client warnings.<br />
<br />
<br /><br />
[[File:NETIO_4PZ_HTTPs.png |Https setup]]<br />
<br /><br />
<br />
<h2>TLS Versions and Cipher Suites Supported by NETIO</h2><br />
<br />
NETIO power devices support encrypted HTTPS communication using the TLS (Transport Layer Security) protocol. TLS ensures confidentiality, integrity, and authentication when accessing the device’s web interface or APIs (e.g., JSON/XML REST API).<br />
<br />
<br />
<br />
<u><b>Supported TLS Versions.:</b></u><br />
<br />
**TLS 1.0 and TLS 1.1 – (Deprecated for security reasons)<br />
**TLS 1.2 (<b>Supported</b>) (minimum secure standard and should always be used).Legacy TLS versions are disabled by default for security.<br />
**TLS 1.3 – Not supported at the moment* (future development under investigation)<br />
<br />
<br />
NETIO firmware supports multiple cipher suites using <b>RSA</b> or <b>ECDHE</b> (Elliptic Curve Diffie-Hellman Ephemeral) key exchange, combined with AES encryption (GCM/CCM) modes. There is a list of supported TLS cipher suites and key types that NETIO devices accept when establishing a secure HTTPS connection.<br />
<br /><br />
<br />
<br />
<u><b>Key Types used during the TLS handshake:</b></u><br />
**ecc_prime256v1 – elliptic curve (ECDSA) key, 256-bit (NIST P-256)<br />
**ecc_secp384r1 – stronger ECC key, 384-bit<br />
**ecc_secp521r1 – even stronger ECC key, 521-bit<br />
**rsa_1024 / rsa_2048 / rsa_3072 / rsa_4096 – RSA keys of corresponding lengths<br />
<br />
<br />
<u><b>Cipher Suite – a specific combination of algorithms used to encrypt the TLS connection:</b></u><br />
**ECDHE – key exchange algorithm (supports forward secrecy)<br />
**ECDSA – digital certificate based on ECC key (e.g., prime256v1)<br />
**AES_256_GCM – symmetric encryption (AES 256-bit, Galois/Counter Mode)<br />
**SHA384 – hashing algorithm used for integrity checks<br />
<br />
<br />
List of combinations tested with NETIO device<br />
<table style="border-collapse: collapse; width: 97.80949%;" border="1"><br />
<tr><br />
<td style="width: 8.687943%;"><br />
<p style="font-weight: 400;">&nbsp;<strong>-&gt; ecc_prime256v1</strong>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</p><br />
<ul><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</li><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_CCM</li><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_CCM</li><br />
</ul><br />
</td><br />
<td style="width: 20.451527%;" width="269"><br />
<p style="font-weight: 400;"><strong>-&gt; ecc_secp384r1</strong>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</p><br />
<ul><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_CCM</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_CCM</span></li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p style="font-weight: 400;"><strong>-&gt; ecc_secp521r1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</strong></p><br />
<ul><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_CCM:</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_CCM</span></li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p></p><br />
</td><br />
</tr><br />
<tr><br />
<td style="width: 8.687943%;"><br />
<p style="font-weight: 400;"><strong>-&gt; rsa_1024</strong></p><br />
<ul><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_CCM</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_CCM</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_SHA</li><br />
<li style="font-weight: 400;"><span style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_SHA</span></li><br />
</ul><br />
</td><br />
<td style="width: 20.451527%;"><br />
<p style="font-weight: 400;">-<strong>&gt; rsa_2048</strong></p><br />
<ul><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_SHA</span></li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p>-<strong>&gt; rsa_3072</strong></p><br />
<ul><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_SHA</li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p style="font-weight: 400;"><strong>-&gt; rsa_4096</strong></p><br />
<ul><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_CCM</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_CCM</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_SHA</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_SHA</span></li><br />
</ul><br />
</td><br />
</tr><br />
</table><br />
<br />
<br />
<h1>Secure M2M API Access via HTTPs</h1><br />
<br />
NETIO devices support secure communication over HTTPS to protect API access to power sockets and configuration interfaces. This is essential when integrating NETIO devices with 3th party systems. M2M API Machine protocols setup uses the same port as being setup at configuration setting. <br />
Device provide access to various machine-readable APIs, such as:<br />
**JSON API<br />
**XML API<br />
**MQTTs (optional for some models)<br />
**URL<br />
<br />
As HTTPS is enabled, all communication with these APIs is encrypted using TLS (Transport Layer Security). This ensures that authentication tokens, control commands (e.g., socket ON/OFF), and monitoring data cannot be intercepted or altered.<br />
<br />
<b>Here is an examples of turning socket 1 ON using the JSON API over HTTPS:</b><br />
<br /><br />
<em>curl -k netio_user:netio_password -d '{"Outputs":[{"ID":1,"Action":1}]}' -H "Content-Type: application/json" -X POST https://192.168.105.160:81/netio.json</em><br />
<br /><br />
**(**Replace netio_user & netio_password with proper JSON API password)<br />
<br />
<br />
<b>Here is an example of turning socket 1 ON using URL over HTTPS:</b><br />
<br /><br />
<em>https://192.168.1.100/netio.json?pass=netio123&output1=1"</em><br />
<br /><br />
**(**Replace netio123 with your actual API password)<br />
<br />
<br />
<b> API Performance testing </b><br />
In internal NETIO testing on PowerPDU 4KS device (see below), various cipher suites and elliptic curves were evaluated for performance during secure HTTPS communication with the JSON and WebSocket APIs. Prime256v1 (NIST P-256) is recommended for best performance and compatibility. <br />
<br />
<br />
<table border="1" cellspacing="0" cellpadding="5"><br />
<tr><br />
<th>&nbsp;</th><br />
<th>Response time Web Socket [s]</th><br />
<th>Response time JSON [s]</th><br />
</tr><br />
<tr><br />
<td colspan="3"><strong>ecc_prime256v1</strong></td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</td><br />
<td style="text-align: center;">5.7</td><br />
<td style="text-align: center;">6.0</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_CCM</td><br />
<td style="text-align: center;">5.9</td><br />
<td style="text-align: center;">5.6</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</td><br />
<td style="text-align: center;">5.8</td><br />
<td style="text-align: center;">5.7</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_CCM</td><br />
<td style="text-align: center;">6.1</td><br />
<td style="text-align: center;">6.2</td><br />
</tr><br />
<tr><br />
<td colspan="3"><strong>ecc_secp384r1</strong></td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</td><br />
<td style="text-align: center;">6.4</td><br />
<td style="text-align: center;">6.3</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_CCM</td><br />
<td style="text-align: center;">6.3</td><br />
<td style="text-align: center;">6.2</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</td><br />
<td style="text-align: center;">6.2</td><br />
<td style="text-align: center;">6.2</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_CCM</td><br />
<td style="text-align: center;">6.5</td><br />
<td style="text-align: center;">6.3</td><br />
</tr><br />
<tr><br />
<td colspan="3"><strong>ecc_secp521r1</strong></td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</td><br />
<td style="text-align: center;">6.5</td><br />
<td style="text-align: center;">6.4</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_CCM</td><br />
<td style="text-align: center;">6.6</td><br />
<td style="text-align: center;">6.5</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</td><br />
<td style="text-align: center;">6.7</td><br />
<td style="text-align: center;">6.3</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_CCM</td><br />
<td style="text-align: center;">6.6</td><br />
<td style="text-align: center;">6.5</td><br />
</tr><br />
</table><br />
<br />
<p>* values are valid for ethernet connection only<br /><br />
<p>** values can differentiate on WiFi connection</p></div>
Tbezstarosta
https://wiki.netio-products.com/index.php?title=HTTPs_details&diff=1076
HTTPs details
2025-08-13T08:34:40Z
<p>Tbezstarosta: </p>
<hr />
<div><br /><br />
<h1>HTTPS (Hypertext Transfer Protocol Secure)</h1> HTTPs is the secure version of HTTP, the protocol used for communication between a web browser or application and a web server or device. HTTPS adds a layer of encryption using TLS (Transport Layer Security), which protects the data transmitted over the network.<br />
<b>Why Use HTTPs with NETIO Power Devices?</b><br />
<br /><br />
NETIO devices often operate in environments where they are remotely controlled or monitored, sometimes even over public or shared networks. Using HTTPS ensures that communication between your application and the NETIO device remains private and secure, even if someone intercepts the network traffic.<br />
<br /><br />
<br /><br />
<h2>How to enable HTTPs on NETIO Device</h2><br />
All NETIO devices running on <b><u>FW 5.0.X</b></u> can be configure the way to support HTTPs communication. HTTPs option is available via Setting/ Security. Port 443 is pre-defined, but can be changed. HTTPs configuration port is shared to the port at M2M API Machine protocols setup NETIO devices support HTTPs using a self-signed certificate by default. This allows you to use secure connections immediately, even in isolated or internal networks. For production environments or public access, it is recommended to upload a certificate from a trusted Certificate Authority (CA). This ensures proper validation and avoids browser or client warnings.<br />
<br />
<br /><br />
[[File:NETIO_4PZ_HTTPs.png |Https setup]]<br />
<br /><br />
<br />
<h2>TLS Versions and Cipher Suites Supported by NETIO</h2><br />
<br />
NETIO power devices support encrypted HTTPS communication using the TLS (Transport Layer Security) protocol. TLS ensures confidentiality, integrity, and authentication when accessing the device’s web interface or APIs (e.g., JSON/XML REST API).<br />
<br />
<br />
<br />
<u><b>Supported TLS Versions.:</b></u><br />
<br />
**TLS 1.0 and TLS 1.1 – (Deprecated for security reasons)<br />
**TLS 1.2 (<b>Supported</b>) (minimum secure standard and should always be used).Legacy TLS versions are disabled by default for security.<br />
**TLS 1.3 – Not supported at the moment* (future development under investigation)<br />
<br />
<br />
NETIO firmware supports multiple cipher suites using <b>RSA</b> or <b>ECDHE</b> (Elliptic Curve Diffie-Hellman Ephemeral) key exchange, combined with AES encryption (GCM/CCM) modes. There is a list of supported TLS cipher suites and key types that NETIO devices accept when establishing a secure HTTPS connection.<br />
<br /><br />
<br />
<br />
<u><b>Key Types used during the TLS handshake:</b></u><br />
**ecc_prime256v1 – elliptic curve (ECDSA) key, 256-bit (NIST P-256)<br />
**ecc_secp384r1 – stronger ECC key, 384-bit<br />
**ecc_secp521r1 – even stronger ECC key, 521-bit<br />
**rsa_1024 / rsa_2048 / rsa_3072 / rsa_4096 – RSA keys of corresponding lengths<br />
<br />
<br />
<u><b>Cipher Suite – a specific combination of algorithms used to encrypt the TLS connection:</b></u><br />
**ECDHE – key exchange algorithm (supports forward secrecy)<br />
**ECDSA – digital certificate based on ECC key (e.g., prime256v1)<br />
**AES_256_GCM – symmetric encryption (AES 256-bit, Galois/Counter Mode)<br />
**SHA384 – hashing algorithm used for integrity checks<br />
<br />
<br />
List of combinations tested with NETIO device<br />
<table style="border-collapse: collapse; width: 97.80949%;" border="1"><br />
<tr><br />
<td style="width: 8.687943%;"><br />
<p style="font-weight: 400;">&nbsp;<strong>-&gt; ecc_prime256v1</strong>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</p><br />
<ul><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</li><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_CCM</li><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_CCM</li><br />
</ul><br />
</td><br />
<td style="width: 20.451527%;" width="269"><br />
<p style="font-weight: 400;"><strong>-&gt; ecc_secp384r1</strong>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</p><br />
<ul><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_CCM</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_CCM</span></li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p style="font-weight: 400;"><strong>-&gt; ecc_secp521r1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</strong></p><br />
<ul><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_CCM:</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_CCM</span></li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p></p><br />
</td><br />
</tr><br />
<tr><br />
<td style="width: 8.687943%;"><br />
<p style="font-weight: 400;"><strong>-&gt; rsa_1024</strong></p><br />
<ul><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_CCM</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_CCM</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_SHA</li><br />
<li style="font-weight: 400;"><span style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_SHA</span></li><br />
</ul><br />
</td><br />
<td style="width: 20.451527%;"><br />
<p style="font-weight: 400;">-<strong>&gt; rsa_2048</strong></p><br />
<ul><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_SHA</span></li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p>-<strong>&gt; rsa_3072</strong></p><br />
<ul><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_SHA</li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p style="font-weight: 400;"><strong>-&gt; rsa_4096</strong></p><br />
<ul><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_CCM</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_CCM</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_SHA</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_SHA</span></li><br />
</ul><br />
</td><br />
</tr><br />
</table><br />
<br />
<br />
<h1>Secure M2M API Access via HTTPs</h1><br />
<br />
NETIO devices support secure communication over HTTPS to protect API access to power sockets and configuration interfaces. This is essential when integrating NETIO devices with 3th party systems. M2M API Machine protocols setup uses the same port as being setup at configuration setting. <br />
Device provide access to various machine-readable APIs, such as:<br />
**JSON API<br />
**XML API<br />
**MQTTs (optional for some models)<br />
**URL<br />
<br />
As HTTPS is enabled, all communication with these APIs is encrypted using TLS (Transport Layer Security). This ensures that authentication tokens, control commands (e.g., socket ON/OFF), and monitoring data cannot be intercepted or altered.<br />
<br />
<b>Here is an examples of turning socket 1 ON using the JSON API over HTTPS:</b><br />
<br /><br />
<em>curl -k netio_user:netio_password -d '{"Outputs":[{"ID":1,"Action":1}]}' -H "Content-Type: application/json" -X POST https://192.168.105.160:81/netio.json</em><br />
<br /><br />
**(**Replace netio_user & netio_password with proper JSON API password)<br />
<br />
<br />
<b>Here is an example of turning socket 1 ON using URL over HTTPS:</b><br />
<br /><br />
<em>https://192.168.1.100/netio.json?pass=netio123&output1=1"</em><br />
<br /><br />
**(**Replace netio123 with your actual API password)<br />
<br />
<br />
<b> API Performance testing </b><br />
In internal NETIO testing on PowerPDU 4KS device (see below), various cipher suites and elliptic curves were evaluated for performance during secure HTTPS communication with the JSON and WebSocket APIs. Prime256v1 (NIST P-256) is recommended for best performance and compatibility. <br />
<br />
<br />
<table border="1" cellspacing="0" cellpadding="5"><br />
<tr><br />
<th>&nbsp;</th><br />
<th>Response time Web Socket [s]</th><br />
<th>Response time JSON [s]</th><br />
</tr><br />
<tr><br />
<td colspan="3"><strong>ecc_prime256v1</strong></td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</td><br />
<td style="text-align: center;">5.7</td><br />
<td style="text-align: center;">6.0</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_CCM</td><br />
<td style="text-align: center;">5.9</td><br />
<td style="text-align: center;">5.6</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</td><br />
<td style="text-align: center;">5.8</td><br />
<td style="text-align: center;">5.7</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_CCM</td><br />
<td style="text-align: center;">6.1</td><br />
<td style="text-align: center;">6.2</td><br />
</tr><br />
<tr><br />
<td colspan="3"><strong>ecc_secp384r1</strong></td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</td><br />
<td style="text-align: center;">6.4</td><br />
<td style="text-align: center;">6.3</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_CCM</td><br />
<td style="text-align: center;">6.3</td><br />
<td style="text-align: center;">6.2</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</td><br />
<td style="text-align: center;">6.2</td><br />
<td style="text-align: center;">6.2</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_CCM</td><br />
<td style="text-align: center;">6.5</td><br />
<td style="text-align: center;">6.3</td><br />
</tr><br />
<tr><br />
<td colspan="3"><strong>ecc_secp521r1</strong></td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</td><br />
<td style="text-align: center;">6.5</td><br />
<td style="text-align: center;">6.4</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_CCM</td><br />
<td style="text-align: center;">6.6</td><br />
<td style="text-align: center;">6.5</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</td><br />
<td style="text-align: center;">6.7</td><br />
<td style="text-align: center;">6.3</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_CCM</td><br />
<td style="text-align: center;">6.6</td><br />
<td style="text-align: center;">6.5</td><br />
</tr><br />
</table><br />
<br />
<p>* values are valid for ethernet connection only<br /><br />
<p>** values can differentiate on WiFi connection</p></div>
Tbezstarosta
https://wiki.netio-products.com/index.php?title=HTTPs_details&diff=1075
HTTPs details
2025-08-13T08:32:37Z
<p>Tbezstarosta: </p>
<hr />
<div><br /><br />
<h1>HTTPS (Hypertext Transfer Protocol Secure)</h1> HTTPs is the secure version of HTTP, the protocol used for communication between a web browser or application and a web server or device. HTTPS adds a layer of encryption using TLS (Transport Layer Security), which protects the data transmitted over the network.<br />
<b>Why Use HTTPs with NETIO Power Devices?</b><br />
<br /><br />
NETIO devices often operate in environments where they are remotely controlled or monitored, sometimes even over public or shared networks. Using HTTPS ensures that communication between your application and the NETIO device remains private and secure, even if someone intercepts the network traffic.<br />
<br /><br />
<br /><br />
<h2>How to enable HTTPs on NETIO Device</h2><br />
All NETIO devices running on <b><u>FW 5.0.X</b></u> can be configure the way to support HTTPs communication. HTTPs option is available via Setting/ Security. Port 443 is pre-defined, but can be changed. HTTPs configuration port is shared to the port at M2M API Machine protocols setup NETIO devices support HTTPs using a self-signed certificate by default. This allows you to use secure connections immediately, even in isolated or internal networks. For production environments or public access, it is recommended to upload a certificate from a trusted Certificate Authority (CA). This ensures proper validation and avoids browser or client warnings.<br />
<br />
<br /><br />
[[File:NETIO_4PZ_HTTPs.png |Https setup]]<br />
<br /><br />
<br />
<h2>TLS Versions and Cipher Suites Supported by NETIO</h2><br />
<br />
NETIO power devices support encrypted HTTPS communication using the TLS (Transport Layer Security) protocol. TLS ensures confidentiality, integrity, and authentication when accessing the device’s web interface or APIs (e.g., JSON/XML REST API).<br />
<br />
<br />
<br />
<u><b>Supported TLS Versions.:</b></u><br />
<br />
**TLS 1.0 and TLS 1.1 – (Deprecated for security reasons)<br />
**TLS 1.2 (<b>Supported</b>) (minimum secure standard and should always be used).Legacy TLS versions are disabled by default for security.<br />
**TLS 1.3 – Not supported at the moment* (future development under investigation)<br />
<br />
<br />
NETIO firmware supports multiple cipher suites using <b>RSA</b> or <b>ECDHE</b> (Elliptic Curve Diffie-Hellman Ephemeral) key exchange, combined with AES encryption (GCM/CCM) modes. There is a list of supported TLS cipher suites and key types that NETIO devices accept when establishing a secure HTTPS connection.<br />
<br /><br />
<br />
<br />
<u><b>Key Types used during the TLS handshake:</b></u><br />
**ecc_prime256v1 – elliptic curve (ECDSA) key, 256-bit (NIST P-256)<br />
**ecc_secp384r1 – stronger ECC key, 384-bit<br />
**ecc_secp521r1 – even stronger ECC key, 521-bit<br />
**rsa_1024 / rsa_2048 / rsa_3072 / rsa_4096 – RSA keys of corresponding lengths<br />
<br />
<br />
<u><b>Cipher Suite – a specific combination of algorithms used to encrypt the TLS connection:</b></u><br />
**ECDHE – key exchange algorithm (supports forward secrecy)<br />
**ECDSA – digital certificate based on ECC key (e.g., prime256v1)<br />
**AES_256_GCM – symmetric encryption (AES 256-bit, Galois/Counter Mode)<br />
**SHA384 – hashing algorithm used for integrity checks<br />
<br />
<br />
List on combinations tested with NETIO device<br />
<table style="border-collapse: collapse; width: 97.80949%;" border="1"><br />
<tr><br />
<td style="width: 8.687943%;"><br />
<p style="font-weight: 400;">&nbsp;<strong>-&gt; ecc_prime256v1</strong>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</p><br />
<ul><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</li><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_CCM</li><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_CCM</li><br />
</ul><br />
</td><br />
<td style="width: 20.451527%;" width="269"><br />
<p style="font-weight: 400;"><strong>-&gt; ecc_secp384r1</strong>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</p><br />
<ul><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_CCM</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_CCM</span></li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p style="font-weight: 400;"><strong>-&gt; ecc_secp521r1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</strong></p><br />
<ul><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_CCM:</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_CCM</span></li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p></p><br />
</td><br />
</tr><br />
<tr><br />
<td style="width: 8.687943%;"><br />
<p style="font-weight: 400;"><strong>-&gt; rsa_1024</strong></p><br />
<ul><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_CCM</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_CCM</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_SHA</li><br />
<li style="font-weight: 400;"><span style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_SHA</span></li><br />
</ul><br />
</td><br />
<td style="width: 20.451527%;"><br />
<p style="font-weight: 400;">-<strong>&gt; rsa_2048</strong></p><br />
<ul><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_SHA</span></li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p>-<strong>&gt; rsa_3072</strong></p><br />
<ul><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_SHA</li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p style="font-weight: 400;"><strong>-&gt; rsa_4096</strong></p><br />
<ul><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_CCM</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_CCM</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_SHA</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_SHA</span></li><br />
</ul><br />
</td><br />
</tr><br />
</table><br />
<br />
<br />
<h1>Secure M2M API Access via HTTPs</h1><br />
<br />
NETIO devices support secure communication over HTTPS to protect API access to power sockets and configuration interfaces. This is essential when integrating NETIO devices with 3th party systems. M2M API Machine protocols setup uses the same port as being setup at configuration setting. <br />
Device provide access to various machine-readable APIs, such as:<br />
**JSON API<br />
**XML API<br />
**MQTTs (optional for some models)<br />
**URL<br />
<br />
As HTTPS is enabled, all communication with these APIs is encrypted using TLS (Transport Layer Security). This ensures that authentication tokens, control commands (e.g., socket ON/OFF), and monitoring data cannot be intercepted or altered.<br />
<br />
<b>Here is an examples of turning socket 1 ON using the JSON API over HTTPS:</b><br />
<br /><br />
<em>curl -k netio_user:netio_password -d '{"Outputs":[{"ID":1,"Action":1}]}' -H "Content-Type: application/json" -X POST https://192.168.105.160:81/netio.json</em><br />
<br /><br />
**(**Replace netio_user & netio_password with proper JSON API password)<br />
<br />
<br />
<b>Here is an example of turning socket 1 ON using URL over HTTPS:</b><br />
<br /><br />
<em>https://192.168.1.100/netio.json?pass=netio123&output1=1"</em><br />
<br /><br />
**(**Replace netio123 with your actual API password)<br />
<br />
<br />
<b> API Performance testing </b><br />
In internal NETIO testing on PowerPDU 4KS device (see below), various cipher suites and elliptic curves were evaluated for performance during secure HTTPS communication with the JSON and WebSocket APIs. Prime256v1 (NIST P-256) is recommended for best performance and compatibility. <br />
<br />
<br />
<table border="1" cellspacing="0" cellpadding="5"><br />
<tr><br />
<th>&nbsp;</th><br />
<th>Response time Web Socket [s]</th><br />
<th>Response time JSON [s]</th><br />
</tr><br />
<tr><br />
<td colspan="3"><strong>ecc_prime256v1</strong></td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</td><br />
<td style="text-align: center;">5.7</td><br />
<td style="text-align: center;">6.0</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_CCM</td><br />
<td style="text-align: center;">5.9</td><br />
<td style="text-align: center;">5.6</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</td><br />
<td style="text-align: center;">5.8</td><br />
<td style="text-align: center;">5.7</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_CCM</td><br />
<td style="text-align: center;">6.1</td><br />
<td style="text-align: center;">6.2</td><br />
</tr><br />
<tr><br />
<td colspan="3"><strong>ecc_secp384r1</strong></td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</td><br />
<td style="text-align: center;">6.4</td><br />
<td style="text-align: center;">6.3</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_CCM</td><br />
<td style="text-align: center;">6.3</td><br />
<td style="text-align: center;">6.2</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</td><br />
<td style="text-align: center;">6.2</td><br />
<td style="text-align: center;">6.2</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_CCM</td><br />
<td style="text-align: center;">6.5</td><br />
<td style="text-align: center;">6.3</td><br />
</tr><br />
<tr><br />
<td colspan="3"><strong>ecc_secp521r1</strong></td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</td><br />
<td style="text-align: center;">6.5</td><br />
<td style="text-align: center;">6.4</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_CCM</td><br />
<td style="text-align: center;">6.6</td><br />
<td style="text-align: center;">6.5</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</td><br />
<td style="text-align: center;">6.7</td><br />
<td style="text-align: center;">6.3</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_CCM</td><br />
<td style="text-align: center;">6.6</td><br />
<td style="text-align: center;">6.5</td><br />
</tr><br />
</table><br />
<br />
<p>* values are valid for ethernet connection only<br /><br />
<p>** values can differentiate on WiFi connection</p></div>
Tbezstarosta
https://wiki.netio-products.com/index.php?title=HTTPs_details&diff=1074
HTTPs details
2025-08-13T08:30:08Z
<p>Tbezstarosta: </p>
<hr />
<div><br /><br />
<h1>HTTPS (Hypertext Transfer Protocol Secure)</h1> HTTPs is the secure version of HTTP, the protocol used for communication between a web browser or application and a web server or device. HTTPS adds a layer of encryption using TLS (Transport Layer Security), which protects the data transmitted over the network.<br />
<b>Why Use HTTPs with NETIO Power Devices?</b><br />
<br /><br />
NETIO devices often operate in environments where they are remotely controlled or monitored, sometimes even over public or shared networks. Using HTTPS ensures that communication between your application and the NETIO device remains private and secure, even if someone intercepts the network traffic.<br />
<br /><br />
<br /><br />
<h2>How to enable HTTPs on NETIO Device</h2><br />
All NETIO devices running on <b><u>FW 5.0.X</b></u> can be configure the way to support HTTPs communication. HTTPs option is available via Setting/ Security. Port 443 is pre-defined, but can be changed. HTTPs configuration port is shared to the port at M2M API Machine protocols setup NETIO devices support HTTPs using a self-signed certificate by default. This allows you to use secure connections immediately, even in isolated or internal networks. For production environments or public access, it is recommended to upload a certificate from a trusted Certificate Authority (CA). This ensures proper validation and avoids browser or client warnings.<br />
<br />
<br /><br />
[[File:NETIO_4PZ_HTTPs.png |Https setup]]<br />
<br /><br />
<br />
<h2>TLS Versions and Cipher Suites Supported by NETIO</h2><br />
<br />
NETIO power devices support encrypted HTTPS communication using the TLS (Transport Layer Security) protocol. TLS ensures confidentiality, integrity, and authentication when accessing the device’s web interface or APIs (e.g., JSON/XML REST API).<br />
<br />
<br />
<br />
<u><b>Supported TLS Versions.:</b></u><br />
<br />
**TLS 1.0 and TLS 1.1 – (Deprecated for security reasons)<br />
**TLS 1.2 (Supported) (minimum secure standard and should always be used).Legacy TLS versions are disabled by default for security.<br />
**TLS 1.3 – Not supported at the moment* (future development under investigation)<br />
<br />
<br />
NETIO firmware supports multiple cipher suites using <b>RSA</b> or <b>ECDHE</b> (Elliptic Curve Diffie-Hellman Ephemeral) key exchange, combined with AES encryption (GCM/CCM) modes. There is a list of supported TLS cipher suites and key types that NETIO devices accept when establishing a secure HTTPS connection.<br />
<br /><br />
<br />
<br />
<u><b>Key Types used during the TLS handshake:</b></u><br />
**ecc_prime256v1 – elliptic curve (ECDSA) key, 256-bit (NIST P-256)<br />
**ecc_secp384r1 – stronger ECC key, 384-bit<br />
**ecc_secp521r1 – even stronger ECC key, 521-bit<br />
**rsa_1024 / rsa_2048 / rsa_3072 / rsa_4096 – RSA keys of corresponding lengths<br />
<br />
<br />
<u><b>Cipher Suite – a specific combination of algorithms used to encrypt the TLS connection:</b></u><br />
**ECDHE – key exchange algorithm (supports forward secrecy)<br />
**ECDSA – digital certificate based on ECC key (e.g., prime256v1)<br />
**AES_256_GCM – symmetric encryption (AES 256-bit, Galois/Counter Mode)<br />
**SHA384 – hashing algorithm used for integrity checks<br />
<br />
<br />
List on combinations tested with NETIO device<br />
<table style="border-collapse: collapse; width: 97.80949%;" border="1"><br />
<tr><br />
<td style="width: 8.687943%;"><br />
<p style="font-weight: 400;">&nbsp;<strong>-&gt; ecc_prime256v1</strong>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</p><br />
<ul><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</li><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_CCM</li><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_CCM</li><br />
</ul><br />
</td><br />
<td style="width: 20.451527%;" width="269"><br />
<p style="font-weight: 400;"><strong>-&gt; ecc_secp384r1</strong>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</p><br />
<ul><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_CCM</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_CCM</span></li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p style="font-weight: 400;"><strong>-&gt; ecc_secp521r1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</strong></p><br />
<ul><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_CCM:</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_CCM</span></li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p></p><br />
</td><br />
</tr><br />
<tr><br />
<td style="width: 8.687943%;"><br />
<p style="font-weight: 400;"><strong>-&gt; rsa_1024</strong></p><br />
<ul><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_CCM</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_CCM</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_SHA</li><br />
<li style="font-weight: 400;"><span style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_SHA</span></li><br />
</ul><br />
</td><br />
<td style="width: 20.451527%;"><br />
<p style="font-weight: 400;">-<strong>&gt; rsa_2048</strong></p><br />
<ul><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_SHA</span></li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p>-<strong>&gt; rsa_3072</strong></p><br />
<ul><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_SHA</li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p style="font-weight: 400;"><strong>-&gt; rsa_4096</strong></p><br />
<ul><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_CCM</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_CCM</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_SHA</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_SHA</span></li><br />
</ul><br />
</td><br />
</tr><br />
</table><br />
<br />
<br />
<h1>Secure M2M API Access via HTTPs</h1><br />
<br />
NETIO devices support secure communication over HTTPS to protect API access to power sockets and configuration interfaces. This is essential when integrating NETIO devices with 3th party systems. M2M API Machine protocols setup uses the same port as being setup at configuration setting. <br />
Device provide access to various machine-readable APIs, such as:<br />
**JSON API<br />
**XML API<br />
**MQTTs (optional for some models)<br />
**URL<br />
<br />
As HTTPS is enabled, all communication with these APIs is encrypted using TLS (Transport Layer Security). This ensures that authentication tokens, control commands (e.g., socket ON/OFF), and monitoring data cannot be intercepted or altered.<br />
<br />
<b>Here is an examples of turning socket 1 ON using the JSON API over HTTPS:</b><br />
<br /><br />
<em>curl -k netio_user:netio_password -d '{"Outputs":[{"ID":1,"Action":1}]}' -H "Content-Type: application/json" -X POST https://192.168.105.160:81/netio.json</em><br />
<br /><br />
**(**Replace netio_user & netio_password with proper JSON API password)<br />
<br />
<br />
<b>Here is an example of turning socket 1 ON using URL over HTTPS:</b><br />
<br /><br />
<em>https://192.168.1.100/netio.json?pass=netio123&output1=1"</em><br />
<br /><br />
**(**Replace netio123 with your actual API password)<br />
<br />
<br />
<b> API Performance testing </b><br />
In internal NETIO testing on PowerPDU 4KS device (see below), various cipher suites and elliptic curves were evaluated for performance during secure HTTPS communication with the JSON and WebSocket APIs. Prime256v1 (NIST P-256) is recommended for best performance and compatibility. <br />
<br />
<br />
<table border="1" cellspacing="0" cellpadding="5"><br />
<tr><br />
<th>&nbsp;</th><br />
<th>Response time Web Socket [s]</th><br />
<th>Response time JSON [s]</th><br />
</tr><br />
<tr><br />
<td colspan="3"><strong>ecc_prime256v1</strong></td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</td><br />
<td style="text-align: center;">5.7</td><br />
<td style="text-align: center;">6.0</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_CCM</td><br />
<td style="text-align: center;">5.9</td><br />
<td style="text-align: center;">5.6</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</td><br />
<td style="text-align: center;">5.8</td><br />
<td style="text-align: center;">5.7</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_CCM</td><br />
<td style="text-align: center;">6.1</td><br />
<td style="text-align: center;">6.2</td><br />
</tr><br />
<tr><br />
<td colspan="3"><strong>ecc_secp384r1</strong></td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</td><br />
<td style="text-align: center;">6.4</td><br />
<td style="text-align: center;">6.3</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_CCM</td><br />
<td style="text-align: center;">6.3</td><br />
<td style="text-align: center;">6.2</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</td><br />
<td style="text-align: center;">6.2</td><br />
<td style="text-align: center;">6.2</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_CCM</td><br />
<td style="text-align: center;">6.5</td><br />
<td style="text-align: center;">6.3</td><br />
</tr><br />
<tr><br />
<td colspan="3"><strong>ecc_secp521r1</strong></td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</td><br />
<td style="text-align: center;">6.5</td><br />
<td style="text-align: center;">6.4</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_CCM</td><br />
<td style="text-align: center;">6.6</td><br />
<td style="text-align: center;">6.5</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</td><br />
<td style="text-align: center;">6.7</td><br />
<td style="text-align: center;">6.3</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_CCM</td><br />
<td style="text-align: center;">6.6</td><br />
<td style="text-align: center;">6.5</td><br />
</tr><br />
</table><br />
<br />
<p>* values are valid for ethernet connection only<br /><br />
<p>** values can differentiate on WiFi connection</p></div>
Tbezstarosta
https://wiki.netio-products.com/index.php?title=File:NETIO_4PZ_HTTPs.png&diff=1073
File:NETIO 4PZ HTTPs.png
2025-08-13T08:28:23Z
<p>Tbezstarosta: </p>
<hr />
<div></div>
Tbezstarosta
https://wiki.netio-products.com/index.php?title=HTTPs_details&diff=1071
HTTPs details
2025-08-11T12:16:43Z
<p>Tbezstarosta: </p>
<hr />
<div><br /><br />
<h1>HTTPS (Hypertext Transfer Protocol Secure)</h1> HTTPs is the secure version of HTTP, the protocol used for communication between a web browser or application and a web server or device. HTTPS adds a layer of encryption using TLS (Transport Layer Security), which protects the data transmitted over the network.<br />
<b>Why Use HTTPs with NETIO Power Devices?</b><br />
<br /><br />
NETIO devices often operate in environments where they are remotely controlled or monitored, sometimes even over public or shared networks. Using HTTPS ensures that communication between your application and the NETIO device remains private and secure, even if someone intercepts the network traffic.<br />
<br /><br />
<br /><br />
<h2>How to enable HTTPs on NETIO Device</h2><br />
All NETIO devices running on <b><u>FW 5.0.X</b></u> can be configure the way to support HTTPs communication. HTTPs option is available via Setting/ Security. Port 443 is pre-defined, but can be changed. HTTPs configuration port is shared to the port at M2M API Machine protocols setup NETIO devices support HTTPs using a self-signed certificate by default. This allows you to use secure connections immediately, even in isolated or internal networks. For production environments or public access, it is recommended to upload a certificate from a trusted Certificate Authority (CA). This ensures proper validation and avoids browser or client warnings.<br />
<br />
<br /><br />
****ADD PICTURE<br />
<br /><br />
<br />
<h2>TLS Versions and Cipher Suites Supported by NETIO</h2><br />
<br />
NETIO power devices support encrypted HTTPS communication using the TLS (Transport Layer Security) protocol. TLS ensures confidentiality, integrity, and authentication when accessing the device’s web interface or APIs (e.g., JSON/XML REST API).<br />
<br />
<br />
<br />
<u><b>Supported TLS Versions.:</b></u><br />
<br />
**TLS 1.0 and TLS 1.1 – (Deprecated for security reasons)<br />
**TLS 1.2 (Supported) (minimum secure standard and should always be used).Legacy TLS versions are disabled by default for security.<br />
**TLS 1.3 – Not supported at the moment* (future development under investigation)<br />
<br />
<br />
NETIO firmware supports multiple cipher suites using <b>RSA</b> or <b>ECDHE</b> (Elliptic Curve Diffie-Hellman Ephemeral) key exchange, combined with AES encryption (GCM/CCM) modes. There is a list of supported TLS cipher suites and key types that NETIO devices accept when establishing a secure HTTPS connection.<br />
<br /><br />
<br />
<br />
<u><b>Key Types used during the TLS handshake:</b></u><br />
**ecc_prime256v1 – elliptic curve (ECDSA) key, 256-bit (NIST P-256)<br />
**ecc_secp384r1 – stronger ECC key, 384-bit<br />
**ecc_secp521r1 – even stronger ECC key, 521-bit<br />
**rsa_1024 / rsa_2048 / rsa_3072 / rsa_4096 – RSA keys of corresponding lengths<br />
<br />
<br />
<u><b>Cipher Suite – a specific combination of algorithms used to encrypt the TLS connection:</b></u><br />
**ECDHE – key exchange algorithm (supports forward secrecy)<br />
**ECDSA – digital certificate based on ECC key (e.g., prime256v1)<br />
**AES_256_GCM – symmetric encryption (AES 256-bit, Galois/Counter Mode)<br />
**SHA384 – hashing algorithm used for integrity checks<br />
<br />
<br />
List on combinations tested with NETIO device<br />
<table style="border-collapse: collapse; width: 97.80949%;" border="1"><br />
<tr><br />
<td style="width: 8.687943%;"><br />
<p style="font-weight: 400;">&nbsp;<strong>-&gt; ecc_prime256v1</strong>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</p><br />
<ul><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</li><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_CCM</li><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_CCM</li><br />
</ul><br />
</td><br />
<td style="width: 20.451527%;" width="269"><br />
<p style="font-weight: 400;"><strong>-&gt; ecc_secp384r1</strong>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</p><br />
<ul><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_CCM</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_CCM</span></li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p style="font-weight: 400;"><strong>-&gt; ecc_secp521r1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</strong></p><br />
<ul><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_CCM:</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_CCM</span></li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p></p><br />
</td><br />
</tr><br />
<tr><br />
<td style="width: 8.687943%;"><br />
<p style="font-weight: 400;"><strong>-&gt; rsa_1024</strong></p><br />
<ul><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_CCM</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_CCM</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_SHA</li><br />
<li style="font-weight: 400;"><span style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_SHA</span></li><br />
</ul><br />
</td><br />
<td style="width: 20.451527%;"><br />
<p style="font-weight: 400;">-<strong>&gt; rsa_2048</strong></p><br />
<ul><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_SHA</span></li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p>-<strong>&gt; rsa_3072</strong></p><br />
<ul><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_SHA</li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p style="font-weight: 400;"><strong>-&gt; rsa_4096</strong></p><br />
<ul><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_CCM</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_CCM</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_SHA</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_SHA</span></li><br />
</ul><br />
</td><br />
</tr><br />
</table><br />
<br />
<br />
<h1>Secure M2M API Access via HTTPs</h1><br />
<br />
NETIO devices support secure communication over HTTPS to protect API access to power sockets and configuration interfaces. This is essential when integrating NETIO devices with 3th party systems. M2M API Machine protocols setup uses the same port as being setup at configuration setting. <br />
Device provide access to various machine-readable APIs, such as:<br />
**JSON API<br />
**XML API<br />
**MQTTs (optional for some models)<br />
**URL<br />
<br />
As HTTPS is enabled, all communication with these APIs is encrypted using TLS (Transport Layer Security). This ensures that authentication tokens, control commands (e.g., socket ON/OFF), and monitoring data cannot be intercepted or altered.<br />
<br />
<b>Here is an examples of turning socket 1 ON using the JSON API over HTTPS:</b><br />
<br /><br />
<em>curl -k netio_user:netio_password -d '{"Outputs":[{"ID":1,"Action":1}]}' -H "Content-Type: application/json" -X POST https://192.168.105.160:81/netio.json</em><br />
<br /><br />
**(**Replace netio_user & netio_password with proper JSON API password)<br />
<br />
<br />
<b>Here is an example of turning socket 1 ON using URL over HTTPS:</b><br />
<br /><br />
<em>https://192.168.1.100/netio.json?pass=netio123&output1=1"</em><br />
<br /><br />
**(**Replace netio123 with your actual API password)<br />
<br />
<br />
<b> API Performance testing </b><br />
In internal NETIO testing on PowerPDU 4KS device (see below), various cipher suites and elliptic curves were evaluated for performance during secure HTTPS communication with the JSON and WebSocket APIs. Prime256v1 (NIST P-256) is recommended for best performance and compatibility. <br />
<br />
<br />
<table border="1" cellspacing="0" cellpadding="5"><br />
<tr><br />
<th>&nbsp;</th><br />
<th>Response time Web Socket [s]</th><br />
<th>Response time JSON [s]</th><br />
</tr><br />
<tr><br />
<td colspan="3"><strong>ecc_prime256v1</strong></td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</td><br />
<td style="text-align: center;">5.7</td><br />
<td style="text-align: center;">6.0</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_CCM</td><br />
<td style="text-align: center;">5.9</td><br />
<td style="text-align: center;">5.6</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</td><br />
<td style="text-align: center;">5.8</td><br />
<td style="text-align: center;">5.7</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_CCM</td><br />
<td style="text-align: center;">6.1</td><br />
<td style="text-align: center;">6.2</td><br />
</tr><br />
<tr><br />
<td colspan="3"><strong>ecc_secp384r1</strong></td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</td><br />
<td style="text-align: center;">6.4</td><br />
<td style="text-align: center;">6.3</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_CCM</td><br />
<td style="text-align: center;">6.3</td><br />
<td style="text-align: center;">6.2</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</td><br />
<td style="text-align: center;">6.2</td><br />
<td style="text-align: center;">6.2</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_CCM</td><br />
<td style="text-align: center;">6.5</td><br />
<td style="text-align: center;">6.3</td><br />
</tr><br />
<tr><br />
<td colspan="3"><strong>ecc_secp521r1</strong></td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</td><br />
<td style="text-align: center;">6.5</td><br />
<td style="text-align: center;">6.4</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_CCM</td><br />
<td style="text-align: center;">6.6</td><br />
<td style="text-align: center;">6.5</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</td><br />
<td style="text-align: center;">6.7</td><br />
<td style="text-align: center;">6.3</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_CCM</td><br />
<td style="text-align: center;">6.6</td><br />
<td style="text-align: center;">6.5</td><br />
</tr><br />
</table><br />
<br />
<p>* values are valid for ethernet connection only<br /><br />
<p>** values can differentiate on WiFi connection</p></div>
Tbezstarosta
https://wiki.netio-products.com/index.php?title=HTTPs_details&diff=1070
HTTPs details
2025-08-11T12:16:15Z
<p>Tbezstarosta: </p>
<hr />
<div><br /><br />
<h1>HTTPS (Hypertext Transfer Protocol Secure)</h1> HTTPs is the secure version of HTTP, the protocol used for communication between a web browser or application and a web server or device. HTTPS adds a layer of encryption using TLS (Transport Layer Security), which protects the data transmitted over the network.<br />
<b>Why Use HTTPs with NETIO Power Devices?</b><br />
<br /><br />
NETIO devices often operate in environments where they are remotely controlled or monitored, sometimes even over public or shared networks. Using HTTPS ensures that communication between your application and the NETIO device remains private and secure, even if someone intercepts the network traffic.<br />
<br /><br />
<br /><br />
<h2>How to enable HTTPs on NETIO Device</h2><br />
All NETIO devices running on <b><u>FW 5.0.X</b></u> can be configure the way to support HTTPs communication. HTTPs option is available via Setting/ Security. Port 443 is pre-defined, but can be changed. HTTPs configuration port is shared to the port at M2M API Machine protocols setup NETIO devices support HTTPs using a self-signed certificate by default. This allows you to use secure connections immediately, even in isolated or internal networks. For production environments or public access, it is recommended to upload a certificate from a trusted Certificate Authority (CA). This ensures proper validation and avoids browser or client warnings.<br />
<br />
<br /><br />
****ADD PICTURE<br />
<br /><br />
<br />
<h2>TLS Versions and Cipher Suites Supported by NETIO</h2><br />
<br />
NETIO power devices support encrypted HTTPS communication using the TLS (Transport Layer Security) protocol. TLS ensures confidentiality, integrity, and authentication when accessing the device’s web interface or APIs (e.g., JSON/XML REST API).<br />
<br />
<br />
<br />
<u><b>Supported TLS Versions.:</b></u><br />
<br />
**TLS 1.0 and TLS 1.1 – (Deprecated for security reasons)<br />
**TLS 1.2 (Supported) (minimum secure standard and should always be used).Legacy TLS versions are disabled by default for security.<br />
**TLS 1.3 – Not supported at the moment* (future development under investigation)<br />
<br />
<br />
NETIO firmware supports multiple cipher suites using <b>RSA</b> or <b>ECDHE</b> (Elliptic Curve Diffie-Hellman Ephemeral) key exchange, combined with AES encryption (GCM/CCM) modes. There is a list of supported TLS cipher suites and key types that NETIO devices accept when establishing a secure HTTPS connection.<br />
<br /><br />
<br />
<br />
<u><b>Key Types used during the TLS handshake:</b></u><br />
**ecc_prime256v1 – elliptic curve (ECDSA) key, 256-bit (NIST P-256)<br />
**ecc_secp384r1 – stronger ECC key, 384-bit<br />
**ecc_secp521r1 – even stronger ECC key, 521-bit<br />
**rsa_1024 / rsa_2048 / rsa_3072 / rsa_4096 – RSA keys of corresponding lengths<br />
<br />
<br />
<u><b>Cipher Suite – a specific combination of algorithms used to encrypt the TLS connection:</b></u><br />
**ECDHE – key exchange algorithm (supports forward secrecy)<br />
**ECDSA – digital certificate based on ECC key (e.g., prime256v1)<br />
**AES_256_GCM – symmetric encryption (AES 256-bit, Galois/Counter Mode)<br />
**SHA384 – hashing algorithm used for integrity checks<br />
<br />
<br />
List on combinations tested with NETIO device<br />
<table style="border-collapse: collapse; width: 97.80949%;" border="1"><br />
<tr><br />
<td style="width: 8.687943%;"><br />
<p style="font-weight: 400;">&nbsp;<strong>-&gt; ecc_prime256v1</strong>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</p><br />
<ul><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</li><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_CCM</li><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_CCM</li><br />
</ul><br />
</td><br />
<td style="width: 20.451527%;" width="269"><br />
<p style="font-weight: 400;"><strong>-&gt; ecc_secp384r1</strong>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</p><br />
<ul><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_CCM</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_CCM</span></li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p style="font-weight: 400;"><strong>-&gt; ecc_secp521r1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</strong></p><br />
<ul><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_CCM:</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_CCM</span></li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p></p><br />
</td><br />
</tr><br />
<tr><br />
<td style="width: 8.687943%;"><br />
<p style="font-weight: 400;"><strong>-&gt; rsa_1024</strong></p><br />
<ul><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_CCM</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_CCM</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_SHA</li><br />
<li style="font-weight: 400;"><span style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_SHA</span></li><br />
</ul><br />
</td><br />
<td style="width: 20.451527%;"><br />
<p style="font-weight: 400;">-<strong>&gt; rsa_2048</strong></p><br />
<ul><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_SHA</span></li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p>-<strong>&gt; rsa_3072</strong></p><br />
<ul><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_SHA</li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p style="font-weight: 400;"><strong>-&gt; rsa_4096</strong></p><br />
<ul><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_CCM</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_CCM</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_SHA</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_SHA</span></li><br />
</ul><br />
</td><br />
</tr><br />
</table><br />
<br />
<br />
<h1>Secure M2M API Access via HTTPs</h1><br />
<br />
NETIO devices support secure communication over HTTPS to protect API access to power sockets and configuration interfaces. This is essential when integrating NETIO devices with 3th party systems. M2M API Machine protocols setup uses the same port as being setup at configuration setting. <br />
Device provide access to various machine-readable APIs, such as:<br />
**JSON API<br />
**XML API<br />
**MQTTs (optional for some models)<br />
**URL<br />
<br />
As HTTPS is enabled, all communication with these APIs is encrypted using TLS (Transport Layer Security). This ensures that authentication tokens, control commands (e.g., socket ON/OFF), and monitoring data cannot be intercepted or altered.<br />
<br />
<b>Here is an examples of turning socket 1 ON using the JSON API over HTTPS:</b><br />
<br /><br />
<em>curl -k netio_user:netio_password -d '{"Outputs":[{"ID":1,"Action":1}]}' -H "Content-Type: application/json" -X POST https://192.168.105.160:81/netio.json</em><br />
<br /><br />
**(**Replace netio_user & netio_password with proper JSON API password)<br />
<br />
<br />
<b>Here is an example of turning socket 1 ON using URL over HTTPS:</b><br />
<br /><br />
<em>https://192.168.1.100/netio.json?pass=netio123&output1=1"</em><br />
<br /><br />
**(**Replace netio123 with your actual API password)<br />
<br />
<br />
<b> API Performance testing </b><br />
In internal NETIO testing on PowerPDU 4KS device (see below), various cipher suites and elliptic curves were evaluated for performance during secure HTTPS communication with the JSON and WebSocket APIs. Prime256v1 (NIST P-256) is recommended for best performance and compatibility. <br />
<br />
<table border="1" cellspacing="0" cellpadding="5"><br />
<tr><br />
<th>&nbsp;</th><br />
<th>Response time Web Socket [s]</th><br />
<th>Response time JSON [s]</th><br />
</tr><br />
<tr><br />
<td colspan="3"><strong>ecc_prime256v1</strong></td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</td><br />
<td style="text-align: center;">5.7</td><br />
<td style="text-align: center;">6.0</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_CCM</td><br />
<td style="text-align: center;">5.9</td><br />
<td style="text-align: center;">5.6</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</td><br />
<td style="text-align: center;">5.8</td><br />
<td style="text-align: center;">5.7</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_CCM</td><br />
<td style="text-align: center;">6.1</td><br />
<td style="text-align: center;">6.2</td><br />
</tr><br />
<tr><br />
<td colspan="3"><strong>ecc_secp384r1</strong></td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</td><br />
<td style="text-align: center;">6.4</td><br />
<td style="text-align: center;">6.3</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_CCM</td><br />
<td style="text-align: center;">6.3</td><br />
<td style="text-align: center;">6.2</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</td><br />
<td style="text-align: center;">6.2</td><br />
<td style="text-align: center;">6.2</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_CCM</td><br />
<td style="text-align: center;">6.5</td><br />
<td style="text-align: center;">6.3</td><br />
</tr><br />
<tr><br />
<td colspan="3"><strong>ecc_secp521r1</strong></td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</td><br />
<td style="text-align: center;">6.5</td><br />
<td style="text-align: center;">6.4</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_CCM</td><br />
<td style="text-align: center;">6.6</td><br />
<td style="text-align: center;">6.5</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</td><br />
<td style="text-align: center;">6.7</td><br />
<td style="text-align: center;">6.3</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_CCM</td><br />
<td style="text-align: center;">6.6</td><br />
<td style="text-align: center;">6.5</td><br />
</tr><br />
</table><br />
<br />
<p>* values are valid for ethernet connection only<br /><br />
<p>** values can differentiate on WiFi connection</p></div>
Tbezstarosta
https://wiki.netio-products.com/index.php?title=HTTPs_details&diff=1069
HTTPs details
2025-08-11T12:08:42Z
<p>Tbezstarosta: </p>
<hr />
<div><br /><br />
<h1>HTTPS (Hypertext Transfer Protocol Secure)</h1> HTTPs is the secure version of HTTP, the protocol used for communication between a web browser or application and a web server or device. HTTPS adds a layer of encryption using TLS (Transport Layer Security), which protects the data transmitted over the network.<br />
<b>Why Use HTTPs with NETIO Power Devices?</b><br />
<br /><br />
NETIO devices often operate in environments where they are remotely controlled or monitored, sometimes even over public or shared networks. Using HTTPS ensures that communication between your application and the NETIO device remains private and secure, even if someone intercepts the network traffic.<br />
<br /><br />
<br /><br />
<h2>How to enable HTTPs on NETIO Device</h2><br />
All NETIO devices running on <b><u>FW 5.0.X</b></u> can be configure the way to support HTTPs communication. HTTPs option is available via Setting/ Security. Port 443 is pre-defined, but can be changed. HTTPs configuration port is shared to the port at M2M API Machine protocols setup NETIO devices support HTTPs using a self-signed certificate by default. This allows you to use secure connections immediately, even in isolated or internal networks. For production environments or public access, it is recommended to upload a certificate from a trusted Certificate Authority (CA). This ensures proper validation and avoids browser or client warnings.<br />
<br />
<br /><br />
****ADD PICTURE<br />
<br /><br />
<br />
<h2>TLS Versions and Cipher Suites Supported by NETIO</h2><br />
<br />
NETIO power devices support encrypted HTTPS communication using the TLS (Transport Layer Security) protocol. TLS ensures confidentiality, integrity, and authentication when accessing the device’s web interface or APIs (e.g., JSON/XML REST API).<br />
<br />
<br />
<br />
<u><b>Supported TLS Versions.:</b></u><br />
<br />
**TLS 1.0 and TLS 1.1 – (Deprecated for security reasons)<br />
**TLS 1.2 (Supported) (minimum secure standard and should always be used).Legacy TLS versions are disabled by default for security.<br />
**TLS 1.3 – Not supported at the moment* (future development under investigation)<br />
<br />
<br />
NETIO firmware supports multiple cipher suites using <b>RSA</b> or <b>ECDHE</b> (Elliptic Curve Diffie-Hellman Ephemeral) key exchange, combined with AES encryption (GCM/CCM) modes. There is a list of supported TLS cipher suites and key types that NETIO devices accept when establishing a secure HTTPS connection.<br />
<br /><br />
<br />
<br />
<u><b>Key Types used during the TLS handshake:</b></u><br />
**ecc_prime256v1 – elliptic curve (ECDSA) key, 256-bit (NIST P-256)<br />
**ecc_secp384r1 – stronger ECC key, 384-bit<br />
**ecc_secp521r1 – even stronger ECC key, 521-bit<br />
**rsa_1024 / rsa_2048 / rsa_3072 / rsa_4096 – RSA keys of corresponding lengths<br />
<br />
<br />
<u><b>Cipher Suite – a specific combination of algorithms used to encrypt the TLS connection:</b></u><br />
**ECDHE – key exchange algorithm (supports forward secrecy)<br />
**ECDSA – digital certificate based on ECC key (e.g., prime256v1)<br />
**AES_256_GCM – symmetric encryption (AES 256-bit, Galois/Counter Mode)<br />
**SHA384 – hashing algorithm used for integrity checks<br />
<br />
<br />
List on combinations tested with NETIO device<br />
<table style="border-collapse: collapse; width: 97.80949%;" border="1"><br />
<tr><br />
<td style="width: 8.687943%;"><br />
<p style="font-weight: 400;">&nbsp;<strong>-&gt; ecc_prime256v1</strong>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</p><br />
<ul><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</li><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_CCM</li><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_CCM</li><br />
</ul><br />
</td><br />
<td style="width: 20.451527%;" width="269"><br />
<p style="font-weight: 400;"><strong>-&gt; ecc_secp384r1</strong>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</p><br />
<ul><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_CCM</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_CCM</span></li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p style="font-weight: 400;"><strong>-&gt; ecc_secp521r1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</strong></p><br />
<ul><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_CCM:</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_CCM</span></li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p></p><br />
</td><br />
</tr><br />
<tr><br />
<td style="width: 8.687943%;"><br />
<p style="font-weight: 400;"><strong>-&gt; rsa_1024</strong></p><br />
<ul><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_CCM</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_CCM</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_SHA</li><br />
<li style="font-weight: 400;"><span style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_SHA</span></li><br />
</ul><br />
</td><br />
<td style="width: 20.451527%;"><br />
<p style="font-weight: 400;">-<strong>&gt; rsa_2048</strong></p><br />
<ul><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_SHA</span></li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p>-<strong>&gt; rsa_3072</strong></p><br />
<ul><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_SHA</li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p style="font-weight: 400;"><strong>-&gt; rsa_4096</strong></p><br />
<ul><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_CCM</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_CCM</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_SHA</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_SHA</span></li><br />
</ul><br />
</td><br />
</tr><br />
</table><br />
<br />
<br />
<h1>Secure M2M API Access via HTTPs</h1><br />
<br />
NETIO devices support secure communication over HTTPS to protect API access to power sockets and configuration interfaces. This is essential when integrating NETIO devices with 3th party systems. M2M API Machine protocols setup uses the same port as being setup at configuration setting. <br />
Device provide access to various machine-readable APIs, such as:<br />
**JSON API<br />
**XML API<br />
**MQTTs (optional for some models)<br />
**URL<br />
<br />
As HTTPS is enabled, all communication with these APIs is encrypted using TLS (Transport Layer Security). This ensures that authentication tokens, control commands (e.g., socket ON/OFF), and monitoring data cannot be intercepted or altered.<br />
<br />
<b>Here is an examples of turning socket 1 ON using the JSON API over HTTPS:</b><br />
<br /><br />
<em>curl -k netio_user:netio_password -d '{"Outputs":[{"ID":1,"Action":1}]}' -H "Content-Type: application/json" -X POST https://192.168.105.160:81/netio.json</em><br />
<br /><br />
**(**Replace netio_user & netio_password with proper JSON API password)<br />
<br />
<br />
<b>Here is an example of turning socket 1 ON using URL over HTTPS:</b><br />
<br /><br />
<em>https://192.168.1.100/netio.json?pass=netio123&output1=1"</em><br />
<br /><br />
**(**Replace netio123 with your actual API password)<br />
<br />
<br />
<b> API Performance testing </b><br />
In internal NETIO testing on PowerPDU 4KS device (see below), various cipher suites and elliptic curves were evaluated for performance during secure HTTPS communication with the JSON and WebSocket APIs. Prime256v1 (NIST P-256) is recommended for best performance and compatibility. <br />
<br />
<table border="1" cellspacing="0" cellpadding="5"><br />
<tbody><br />
<tr><br />
<th>&nbsp;</th><br />
<th>Response time Web Socket [s]</th><br />
<th>Response time JSON [s]</th><br />
</tr><br />
<tr><br />
<td colspan="3"><strong>ecc_prime256v1</strong></td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</td><br />
<td style="text-align: center;">5.7</td><br />
<td style="text-align: center;">6.0</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_CCM</td><br />
<td style="text-align: center;">5.9</td><br />
<td style="text-align: center;">5.6</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</td><br />
<td style="text-align: center;">5.8</td><br />
<td style="text-align: center;">5.7</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_CCM</td><br />
<td style="text-align: center;">6.1</td><br />
<td style="text-align: center;">6.2</td><br />
</tr><br />
<tr><br />
<td colspan="3"><strong>ecc_secp384r1</strong></td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</td><br />
<td style="text-align: center;">6.4</td><br />
<td style="text-align: center;">6.3</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_CCM</td><br />
<td style="text-align: center;">6.3</td><br />
<td style="text-align: center;">6.2</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</td><br />
<td style="text-align: center;">6.2</td><br />
<td style="text-align: center;">6.2</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_CCM</td><br />
<td style="text-align: center;">6.5</td><br />
<td style="text-align: center;">6.3</td><br />
</tr><br />
<tr><br />
<td colspan="3"><strong>ecc_secp521r1</strong></td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</td><br />
<td style="text-align: center;">6.5</td><br />
<td style="text-align: center;">6.4</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_CCM</td><br />
<td style="text-align: center;">6.6</td><br />
<td style="text-align: center;">6.5</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</td><br />
<td style="text-align: center;">6.7</td><br />
<td style="text-align: center;">6.3</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_CCM</td><br />
<td style="text-align: center;">6.6</td><br />
<td style="text-align: center;">6.5</td><br />
</tr><br />
</tbody><br />
</table><br />
<br />
<p>* values are valid for ethernet connection only<br /><br />
<p>** values can differentiate on WiFi connection</p></div>
Tbezstarosta
https://wiki.netio-products.com/index.php?title=HTTPs_details&diff=1068
HTTPs details
2025-08-11T11:57:53Z
<p>Tbezstarosta: </p>
<hr />
<div><br /><br />
<h1>HTTPS (Hypertext Transfer Protocol Secure)</h1> HTTPs is the secure version of HTTP, the protocol used for communication between a web browser or application and a web server or device. HTTPS adds a layer of encryption using TLS (Transport Layer Security), which protects the data transmitted over the network.<br />
<b>Why Use HTTPs with NETIO Power Devices?</b><br />
<br /><br />
NETIO devices often operate in environments where they are remotely controlled or monitored, sometimes even over public or shared networks. Using HTTPS ensures that communication between your application and the NETIO device remains private and secure, even if someone intercepts the network traffic.<br />
<br /><br />
<br /><br />
<h2>How to enable HTTPs on NETIO Device</h2><br />
All NETIO devices running on <b><u>FW 5.0.X</b></u> can be configure the way to support HTTPs communication. HTTPs option is available via Setting/ Security. Port 443 is pre-defined, but can be changed. HTTPs configuration port is shared to the port at M2M API Machine protocols setup NETIO devices support HTTPs using a self-signed certificate by default. This allows you to use secure connections immediately, even in isolated or internal networks. For production environments or public access, it is recommended to upload a certificate from a trusted Certificate Authority (CA). This ensures proper validation and avoids browser or client warnings.<br />
<br />
<br /><br />
****ADD PICTURE<br />
<br /><br />
<br />
<h2>TLS Versions and Cipher Suites Supported by NETIO</h2><br />
<br />
NETIO power devices support encrypted HTTPS communication using the TLS (Transport Layer Security) protocol. TLS ensures confidentiality, integrity, and authentication when accessing the device’s web interface or APIs (e.g., JSON/XML REST API).<br />
<br />
<br />
<br />
<u><b>Supported TLS Versions.:</b></u><br />
<br />
**TLS 1.0 and TLS 1.1 – (Deprecated for security reasons)<br />
**TLS 1.2 (Supported) (minimum secure standard and should always be used).Legacy TLS versions are disabled by default for security.<br />
**TLS 1.3 – Not supported at the moment* (future development under investigation)<br />
<br />
<br />
NETIO firmware supports multiple cipher suites using <b>RSA</b> or <b>ECDHE</b> (Elliptic Curve Diffie-Hellman Ephemeral) key exchange, combined with AES encryption (GCM/CCM) modes. There is a list of supported TLS cipher suites and key types that NETIO devices accept when establishing a secure HTTPS connection.<br />
<br /><br />
<br />
<br />
<u><b>Key Types used during the TLS handshake:</b></u><br />
**ecc_prime256v1 – elliptic curve (ECDSA) key, 256-bit (NIST P-256)<br />
**ecc_secp384r1 – stronger ECC key, 384-bit<br />
**ecc_secp521r1 – even stronger ECC key, 521-bit<br />
**rsa_1024 / rsa_2048 / rsa_3072 / rsa_4096 – RSA keys of corresponding lengths<br />
<br />
<br />
<u><b>Cipher Suite – a specific combination of algorithms used to encrypt the TLS connection:</b></u><br />
**ECDHE – key exchange algorithm (supports forward secrecy)<br />
**ECDSA – digital certificate based on ECC key (e.g., prime256v1)<br />
**AES_256_GCM – symmetric encryption (AES 256-bit, Galois/Counter Mode)<br />
**SHA384 – hashing algorithm used for integrity checks<br />
<br />
<br />
List on combinations tested with NETIO device<br />
<table style="border-collapse: collapse; width: 97.80949%;" border="1"><br />
<tr><br />
<td style="width: 8.687943%;"><br />
<p style="font-weight: 400;">&nbsp;<strong>-&gt; ecc_prime256v1</strong>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</p><br />
<ul><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</li><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_CCM</li><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_CCM</li><br />
</ul><br />
</td><br />
<td style="width: 20.451527%;" width="269"><br />
<p style="font-weight: 400;"><strong>-&gt; ecc_secp384r1</strong>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</p><br />
<ul><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_CCM</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_CCM</span></li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p style="font-weight: 400;"><strong>-&gt; ecc_secp521r1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</strong></p><br />
<ul><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_CCM:</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_CCM</span></li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p></p><br />
</td><br />
</tr><br />
<tr><br />
<td style="width: 8.687943%;"><br />
<p style="font-weight: 400;"><strong>-&gt; rsa_1024</strong></p><br />
<ul><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_CCM</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_CCM</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_SHA</li><br />
<li style="font-weight: 400;"><span style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_SHA</span></li><br />
</ul><br />
</td><br />
<td style="width: 20.451527%;"><br />
<p style="font-weight: 400;">-<strong>&gt; rsa_2048</strong></p><br />
<ul><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_SHA</span></li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p>-<strong>&gt; rsa_3072</strong></p><br />
<ul><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_SHA</li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p style="font-weight: 400;"><strong>-&gt; rsa_4096</strong></p><br />
<ul><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_CCM</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_CCM</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_SHA</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_SHA</span></li><br />
</ul><br />
</td><br />
</tr><br />
</table><br />
<br />
<br />
<h1>Secure M2M API Access via HTTPs</h1><br />
<br />
NETIO devices support secure communication over HTTPS to protect API access to power sockets and configuration interfaces. This is essential when integrating NETIO devices with 3th party systems. M2M API Machine protocols setup uses the same port as being setup at configuration setting. <br />
Device provide access to various machine-readable APIs, such as:<br />
**JSON API<br />
**XML API<br />
**MQTTs (optional for some models)<br />
**URL<br />
<br />
As HTTPS is enabled, all communication with these APIs is encrypted using TLS (Transport Layer Security). This ensures that authentication tokens, control commands (e.g., socket ON/OFF), and monitoring data cannot be intercepted or altered.<br />
<br />
<b>Here is an examples of turning socket 1 ON using the JSON API over HTTPS:</b><br />
<br /><br />
curl -k netio_user:netio_password -d '{"Outputs":[{"ID":1,"Action":1}]}' -H "Content-Type: application/json" -X POST https://192.168.105.160:81/netio.json<br />
<br /><br />
**(**Replace netio_user & netio_password with proper JSON API password)<br />
<br />
<br />
<b>Here is an example of turning socket 1 ON using URL over HTTPS:</b><br />
<br /><br />
https://192.168.1.100/netio.json?pass=netio123&output1=1"<br />
<br /><br />
**(**Replace netio123 with your actual API password)<br />
<br />
<br />
<b> API Performance testing </b><br />
In internal NETIO testing on PowerPDU 4KS device (see below), various cipher suites and elliptic curves were evaluated for performance during secure HTTPS communication with the JSON and WebSocket APIs. Prime256v1 (NIST P-256) is recommended for best performance and compatibility. <br />
<br />
<table border="1" cellspacing="0" cellpadding="5"><br />
<tbody><br />
<tr><br />
<th>&nbsp;</th><br />
<th>Response time Web Socket [s]</th><br />
<th>Response time JSON [s]</th><br />
</tr><br />
<tr><br />
<td colspan="3"><strong>ecc_prime256v1</strong></td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</td><br />
<td style="text-align: center;">5.7</td><br />
<td style="text-align: center;">6.0</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_CCM</td><br />
<td style="text-align: center;">5.9</td><br />
<td style="text-align: center;">5.6</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</td><br />
<td style="text-align: center;">5.8</td><br />
<td style="text-align: center;">5.7</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_CCM</td><br />
<td style="text-align: center;">6.1</td><br />
<td style="text-align: center;">6.2</td><br />
</tr><br />
<tr><br />
<td colspan="3"><strong>ecc_secp384r1</strong></td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</td><br />
<td style="text-align: center;">6.4</td><br />
<td style="text-align: center;">6.3</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_CCM</td><br />
<td style="text-align: center;">6.3</td><br />
<td style="text-align: center;">6.2</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</td><br />
<td style="text-align: center;">6.2</td><br />
<td style="text-align: center;">6.2</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_CCM</td><br />
<td style="text-align: center;">6.5</td><br />
<td style="text-align: center;">6.3</td><br />
</tr><br />
<tr><br />
<td colspan="3"><strong>ecc_secp521r1</strong></td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</td><br />
<td style="text-align: center;">6.5</td><br />
<td style="text-align: center;">6.4</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_CCM</td><br />
<td style="text-align: center;">6.6</td><br />
<td style="text-align: center;">6.5</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</td><br />
<td style="text-align: center;">6.7</td><br />
<td style="text-align: center;">6.3</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_CCM</td><br />
<td style="text-align: center;">6.6</td><br />
<td style="text-align: center;">6.5</td><br />
</tr><br />
</tbody><br />
</table><br />
<br />
<p>* values are valid for ethernet connection only<br /><br />
<p>** values can differentiate on WiFi connection</p></div>
Tbezstarosta
https://wiki.netio-products.com/index.php?title=HTTPs_details&diff=1067
HTTPs details
2025-08-11T11:54:37Z
<p>Tbezstarosta: </p>
<hr />
<div><br /><br />
<h1>HTTPS (Hypertext Transfer Protocol Secure)</h1> HTTPs is the secure version of HTTP, the protocol used for communication between a web browser or application and a web server or device. HTTPS adds a layer of encryption using TLS (Transport Layer Security), which protects the data transmitted over the network.<br />
<b>Why Use HTTPs with NETIO Power Devices?</b><br />
<br /><br />
NETIO devices often operate in environments where they are remotely controlled or monitored, sometimes even over public or shared networks. Using HTTPS ensures that communication between your application and the NETIO device remains private and secure, even if someone intercepts the network traffic.<br />
<br /><br />
<br /><br />
<h2>How to enable HTTPs on NETIO Device</h2><br />
All NETIO devices running on <b><u>FW 5.0.X</b></u> can be configure the way to support HTTPs communication. HTTPs option is available via Setting/ Security. Port 443 is pre-defined, but can be changed. HTTPs configuration port is shared to the port at M2M API Machine protocols setup NETIO devices support HTTPs using a self-signed certificate by default. This allows you to use secure connections immediately, even in isolated or internal networks. For production environments or public access, it is recommended to upload a certificate from a trusted Certificate Authority (CA). This ensures proper validation and avoids browser or client warnings.<br />
<br />
<br /><br />
****ADD PICTURE<br />
<br /><br />
<br />
<h2>TLS Versions and Cipher Suites Supported by NETIO</h2><br />
<br />
NETIO power devices support encrypted HTTPS communication using the TLS (Transport Layer Security) protocol. TLS ensures confidentiality, integrity, and authentication when accessing the device’s web interface or APIs (e.g., JSON/XML REST API).<br />
<br />
<br />
<br />
<u><b>Supported TLS Versions.:</b></u><br />
<br />
**TLS 1.0 and TLS 1.1 – (Deprecated for security reasons)<br />
**TLS 1.2 (Supported) (minimum secure standard and should always be used).Legacy TLS versions are disabled by default for security.<br />
**TLS 1.3 – Not supported at the moment* (future development under investigation)<br />
<br />
<br />
NETIO firmware supports multiple cipher suites using <b>RSA</b> or <b>ECDHE</b> (Elliptic Curve Diffie-Hellman Ephemeral) key exchange, combined with AES encryption (GCM/CCM) modes. There is a list of supported TLS cipher suites and key types that NETIO devices accept when establishing a secure HTTPS connection.<br />
<br /><br />
<br />
<br />
<u><b>Key Types used during the TLS handshake:</b></u><br />
**ecc_prime256v1 – elliptic curve (ECDSA) key, 256-bit (NIST P-256)<br />
**ecc_secp384r1 – stronger ECC key, 384-bit<br />
**ecc_secp521r1 – even stronger ECC key, 521-bit<br />
**rsa_1024 / rsa_2048 / rsa_3072 / rsa_4096 – RSA keys of corresponding lengths<br />
<br />
<br />
<u><b>Cipher Suite – a specific combination of algorithms used to encrypt the TLS connection:</b></u><br />
**ECDHE – key exchange algorithm (supports forward secrecy)<br />
**ECDSA – digital certificate based on ECC key (e.g., prime256v1)<br />
**AES_256_GCM – symmetric encryption (AES 256-bit, Galois/Counter Mode)<br />
**SHA384 – hashing algorithm used for integrity checks<br />
<br />
<br />
List on combinations tested with NETIO device<br />
<table style="border-collapse: collapse; width: 97.80949%;" border="1"><br />
<tr><br />
<td style="width: 8.687943%;"><br />
<p style="font-weight: 400;">&nbsp;<strong>-&gt; ecc_prime256v1</strong>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</p><br />
<ul><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</li><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_CCM</li><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_CCM</li><br />
</ul><br />
</td><br />
<td style="width: 20.451527%;" width="269"><br />
<p style="font-weight: 400;"><strong>-&gt; ecc_secp384r1</strong>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</p><br />
<ul><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_CCM</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_CCM</span></li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p style="font-weight: 400;"><strong>-&gt; ecc_secp521r1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</strong></p><br />
<ul><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_CCM:</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_CCM</span></li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p></p><br />
</td><br />
</tr><br />
<tr><br />
<td style="width: 8.687943%;"><br />
<p style="font-weight: 400;"><strong>-&gt; rsa_1024</strong></p><br />
<ul><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_CCM</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_CCM</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_SHA</li><br />
<li style="font-weight: 400;"><span style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_SHA</span></li><br />
</ul><br />
</td><br />
<td style="width: 20.451527%;"><br />
<p style="font-weight: 400;">-<strong>&gt; rsa_2048</strong></p><br />
<ul><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_SHA</span></li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p>-<strong>&gt; rsa_3072</strong></p><br />
<ul><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_SHA</li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p style="font-weight: 400;"><strong>-&gt; rsa_4096</strong></p><br />
<ul><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_CCM</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_CCM</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_SHA</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_SHA</span></li><br />
</ul><br />
</td><br />
</tr><br />
</table><br />
<br />
<br />
<h1>Secure M2M API Access via HTTPs</h1><br />
<br />
NETIO devices support secure communication over HTTPS to protect API access to power sockets and configuration interfaces. This is essential when integrating NETIO devices with 3th party systems. M2M API Machine protocols setup uses the same port as being setup at configuration setting. <br />
Device provide access to various machine-readable APIs, such as:<br />
**JSON API<br />
**XML API<br />
**MQTTs (optional for some models)<br />
**URL<br />
<br />
As HTTPS is enabled, all communication with these APIs is encrypted using TLS (Transport Layer Security). This ensures that authentication tokens, control commands (e.g., socket ON/OFF), and monitoring data cannot be intercepted or altered.<br />
<br />
<b>Here is an examples of turning socket 1 ON using the JSON API over HTTPS:</b><br />
<br /><br />
curl -k netio_user:netio_password -d '{"Outputs":[{"ID":1,"Action":1}]}' -H "Content-Type: application/json" -X POST https://192.168.105.160:81/netio.json<br />
<br /><br />
**(**Replace netio_user & netio_password with proper JSON API password)<br />
<br />
<br />
<b>Here is an example of turning socket 1 ON using URL over HTTPS:</b><br />
<br /><br />
https://192.168.1.100/netio.json?pass=netio123&output1=1"<br />
<br /><br />
**(**Replace netio123 with your actual API password)<br />
<br />
<br />
<b> API Performance testing </b><br />
In internal NETIO testing on PowerPDU 4KS device (see below), various cipher suites and elliptic curves were evaluated for performance during secure HTTPS communication with the JSON and WebSocket APIs. Prime256v1 (NIST P-256) is recommended for best performance and compatibility. <br />
<br />
<table border="1" cellpadding="5" cellspacing="0"><br />
<tr><br />
<th></th><br />
<th>Response time Web Socket [s]</th><br />
<th>Response time JSON [s]</th><br />
</tr><br />
<tr><br />
<td colspan="3"><b>ecc_prime256v1</b></td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</td><br />
<td>5.7</td><br />
<td>6.0</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_CCM</td><br />
<td>5.9</td><br />
<td>5.6</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</td><br />
<td>5.8</td><br />
<td>5.7</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_CCM</td><br />
<td>6.1</td><br />
<td>6.2</td><br />
</tr><br />
<tr><br />
<td colspan="3"><b>ecc_secp384r1</b></td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</td><br />
<td>6.4</td><br />
<td>6.3</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_CCM</td><br />
<td>6.3</td><br />
<td>6.2</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</td><br />
<td>6.2</td><br />
<td>6.2</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_CCM</td><br />
<td>6.5</td><br />
<td>6.3</td><br />
</tr><br />
<tr><br />
<td colspan="3"><b>ecc_secp521r1</b></td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</td><br />
<td>6.5</td><br />
<td>6.4</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_CCM</td><br />
<td>6.6</td><br />
<td>6.5</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</td><br />
<td>6.7</td><br />
<td>6.3</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_CCM</td><br />
<td>6.6</td><br />
<td>6.5</td><br />
</tr><br />
</table><br />
<br />
<p>* values are valid for ethernet connection only<br><br />
** values can differentiate on WiFi connection</p></div>
Tbezstarosta
https://wiki.netio-products.com/index.php?title=HTTPs_details&diff=1066
HTTPs details
2025-08-11T11:52:34Z
<p>Tbezstarosta: </p>
<hr />
<div><br /><br />
<h1>HTTPS (Hypertext Transfer Protocol Secure)</h1> HTTPs is the secure version of HTTP, the protocol used for communication between a web browser or application and a web server or device. HTTPS adds a layer of encryption using TLS (Transport Layer Security), which protects the data transmitted over the network.<br />
<b>Why Use HTTPs with NETIO Power Devices?</b><br />
<br /><br />
NETIO devices often operate in environments where they are remotely controlled or monitored, sometimes even over public or shared networks. Using HTTPS ensures that communication between your application and the NETIO device remains private and secure, even if someone intercepts the network traffic.<br />
<br /><br />
<br /><br />
<h2>How to enable HTTPs on NETIO Device</h2><br />
All NETIO devices running on <b><u>FW 5.0.X</b></u> can be configure the way to support HTTPs communication. HTTPs option is available via Setting/ Security. Port 443 is pre-defined, but can be changed. HTTPs configuration port is shared to the port at M2M API Machine protocols setup NETIO devices support HTTPs using a self-signed certificate by default. This allows you to use secure connections immediately, even in isolated or internal networks. For production environments or public access, it is recommended to upload a certificate from a trusted Certificate Authority (CA). This ensures proper validation and avoids browser or client warnings.<br />
<br />
<br /><br />
****ADD PICTURE<br />
<br /><br />
<br />
<h2>TLS Versions and Cipher Suites Supported by NETIO</h2><br />
<br />
NETIO power devices support encrypted HTTPS communication using the TLS (Transport Layer Security) protocol. TLS ensures confidentiality, integrity, and authentication when accessing the device’s web interface or APIs (e.g., JSON/XML REST API).<br />
<br />
<br />
<br />
<u><b>Supported TLS Versions.:</b></u><br />
<br />
**TLS 1.0 and TLS 1.1 – (Deprecated for security reasons)<br />
**TLS 1.2 (Supported) (minimum secure standard and should always be used).Legacy TLS versions are disabled by default for security.<br />
**TLS 1.3 – Not supported at the moment* (future development under investigation)<br />
<br />
<br />
NETIO firmware supports multiple cipher suites using <b>RSA</b> or <b>ECDHE</b> (Elliptic Curve Diffie-Hellman Ephemeral) key exchange, combined with AES encryption (GCM/CCM) modes. There is a list of supported TLS cipher suites and key types that NETIO devices accept when establishing a secure HTTPS connection.<br />
<br /><br />
<br />
<br />
<u><b>Key Types used during the TLS handshake:</b></u><br />
**ecc_prime256v1 – elliptic curve (ECDSA) key, 256-bit (NIST P-256)<br />
**ecc_secp384r1 – stronger ECC key, 384-bit<br />
**ecc_secp521r1 – even stronger ECC key, 521-bit<br />
**rsa_1024 / rsa_2048 / rsa_3072 / rsa_4096 – RSA keys of corresponding lengths<br />
<br />
<br />
<u><b>Cipher Suite – a specific combination of algorithms used to encrypt the TLS connection:</b></u><br />
**ECDHE – key exchange algorithm (supports forward secrecy)<br />
**ECDSA – digital certificate based on ECC key (e.g., prime256v1)<br />
**AES_256_GCM – symmetric encryption (AES 256-bit, Galois/Counter Mode)<br />
**SHA384 – hashing algorithm used for integrity checks<br />
<br />
<br />
List on combinations tested with NETIO device<br />
<table style="border-collapse: collapse; width: 97.80949%;" border="1"><br />
<tr><br />
<td style="width: 8.687943%;"><br />
<p style="font-weight: 400;">&nbsp;<strong>-&gt; ecc_prime256v1</strong>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</p><br />
<ul><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</li><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_CCM</li><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_CCM</li><br />
</ul><br />
</td><br />
<td style="width: 20.451527%;" width="269"><br />
<p style="font-weight: 400;"><strong>-&gt; ecc_secp384r1</strong>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</p><br />
<ul><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_CCM</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_CCM</span></li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p style="font-weight: 400;"><strong>-&gt; ecc_secp521r1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</strong></p><br />
<ul><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_CCM:</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_CCM</span></li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p></p><br />
</td><br />
</tr><br />
<tr><br />
<td style="width: 8.687943%;"><br />
<p style="font-weight: 400;"><strong>-&gt; rsa_1024</strong></p><br />
<ul><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_CCM</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_CCM</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_SHA</li><br />
<li style="font-weight: 400;"><span style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_SHA</span></li><br />
</ul><br />
</td><br />
<td style="width: 20.451527%;"><br />
<p style="font-weight: 400;">-<strong>&gt; rsa_2048</strong></p><br />
<ul><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_SHA</span></li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p>-<strong>&gt; rsa_3072</strong></p><br />
<ul><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_SHA</li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p style="font-weight: 400;"><strong>-&gt; rsa_4096</strong></p><br />
<ul><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_CCM</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_CCM</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_SHA</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_SHA</span></li><br />
</ul><br />
</td><br />
</tr><br />
</table><br />
<br />
<br />
<h1>Secure API Access via HTTPs</h1><br />
<br />
NETIO devices support secure communication over HTTPS to protect API access to power sockets and configuration interfaces. This is essential when integrating NETIO devices with 3th party systems. M2M API Machine protocols setup uses the same port as being setup at configuration setting. <br />
Device provide access to various machine-readable APIs, such as:<br />
**JSON API<br />
**XML API<br />
**MQTTs (optional for some models)<br />
**URL<br />
<br />
As HTTPS is enabled, all communication with these APIs is encrypted using TLS (Transport Layer Security). This ensures that authentication tokens, control commands (e.g., socket ON/OFF), and monitoring data cannot be intercepted or altered.<br />
<br />
<b>Here is an examples of turning socket 1 ON using the JSON API over HTTPS:</b><br />
<br /><br />
curl -k netio_user:netio_password -d '{"Outputs":[{"ID":1,"Action":1}]}' -H "Content-Type: application/json" -X POST https://192.168.105.160:81/netio.json<br />
<br /><br />
**(**Replace netio_user & netio_password with proper JSON API password)<br />
<br />
<br />
<b>Here is an example of turning socket 1 ON using URL over HTTPS:</b><br />
<br /><br />
https://192.168.1.100/netio.json?pass=netio123&output1=1"<br />
<br /><br />
**(**Replace netio123 with your actual API password)<br />
<br />
<br />
<b> API Performance testing </b><br />
In internal NETIO testing on PowerPDU 4KS device (see below), various cipher suites and elliptic curves were evaluated for performance during secure HTTPS communication with the JSON and WebSocket APIs. Prime256v1 (NIST P-256) is recommended for best performance and compatibility. <br />
<br />
<table border="1" cellpadding="5" cellspacing="0"><br />
<tr><br />
<th></th><br />
<th>Response time Web Socket [s]</th><br />
<th>Response time JSON [s]</th><br />
</tr><br />
<tr><br />
<td colspan="3"><b>ecc_prime256v1</b></td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</td><br />
<td>5.7</td><br />
<td>6.0</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_CCM</td><br />
<td>5.9</td><br />
<td>5.6</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</td><br />
<td>5.8</td><br />
<td>5.7</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_CCM</td><br />
<td>6.1</td><br />
<td>6.2</td><br />
</tr><br />
<tr><br />
<td colspan="3"><b>ecc_secp384r1</b></td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</td><br />
<td>6.4</td><br />
<td>6.3</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_CCM</td><br />
<td>6.3</td><br />
<td>6.2</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</td><br />
<td>6.2</td><br />
<td>6.2</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_CCM</td><br />
<td>6.5</td><br />
<td>6.3</td><br />
</tr><br />
<tr><br />
<td colspan="3"><b>ecc_secp521r1</b></td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</td><br />
<td>6.5</td><br />
<td>6.4</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_CCM</td><br />
<td>6.6</td><br />
<td>6.5</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</td><br />
<td>6.7</td><br />
<td>6.3</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_CCM</td><br />
<td>6.6</td><br />
<td>6.5</td><br />
</tr><br />
</table><br />
<br />
<p>* values are valid for ethernet connection only<br><br />
** values can differentiate on WiFi connection</p></div>
Tbezstarosta
https://wiki.netio-products.com/index.php?title=HTTPs_details&diff=1065
HTTPs details
2025-08-11T11:48:18Z
<p>Tbezstarosta: </p>
<hr />
<div><br /><br />
<h1>HTTPS (Hypertext Transfer Protocol Secure)</h1> HTTPs is the secure version of HTTP, the protocol used for communication between a web browser or application and a web server or device. HTTPS adds a layer of encryption using TLS (Transport Layer Security), which protects the data transmitted over the network.<br />
<b>Why Use HTTPs with NETIO Power Devices?</b><br />
<br /><br />
NETIO devices often operate in environments where they are remotely controlled or monitored, sometimes even over public or shared networks. Using HTTPS ensures that communication between your application and the NETIO device remains private and secure, even if someone intercepts the network traffic.<br />
<br /><br />
<br /><br />
<h2>How to enable HTTPs on NETIO Device</h2><br />
All NETIO devices running on <b><u>FW 5.0.X</b></u> can be configure the way to support HTTPs communication. HTTPs option is available via Setting/ Security. Port 443 is pre-defined, but can be changed. HTTPs configuration port is shared to the port at M2M API Machine protocols setup NETIO devices support HTTPs using a self-signed certificate by default. This allows you to use secure connections immediately, even in isolated or internal networks. For production environments or public access, it is recommended to upload a certificate from a trusted Certificate Authority (CA). This ensures proper validation and avoids browser or client warnings.<br />
<br />
<br /><br />
****ADD PICTURE<br />
<br /><br />
<br />
<h2>TLS Versions and Cipher Suites Supported by NETIO</h2><br />
<br />
NETIO power devices support encrypted HTTPS communication using the TLS (Transport Layer Security) protocol. TLS ensures confidentiality, integrity, and authentication when accessing the device’s web interface or APIs (e.g., JSON/XML REST API).<br />
<br />
<br />
<br />
<u><b>Supported TLS Versions.:</b></u><br />
<br />
**TLS 1.0 and TLS 1.1 – (Deprecated for security reasons)<br />
**TLS 1.2 (Supported) (minimum secure standard and should always be used).Legacy TLS versions are disabled by default for security.<br />
**TLS 1.3 – Not supported at the moment* (future development under investigation)<br />
<br />
<br />
NETIO firmware supports multiple cipher suites using <b>RSA</b> or <b>ECDHE</b> (Elliptic Curve Diffie-Hellman Ephemeral) key exchange, combined with AES encryption (GCM/CCM) modes. There is a list of supported TLS cipher suites and key types that NETIO devices accept when establishing a secure HTTPS connection.<br />
<br /><br />
<br />
<br />
<u><b>Key Types used during the TLS handshake:</b></u><br />
**ecc_prime256v1 – elliptic curve (ECDSA) key, 256-bit (NIST P-256)<br />
**ecc_secp384r1 – stronger ECC key, 384-bit<br />
**ecc_secp521r1 – even stronger ECC key, 521-bit<br />
**rsa_1024 / rsa_2048 / rsa_3072 / rsa_4096 – RSA keys of corresponding lengths<br />
<br />
<br />
<u><b>Cipher Suite – a specific combination of algorithms used to encrypt the TLS connection:</b></u><br />
**ECDHE – key exchange algorithm (supports forward secrecy)<br />
**ECDSA – digital certificate based on ECC key (e.g., prime256v1)<br />
**AES_256_GCM – symmetric encryption (AES 256-bit, Galois/Counter Mode)<br />
**SHA384 – hashing algorithm used for integrity checks<br />
<br />
<br />
List on combinations tested with NETIO device<br />
<table style="border-collapse: collapse; width: 97.80949%;" border="1"><br />
<tr><br />
<td style="width: 8.687943%;"><br />
<p style="font-weight: 400;">&nbsp;<strong>-&gt; ecc_prime256v1</strong>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</p><br />
<ul><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</li><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_CCM</li><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_CCM</li><br />
</ul><br />
</td><br />
<td style="width: 20.451527%;" width="269"><br />
<p style="font-weight: 400;"><strong>-&gt; ecc_secp384r1</strong>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</p><br />
<ul><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_CCM</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_CCM</span></li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p style="font-weight: 400;"><strong>-&gt; ecc_secp521r1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</strong></p><br />
<ul><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_CCM:</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_CCM</span></li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p></p><br />
</td><br />
</tr><br />
<tr><br />
<td style="width: 8.687943%;"><br />
<p style="font-weight: 400;"><strong>-&gt; rsa_1024</strong></p><br />
<ul><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_CCM</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_CCM</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_SHA</li><br />
<li style="font-weight: 400;"><span style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_SHA</span></li><br />
</ul><br />
</td><br />
<td style="width: 20.451527%;"><br />
<p style="font-weight: 400;">-<strong>&gt; rsa_2048</strong></p><br />
<ul><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_SHA</span></li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p>-<strong>&gt; rsa_3072</strong></p><br />
<ul><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_SHA</li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p style="font-weight: 400;"><strong>-&gt; rsa_4096</strong></p><br />
<ul><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_CCM</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_CCM</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_SHA</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_SHA</span></li><br />
</ul><br />
</td><br />
</tr><br />
</table><br />
<br />
<br />
<h1>How NETIO Devices Use HTTPS for Secure API Access</h1><br />
<br />
NETIO devices support secure communication over HTTPS to protect API access to power sockets and configuration interfaces. This is essential when integrating NETIO devices with 3th party systems. M2M API Machine protocols setup uses the same port as being setup at configuration setting. <br />
Device provide access to various machine-readable APIs, such as:<br />
**JSON API<br />
**XML API<br />
**MQTTs (optional for some models)<br />
**URL<br />
<br />
As HTTPS is enabled, all communication with these APIs is encrypted using TLS (Transport Layer Security). This ensures that authentication tokens, control commands (e.g., socket ON/OFF), and monitoring data cannot be intercepted or altered.<br />
<br />
<b>Here is an examples of turning socket 1 ON using the JSON API over HTTPS:</b><br />
<br /><br />
curl -k netio_user:netio_password -d '{"Outputs":[{"ID":1,"Action":1}]}' -H "Content-Type: application/json" -X POST https://192.168.105.160:81/netio.json<br />
<br /><br />
**(**Replace netio_user & netio_password with proper JSON API password)<br />
<br />
<br />
<b>Here is an example of turning socket 1 ON using URL over HTTPS:</b><br />
<br /><br />
https://192.168.1.100/netio.json?pass=netio123&output1=1"<br />
<br /><br />
**(**Replace netio123 with your actual API password)<br />
<br />
<br />
<b> API Performance testing </b><br />
In internal NETIO testing on PowerPDU 4KS device (see below), various cipher suites and elliptic curves were evaluated for performance during secure HTTPS communication with the JSON and WebSocket APIs. Prime256v1 (NIST P-256) is recommended for best performance and compatibility. <br />
<br />
<table border="1" cellpadding="5" cellspacing="0"><br />
<tr><br />
<th></th><br />
<th>Response time Web Socket [s]</th><br />
<th>Response time JSON [s]</th><br />
</tr><br />
<tr><br />
<td colspan="3"><b>ecc_prime256v1</b></td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</td><br />
<td>5.7</td><br />
<td>6.0</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_CCM</td><br />
<td>5.9</td><br />
<td>5.6</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</td><br />
<td>5.8</td><br />
<td>5.7</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_CCM</td><br />
<td>6.1</td><br />
<td>6.2</td><br />
</tr><br />
<tr><br />
<td colspan="3"><b>ecc_secp384r1</b></td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</td><br />
<td>6.4</td><br />
<td>6.3</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_CCM</td><br />
<td>6.3</td><br />
<td>6.2</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</td><br />
<td>6.2</td><br />
<td>6.2</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_CCM</td><br />
<td>6.5</td><br />
<td>6.3</td><br />
</tr><br />
<tr><br />
<td colspan="3"><b>ecc_secp521r1</b></td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</td><br />
<td>6.5</td><br />
<td>6.4</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_CCM</td><br />
<td>6.6</td><br />
<td>6.5</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</td><br />
<td>6.7</td><br />
<td>6.3</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_CCM</td><br />
<td>6.6</td><br />
<td>6.5</td><br />
</tr><br />
</table><br />
<br />
<p>* values are valid for ethernet connection only<br><br />
** values can differentiate on WiFi connection</p></div>
Tbezstarosta
https://wiki.netio-products.com/index.php?title=HTTPs_details&diff=1064
HTTPs details
2025-08-11T11:47:00Z
<p>Tbezstarosta: </p>
<hr />
<div><br /><br />
<h1>HTTPS (Hypertext Transfer Protocol Secure)</h1> HTTPs is the secure version of HTTP, the protocol used for communication between a web browser or application and a web server or device. HTTPS adds a layer of encryption using TLS (Transport Layer Security), which protects the data transmitted over the network.<br />
<b>Why Use HTTPs with NETIO Power Devices?</b><br />
<br /><br />
NETIO devices often operate in environments where they are remotely controlled or monitored, sometimes even over public or shared networks. Using HTTPS ensures that communication between your application and the NETIO device remains private and secure, even if someone intercepts the network traffic.<br />
<br /><br />
<br /><br />
<h2>How to enable HTTPs on NETIO Device</h2><br />
All NETIO devices running on <b><u>FW 5.0.X</b></u> can be configure the way to support HTTPs communication. HTTPs option is available via Setting/ Security. Port 443 is pre-defined, but can be changed. HTTPs configuration port is shared to the port at M2M API Machine protocols setup NETIO devices support HTTPs using a self-signed certificate by default. This allows you to use secure connections immediately, even in isolated or internal networks. For production environments or public access, it is recommended to upload a certificate from a trusted Certificate Authority (CA). This ensures proper validation and avoids browser or client warnings.<br />
<br />
<br /><br />
****ADD PICTURE<br />
<br /><br />
<br />
<h2>TLS Versions and Cipher Suites Supported by NETIO</h2><br />
<br />
NETIO power devices support encrypted HTTPS communication using the TLS (Transport Layer Security) protocol. TLS ensures confidentiality, integrity, and authentication when accessing the device’s web interface or APIs (e.g., JSON/XML REST API).<br />
<br />
<br />
<br />
<u><b>Supported TLS Versions.:</b></u><br />
<br />
**TLS 1.0 and TLS 1.1 – (Deprecated for security reasons)<br />
**TLS 1.2 (Supported) (minimum secure standard and should always be used).Legacy TLS versions are disabled by default for security.<br />
**TLS 1.3 – Not supported at the moment* (future development under investigation)<br />
<br />
<br />
NETIO firmware supports multiple cipher suites using <b>RSA</b> or <b>ECDHE</b> (Elliptic Curve Diffie-Hellman Ephemeral) key exchange, combined with AES encryption (GCM/CCM) modes. There is a list of supported TLS cipher suites and key types that NETIO devices accept when establishing a secure HTTPS connection.<br />
<br /><br />
<br />
<br />
<u><b>Key Types used during the TLS handshake:</b></u><br />
**ecc_prime256v1 – elliptic curve (ECDSA) key, 256-bit (NIST P-256)<br />
**ecc_secp384r1 – stronger ECC key, 384-bit<br />
**ecc_secp521r1 – even stronger ECC key, 521-bit<br />
**rsa_1024 / rsa_2048 / rsa_3072 / rsa_4096 – RSA keys of corresponding lengths<br />
<br />
<br />
<u><b>Cipher Suite – a specific combination of algorithms used to encrypt the TLS connection:</b></u><br />
**ECDHE – key exchange algorithm (supports forward secrecy)<br />
**ECDSA – digital certificate based on ECC key (e.g., prime256v1)<br />
**AES_256_GCM – symmetric encryption (AES 256-bit, Galois/Counter Mode)<br />
**SHA384 – hashing algorithm used for integrity checks<br />
<br />
<br />
List on combinations tested with NETIO device<br />
<table style="border-collapse: collapse; width: 97.80949%;" border="1"><br />
<tr><br />
<td style="width: 8.687943%;"><br />
<p style="font-weight: 400;">&nbsp;<strong>-&gt; ecc_prime256v1</strong>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</p><br />
<ul><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</li><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_CCM</li><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_CCM</li><br />
</ul><br />
</td><br />
<td style="width: 20.451527%;" width="269"><br />
<p style="font-weight: 400;"><strong>-&gt; ecc_secp384r1</strong>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</p><br />
<ul><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_CCM</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_CCM</span></li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p style="font-weight: 400;"><strong>-&gt; ecc_secp521r1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</strong></p><br />
<ul><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_CCM:</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_CCM</span></li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p></p><br />
</td><br />
</tr><br />
<tr><br />
<td style="width: 8.687943%;"><br />
<p style="font-weight: 400;"><strong>-&gt; rsa_1024</strong></p><br />
<ul><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_CCM</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_CCM</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_SHA</li><br />
<li style="font-weight: 400;"><span style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_SHA</span></li><br />
</ul><br />
</td><br />
<td style="width: 20.451527%;"><br />
<p style="font-weight: 400;">-<strong>&gt; rsa_2048</strong></p><br />
<ul><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_SHA</span></li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p>-<strong>&gt; rsa_3072</strong></p><br />
<ul><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_SHA</li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p style="font-weight: 400;"><strong>-&gt; rsa_4096</strong></p><br />
<ul><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_CCM</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_CCM</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_SHA</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_SHA</span></li><br />
</ul><br />
</td><br />
</tr><br />
</table><br />
<br />
<br />
<h1>How NETIO Devices Use HTTPS for Secure API Access</h1><br />
<br />
NETIO devices support secure communication over HTTPS to protect API access to power sockets and configuration interfaces. This is essential when integrating NETIO devices with 3th party systems. M2M API Machine protocols setup uses the same port as being setup at configuration setting. <br />
Device provide access to various machine-readable APIs, such as:<br />
**JSON API<br />
**XML API<br />
**MQTTs (optional for some models)<br />
**URL<br />
<br />
As HTTPS is enabled, all communication with these APIs is encrypted using TLS (Transport Layer Security). This ensures that authentication tokens, control commands (e.g., socket ON/OFF), and monitoring data cannot be intercepted or altered.<br />
<br />
<b>Here is an examples of turning socket 1 ON using the JSON API over HTTPS:</b><br />
<br /><br />
curl -k netio_user:netio_password -d '{"Outputs":[{"ID":1,"Action":1}]}' -H "Content-Type: application/json" -X POST https://192.168.105.160:81/netio.json<br />
<br /><br />
(**Replace netio_user & netio_password with proper JSON API password)<br />
<br />
<br />
<b>Here is an example of turning socket 1 ON using URL over HTTPS:</b><br />
<br /><br />
https://192.168.1.100/netio.json?pass=netio123&output1=1"<br />
<br /><br />
(**Replace netio123 with your actual API password)<br />
<br />
<br />
<br />
<table border="1" cellpadding="5" cellspacing="0"><br />
<tr><br />
<th></th><br />
<th>Response time Web Socket [s]</th><br />
<th>Response time JSON [s]</th><br />
</tr><br />
<tr><br />
<td colspan="3"><b>ecc_prime256v1</b></td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</td><br />
<td>5.7</td><br />
<td>6.0</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_CCM</td><br />
<td>5.9</td><br />
<td>5.6</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</td><br />
<td>5.8</td><br />
<td>5.7</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_CCM</td><br />
<td>6.1</td><br />
<td>6.2</td><br />
</tr><br />
<tr><br />
<td colspan="3"><b>ecc_secp384r1</b></td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</td><br />
<td>6.4</td><br />
<td>6.3</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_CCM</td><br />
<td>6.3</td><br />
<td>6.2</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</td><br />
<td>6.2</td><br />
<td>6.2</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_CCM</td><br />
<td>6.5</td><br />
<td>6.3</td><br />
</tr><br />
<tr><br />
<td colspan="3"><b>ecc_secp521r1</b></td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</td><br />
<td>6.5</td><br />
<td>6.4</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_256_CCM</td><br />
<td>6.6</td><br />
<td>6.5</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</td><br />
<td>6.7</td><br />
<td>6.3</td><br />
</tr><br />
<tr><br />
<td>TLS_ECDHE_ECDSA_WITH_AES_128_CCM</td><br />
<td>6.6</td><br />
<td>6.5</td><br />
</tr><br />
</table><br />
<br />
<p>* values are valid for ethernet connection only<br><br />
** values can differentiate on WiFi connection</p></div>
Tbezstarosta
https://wiki.netio-products.com/index.php?title=HTTPs_details&diff=1063
HTTPs details
2025-08-11T11:40:20Z
<p>Tbezstarosta: </p>
<hr />
<div><br /><br />
<h1>HTTPS (Hypertext Transfer Protocol Secure)</h1> HTTPs is the secure version of HTTP, the protocol used for communication between a web browser or application and a web server or device. HTTPS adds a layer of encryption using TLS (Transport Layer Security), which protects the data transmitted over the network.<br />
<b>Why Use HTTPs with NETIO Power Devices?</b><br />
<br /><br />
NETIO devices often operate in environments where they are remotely controlled or monitored, sometimes even over public or shared networks. Using HTTPS ensures that communication between your application and the NETIO device remains private and secure, even if someone intercepts the network traffic.<br />
<br /><br />
<br /><br />
<h2>How to enable HTTPs on NETIO Device</h2><br />
All NETIO devices running on <b><u>FW 5.0.X</b></u> can be configure the way to support HTTPs communication. HTTPs option is available via Setting/ Security. Port 443 is pre-defined, but can be changed. HTTPs configuration port is shared to the port at M2M API Machine protocols setup NETIO devices support HTTPs using a self-signed certificate by default. This allows you to use secure connections immediately, even in isolated or internal networks. For production environments or public access, it is recommended to upload a certificate from a trusted Certificate Authority (CA). This ensures proper validation and avoids browser or client warnings.<br />
<br />
<br /><br />
****ADD PICTURE<br />
<br /><br />
<br />
<h2>TLS Versions and Cipher Suites Supported by NETIO</h2><br />
<br />
NETIO power devices support encrypted HTTPS communication using the TLS (Transport Layer Security) protocol. TLS ensures confidentiality, integrity, and authentication when accessing the device’s web interface or APIs (e.g., JSON/XML REST API).<br />
<br />
<br />
<br />
<u><b>Supported TLS Versions.:</b></u><br />
<br />
**TLS 1.0 and TLS 1.1 – (Deprecated for security reasons)<br />
**TLS 1.2 (Supported) (minimum secure standard and should always be used).Legacy TLS versions are disabled by default for security.<br />
**TLS 1.3 – Not supported at the moment* (future development under investigation)<br />
<br />
<br />
NETIO firmware supports multiple cipher suites using <b>RSA</b> or <b>ECDHE</b> (Elliptic Curve Diffie-Hellman Ephemeral) key exchange, combined with AES encryption (GCM/CCM) modes. There is a list of supported TLS cipher suites and key types that NETIO devices accept when establishing a secure HTTPS connection.<br />
<br /><br />
<br />
<br />
<u><b>Key Types used during the TLS handshake:</b></u><br />
**ecc_prime256v1 – elliptic curve (ECDSA) key, 256-bit (NIST P-256)<br />
**ecc_secp384r1 – stronger ECC key, 384-bit<br />
**ecc_secp521r1 – even stronger ECC key, 521-bit<br />
**rsa_1024 / rsa_2048 / rsa_3072 / rsa_4096 – RSA keys of corresponding lengths<br />
<br />
<br />
<u><b>Cipher Suite – a specific combination of algorithms used to encrypt the TLS connection:</b></u><br />
**ECDHE – key exchange algorithm (supports forward secrecy)<br />
**ECDSA – digital certificate based on ECC key (e.g., prime256v1)<br />
**AES_256_GCM – symmetric encryption (AES 256-bit, Galois/Counter Mode)<br />
**SHA384 – hashing algorithm used for integrity checks<br />
<br />
<br />
List on combinations tested with NETIO device<br />
<table style="border-collapse: collapse; width: 97.80949%;" border="1"><br />
<tr><br />
<td style="width: 8.687943%;"><br />
<p style="font-weight: 400;">&nbsp;<strong>-&gt; ecc_prime256v1</strong>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</p><br />
<ul><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</li><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_CCM</li><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_CCM</li><br />
</ul><br />
</td><br />
<td style="width: 20.451527%;" width="269"><br />
<p style="font-weight: 400;"><strong>-&gt; ecc_secp384r1</strong>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</p><br />
<ul><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_CCM</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_CCM</span></li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p style="font-weight: 400;"><strong>-&gt; ecc_secp521r1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</strong></p><br />
<ul><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_CCM:</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_CCM</span></li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p></p><br />
</td><br />
</tr><br />
<tr><br />
<td style="width: 8.687943%;"><br />
<p style="font-weight: 400;"><strong>-&gt; rsa_1024</strong></p><br />
<ul><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_CCM</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_CCM</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_SHA</li><br />
<li style="font-weight: 400;"><span style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_SHA</span></li><br />
</ul><br />
</td><br />
<td style="width: 20.451527%;"><br />
<p style="font-weight: 400;">-<strong>&gt; rsa_2048</strong></p><br />
<ul><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_SHA</span></li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p>-<strong>&gt; rsa_3072</strong></p><br />
<ul><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_SHA</li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p style="font-weight: 400;"><strong>-&gt; rsa_4096</strong></p><br />
<ul><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_CCM</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_CCM</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_SHA</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_SHA</span></li><br />
</ul><br />
</td><br />
</tr><br />
</table><br />
<br />
<br />
<h1>How NETIO Devices Use HTTPS for Secure API Access</h1><br />
<br />
NETIO devices support secure communication over HTTPS to protect API access to power sockets and configuration interfaces. This is essential when integrating NETIO devices with 3th party systems. M2M API Machine protocols setup uses the same port as being setup at configuration setting. <br />
Device provide access to various machine-readable APIs, such as:<br />
**JSON API<br />
**XML API<br />
**MQTTs (optional for some models)<br />
**URL<br />
<br />
As HTTPS is enabled, all communication with these APIs is encrypted using TLS (Transport Layer Security). This ensures that authentication tokens, control commands (e.g., socket ON/OFF), and monitoring data cannot be intercepted or altered.<br />
<br />
<b>Here is an examples of turning socket 1 ON using the JSON API over HTTPS:</b><br />
<br /><br />
curl -k netio_user:netio_password -d '{"Outputs":[{"ID":1,"Action":1}]}' -H "Content-Type: application/json" -X POST https://192.168.105.160:81/netio.json<br />
<br /><br />
(**Replace netio_user & netio_password with proper JSON API password)<br />
<br />
<br />
<b>Here is an example of turning socket 1 ON using URL over HTTPS:</b><br />
<br /><br />
https://192.168.1.100/netio.json?pass=netio123&output1=1"<br />
<br /><br />
(**Replace netio123 with your actual API password)</div>
Tbezstarosta
https://wiki.netio-products.com/index.php?title=HTTPs_details&diff=1062
HTTPs details
2025-08-11T11:30:18Z
<p>Tbezstarosta: </p>
<hr />
<div><br /><br />
<h1>HTTPS (Hypertext Transfer Protocol Secure)</h1> HTTPs is the secure version of HTTP, the protocol used for communication between a web browser or application and a web server or device. HTTPS adds a layer of encryption using TLS (Transport Layer Security), which protects the data transmitted over the network.<br />
<b>Why Use HTTPs with NETIO Power Devices?</b><br />
<br /><br />
NETIO devices often operate in environments where they are remotely controlled or monitored, sometimes even over public or shared networks. Using HTTPS ensures that communication between your application and the NETIO device remains private and secure, even if someone intercepts the network traffic.<br />
<br /><br />
<br /><br />
<h2>How to enable HTTPs on NETIO Device</h2><br />
All NETIO devices running on <b><u>FW 5.0.X</b></u> can be configure the way to support HTTPs communication. HTTPs option is available via Setting/ Security. Port 443 is pre-defined, but can be changed. HTTPs configuration port is shared to the port at M2M API Machine protocols setup NETIO devices support HTTPs using a self-signed certificate by default. This allows you to use secure connections immediately, even in isolated or internal networks. For production environments or public access, it is recommended to upload a certificate from a trusted Certificate Authority (CA). This ensures proper validation and avoids browser or client warnings.<br />
<br />
<br /><br />
****ADD PICTURE<br />
<br /><br />
<br />
<h2>TLS Versions and Cipher Suites Supported by NETIO</h2><br />
<br />
NETIO power devices support encrypted HTTPS communication using the TLS (Transport Layer Security) protocol. TLS ensures confidentiality, integrity, and authentication when accessing the device’s web interface or APIs (e.g., JSON/XML REST API).<br />
<br />
<br />
<br />
<u><b>Supported TLS Versions.:</b></u><br />
<br />
**TLS 1.0 and TLS 1.1 – (Deprecated for security reasons)<br />
**TLS 1.2 (Supported) (minimum secure standard and should always be used).Legacy TLS versions are disabled by default for security.<br />
**TLS 1.3 – Not supported at the moment* (future development under investigation)<br />
<br />
<br />
NETIO firmware supports multiple cipher suites using <b>RSA</b> or <b>ECDHE</b> (Elliptic Curve Diffie-Hellman Ephemeral) key exchange, combined with AES encryption (GCM/CCM) modes. There is a list of supported TLS cipher suites and key types that NETIO devices accept when establishing a secure HTTPS connection.<br />
<br /><br />
<br />
<br />
<u><b>Key Types used during the TLS handshake:</b></u><br />
**ecc_prime256v1 – elliptic curve (ECDSA) key, 256-bit (NIST P-256)<br />
**ecc_secp384r1 – stronger ECC key, 384-bit<br />
**ecc_secp521r1 – even stronger ECC key, 521-bit<br />
**rsa_1024 / rsa_2048 / rsa_3072 / rsa_4096 – RSA keys of corresponding lengths<br />
<br />
<br />
<u><b>Cipher Suite – a specific combination of algorithms used to encrypt the TLS connection:</b></u><br />
**ECDHE – key exchange algorithm (supports forward secrecy)<br />
**ECDSA – digital certificate based on ECC key (e.g., prime256v1)<br />
**AES_256_GCM – symmetric encryption (AES 256-bit, Galois/Counter Mode)<br />
**SHA384 – hashing algorithm used for integrity checks<br />
<br />
<br />
List on combinations tested with NETIO device<br />
<table style="border-collapse: collapse; width: 97.80949%;" border="1"><br />
<tr><br />
<td style="width: 8.687943%;"><br />
<p style="font-weight: 400;">&nbsp;<strong>-&gt; ecc_prime256v1</strong>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</p><br />
<ul><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</li><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_CCM</li><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_CCM</li><br />
</ul><br />
</td><br />
<td style="width: 20.451527%;" width="269"><br />
<p style="font-weight: 400;"><strong>-&gt; ecc_secp384r1</strong>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</p><br />
<ul><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_CCM</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_CCM</span></li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p style="font-weight: 400;"><strong>-&gt; ecc_secp521r1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</strong></p><br />
<ul><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_256_CCM:</li><br />
<li>&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_ECDHE_ECDSA_WITH_AES_128_CCM</span></li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p></p><br />
</td><br />
</tr><br />
<tr><br />
<td style="width: 8.687943%;"><br />
<p style="font-weight: 400;"><strong>-&gt; rsa_1024</strong></p><br />
<ul><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_CCM</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_CCM</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_256_SHA</li><br />
<li style="font-weight: 400;"><span style="font-weight: 400;">&nbsp;&nbsp;&nbsp; TLS_RSA_WITH_AES_128_SHA</span></li><br />
</ul><br />
</td><br />
<td style="width: 20.451527%;"><br />
<p style="font-weight: 400;">-<strong>&gt; rsa_2048</strong></p><br />
<ul><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_SHA</span></li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p>-<strong>&gt; rsa_3072</strong></p><br />
<ul><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_CCM</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_SHA256</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_256_SHA</li><br />
<li>&nbsp;TLS_RSA_WITH_AES_128_SHA</li><br />
</ul><br />
</td><br />
<td style="width: 10.225763%;"><br />
<p style="font-weight: 400;"><strong>-&gt; rsa_4096</strong></p><br />
<ul><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_GCM_SHA384</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_CCM</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_GCM_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_CCM</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_SHA256</li><br />
<li style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_256_SHA</li><br />
<li><span style="font-weight: 400;">&nbsp;TLS_RSA_WITH_AES_128_SHA</span></li><br />
</ul><br />
</td><br />
</tr><br />
</table></div>
Tbezstarosta
https://wiki.netio-products.com/index.php?title=HTTPs_details&diff=1061
HTTPs details
2025-08-11T11:14:20Z
<p>Tbezstarosta: </p>
<hr />
<div><br /><br />
<h1>HTTPS (Hypertext Transfer Protocol Secure)</h1> HTTPs is the secure version of HTTP, the protocol used for communication between a web browser or application and a web server or device. HTTPS adds a layer of encryption using TLS (Transport Layer Security), which protects the data transmitted over the network.<br />
<b>Why Use HTTPs with NETIO Power Devices?</b><br />
<br /><br />
NETIO devices often operate in environments where they are remotely controlled or monitored, sometimes even over public or shared networks. Using HTTPS ensures that communication between your application and the NETIO device remains private and secure, even if someone intercepts the network traffic.<br />
<br /><br />
<br /><br />
<h2>How to enable HTTPs on NETIO Device</h2><br />
All NETIO devices running on <b><u>FW 5.0.X</b></u> can be configure the way to support HTTPs communication. HTTPs option is available via Setting/ Security. Port 443 is pre-defined, but can be changed. HTTPs configuration port is shared to the port at M2M API Machine protocols setup NETIO devices support HTTPs using a self-signed certificate by default. This allows you to use secure connections immediately, even in isolated or internal networks. For production environments or public access, it is recommended to upload a certificate from a trusted Certificate Authority (CA). This ensures proper validation and avoids browser or client warnings.<br />
<br />
<br /><br />
****ADD PICTURE<br />
<br /><br />
<br />
<h2>TLS Versions and Cipher Suites Supported by NETIO</h2><br />
<br />
NETIO power devices support encrypted HTTPS communication using the TLS (Transport Layer Security) protocol. TLS ensures confidentiality, integrity, and authentication when accessing the device’s web interface or APIs (e.g., JSON/XML REST API).<br />
<br />
<br />
<br />
<u><b>Supported TLS Versions.:</b></u><br />
<br />
**TLS 1.0 and TLS 1.1 – (Deprecated for security reasons)<br />
**TLS 1.2 (Supported) (minimum secure standard and should always be used).Legacy TLS versions are disabled by default for security.<br />
**TLS 1.3 – Not supported at the moment* (future development under investigation)<br />
<br />
<br />
NETIO firmware supports multiple cipher suites using <b>RSA</b> or <b>ECDHE</b> (Elliptic Curve Diffie-Hellman Ephemeral) key exchange, combined with AES encryption (GCM/CCM) modes. There is a list of supported TLS cipher suites and key types that NETIO devices accept when establishing a secure HTTPS connection.<br />
<br /><br />
<br />
<br />
<u><b>Key Types used during the TLS handshake:</b></u><br />
**ecc_prime256v1 – elliptic curve (ECDSA) key, 256-bit (NIST P-256)<br />
**ecc_secp384r1 – stronger ECC key, 384-bit<br />
**ecc_secp521r1 – even stronger ECC key, 521-bit<br />
**rsa_1024 / rsa_2048 / rsa_3072 / rsa_4096 – RSA keys of corresponding lengths<br />
<br />
<br />
<u><b>Cipher Suite – a specific combination of algorithms used to encrypt the TLS connection:</b></u><br />
**ECDHE – key exchange algorithm (supports forward secrecy)<br />
**ECDSA – digital certificate based on ECC key (e.g., prime256v1)<br />
**AES_256_GCM – symmetric encryption (AES 256-bit, Galois/Counter Mode)<br />
**SHA384 – hashing algorithm used for integrity checks<br />
<br />
<br />
List on combinations tested with NETIO device</div>
Tbezstarosta
https://wiki.netio-products.com/index.php?title=HTTPs_details&diff=1060
HTTPs details
2025-08-11T10:49:44Z
<p>Tbezstarosta: Created page with "<br /> <b>HTTPS (Hypertext Transfer Protocol Secure)</b> is the secure version of HTTP, the protocol used for communication between a web browser or application and a web serv..."</p>
<hr />
<div><br /><br />
<b>HTTPS (Hypertext Transfer Protocol Secure)</b> is the secure version of HTTP, the protocol used for communication between a web browser or application and a web server or device. HTTPS adds a layer of encryption using TLS (Transport Layer Security), which protects the data transmitted over the network.<br />
<br /><br />
<br /><br />
<b>Why Use HTTPs with NETIO Power Devices?</b><br />
<br /><br />
NETIO devices often operate in environments where they are remotely controlled or monitored, sometimes even over public or shared networks. Using HTTPS ensures that communication between your application and the NETIO device remains private and secure, even if someone intercepts the network traffic.<br />
<br /><br />
<br /><br />
<b>How to enable HTTPs on NETIO Device</b><br />
<br /><br />
All NETIO devices running on <b><u>FW 5.0.X</b></u> can be configure the way to support HTTPs communication. HTTPs option is available via Setting/ Security. Port 443 is pre-defined, but can be changed. HTTPs configuration port is shared to the port at M2M API Machine protocols setup NETIO devices support HTTPs using a self-signed certificate by default. This allows you to use secure connections immediately, even in isolated or internal networks. For production environments or public access, it is recommended to upload a certificate from a trusted Certificate Authority (CA). This ensures proper validation and avoids browser or client warnings.</div>
Tbezstarosta
https://wiki.netio-products.com/index.php?title=Welcome_to_NETIO_resources_%26_projects_%26_documentation_overview&diff=1059
Welcome to NETIO resources & projects & documentation overview
2025-08-11T10:48:45Z
<p>Tbezstarosta: /* NETIO Secure communication */</p>
<hr />
<div><div style="text-align: center; white-space: nowrap;"><br />
<div style="display: inline-block; padding: 0 0 0 0; border-left: 0px solid gray; width: 40%; vertical-align: top; white-space: normal;"><br />
<div style="text-align: center; white-space: nowrap;"><br />
<br />
<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;"><br />
<h2 style="background: #005f41; color: #FFF; margin: 0 0 0 0; padding: 0 1em 0 1em;">Interoperability</h2><br />
<div style=" display: inline-block; padding: 0 1em 0 1em;text-align: left; vertical-align: top; white-space: normal;"><br />
===NETIO unified Open API===<br />
<br />
*[[JSON API]] (default enabled)<br />
<br />
*[[MQTT-flex]]<br />
<br />
*[[NETIO Cloud API]]<br />
<br />
*[[HTTP(s) Push - JSON/XML]]<br />
<br />
*[[Modbus TCP]]<br />
<br />
*[[SNMP]]<br />
<br />
*[[Telnet/Kshell]]<br />
<br />
*[[URL API]]<br />
<br />
*[[XML API]]<br />
<br />
*[[MQTT]] (PowerPDU 4C)<br />
<br />
*[[SIP]] <br />
<br />
<br /><br />
===NETIO Secure communication=== <br />
*[[HTTPs details]]<br />
<br />
===AV drivers for NETIO===<br />
<br />
<br />
*'''[https://www.netio-products.com/en/partners#BrightSign BrightSign]'''<br />
*'''DOMOTZ''' (coming soon)<br />
<br />
*[[ELAN]]<br />
<br />
*[https://www.netio-products.com/en/partners#Crestron '''Crestron''']<br />
<br />
*[https://www.netio-products.com/en/partners#Control%204 '''Control 4''']<br />
<br />
*[https://www.netio-products.com/en/partners#HSYCO '''HSYCO''']<br />
<br />
*[https://www.netio-products.com/en/partners#Neets%20A/S '''Neets''']<br />
<br />
*[https://www.netio-products.com/en/partners#RTI '''RTI''']<br />
<br />
*[https://www.netio-products.com/en/partners#Savant '''SAVANT''']<br />
<br />
<br />
<br /><br />
<br />
===Integrations from NETIO===<br />
<br />
*[https://www.netio-products.com/en/application-notes/an22-abacom-profilab-expert-software-controls-netio-power-sockets-and-reads-measurements '''ABACOM''' ProfiLab-Expert]<br />
<br />
*[https://www.netio-products.com/en/application-notes/an33-domoticz-controls-netio-smart-sockets-http-json Domoticz]<br />
<br />
*'''Domotz''' (coming soon)<br />
<br />
*[https://forum.fibaro.com/topic/53599-quickapp-netio/ '''Fibaro HC3''']<br />
<br />
*[https://www.netio-products.com/en/partners#Grafana '''Grafana''']<br />
<br />
*[[HiveMQ]] (using MQTT-flex)<br />
<br />
*[https://www.netio-products.com/en/application-notes/an53-loxone-controls-netio-power-sockets-with-url-api-or-modbustcp LOXONE]<br />
<br />
*[https://www.netio-products.com/en/application-notes/an26-ms-azure-and-netio-4x-power-metering-and-output-control-from-a-cloud-service MS Azure]<br />
<br />
*[https://www.netio-products.com/en/application-notes/an41-power-monitoring-over-snmp-in-zabbix-nagios-for-netio-power-sockets '''Nagios'' / '''''<nowiki/>''Zabbix'<nowiki/>'']<br />
<br />
*'''[[NodeRED]]''' - several examples<br />
<br />
*[https://www.netio-products.com/en/partners#Paessler%20AG '''PRTG - Paessler''']<br />
<br />
*[https://github.com/pixilab/blocks-script/tree/master/driver PIXILAB Blocks]<br />
<br />
<br />
</div><br />
</div><br />
<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;"><br />
<h2 style="background: #005f41; color: #FFF; margin: 0 0 0 0; padding: 0 1em 0 1em;"> Community </h2><br />
<div style=" display: inline-block; padding: 0 1em 0 1em;text-align: left; vertical-align: top; white-space: normal;"><br />
<br />
===Tools===<br />
[https://github.com/netioproducts NETIO GitHub - official]<br />
<br />
*[https://github.com/netioproducts/PyNetio PyNetio (Python to control NETIOs)]<br />
<br />
*[https://github.com/netioproducts/PyNetioConf PyNetioConf - python library control/manage NETIO devices ]<br />
<br />
*[https://github.com/netioproducts/c-sharp-examples c-sharp-examples]<br />
<br />
*[https://github.com/netioproducts/python-netio-discover python-netio-discover]<br />
<br />
*[https://github.com/netioproducts/php-examples PHP examples]<br />
<br />
*[https://github.com/netioproducts/netio-data-collector NETIO data collector]<br />
<br />
<br />
<br />
[[NETIO UDP Discover]]<br />
<br />
[[NETIO UPnP (Universal Plug and Play)]]<br />
<br />
[https://github.com/Koukaam/netio-utils/tree/master/actions GitHub - obsolete (Koukaam)]<br />
<br />
<br /><br />
<br />
===Integrations by Community===<br />
<br />
*[https://github.com/bitfocus/companion-module-netio-powerbox '''Companion''' module by Bitfocus AS]<br />
<br />
*[https://github.com/elmicro/fhem_netio_4x_pm '''FHEM''' module by Elmicro]<br />
<br />
*[https://grafana.com/grafana/dashboards/12022-netio-power-pdu/ '''Grafana''' dashboard for Prometheus]<br />
<br />
*[https://www.home-assistant.io/components/netio/ '''Home Assistant''']<br />
<br />
<UL><br />
*[https://github.com/jvyoralek/homeassistant-config/tree/master/products/netio HomeAssistant - PowerCable MQTTflex]<br />
<br />
*[[HomeAssistant - PowerCable MQTTflex configuration update]]<br />
<br />
*[https://peyanski.com/netio-powerdin-4pz-and-home-assistant/ PowerDIN 4PZ smart electricity meter and Home Assistant]<br />
<br />
</UL><br />
<br />
<br />
*[https://github.com/VerosK/icinga-check-netio-pdu '''Icinga''']<br />
<br />
*[https://github.com/theone1984/netio-jenkins '''Jenkins''' plugin] <br />
<br />
*[https://www.jam-software.com/serversentinel/online_manual/EN/index.html?actions_netio230bnetworkpowersocket.html '''Jam-software''' - ServerSentinel]<br />
<br />
*[https://github.com/theone1984/netio-jenkins '''Jenkins''' plugin]<br />
<br />
*[https://github.com/stdevel/check_netio '''Nagios plugin''']<br />
<br />
*[https://www.instructables.com/id/How-to-Work-With-JSON-in-Node-RED/ '''NodeRED''' access to NETIO 4All]<br />
<br />
*[https://jirikuba.github.io/NETIO.SpinaniHDO/ '''NETIO controlled by HDO in Lua''']<br />
<br />
*[https://bytehive.gumroad.com/l/playoutbee?layout=profile '''PlayoutBee''' integration]<br />
<br />
*[https://github.com/tomsajan/netio-exporter '''Prometheus''' integration]<br />
<br />
*[https://github.com/st3veV/Netio-OpenHAB '''OpenHAB''' using MQTT]<br />
<br />
*[https://groups.google.com/forum/#!topic/openhab/O6psocjU70s '''OpenHAB''' Reading power consumption - HTTP (NETIO4)]<br />
<br />
*[https://discourse.ros.org/t/netio-ros-interface/20737 '''ROS''' Robot Operating System integration]<br />
<br />
<br /><br />
<br />
===Programming examples===<br />
<br />
*[https://github.com/svartnos/NETIO4-Json-Demo '''C# example''' JSON based device control example]<br />
<br />
*[https://github.com/netioproducts/c-sharp-examples/tree/master/netioControllerXML-Stefano '''M2M XML API integration in C#''']<br />
<br />
*[https://github.com/rynr/netio '''Java Control Library''']<br />
<br />
*[https://github.com/imolein/lua-netio '''LUA control Library''']<br />
<br />
<br /><br />
===Other 3rd party tools===<br />
<br />
*[https://www1.stardraw.com/stardraw2/sd7/features/manufacturer/6f7f9fe5-0026-4922-b15c-d287d3ce3fef '''Stardraw''' Design 7.3]<br />
<br />
<br />
<br />
<br />
</div><br />
</div><br />
<br />
<br />
</div><br />
<br />
<br />
</div><br />
<div style="display: inline-block; padding: 0 1em 0 0; border-right: 0px solid gray; width: 60%; vertical-align: top; white-space: normal;"><br />
<div style="text-align: center; white-space: nowrap;"><br />
<br />
<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;"><br />
<h2 style="background: #005f41; color: #FFF; margin: 0 0 0 0; padding: 0 1em 0 1em;">NETIO Conditions & Rules: Local device scripting</h2><br />
<div style=" display: inline-block; padding: 0 1em 0 1em;text-align: left; vertical-align: top; white-space: normal;"><br />
<br />
<i>These features are available for all NETIO devices except PowerPDU 4C (LUA is supported there)</i>.<br />
<br/><br />
<br />
<br />
[https://wiki.netio-products.com/index.php?title=Rules_Complete_Examples '''CRxx Conditions & Rules - examples''']<br />Check most common practical examples<br />
<br />
===Power Analysis Blocks (PAB)===<br />
*[https://wiki.netio-products.com/index.php?title=PAB '''PAB Description''']<br />
**[https://wiki.netio-products.com/index.php?title=PAB#RANGE '''PAB - RANGE''']<br />
**[https://wiki.netio-products.com/index.php?title=PAB#ZONES '''PAB - ZONES''']<br />
<br /><br />
<br />
===WatchDog (WDT)===<br />
*[https://wiki.netio-products.com/index.php?title=Watchdog '''WatchDog Description''']<br />
<br />
*[https://wiki.netio-products.com/index.php?title=Watchdog_Examples '''WatchDog Examples''']<br />
**One IP address WatchDog<br />
**Multiple IP addresses WatchDog with rules<br />
<br /><br />
<br />
===Rules===<br />
*[https://wiki.netio-products.com/index.php?title=Rules '''Rules Description''']<br />
<br />
</div><br />
</div><br />
<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;"><br />
<h2 style="background: #005f41; color: #FFF; margin: 0 0 0 0; padding: 0 1em 0 1em;"> NETIO Lua Programming </h2><br />
<div style=" display: inline-block; padding: 0 1em 0 1em;text-align: left; vertical-align: top; white-space: normal;"><br />
<br />
<i>Lua is available for PowerPDU 4C device only</i>.<br />
<br />
===Don't know LUA?===<br />
====[https://www.lua.org/pil/contents.html Official Lua tutorial]====<br />
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.<br />
====[https://www.lua.org/manual/5.3/ Official Lua manual]====<br />
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.<br />
<br />
===Lua in NETIO===<br />
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.<br />
====[[Lua basics for other language programmers]]====<br />
A quick jump into NETIO Lua programming if you mastered another programming language. It's simple...<br />
====[[NETIO Lua Tips & Philosophy]]====<br />
Explanation of starting LUA scripts in NETIO devices and some tips how to hack NETIO to doing what you want.<br />
<br />
====[[NETIO Specific Reference manual]]====<br />
If you can already code in Lua, NETIO-specific Lua functions is your main guide to programing NETIO Sockets.<br />
<br />
====[[Examples & Aplication notes]]====<br />
Aplication notes for devices supporting LUA programming. Example configurations downloads and Script programming explanation with direct links to reference<br />
<br />
<br />
<b>[https://www.netio-products.com/en/glossary/m2m-active-client M2M Lua Active Client]</b><br />
<br />
<b>M2M Lua Active Client</b> means = SNMP get/set, HTTP get, MQTT from the custom Lua scripts. <br />
<br />
</div><br />
</div><br />
<br />
<br />
</div><br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
</div><br />
__NOTOC__</div>
Tbezstarosta
https://wiki.netio-products.com/index.php?title=Welcome_to_NETIO_resources_%26_projects_%26_documentation_overview&diff=1058
Welcome to NETIO resources & projects & documentation overview
2025-08-11T10:48:15Z
<p>Tbezstarosta: /* NETIO Secure communication */</p>
<hr />
<div><div style="text-align: center; white-space: nowrap;"><br />
<div style="display: inline-block; padding: 0 0 0 0; border-left: 0px solid gray; width: 40%; vertical-align: top; white-space: normal;"><br />
<div style="text-align: center; white-space: nowrap;"><br />
<br />
<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;"><br />
<h2 style="background: #005f41; color: #FFF; margin: 0 0 0 0; padding: 0 1em 0 1em;">Interoperability</h2><br />
<div style=" display: inline-block; padding: 0 1em 0 1em;text-align: left; vertical-align: top; white-space: normal;"><br />
===NETIO unified Open API===<br />
<br />
*[[JSON API]] (default enabled)<br />
<br />
*[[MQTT-flex]]<br />
<br />
*[[NETIO Cloud API]]<br />
<br />
*[[HTTP(s) Push - JSON/XML]]<br />
<br />
*[[Modbus TCP]]<br />
<br />
*[[SNMP]]<br />
<br />
*[[Telnet/Kshell]]<br />
<br />
*[[URL API]]<br />
<br />
*[[XML API]]<br />
<br />
*[[MQTT]] (PowerPDU 4C)<br />
<br />
*[[SIP]] <br />
<br />
<br /><br />
===NETIO Secure communication=== <br />
*[[HTTPs details]] <br />
<br />
<br /><br />
<b>HTTPS (Hypertext Transfer Protocol Secure)</b> is the secure version of HTTP, the protocol used for communication between a web browser or application and a web server or device. HTTPS adds a layer of encryption using TLS (Transport Layer Security), which protects the data transmitted over the network.<br />
<br /><br />
<br /><br />
<b>Why Use HTTPs with NETIO Power Devices?</b><br />
<br /><br />
NETIO devices often operate in environments where they are remotely controlled or monitored, sometimes even over public or shared networks. Using HTTPS ensures that communication between your application and the NETIO device remains private and secure, even if someone intercepts the network traffic.<br />
<br /><br />
<br /><br />
<b>How to enable HTTPs on NETIO Device</b><br />
<br /><br />
All NETIO devices running on <b><u>FW 5.0.X</b></u> can be configure the way to support HTTPs communication. HTTPs option is available via Setting/ Security. Port 443 is pre-defined, but can be changed. HTTPs configuration port is shared to the port at M2M API Machine protocols setup NETIO devices support HTTPs using a self-signed certificate by default. This allows you to use secure connections immediately, even in isolated or internal networks. For production environments or public access, it is recommended to upload a certificate from a trusted Certificate Authority (CA). This ensures proper validation and avoids browser or client warnings.<br />
<br />
===AV drivers for NETIO===<br />
<br />
<br />
*'''[https://www.netio-products.com/en/partners#BrightSign BrightSign]'''<br />
*'''DOMOTZ''' (coming soon)<br />
<br />
*[[ELAN]]<br />
<br />
*[https://www.netio-products.com/en/partners#Crestron '''Crestron''']<br />
<br />
*[https://www.netio-products.com/en/partners#Control%204 '''Control 4''']<br />
<br />
*[https://www.netio-products.com/en/partners#HSYCO '''HSYCO''']<br />
<br />
*[https://www.netio-products.com/en/partners#Neets%20A/S '''Neets''']<br />
<br />
*[https://www.netio-products.com/en/partners#RTI '''RTI''']<br />
<br />
*[https://www.netio-products.com/en/partners#Savant '''SAVANT''']<br />
<br />
<br />
<br /><br />
<br />
===Integrations from NETIO===<br />
<br />
*[https://www.netio-products.com/en/application-notes/an22-abacom-profilab-expert-software-controls-netio-power-sockets-and-reads-measurements '''ABACOM''' ProfiLab-Expert]<br />
<br />
*[https://www.netio-products.com/en/application-notes/an33-domoticz-controls-netio-smart-sockets-http-json Domoticz]<br />
<br />
*'''Domotz''' (coming soon)<br />
<br />
*[https://forum.fibaro.com/topic/53599-quickapp-netio/ '''Fibaro HC3''']<br />
<br />
*[https://www.netio-products.com/en/partners#Grafana '''Grafana''']<br />
<br />
*[[HiveMQ]] (using MQTT-flex)<br />
<br />
*[https://www.netio-products.com/en/application-notes/an53-loxone-controls-netio-power-sockets-with-url-api-or-modbustcp LOXONE]<br />
<br />
*[https://www.netio-products.com/en/application-notes/an26-ms-azure-and-netio-4x-power-metering-and-output-control-from-a-cloud-service MS Azure]<br />
<br />
*[https://www.netio-products.com/en/application-notes/an41-power-monitoring-over-snmp-in-zabbix-nagios-for-netio-power-sockets '''Nagios'' / '''''<nowiki/>''Zabbix'<nowiki/>'']<br />
<br />
*'''[[NodeRED]]''' - several examples<br />
<br />
*[https://www.netio-products.com/en/partners#Paessler%20AG '''PRTG - Paessler''']<br />
<br />
*[https://github.com/pixilab/blocks-script/tree/master/driver PIXILAB Blocks]<br />
<br />
<br />
</div><br />
</div><br />
<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;"><br />
<h2 style="background: #005f41; color: #FFF; margin: 0 0 0 0; padding: 0 1em 0 1em;"> Community </h2><br />
<div style=" display: inline-block; padding: 0 1em 0 1em;text-align: left; vertical-align: top; white-space: normal;"><br />
<br />
===Tools===<br />
[https://github.com/netioproducts NETIO GitHub - official]<br />
<br />
*[https://github.com/netioproducts/PyNetio PyNetio (Python to control NETIOs)]<br />
<br />
*[https://github.com/netioproducts/PyNetioConf PyNetioConf - python library control/manage NETIO devices ]<br />
<br />
*[https://github.com/netioproducts/c-sharp-examples c-sharp-examples]<br />
<br />
*[https://github.com/netioproducts/python-netio-discover python-netio-discover]<br />
<br />
*[https://github.com/netioproducts/php-examples PHP examples]<br />
<br />
*[https://github.com/netioproducts/netio-data-collector NETIO data collector]<br />
<br />
<br />
<br />
[[NETIO UDP Discover]]<br />
<br />
[[NETIO UPnP (Universal Plug and Play)]]<br />
<br />
[https://github.com/Koukaam/netio-utils/tree/master/actions GitHub - obsolete (Koukaam)]<br />
<br />
<br /><br />
<br />
===Integrations by Community===<br />
<br />
*[https://github.com/bitfocus/companion-module-netio-powerbox '''Companion''' module by Bitfocus AS]<br />
<br />
*[https://github.com/elmicro/fhem_netio_4x_pm '''FHEM''' module by Elmicro]<br />
<br />
*[https://grafana.com/grafana/dashboards/12022-netio-power-pdu/ '''Grafana''' dashboard for Prometheus]<br />
<br />
*[https://www.home-assistant.io/components/netio/ '''Home Assistant''']<br />
<br />
<UL><br />
*[https://github.com/jvyoralek/homeassistant-config/tree/master/products/netio HomeAssistant - PowerCable MQTTflex]<br />
<br />
*[[HomeAssistant - PowerCable MQTTflex configuration update]]<br />
<br />
*[https://peyanski.com/netio-powerdin-4pz-and-home-assistant/ PowerDIN 4PZ smart electricity meter and Home Assistant]<br />
<br />
</UL><br />
<br />
<br />
*[https://github.com/VerosK/icinga-check-netio-pdu '''Icinga''']<br />
<br />
*[https://github.com/theone1984/netio-jenkins '''Jenkins''' plugin] <br />
<br />
*[https://www.jam-software.com/serversentinel/online_manual/EN/index.html?actions_netio230bnetworkpowersocket.html '''Jam-software''' - ServerSentinel]<br />
<br />
*[https://github.com/theone1984/netio-jenkins '''Jenkins''' plugin]<br />
<br />
*[https://github.com/stdevel/check_netio '''Nagios plugin''']<br />
<br />
*[https://www.instructables.com/id/How-to-Work-With-JSON-in-Node-RED/ '''NodeRED''' access to NETIO 4All]<br />
<br />
*[https://jirikuba.github.io/NETIO.SpinaniHDO/ '''NETIO controlled by HDO in Lua''']<br />
<br />
*[https://bytehive.gumroad.com/l/playoutbee?layout=profile '''PlayoutBee''' integration]<br />
<br />
*[https://github.com/tomsajan/netio-exporter '''Prometheus''' integration]<br />
<br />
*[https://github.com/st3veV/Netio-OpenHAB '''OpenHAB''' using MQTT]<br />
<br />
*[https://groups.google.com/forum/#!topic/openhab/O6psocjU70s '''OpenHAB''' Reading power consumption - HTTP (NETIO4)]<br />
<br />
*[https://discourse.ros.org/t/netio-ros-interface/20737 '''ROS''' Robot Operating System integration]<br />
<br />
<br /><br />
<br />
===Programming examples===<br />
<br />
*[https://github.com/svartnos/NETIO4-Json-Demo '''C# example''' JSON based device control example]<br />
<br />
*[https://github.com/netioproducts/c-sharp-examples/tree/master/netioControllerXML-Stefano '''M2M XML API integration in C#''']<br />
<br />
*[https://github.com/rynr/netio '''Java Control Library''']<br />
<br />
*[https://github.com/imolein/lua-netio '''LUA control Library''']<br />
<br />
<br /><br />
===Other 3rd party tools===<br />
<br />
*[https://www1.stardraw.com/stardraw2/sd7/features/manufacturer/6f7f9fe5-0026-4922-b15c-d287d3ce3fef '''Stardraw''' Design 7.3]<br />
<br />
<br />
<br />
<br />
</div><br />
</div><br />
<br />
<br />
</div><br />
<br />
<br />
</div><br />
<div style="display: inline-block; padding: 0 1em 0 0; border-right: 0px solid gray; width: 60%; vertical-align: top; white-space: normal;"><br />
<div style="text-align: center; white-space: nowrap;"><br />
<br />
<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;"><br />
<h2 style="background: #005f41; color: #FFF; margin: 0 0 0 0; padding: 0 1em 0 1em;">NETIO Conditions & Rules: Local device scripting</h2><br />
<div style=" display: inline-block; padding: 0 1em 0 1em;text-align: left; vertical-align: top; white-space: normal;"><br />
<br />
<i>These features are available for all NETIO devices except PowerPDU 4C (LUA is supported there)</i>.<br />
<br/><br />
<br />
<br />
[https://wiki.netio-products.com/index.php?title=Rules_Complete_Examples '''CRxx Conditions & Rules - examples''']<br />Check most common practical examples<br />
<br />
===Power Analysis Blocks (PAB)===<br />
*[https://wiki.netio-products.com/index.php?title=PAB '''PAB Description''']<br />
**[https://wiki.netio-products.com/index.php?title=PAB#RANGE '''PAB - RANGE''']<br />
**[https://wiki.netio-products.com/index.php?title=PAB#ZONES '''PAB - ZONES''']<br />
<br /><br />
<br />
===WatchDog (WDT)===<br />
*[https://wiki.netio-products.com/index.php?title=Watchdog '''WatchDog Description''']<br />
<br />
*[https://wiki.netio-products.com/index.php?title=Watchdog_Examples '''WatchDog Examples''']<br />
**One IP address WatchDog<br />
**Multiple IP addresses WatchDog with rules<br />
<br /><br />
<br />
===Rules===<br />
*[https://wiki.netio-products.com/index.php?title=Rules '''Rules Description''']<br />
<br />
</div><br />
</div><br />
<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;"><br />
<h2 style="background: #005f41; color: #FFF; margin: 0 0 0 0; padding: 0 1em 0 1em;"> NETIO Lua Programming </h2><br />
<div style=" display: inline-block; padding: 0 1em 0 1em;text-align: left; vertical-align: top; white-space: normal;"><br />
<br />
<i>Lua is available for PowerPDU 4C device only</i>.<br />
<br />
===Don't know LUA?===<br />
====[https://www.lua.org/pil/contents.html Official Lua tutorial]====<br />
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.<br />
====[https://www.lua.org/manual/5.3/ Official Lua manual]====<br />
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.<br />
<br />
===Lua in NETIO===<br />
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.<br />
====[[Lua basics for other language programmers]]====<br />
A quick jump into NETIO Lua programming if you mastered another programming language. It's simple...<br />
====[[NETIO Lua Tips & Philosophy]]====<br />
Explanation of starting LUA scripts in NETIO devices and some tips how to hack NETIO to doing what you want.<br />
<br />
====[[NETIO Specific Reference manual]]====<br />
If you can already code in Lua, NETIO-specific Lua functions is your main guide to programing NETIO Sockets.<br />
<br />
====[[Examples & Aplication notes]]====<br />
Aplication notes for devices supporting LUA programming. Example configurations downloads and Script programming explanation with direct links to reference<br />
<br />
<br />
<b>[https://www.netio-products.com/en/glossary/m2m-active-client M2M Lua Active Client]</b><br />
<br />
<b>M2M Lua Active Client</b> means = SNMP get/set, HTTP get, MQTT from the custom Lua scripts. <br />
<br />
</div><br />
</div><br />
<br />
<br />
</div><br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
</div><br />
__NOTOC__</div>
Tbezstarosta
https://wiki.netio-products.com/index.php?title=Welcome_to_NETIO_resources_%26_projects_%26_documentation_overview&diff=1057
Welcome to NETIO resources & projects & documentation overview
2025-08-11T10:39:48Z
<p>Tbezstarosta: </p>
<hr />
<div><div style="text-align: center; white-space: nowrap;"><br />
<div style="display: inline-block; padding: 0 0 0 0; border-left: 0px solid gray; width: 40%; vertical-align: top; white-space: normal;"><br />
<div style="text-align: center; white-space: nowrap;"><br />
<br />
<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;"><br />
<h2 style="background: #005f41; color: #FFF; margin: 0 0 0 0; padding: 0 1em 0 1em;">Interoperability</h2><br />
<div style=" display: inline-block; padding: 0 1em 0 1em;text-align: left; vertical-align: top; white-space: normal;"><br />
===NETIO unified Open API===<br />
<br />
*[[JSON API]] (default enabled)<br />
<br />
*[[MQTT-flex]]<br />
<br />
*[[NETIO Cloud API]]<br />
<br />
*[[HTTP(s) Push - JSON/XML]]<br />
<br />
*[[Modbus TCP]]<br />
<br />
*[[SNMP]]<br />
<br />
*[[Telnet/Kshell]]<br />
<br />
*[[URL API]]<br />
<br />
*[[XML API]]<br />
<br />
*[[MQTT]] (PowerPDU 4C)<br />
<br />
*[[SIP]] <br />
<br />
<br /><br />
===NETIO Secure communication=== <br />
*[[HTTPs details]] <br />
<br />
<br /><br />
<br />
===AV drivers for NETIO===<br />
<br />
<br />
*'''[https://www.netio-products.com/en/partners#BrightSign BrightSign]'''<br />
*'''DOMOTZ''' (coming soon)<br />
<br />
*[[ELAN]]<br />
<br />
*[https://www.netio-products.com/en/partners#Crestron '''Crestron''']<br />
<br />
*[https://www.netio-products.com/en/partners#Control%204 '''Control 4''']<br />
<br />
*[https://www.netio-products.com/en/partners#HSYCO '''HSYCO''']<br />
<br />
*[https://www.netio-products.com/en/partners#Neets%20A/S '''Neets''']<br />
<br />
*[https://www.netio-products.com/en/partners#RTI '''RTI''']<br />
<br />
*[https://www.netio-products.com/en/partners#Savant '''SAVANT''']<br />
<br />
<br />
<br /><br />
<br />
===Integrations from NETIO===<br />
<br />
*[https://www.netio-products.com/en/application-notes/an22-abacom-profilab-expert-software-controls-netio-power-sockets-and-reads-measurements '''ABACOM''' ProfiLab-Expert]<br />
<br />
*[https://www.netio-products.com/en/application-notes/an33-domoticz-controls-netio-smart-sockets-http-json Domoticz]<br />
<br />
*'''Domotz''' (coming soon)<br />
<br />
*[https://forum.fibaro.com/topic/53599-quickapp-netio/ '''Fibaro HC3''']<br />
<br />
*[https://www.netio-products.com/en/partners#Grafana '''Grafana''']<br />
<br />
*[[HiveMQ]] (using MQTT-flex)<br />
<br />
*[https://www.netio-products.com/en/application-notes/an53-loxone-controls-netio-power-sockets-with-url-api-or-modbustcp LOXONE]<br />
<br />
*[https://www.netio-products.com/en/application-notes/an26-ms-azure-and-netio-4x-power-metering-and-output-control-from-a-cloud-service MS Azure]<br />
<br />
*[https://www.netio-products.com/en/application-notes/an41-power-monitoring-over-snmp-in-zabbix-nagios-for-netio-power-sockets '''Nagios'' / '''''<nowiki/>''Zabbix'<nowiki/>'']<br />
<br />
*'''[[NodeRED]]''' - several examples<br />
<br />
*[https://www.netio-products.com/en/partners#Paessler%20AG '''PRTG - Paessler''']<br />
<br />
*[https://github.com/pixilab/blocks-script/tree/master/driver PIXILAB Blocks]<br />
<br />
<br />
</div><br />
</div><br />
<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;"><br />
<h2 style="background: #005f41; color: #FFF; margin: 0 0 0 0; padding: 0 1em 0 1em;"> Community </h2><br />
<div style=" display: inline-block; padding: 0 1em 0 1em;text-align: left; vertical-align: top; white-space: normal;"><br />
<br />
===Tools===<br />
[https://github.com/netioproducts NETIO GitHub - official]<br />
<br />
*[https://github.com/netioproducts/PyNetio PyNetio (Python to control NETIOs)]<br />
<br />
*[https://github.com/netioproducts/PyNetioConf PyNetioConf - python library control/manage NETIO devices ]<br />
<br />
*[https://github.com/netioproducts/c-sharp-examples c-sharp-examples]<br />
<br />
*[https://github.com/netioproducts/python-netio-discover python-netio-discover]<br />
<br />
*[https://github.com/netioproducts/php-examples PHP examples]<br />
<br />
*[https://github.com/netioproducts/netio-data-collector NETIO data collector]<br />
<br />
<br />
<br />
[[NETIO UDP Discover]]<br />
<br />
[[NETIO UPnP (Universal Plug and Play)]]<br />
<br />
[https://github.com/Koukaam/netio-utils/tree/master/actions GitHub - obsolete (Koukaam)]<br />
<br />
<br /><br />
<br />
===Integrations by Community===<br />
<br />
*[https://github.com/bitfocus/companion-module-netio-powerbox '''Companion''' module by Bitfocus AS]<br />
<br />
*[https://github.com/elmicro/fhem_netio_4x_pm '''FHEM''' module by Elmicro]<br />
<br />
*[https://grafana.com/grafana/dashboards/12022-netio-power-pdu/ '''Grafana''' dashboard for Prometheus]<br />
<br />
*[https://www.home-assistant.io/components/netio/ '''Home Assistant''']<br />
<br />
<UL><br />
*[https://github.com/jvyoralek/homeassistant-config/tree/master/products/netio HomeAssistant - PowerCable MQTTflex]<br />
<br />
*[[HomeAssistant - PowerCable MQTTflex configuration update]]<br />
<br />
*[https://peyanski.com/netio-powerdin-4pz-and-home-assistant/ PowerDIN 4PZ smart electricity meter and Home Assistant]<br />
<br />
</UL><br />
<br />
<br />
*[https://github.com/VerosK/icinga-check-netio-pdu '''Icinga''']<br />
<br />
*[https://github.com/theone1984/netio-jenkins '''Jenkins''' plugin] <br />
<br />
*[https://www.jam-software.com/serversentinel/online_manual/EN/index.html?actions_netio230bnetworkpowersocket.html '''Jam-software''' - ServerSentinel]<br />
<br />
*[https://github.com/theone1984/netio-jenkins '''Jenkins''' plugin]<br />
<br />
*[https://github.com/stdevel/check_netio '''Nagios plugin''']<br />
<br />
*[https://www.instructables.com/id/How-to-Work-With-JSON-in-Node-RED/ '''NodeRED''' access to NETIO 4All]<br />
<br />
*[https://jirikuba.github.io/NETIO.SpinaniHDO/ '''NETIO controlled by HDO in Lua''']<br />
<br />
*[https://bytehive.gumroad.com/l/playoutbee?layout=profile '''PlayoutBee''' integration]<br />
<br />
*[https://github.com/tomsajan/netio-exporter '''Prometheus''' integration]<br />
<br />
*[https://github.com/st3veV/Netio-OpenHAB '''OpenHAB''' using MQTT]<br />
<br />
*[https://groups.google.com/forum/#!topic/openhab/O6psocjU70s '''OpenHAB''' Reading power consumption - HTTP (NETIO4)]<br />
<br />
*[https://discourse.ros.org/t/netio-ros-interface/20737 '''ROS''' Robot Operating System integration]<br />
<br />
<br /><br />
<br />
===Programming examples===<br />
<br />
*[https://github.com/svartnos/NETIO4-Json-Demo '''C# example''' JSON based device control example]<br />
<br />
*[https://github.com/netioproducts/c-sharp-examples/tree/master/netioControllerXML-Stefano '''M2M XML API integration in C#''']<br />
<br />
*[https://github.com/rynr/netio '''Java Control Library''']<br />
<br />
*[https://github.com/imolein/lua-netio '''LUA control Library''']<br />
<br />
<br /><br />
===Other 3rd party tools===<br />
<br />
*[https://www1.stardraw.com/stardraw2/sd7/features/manufacturer/6f7f9fe5-0026-4922-b15c-d287d3ce3fef '''Stardraw''' Design 7.3]<br />
<br />
<br />
<br />
<br />
</div><br />
</div><br />
<br />
<br />
</div><br />
<br />
<br />
</div><br />
<div style="display: inline-block; padding: 0 1em 0 0; border-right: 0px solid gray; width: 60%; vertical-align: top; white-space: normal;"><br />
<div style="text-align: center; white-space: nowrap;"><br />
<br />
<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;"><br />
<h2 style="background: #005f41; color: #FFF; margin: 0 0 0 0; padding: 0 1em 0 1em;">NETIO Conditions & Rules: Local device scripting</h2><br />
<div style=" display: inline-block; padding: 0 1em 0 1em;text-align: left; vertical-align: top; white-space: normal;"><br />
<br />
<i>These features are available for all NETIO devices except PowerPDU 4C (LUA is supported there)</i>.<br />
<br/><br />
<br />
<br />
[https://wiki.netio-products.com/index.php?title=Rules_Complete_Examples '''CRxx Conditions & Rules - examples''']<br />Check most common practical examples<br />
<br />
===Power Analysis Blocks (PAB)===<br />
*[https://wiki.netio-products.com/index.php?title=PAB '''PAB Description''']<br />
**[https://wiki.netio-products.com/index.php?title=PAB#RANGE '''PAB - RANGE''']<br />
**[https://wiki.netio-products.com/index.php?title=PAB#ZONES '''PAB - ZONES''']<br />
<br /><br />
<br />
===WatchDog (WDT)===<br />
*[https://wiki.netio-products.com/index.php?title=Watchdog '''WatchDog Description''']<br />
<br />
*[https://wiki.netio-products.com/index.php?title=Watchdog_Examples '''WatchDog Examples''']<br />
**One IP address WatchDog<br />
**Multiple IP addresses WatchDog with rules<br />
<br /><br />
<br />
===Rules===<br />
*[https://wiki.netio-products.com/index.php?title=Rules '''Rules Description''']<br />
<br />
</div><br />
</div><br />
<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;"><br />
<h2 style="background: #005f41; color: #FFF; margin: 0 0 0 0; padding: 0 1em 0 1em;"> NETIO Lua Programming </h2><br />
<div style=" display: inline-block; padding: 0 1em 0 1em;text-align: left; vertical-align: top; white-space: normal;"><br />
<br />
<i>Lua is available for PowerPDU 4C device only</i>.<br />
<br />
===Don't know LUA?===<br />
====[https://www.lua.org/pil/contents.html Official Lua tutorial]====<br />
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.<br />
====[https://www.lua.org/manual/5.3/ Official Lua manual]====<br />
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.<br />
<br />
===Lua in NETIO===<br />
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.<br />
====[[Lua basics for other language programmers]]====<br />
A quick jump into NETIO Lua programming if you mastered another programming language. It's simple...<br />
====[[NETIO Lua Tips & Philosophy]]====<br />
Explanation of starting LUA scripts in NETIO devices and some tips how to hack NETIO to doing what you want.<br />
<br />
====[[NETIO Specific Reference manual]]====<br />
If you can already code in Lua, NETIO-specific Lua functions is your main guide to programing NETIO Sockets.<br />
<br />
====[[Examples & Aplication notes]]====<br />
Aplication notes for devices supporting LUA programming. Example configurations downloads and Script programming explanation with direct links to reference<br />
<br />
<br />
<b>[https://www.netio-products.com/en/glossary/m2m-active-client M2M Lua Active Client]</b><br />
<br />
<b>M2M Lua Active Client</b> means = SNMP get/set, HTTP get, MQTT from the custom Lua scripts. <br />
<br />
</div><br />
</div><br />
<br />
<br />
</div><br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
</div><br />
__NOTOC__</div>
Tbezstarosta
https://wiki.netio-products.com/index.php?title=Welcome_to_NETIO_resources_%26_projects_%26_documentation_overview&diff=1056
Welcome to NETIO resources & projects & documentation overview
2025-04-03T07:58:50Z
<p>Tbezstarosta: /* NETIO unified Open API */</p>
<hr />
<div><div style="text-align: center; white-space: nowrap;"><br />
<div style="display: inline-block; padding: 0 0 0 0; border-left: 0px solid gray; width: 40%; vertical-align: top; white-space: normal;"><br />
<div style="text-align: center; white-space: nowrap;"><br />
<br />
<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;"><br />
<h2 style="background: #005f41; color: #FFF; margin: 0 0 0 0; padding: 0 1em 0 1em;">Interoperability</h2><br />
<div style=" display: inline-block; padding: 0 1em 0 1em;text-align: left; vertical-align: top; white-space: normal;"><br />
===NETIO unified Open API===<br />
<br />
*[[JSON API]] (default enabled)<br />
<br />
*[[MQTT-flex]]<br />
<br />
*[[NETIO Cloud API]]<br />
<br />
*[[HTTP(s) Push - JSON/XML]]<br />
<br />
*[[Modbus TCP]]<br />
<br />
*[[SNMP]]<br />
<br />
*[[Telnet/Kshell]]<br />
<br />
*[[URL API]]<br />
<br />
*[[XML API]]<br />
<br />
*[[MQTT]] (PowerPDU 4C)<br />
<br />
*[[SIP]]<br />
<br />
<br />
<br /><br />
<br />
===AV drivers for NETIO===<br />
<br />
<br />
*'''[https://www.netio-products.com/en/partners#BrightSign BrightSign]'''<br />
*'''DOMOTZ''' (coming soon)<br />
<br />
*[[ELAN]]<br />
<br />
*[https://www.netio-products.com/en/partners#Crestron '''Crestron''']<br />
<br />
*[https://www.netio-products.com/en/partners#Control%204 '''Control 4''']<br />
<br />
*[https://www.netio-products.com/en/partners#HSYCO '''HSYCO''']<br />
<br />
*[https://www.netio-products.com/en/partners#Neets%20A/S '''Neets''']<br />
<br />
*[https://www.netio-products.com/en/partners#RTI '''RTI''']<br />
<br />
*[https://www.netio-products.com/en/partners#Savant '''SAVANT''']<br />
<br />
<br />
<br /><br />
<br />
===Integrations from NETIO===<br />
<br />
*[https://www.netio-products.com/en/application-notes/an22-abacom-profilab-expert-software-controls-netio-power-sockets-and-reads-measurements '''ABACOM''' ProfiLab-Expert]<br />
<br />
*[https://www.netio-products.com/en/application-notes/an33-domoticz-controls-netio-smart-sockets-http-json Domoticz]<br />
<br />
*'''Domotz''' (coming soon)<br />
<br />
*[https://forum.fibaro.com/topic/53599-quickapp-netio/ '''Fibaro HC3''']<br />
<br />
*[https://www.netio-products.com/en/partners#Grafana '''Grafana''']<br />
<br />
*[[HiveMQ]] (using MQTT-flex)<br />
<br />
*[https://www.netio-products.com/en/application-notes/an53-loxone-controls-netio-power-sockets-with-url-api-or-modbustcp LOXONE]<br />
<br />
*[https://www.netio-products.com/en/application-notes/an26-ms-azure-and-netio-4x-power-metering-and-output-control-from-a-cloud-service MS Azure]<br />
<br />
*[https://www.netio-products.com/en/application-notes/an41-power-monitoring-over-snmp-in-zabbix-nagios-for-netio-power-sockets '''Nagios'' / '''''<nowiki/>''Zabbix'<nowiki/>'']<br />
<br />
*'''[[NodeRED]]''' - several examples<br />
<br />
*[https://www.netio-products.com/en/partners#Paessler%20AG '''PRTG - Paessler''']<br />
<br />
*[https://github.com/pixilab/blocks-script/tree/master/driver PIXILAB Blocks]<br />
<br />
<br />
</div><br />
</div><br />
<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;"><br />
<h2 style="background: #005f41; color: #FFF; margin: 0 0 0 0; padding: 0 1em 0 1em;"> Community </h2><br />
<div style=" display: inline-block; padding: 0 1em 0 1em;text-align: left; vertical-align: top; white-space: normal;"><br />
<br />
===Tools===<br />
[https://github.com/netioproducts NETIO GitHub - official]<br />
<br />
*[https://github.com/netioproducts/PyNetio PyNetio (Python to control NETIOs)]<br />
<br />
*[https://github.com/netioproducts/PyNetioConf PyNetioConf - python library control/manage NETIO devices ]<br />
<br />
*[https://github.com/netioproducts/c-sharp-examples c-sharp-examples]<br />
<br />
*[https://github.com/netioproducts/python-netio-discover python-netio-discover]<br />
<br />
*[https://github.com/netioproducts/php-examples PHP examples]<br />
<br />
*[https://github.com/netioproducts/netio-data-collector NETIO data collector]<br />
<br />
<br />
<br />
[[NETIO UDP Discover]]<br />
<br />
[[NETIO UPnP (Universal Plug and Play)]]<br />
<br />
[https://github.com/Koukaam/netio-utils/tree/master/actions GitHub - obsolete (Koukaam)]<br />
<br />
<br /><br />
<br />
===Integrations by Community===<br />
<br />
*[https://github.com/bitfocus/companion-module-netio-powerbox '''Companion''' module by Bitfocus AS]<br />
<br />
*[https://github.com/elmicro/fhem_netio_4x_pm '''FHEM''' module by Elmicro]<br />
<br />
*[https://grafana.com/grafana/dashboards/12022-netio-power-pdu/ '''Grafana''' dashboard for Prometheus]<br />
<br />
*[https://www.home-assistant.io/components/netio/ '''Home Assistant''']<br />
<br />
<UL><br />
*[https://github.com/jvyoralek/homeassistant-config/tree/master/products/netio HomeAssistant - PowerCable MQTTflex]<br />
<br />
*[[HomeAssistant - PowerCable MQTTflex configuration update]]<br />
<br />
*[https://peyanski.com/netio-powerdin-4pz-and-home-assistant/ PowerDIN 4PZ smart electricity meter and Home Assistant]<br />
<br />
</UL><br />
<br />
<br />
*[https://github.com/VerosK/icinga-check-netio-pdu '''Icinga''']<br />
<br />
*[https://github.com/theone1984/netio-jenkins '''Jenkins''' plugin] <br />
<br />
*[https://www.jam-software.com/serversentinel/online_manual/EN/index.html?actions_netio230bnetworkpowersocket.html '''Jam-software''' - ServerSentinel]<br />
<br />
*[https://github.com/theone1984/netio-jenkins '''Jenkins''' plugin]<br />
<br />
*[https://github.com/stdevel/check_netio '''Nagios plugin''']<br />
<br />
*[https://www.instructables.com/id/How-to-Work-With-JSON-in-Node-RED/ '''NodeRED''' access to NETIO 4All]<br />
<br />
*[https://jirikuba.github.io/NETIO.SpinaniHDO/ '''NETIO controlled by HDO in Lua''']<br />
<br />
*[https://bytehive.gumroad.com/l/playoutbee?layout=profile '''PlayoutBee''' integration]<br />
<br />
*[https://github.com/tomsajan/netio-exporter '''Prometheus''' integration]<br />
<br />
*[https://github.com/st3veV/Netio-OpenHAB '''OpenHAB''' using MQTT]<br />
<br />
*[https://groups.google.com/forum/#!topic/openhab/O6psocjU70s '''OpenHAB''' Reading power consumption - HTTP (NETIO4)]<br />
<br />
*[https://discourse.ros.org/t/netio-ros-interface/20737 '''ROS''' Robot Operating System integration]<br />
<br />
<br /><br />
<br />
===Programming examples===<br />
<br />
*[https://github.com/svartnos/NETIO4-Json-Demo '''C# example''' JSON based device control example]<br />
<br />
*[https://github.com/netioproducts/c-sharp-examples/tree/master/netioControllerXML-Stefano '''M2M XML API integration in C#''']<br />
<br />
*[https://github.com/rynr/netio '''Java Control Library''']<br />
<br />
*[https://github.com/imolein/lua-netio '''LUA control Library''']<br />
<br />
<br /><br />
===Other 3rd party tools===<br />
<br />
*[https://www1.stardraw.com/stardraw2/sd7/features/manufacturer/6f7f9fe5-0026-4922-b15c-d287d3ce3fef '''Stardraw''' Design 7.3]<br />
<br />
<br />
<br />
<br />
</div><br />
</div><br />
<br />
<br />
</div><br />
<br />
<br />
</div><br />
<div style="display: inline-block; padding: 0 1em 0 0; border-right: 0px solid gray; width: 60%; vertical-align: top; white-space: normal;"><br />
<div style="text-align: center; white-space: nowrap;"><br />
<br />
<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;"><br />
<h2 style="background: #005f41; color: #FFF; margin: 0 0 0 0; padding: 0 1em 0 1em;">NETIO Conditions & Rules: Local device scripting</h2><br />
<div style=" display: inline-block; padding: 0 1em 0 1em;text-align: left; vertical-align: top; white-space: normal;"><br />
<br />
<i>These features are available for all NETIO devices except PowerPDU 4C (LUA is supported there)</i>.<br />
<br/><br />
<br />
<br />
[https://wiki.netio-products.com/index.php?title=Rules_Complete_Examples '''CRxx Conditions & Rules - examples''']<br />Check most common practical examples<br />
<br />
===Power Analysis Blocks (PAB)===<br />
*[https://wiki.netio-products.com/index.php?title=PAB '''PAB Description''']<br />
**[https://wiki.netio-products.com/index.php?title=PAB#RANGE '''PAB - RANGE''']<br />
**[https://wiki.netio-products.com/index.php?title=PAB#ZONES '''PAB - ZONES''']<br />
<br /><br />
<br />
===WatchDog (WDT)===<br />
*[https://wiki.netio-products.com/index.php?title=Watchdog '''WatchDog Description''']<br />
<br />
*[https://wiki.netio-products.com/index.php?title=Watchdog_Examples '''WatchDog Examples''']<br />
**One IP address WatchDog<br />
**Multiple IP addresses WatchDog with rules<br />
<br /><br />
<br />
===Rules===<br />
*[https://wiki.netio-products.com/index.php?title=Rules '''Rules Description''']<br />
<br />
</div><br />
</div><br />
<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;"><br />
<h2 style="background: #005f41; color: #FFF; margin: 0 0 0 0; padding: 0 1em 0 1em;"> NETIO Lua Programming </h2><br />
<div style=" display: inline-block; padding: 0 1em 0 1em;text-align: left; vertical-align: top; white-space: normal;"><br />
<br />
<i>Lua is available for PowerPDU 4C device only</i>.<br />
<br />
===Don't know LUA?===<br />
====[https://www.lua.org/pil/contents.html Official Lua tutorial]====<br />
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.<br />
====[https://www.lua.org/manual/5.3/ Official Lua manual]====<br />
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.<br />
<br />
===Lua in NETIO===<br />
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.<br />
====[[Lua basics for other language programmers]]====<br />
A quick jump into NETIO Lua programming if you mastered another programming language. It's simple...<br />
====[[NETIO Lua Tips & Philosophy]]====<br />
Explanation of starting LUA scripts in NETIO devices and some tips how to hack NETIO to doing what you want.<br />
<br />
====[[NETIO Specific Reference manual]]====<br />
If you can already code in Lua, NETIO-specific Lua functions is your main guide to programing NETIO Sockets.<br />
<br />
====[[Examples & Aplication notes]]====<br />
Aplication notes for devices supporting LUA programming. Example configurations downloads and Script programming explanation with direct links to reference<br />
<br />
<br />
<b>[https://www.netio-products.com/en/glossary/m2m-active-client M2M Lua Active Client]</b><br />
<br />
<b>M2M Lua Active Client</b> means = SNMP get/set, HTTP get, MQTT from the custom Lua scripts. <br />
<br />
</div><br />
</div><br />
<br />
<br />
</div><br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
</div><br />
__NOTOC__</div>
Tbezstarosta
https://wiki.netio-products.com/index.php?title=Welcome_to_NETIO_resources_%26_projects_%26_documentation_overview&diff=1055
Welcome to NETIO resources & projects & documentation overview
2024-12-02T15:09:00Z
<p>Tbezstarosta: /* Tools */</p>
<hr />
<div><div style="text-align: center; white-space: nowrap;"><br />
<div style="display: inline-block; padding: 0 0 0 0; border-left: 0px solid gray; width: 40%; vertical-align: top; white-space: normal;"><br />
<div style="text-align: center; white-space: nowrap;"><br />
<br />
<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;"><br />
<h2 style="background: #005f41; color: #FFF; margin: 0 0 0 0; padding: 0 1em 0 1em;">Interoperability</h2><br />
<div style=" display: inline-block; padding: 0 1em 0 1em;text-align: left; vertical-align: top; white-space: normal;"><br />
===NETIO unified Open API===<br />
<br />
*[[JSON API]] (default enabled)<br />
<br />
*[[MQTT-flex]]<br />
<br />
*[[NETIO Cloud API]]<br />
<br />
<br />
*[[HTTP(s) Push - JSON/XML]]<br />
<br />
*[[Modbus TCP]]<br />
<br />
*[[SNMP]]<br />
<br />
*[[Telnet/Kshell]]<br />
<br />
*[[URL API]]<br />
<br />
*[[XML API]]<br />
<br />
<br />
*[[MQTT]] (PowerPDU 4C)<br />
<br />
*[[SIP]]<br />
<br />
<br />
<br /><br />
<br />
===AV drivers for NETIO===<br />
<br />
<br />
*'''[https://www.netio-products.com/en/partners#BrightSign BrightSign]'''<br />
*'''DOMOTZ''' (coming soon)<br />
<br />
*[[ELAN]]<br />
<br />
*[https://www.netio-products.com/en/partners#Crestron '''Crestron''']<br />
<br />
*[https://www.netio-products.com/en/partners#Control%204 '''Control 4''']<br />
<br />
*[https://www.netio-products.com/en/partners#HSYCO '''HSYCO''']<br />
<br />
*[https://www.netio-products.com/en/partners#Neets%20A/S '''Neets''']<br />
<br />
*[https://www.netio-products.com/en/partners#RTI '''RTI''']<br />
<br />
*[https://www.netio-products.com/en/partners#Savant '''SAVANT''']<br />
<br />
<br />
<br /><br />
<br />
===Integrations from NETIO===<br />
<br />
*[https://www.netio-products.com/en/application-notes/an22-abacom-profilab-expert-software-controls-netio-power-sockets-and-reads-measurements '''ABACOM''' ProfiLab-Expert]<br />
<br />
*[https://www.netio-products.com/en/application-notes/an33-domoticz-controls-netio-smart-sockets-http-json Domoticz]<br />
<br />
*'''Domotz''' (coming soon)<br />
<br />
*[https://forum.fibaro.com/topic/53599-quickapp-netio/ '''Fibaro HC3''']<br />
<br />
*[https://www.netio-products.com/en/partners#Grafana '''Grafana''']<br />
<br />
*[[HiveMQ]] (using MQTT-flex)<br />
<br />
*[https://www.netio-products.com/en/application-notes/an53-loxone-controls-netio-power-sockets-with-url-api-or-modbustcp LOXONE]<br />
<br />
*[https://www.netio-products.com/en/application-notes/an26-ms-azure-and-netio-4x-power-metering-and-output-control-from-a-cloud-service MS Azure]<br />
<br />
*[https://www.netio-products.com/en/application-notes/an41-power-monitoring-over-snmp-in-zabbix-nagios-for-netio-power-sockets '''Nagios'' / '''''<nowiki/>''Zabbix'<nowiki/>'']<br />
<br />
*'''[[NodeRED]]''' - several examples<br />
<br />
*[https://www.netio-products.com/en/partners#Paessler%20AG '''PRTG - Paessler''']<br />
<br />
*[https://github.com/pixilab/blocks-script/tree/master/driver PIXILAB Blocks]<br />
<br />
<br />
</div><br />
</div><br />
<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;"><br />
<h2 style="background: #005f41; color: #FFF; margin: 0 0 0 0; padding: 0 1em 0 1em;"> Community </h2><br />
<div style=" display: inline-block; padding: 0 1em 0 1em;text-align: left; vertical-align: top; white-space: normal;"><br />
<br />
===Tools===<br />
[https://github.com/netioproducts NETIO GitHub - official]<br />
<br />
*[https://github.com/netioproducts/PyNetio PyNetio (Python to control NETIOs)]<br />
<br />
*[https://github.com/netioproducts/PyNetioConf PyNetioConf - python library control/manage NETIO devices ]<br />
<br />
*[https://github.com/netioproducts/c-sharp-examples c-sharp-examples]<br />
<br />
*[https://github.com/netioproducts/python-netio-discover python-netio-discover]<br />
<br />
*[https://github.com/netioproducts/php-examples PHP examples]<br />
<br />
*[https://github.com/netioproducts/netio-data-collector NETIO data collector]<br />
<br />
<br />
<br />
[[NETIO UDP Discover]]<br />
<br />
[[NETIO UPnP (Universal Plug and Play)]]<br />
<br />
[https://github.com/Koukaam/netio-utils/tree/master/actions GitHub - obsolete (Koukaam)]<br />
<br />
<br /><br />
<br />
===Integrations by Community===<br />
<br />
*[https://github.com/bitfocus/companion-module-netio-powerbox '''Companion''' module by Bitfocus AS]<br />
<br />
*[https://github.com/elmicro/fhem_netio_4x_pm '''FHEM''' module by Elmicro]<br />
<br />
*[https://grafana.com/grafana/dashboards/12022-netio-power-pdu/ '''Grafana''' dashboard for Prometheus]<br />
<br />
*[https://www.home-assistant.io/components/netio/ '''Home Assistant''']<br />
<br />
<UL><br />
*[https://github.com/jvyoralek/homeassistant-config/tree/master/products/netio HomeAssistant - PowerCable MQTTflex]<br />
<br />
*[[HomeAssistant - PowerCable MQTTflex configuration update]]<br />
<br />
*[https://peyanski.com/netio-powerdin-4pz-and-home-assistant/ PowerDIN 4PZ smart electricity meter and Home Assistant]<br />
<br />
</UL><br />
<br />
<br />
*[https://github.com/VerosK/icinga-check-netio-pdu '''Icinga''']<br />
<br />
*[https://github.com/theone1984/netio-jenkins '''Jenkins''' plugin] <br />
<br />
*[https://www.jam-software.com/serversentinel/online_manual/EN/index.html?actions_netio230bnetworkpowersocket.html '''Jam-software''' - ServerSentinel]<br />
<br />
*[https://github.com/theone1984/netio-jenkins '''Jenkins''' plugin]<br />
<br />
*[https://github.com/stdevel/check_netio '''Nagios plugin''']<br />
<br />
*[https://www.instructables.com/id/How-to-Work-With-JSON-in-Node-RED/ '''NodeRED''' access to NETIO 4All]<br />
<br />
*[https://jirikuba.github.io/NETIO.SpinaniHDO/ '''NETIO controlled by HDO in Lua''']<br />
<br />
*[https://bytehive.gumroad.com/l/playoutbee?layout=profile '''PlayoutBee''' integration]<br />
<br />
*[https://github.com/tomsajan/netio-exporter '''Prometheus''' integration]<br />
<br />
*[https://github.com/st3veV/Netio-OpenHAB '''OpenHAB''' using MQTT]<br />
<br />
*[https://groups.google.com/forum/#!topic/openhab/O6psocjU70s '''OpenHAB''' Reading power consumption - HTTP (NETIO4)]<br />
<br />
*[https://discourse.ros.org/t/netio-ros-interface/20737 '''ROS''' Robot Operating System integration]<br />
<br />
<br /><br />
<br />
===Programming examples===<br />
<br />
*[https://github.com/svartnos/NETIO4-Json-Demo '''C# example''' JSON based device control example]<br />
<br />
*[https://github.com/netioproducts/c-sharp-examples/tree/master/netioControllerXML-Stefano '''M2M XML API integration in C#''']<br />
<br />
*[https://github.com/rynr/netio '''Java Control Library''']<br />
<br />
*[https://github.com/imolein/lua-netio '''LUA control Library''']<br />
<br />
<br /><br />
===Other 3rd party tools===<br />
<br />
*[https://www1.stardraw.com/stardraw2/sd7/features/manufacturer/6f7f9fe5-0026-4922-b15c-d287d3ce3fef '''Stardraw''' Design 7.3]<br />
<br />
<br />
<br />
<br />
</div><br />
</div><br />
<br />
<br />
</div><br />
<br />
<br />
</div><br />
<div style="display: inline-block; padding: 0 1em 0 0; border-right: 0px solid gray; width: 60%; vertical-align: top; white-space: normal;"><br />
<div style="text-align: center; white-space: nowrap;"><br />
<br />
<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;"><br />
<h2 style="background: #005f41; color: #FFF; margin: 0 0 0 0; padding: 0 1em 0 1em;">NETIO Conditions & Rules: Local device scripting</h2><br />
<div style=" display: inline-block; padding: 0 1em 0 1em;text-align: left; vertical-align: top; white-space: normal;"><br />
<br />
<i>These features are available for all NETIO devices except PowerPDU 4C (LUA is supported there)</i>.<br />
<br/><br />
<br />
<br />
[https://wiki.netio-products.com/index.php?title=Rules_Complete_Examples '''CRxx Conditions & Rules - examples''']<br />Check most common practical examples<br />
<br />
===Power Analysis Blocks (PAB)===<br />
*[https://wiki.netio-products.com/index.php?title=PAB '''PAB Description''']<br />
**[https://wiki.netio-products.com/index.php?title=PAB#RANGE '''PAB - RANGE''']<br />
**[https://wiki.netio-products.com/index.php?title=PAB#ZONES '''PAB - ZONES''']<br />
<br /><br />
<br />
===WatchDog (WDT)===<br />
*[https://wiki.netio-products.com/index.php?title=Watchdog '''WatchDog Description''']<br />
<br />
*[https://wiki.netio-products.com/index.php?title=Watchdog_Examples '''WatchDog Examples''']<br />
**One IP address WatchDog<br />
**Multiple IP addresses WatchDog with rules<br />
<br /><br />
<br />
===Rules===<br />
*[https://wiki.netio-products.com/index.php?title=Rules '''Rules Description''']<br />
<br />
</div><br />
</div><br />
<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;"><br />
<h2 style="background: #005f41; color: #FFF; margin: 0 0 0 0; padding: 0 1em 0 1em;"> NETIO Lua Programming </h2><br />
<div style=" display: inline-block; padding: 0 1em 0 1em;text-align: left; vertical-align: top; white-space: normal;"><br />
<br />
<i>Lua is available for PowerPDU 4C device only</i>.<br />
<br />
===Don't know LUA?===<br />
====[https://www.lua.org/pil/contents.html Official Lua tutorial]====<br />
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.<br />
====[https://www.lua.org/manual/5.3/ Official Lua manual]====<br />
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.<br />
<br />
===Lua in NETIO===<br />
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.<br />
====[[Lua basics for other language programmers]]====<br />
A quick jump into NETIO Lua programming if you mastered another programming language. It's simple...<br />
====[[NETIO Lua Tips & Philosophy]]====<br />
Explanation of starting LUA scripts in NETIO devices and some tips how to hack NETIO to doing what you want.<br />
<br />
====[[NETIO Specific Reference manual]]====<br />
If you can already code in Lua, NETIO-specific Lua functions is your main guide to programing NETIO Sockets.<br />
<br />
====[[Examples & Aplication notes]]====<br />
Aplication notes for devices supporting LUA programming. Example configurations downloads and Script programming explanation with direct links to reference<br />
<br />
<br />
<b>[https://www.netio-products.com/en/glossary/m2m-active-client M2M Lua Active Client]</b><br />
<br />
<b>M2M Lua Active Client</b> means = SNMP get/set, HTTP get, MQTT from the custom Lua scripts. <br />
<br />
</div><br />
</div><br />
<br />
<br />
</div><br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
</div><br />
__NOTOC__</div>
Tbezstarosta
https://wiki.netio-products.com/index.php?title=Welcome_to_NETIO_resources_%26_projects_%26_documentation_overview&diff=1054
Welcome to NETIO resources & projects & documentation overview
2024-12-02T15:06:49Z
<p>Tbezstarosta: /* Tools */</p>
<hr />
<div><div style="text-align: center; white-space: nowrap;"><br />
<div style="display: inline-block; padding: 0 0 0 0; border-left: 0px solid gray; width: 40%; vertical-align: top; white-space: normal;"><br />
<div style="text-align: center; white-space: nowrap;"><br />
<br />
<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;"><br />
<h2 style="background: #005f41; color: #FFF; margin: 0 0 0 0; padding: 0 1em 0 1em;">Interoperability</h2><br />
<div style=" display: inline-block; padding: 0 1em 0 1em;text-align: left; vertical-align: top; white-space: normal;"><br />
===NETIO unified Open API===<br />
<br />
*[[JSON API]] (default enabled)<br />
<br />
*[[MQTT-flex]]<br />
<br />
*[[NETIO Cloud API]]<br />
<br />
<br />
*[[HTTP(s) Push - JSON/XML]]<br />
<br />
*[[Modbus TCP]]<br />
<br />
*[[SNMP]]<br />
<br />
*[[Telnet/Kshell]]<br />
<br />
*[[URL API]]<br />
<br />
*[[XML API]]<br />
<br />
<br />
*[[MQTT]] (PowerPDU 4C)<br />
<br />
*[[SIP]]<br />
<br />
<br />
<br /><br />
<br />
===AV drivers for NETIO===<br />
<br />
<br />
*'''[https://www.netio-products.com/en/partners#BrightSign BrightSign]'''<br />
*'''DOMOTZ''' (coming soon)<br />
<br />
*[[ELAN]]<br />
<br />
*[https://www.netio-products.com/en/partners#Crestron '''Crestron''']<br />
<br />
*[https://www.netio-products.com/en/partners#Control%204 '''Control 4''']<br />
<br />
*[https://www.netio-products.com/en/partners#HSYCO '''HSYCO''']<br />
<br />
*[https://www.netio-products.com/en/partners#Neets%20A/S '''Neets''']<br />
<br />
*[https://www.netio-products.com/en/partners#RTI '''RTI''']<br />
<br />
*[https://www.netio-products.com/en/partners#Savant '''SAVANT''']<br />
<br />
<br />
<br /><br />
<br />
===Integrations from NETIO===<br />
<br />
*[https://www.netio-products.com/en/application-notes/an22-abacom-profilab-expert-software-controls-netio-power-sockets-and-reads-measurements '''ABACOM''' ProfiLab-Expert]<br />
<br />
*[https://www.netio-products.com/en/application-notes/an33-domoticz-controls-netio-smart-sockets-http-json Domoticz]<br />
<br />
*'''Domotz''' (coming soon)<br />
<br />
*[https://forum.fibaro.com/topic/53599-quickapp-netio/ '''Fibaro HC3''']<br />
<br />
*[https://www.netio-products.com/en/partners#Grafana '''Grafana''']<br />
<br />
*[[HiveMQ]] (using MQTT-flex)<br />
<br />
*[https://www.netio-products.com/en/application-notes/an53-loxone-controls-netio-power-sockets-with-url-api-or-modbustcp LOXONE]<br />
<br />
*[https://www.netio-products.com/en/application-notes/an26-ms-azure-and-netio-4x-power-metering-and-output-control-from-a-cloud-service MS Azure]<br />
<br />
*[https://www.netio-products.com/en/application-notes/an41-power-monitoring-over-snmp-in-zabbix-nagios-for-netio-power-sockets '''Nagios'' / '''''<nowiki/>''Zabbix'<nowiki/>'']<br />
<br />
*'''[[NodeRED]]''' - several examples<br />
<br />
*[https://www.netio-products.com/en/partners#Paessler%20AG '''PRTG - Paessler''']<br />
<br />
*[https://github.com/pixilab/blocks-script/tree/master/driver PIXILAB Blocks]<br />
<br />
<br />
</div><br />
</div><br />
<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;"><br />
<h2 style="background: #005f41; color: #FFF; margin: 0 0 0 0; padding: 0 1em 0 1em;"> Community </h2><br />
<div style=" display: inline-block; padding: 0 1em 0 1em;text-align: left; vertical-align: top; white-space: normal;"><br />
<br />
===Tools===<br />
[https://github.com/netioproducts NETIO GitHub - official]<br />
<br />
*[https://github.com/netioproducts/PyNetio PyNetio (Python to control NETIOs)]<br />
<br />
*[https://github.com/netioproducts/PyNetioConf] PyNetioConf - python library control/manage NETIO devices <br />
<br />
*[https://github.com/netioproducts/c-sharp-examples c-sharp-examples]<br />
<br />
*[https://github.com/netioproducts/python-netio-discover python-netio-discover]<br />
<br />
*[https://github.com/netioproducts/php-examples PHP examples]<br />
<br />
*[https://github.com/netioproducts/netio-data-collector NETIO data collector]<br />
<br />
<br />
<br />
[[NETIO UDP Discover]]<br />
<br />
[[NETIO UPnP (Universal Plug and Play)]]<br />
<br />
[https://github.com/Koukaam/netio-utils/tree/master/actions GitHub - obsolete (Koukaam)]<br />
<br />
<br /><br />
<br />
===Integrations by Community===<br />
<br />
*[https://github.com/bitfocus/companion-module-netio-powerbox '''Companion''' module by Bitfocus AS]<br />
<br />
*[https://github.com/elmicro/fhem_netio_4x_pm '''FHEM''' module by Elmicro]<br />
<br />
*[https://grafana.com/grafana/dashboards/12022-netio-power-pdu/ '''Grafana''' dashboard for Prometheus]<br />
<br />
*[https://www.home-assistant.io/components/netio/ '''Home Assistant''']<br />
<br />
<UL><br />
*[https://github.com/jvyoralek/homeassistant-config/tree/master/products/netio HomeAssistant - PowerCable MQTTflex]<br />
<br />
*[[HomeAssistant - PowerCable MQTTflex configuration update]]<br />
<br />
*[https://peyanski.com/netio-powerdin-4pz-and-home-assistant/ PowerDIN 4PZ smart electricity meter and Home Assistant]<br />
<br />
</UL><br />
<br />
<br />
*[https://github.com/VerosK/icinga-check-netio-pdu '''Icinga''']<br />
<br />
*[https://github.com/theone1984/netio-jenkins '''Jenkins''' plugin] <br />
<br />
*[https://www.jam-software.com/serversentinel/online_manual/EN/index.html?actions_netio230bnetworkpowersocket.html '''Jam-software''' - ServerSentinel]<br />
<br />
*[https://github.com/theone1984/netio-jenkins '''Jenkins''' plugin]<br />
<br />
*[https://github.com/stdevel/check_netio '''Nagios plugin''']<br />
<br />
*[https://www.instructables.com/id/How-to-Work-With-JSON-in-Node-RED/ '''NodeRED''' access to NETIO 4All]<br />
<br />
*[https://jirikuba.github.io/NETIO.SpinaniHDO/ '''NETIO controlled by HDO in Lua''']<br />
<br />
*[https://bytehive.gumroad.com/l/playoutbee?layout=profile '''PlayoutBee''' integration]<br />
<br />
*[https://github.com/tomsajan/netio-exporter '''Prometheus''' integration]<br />
<br />
*[https://github.com/st3veV/Netio-OpenHAB '''OpenHAB''' using MQTT]<br />
<br />
*[https://groups.google.com/forum/#!topic/openhab/O6psocjU70s '''OpenHAB''' Reading power consumption - HTTP (NETIO4)]<br />
<br />
*[https://discourse.ros.org/t/netio-ros-interface/20737 '''ROS''' Robot Operating System integration]<br />
<br />
<br /><br />
<br />
===Programming examples===<br />
<br />
*[https://github.com/svartnos/NETIO4-Json-Demo '''C# example''' JSON based device control example]<br />
<br />
*[https://github.com/netioproducts/c-sharp-examples/tree/master/netioControllerXML-Stefano '''M2M XML API integration in C#''']<br />
<br />
*[https://github.com/rynr/netio '''Java Control Library''']<br />
<br />
*[https://github.com/imolein/lua-netio '''LUA control Library''']<br />
<br />
<br /><br />
===Other 3rd party tools===<br />
<br />
*[https://www1.stardraw.com/stardraw2/sd7/features/manufacturer/6f7f9fe5-0026-4922-b15c-d287d3ce3fef '''Stardraw''' Design 7.3]<br />
<br />
<br />
<br />
<br />
</div><br />
</div><br />
<br />
<br />
</div><br />
<br />
<br />
</div><br />
<div style="display: inline-block; padding: 0 1em 0 0; border-right: 0px solid gray; width: 60%; vertical-align: top; white-space: normal;"><br />
<div style="text-align: center; white-space: nowrap;"><br />
<br />
<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;"><br />
<h2 style="background: #005f41; color: #FFF; margin: 0 0 0 0; padding: 0 1em 0 1em;">NETIO Conditions & Rules: Local device scripting</h2><br />
<div style=" display: inline-block; padding: 0 1em 0 1em;text-align: left; vertical-align: top; white-space: normal;"><br />
<br />
<i>These features are available for all NETIO devices except PowerPDU 4C (LUA is supported there)</i>.<br />
<br/><br />
<br />
<br />
[https://wiki.netio-products.com/index.php?title=Rules_Complete_Examples '''CRxx Conditions & Rules - examples''']<br />Check most common practical examples<br />
<br />
===Power Analysis Blocks (PAB)===<br />
*[https://wiki.netio-products.com/index.php?title=PAB '''PAB Description''']<br />
**[https://wiki.netio-products.com/index.php?title=PAB#RANGE '''PAB - RANGE''']<br />
**[https://wiki.netio-products.com/index.php?title=PAB#ZONES '''PAB - ZONES''']<br />
<br /><br />
<br />
===WatchDog (WDT)===<br />
*[https://wiki.netio-products.com/index.php?title=Watchdog '''WatchDog Description''']<br />
<br />
*[https://wiki.netio-products.com/index.php?title=Watchdog_Examples '''WatchDog Examples''']<br />
**One IP address WatchDog<br />
**Multiple IP addresses WatchDog with rules<br />
<br /><br />
<br />
===Rules===<br />
*[https://wiki.netio-products.com/index.php?title=Rules '''Rules Description''']<br />
<br />
</div><br />
</div><br />
<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;"><br />
<h2 style="background: #005f41; color: #FFF; margin: 0 0 0 0; padding: 0 1em 0 1em;"> NETIO Lua Programming </h2><br />
<div style=" display: inline-block; padding: 0 1em 0 1em;text-align: left; vertical-align: top; white-space: normal;"><br />
<br />
<i>Lua is available for PowerPDU 4C device only</i>.<br />
<br />
===Don't know LUA?===<br />
====[https://www.lua.org/pil/contents.html Official Lua tutorial]====<br />
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.<br />
====[https://www.lua.org/manual/5.3/ Official Lua manual]====<br />
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.<br />
<br />
===Lua in NETIO===<br />
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.<br />
====[[Lua basics for other language programmers]]====<br />
A quick jump into NETIO Lua programming if you mastered another programming language. It's simple...<br />
====[[NETIO Lua Tips & Philosophy]]====<br />
Explanation of starting LUA scripts in NETIO devices and some tips how to hack NETIO to doing what you want.<br />
<br />
====[[NETIO Specific Reference manual]]====<br />
If you can already code in Lua, NETIO-specific Lua functions is your main guide to programing NETIO Sockets.<br />
<br />
====[[Examples & Aplication notes]]====<br />
Aplication notes for devices supporting LUA programming. Example configurations downloads and Script programming explanation with direct links to reference<br />
<br />
<br />
<b>[https://www.netio-products.com/en/glossary/m2m-active-client M2M Lua Active Client]</b><br />
<br />
<b>M2M Lua Active Client</b> means = SNMP get/set, HTTP get, MQTT from the custom Lua scripts. <br />
<br />
</div><br />
</div><br />
<br />
<br />
</div><br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
</div><br />
__NOTOC__</div>
Tbezstarosta
https://wiki.netio-products.com/index.php?title=PAB&diff=1053
PAB
2024-07-29T08:42:15Z
<p>Tbezstarosta: /* Structure */</p>
<hr />
<div>The PAB (Power Analysis Block) is set of Condition & Rules (CR). It's set of most common functions available for NETIO devices. Based on each '''Condition''', subsequent [https://wiki.netio-products.com/index.php?title=Rules '''Rules'''] can be executed. <br />
User friendly examples are prepared as [https://wiki.netio-products.com/index.php?title=Rules_Complete_Examples '''CRxx Conditions & Rules - examples''']<br />
<br />
<br />
The '''Rules''' can be triggered based on a '''Condition''' - analysis of the state of one or more variables:<br />
* Current [mA]<br />
* Energy [Wh]<br />
* Load [W]<br />
* Power Factor<br />
* S0 pulses<br />
* TEMP [°C], [°F] - available from FW 5.0.3+<br />
<br />
Rules can then perform several actions described in section [https://wiki.netio-products.com/index.php?title=Rules '''Rules''']. <br />
Every PAB is internally evaluated as having a discrete state which can be used as an input to a Rule mentioned above. State value is different for each type of PAB (described below). This state is also available in JSON protocol and therefore can be read externally.<br />
<br />
There are two types of PABs available: '''RANGE''' & '''ZONES'''. Each type has different states and configuration options.<br />
<br />
<br />
= RANGE =<br />
True/False-based evaluation. Detects whether a monitored value lies in specified interval (range) for a period of time. PAB evaluates to <code>TRUE</code> or <code>FALSE</code>.<br />
Interval is specified by lower <code>lowerBound</code> and upper <code>upperBound</code> boundaries. PAB evaluates to <code>TRUE</code> if a variable defined in <code>source</code> lies within for a period of time defined in <code>timeHysteresis</code>.<br />
<br />
== Configuration Structure ==<br />
{| class="wikitable"<br />
|-<br />
! Variable<br />
! Value<br />
! Description <br />
|-<br />
| type <br />
| RANGE <br />
| PAB type<br />
|-<br />
| source <br />
| OUTPUTS/'''x'''/(LOAD/CURRENT/POWER/TEMP)<br />
| The monitored variable. '''x''' indicates input / output number.<br />
|-<br />
| timeHysteresis <br />
| int <br />
| [s] Monitored value must be present in defined interval for amount of time defined here.<br />
<br />
Eg: If the time hysteresis is equal to 5, monitored value must be within a defined interval for at least 5s. Only then it will be evaluated.<br />
|-<br />
| lowerBound <br />
| int <br />
| lower bound of the monitored value <br />
|-<br />
| upperBound <br />
| int <br />
| upper bound of the monitored value <br />
|}<br />
<br />
== Examples ==<br />
<br />
=== Immediate evaluation ===<br />
PAB evaluates to <code>TRUE</code> immediately as Output 1 '''Current''' value appears '''between 100 and 200 mA'''<br />
<nowiki><br />
{<br />
"type": "RANGE",<br />
"source": "OUTPUTS/1/CURRENT",<br />
"lowerBound": 100,<br />
"upperBound": 200,<br />
"timeHysteresis": 0<br />
}</nowiki><br />
<br />
=== Evaluation with delay ===<br />
PAB evaluates to <code>TRUE</code> when Output 1 '''Load''' is '''between 200 and 300 Watts for 5s'''.<br />
<br />
<nowiki><br />
{<br />
"type": "RANGE",<br />
"source": "OUTPUTS/1/CURRENT",<br />
"lowerBound": 200,<br />
"upperBound": 300,<br />
"timeHysteresis": 5<br />
}</nowiki><br />
<br />
= ZONES =<br />
Opposed from a previous type, ZONE-type PAB detects, whether a monitored variable finds itself in a specified zone. State of PAB indicates what zone number (index) is the measured variable currently in. Zones are defined by their <code>thresholds</code> (lower bounds) and there must be at least one threshold specified.<br />
Monitored value must be present in a defined interval for period of time defined in <code>timeHysteresis</code>.<br />
<br />
== Structure ==<br />
{| class="wikitable"<br />
|-<br />
! Variable<br />
! Value<br />
! Description <br />
|-<br />
| type <br />
| ZONES<br />
| PAB type<br />
|-<br />
| source <br />
| OUTPUTS/'''x'''/(LOAD/CURRENT/POWER/TEMP)<br />
| The monitored variable. '''x''' indicates input / output number.<br />
|-<br />
| timeHysteresis <br />
| int <br />
| '''[s]''' Monitored value must be present in defined interval for amount of time defined here.<br />
<br />
Eg: If the time hysteresis is equal to 5, monitored value must be within a defined interval for at least 5s. Only then it will be evaluated.<br />
|-<br />
| thresholds<br />
| list of integers <br />
| lower-bounds of individual zones intervals<br />
|}<br />
<br />
== Examples ==<br />
<br />
PAB is evaluated according to the specified zones when the Output 2 '''Current''' value is in one of the zones for 10s.<br />
Zone numbers are as following:<br />
* '''0''': 0 - 49 mA<br />
* '''1''': 50 - 99 mA<br />
* '''2''': 100 - 149 mA<br />
* '''3''': 150 - 199 mA<br />
* '''4''': 200+ mA<br />
<br />
Eg: If the Current value is 130mA for at least 10s, PAB is evaluated as 2.<br />
<br />
<nowiki><br />
{<br />
"type": "ZONES",<br />
"source": "OUTPUTS/2/CURRENT",<br />
"thresholds": [<br />
50,<br />
100,<br />
150,<br />
200<br />
],<br />
"timeHysteresis": 10<br />
}</nowiki><br />
<br />
= DAYLIGHT (sunrise / sunset) <sup><code>FW 4.0.0+</code></sup> =<br />
Enables launching actions based on sunrise / sunset of current place.<br />
<br />
== Structure ==<br />
{| class="wikitable"<br />
|-<br />
! Variable<br />
! Value<br />
! Description <br />
|-<br />
| type<br />
| DAYLIGHT<br />
| PAB type<br />
|-<br />
| longitude<br />
| str "14.4129433E" OR int -73.8390597<br />
| East/West coordinates<br />
|-<br />
| latitude<br />
| str "50.0058144N" OR int -16.5237353<br />
| North/South coordinates<br />
|-<br />
| altitude<br />
| Number of meters above sea level<br />
| 8848<br />
|-<br />
| sunriseDelay<br />
| int [min]<br />
| Delay of PAB activation/deactivation to sunrise<br />
|-<br />
| sunsetDelay<br />
| int [min] <br />
| Delay of PAB activation/deactivation to sunset<br />
|}<br />
<br />
== Examples ==<br />
<br />
=== PAB ===<br />
<br />
<nowiki><br />
{<br />
"type": "DAYLIGHT",<br />
"longitude": "14.4129433E",<br />
"latitude": "50.0058144N",<br />
"altitude": 247,<br />
"sunriseDelay": 240,<br />
"sunsetDelay": -180<br />
}<br />
</nowiki><br />
<br />
or<br />
<br />
<nowiki><br />
{<br />
"type": "DAYLIGHT",<br />
"longitude": -16.5237353,<br />
"latitude": 28.4162475,<br />
"altitude": 247,<br />
"sunriseDelay": 240,<br />
"sunsetDelay": -180<br />
}<br />
</nowiki></div>
Tbezstarosta
https://wiki.netio-products.com/index.php?title=PAB&diff=1052
PAB
2024-07-29T08:41:37Z
<p>Tbezstarosta: /* Configuration Structure */</p>
<hr />
<div>The PAB (Power Analysis Block) is set of Condition & Rules (CR). It's set of most common functions available for NETIO devices. Based on each '''Condition''', subsequent [https://wiki.netio-products.com/index.php?title=Rules '''Rules'''] can be executed. <br />
User friendly examples are prepared as [https://wiki.netio-products.com/index.php?title=Rules_Complete_Examples '''CRxx Conditions & Rules - examples''']<br />
<br />
<br />
The '''Rules''' can be triggered based on a '''Condition''' - analysis of the state of one or more variables:<br />
* Current [mA]<br />
* Energy [Wh]<br />
* Load [W]<br />
* Power Factor<br />
* S0 pulses<br />
* TEMP [°C], [°F] - available from FW 5.0.3+<br />
<br />
Rules can then perform several actions described in section [https://wiki.netio-products.com/index.php?title=Rules '''Rules''']. <br />
Every PAB is internally evaluated as having a discrete state which can be used as an input to a Rule mentioned above. State value is different for each type of PAB (described below). This state is also available in JSON protocol and therefore can be read externally.<br />
<br />
There are two types of PABs available: '''RANGE''' & '''ZONES'''. Each type has different states and configuration options.<br />
<br />
<br />
= RANGE =<br />
True/False-based evaluation. Detects whether a monitored value lies in specified interval (range) for a period of time. PAB evaluates to <code>TRUE</code> or <code>FALSE</code>.<br />
Interval is specified by lower <code>lowerBound</code> and upper <code>upperBound</code> boundaries. PAB evaluates to <code>TRUE</code> if a variable defined in <code>source</code> lies within for a period of time defined in <code>timeHysteresis</code>.<br />
<br />
== Configuration Structure ==<br />
{| class="wikitable"<br />
|-<br />
! Variable<br />
! Value<br />
! Description <br />
|-<br />
| type <br />
| RANGE <br />
| PAB type<br />
|-<br />
| source <br />
| OUTPUTS/'''x'''/(LOAD/CURRENT/POWER/TEMP)<br />
| The monitored variable. '''x''' indicates input / output number.<br />
|-<br />
| timeHysteresis <br />
| int <br />
| [s] Monitored value must be present in defined interval for amount of time defined here.<br />
<br />
Eg: If the time hysteresis is equal to 5, monitored value must be within a defined interval for at least 5s. Only then it will be evaluated.<br />
|-<br />
| lowerBound <br />
| int <br />
| lower bound of the monitored value <br />
|-<br />
| upperBound <br />
| int <br />
| upper bound of the monitored value <br />
|}<br />
<br />
== Examples ==<br />
<br />
=== Immediate evaluation ===<br />
PAB evaluates to <code>TRUE</code> immediately as Output 1 '''Current''' value appears '''between 100 and 200 mA'''<br />
<nowiki><br />
{<br />
"type": "RANGE",<br />
"source": "OUTPUTS/1/CURRENT",<br />
"lowerBound": 100,<br />
"upperBound": 200,<br />
"timeHysteresis": 0<br />
}</nowiki><br />
<br />
=== Evaluation with delay ===<br />
PAB evaluates to <code>TRUE</code> when Output 1 '''Load''' is '''between 200 and 300 Watts for 5s'''.<br />
<br />
<nowiki><br />
{<br />
"type": "RANGE",<br />
"source": "OUTPUTS/1/CURRENT",<br />
"lowerBound": 200,<br />
"upperBound": 300,<br />
"timeHysteresis": 5<br />
}</nowiki><br />
<br />
= ZONES =<br />
Opposed from a previous type, ZONE-type PAB detects, whether a monitored variable finds itself in a specified zone. State of PAB indicates what zone number (index) is the measured variable currently in. Zones are defined by their <code>thresholds</code> (lower bounds) and there must be at least one threshold specified.<br />
Monitored value must be present in a defined interval for period of time defined in <code>timeHysteresis</code>.<br />
<br />
== Structure ==<br />
{| class="wikitable"<br />
|-<br />
! Variable<br />
! Value<br />
! Description <br />
|-<br />
| type <br />
| ZONES<br />
| PAB type<br />
|-<br />
| source <br />
| OUTPUTS/'''x'''/(LOAD/CURRENT/POWER)<br />
| The monitored variable. '''x''' indicates input / output number.<br />
|-<br />
| timeHysteresis <br />
| int <br />
| '''[s]''' Monitored value must be present in defined interval for amount of time defined here.<br />
<br />
Eg: If the time hysteresis is equal to 5, monitored value must be within a defined interval for at least 5s. Only then it will be evaluated.<br />
|-<br />
| thresholds<br />
| list of integers <br />
| lower-bounds of individual zones intervals<br />
|}<br />
<br />
== Examples ==<br />
<br />
PAB is evaluated according to the specified zones when the Output 2 '''Current''' value is in one of the zones for 10s.<br />
Zone numbers are as following:<br />
* '''0''': 0 - 49 mA<br />
* '''1''': 50 - 99 mA<br />
* '''2''': 100 - 149 mA<br />
* '''3''': 150 - 199 mA<br />
* '''4''': 200+ mA<br />
<br />
Eg: If the Current value is 130mA for at least 10s, PAB is evaluated as 2.<br />
<br />
<nowiki><br />
{<br />
"type": "ZONES",<br />
"source": "OUTPUTS/2/CURRENT",<br />
"thresholds": [<br />
50,<br />
100,<br />
150,<br />
200<br />
],<br />
"timeHysteresis": 10<br />
}</nowiki><br />
<br />
= DAYLIGHT (sunrise / sunset) <sup><code>FW 4.0.0+</code></sup> =<br />
Enables launching actions based on sunrise / sunset of current place.<br />
<br />
== Structure ==<br />
{| class="wikitable"<br />
|-<br />
! Variable<br />
! Value<br />
! Description <br />
|-<br />
| type<br />
| DAYLIGHT<br />
| PAB type<br />
|-<br />
| longitude<br />
| str "14.4129433E" OR int -73.8390597<br />
| East/West coordinates<br />
|-<br />
| latitude<br />
| str "50.0058144N" OR int -16.5237353<br />
| North/South coordinates<br />
|-<br />
| altitude<br />
| Number of meters above sea level<br />
| 8848<br />
|-<br />
| sunriseDelay<br />
| int [min]<br />
| Delay of PAB activation/deactivation to sunrise<br />
|-<br />
| sunsetDelay<br />
| int [min] <br />
| Delay of PAB activation/deactivation to sunset<br />
|}<br />
<br />
== Examples ==<br />
<br />
=== PAB ===<br />
<br />
<nowiki><br />
{<br />
"type": "DAYLIGHT",<br />
"longitude": "14.4129433E",<br />
"latitude": "50.0058144N",<br />
"altitude": 247,<br />
"sunriseDelay": 240,<br />
"sunsetDelay": -180<br />
}<br />
</nowiki><br />
<br />
or<br />
<br />
<nowiki><br />
{<br />
"type": "DAYLIGHT",<br />
"longitude": -16.5237353,<br />
"latitude": 28.4162475,<br />
"altitude": 247,<br />
"sunriseDelay": 240,<br />
"sunsetDelay": -180<br />
}<br />
</nowiki></div>
Tbezstarosta
https://wiki.netio-products.com/index.php?title=Rules_Complete_Examples&diff=1051
Rules Complete Examples
2024-07-29T07:18:33Z
<p>Tbezstarosta: /* Temperature out of limit - Output1 ON */</p>
<hr />
<div>The concept of NETIO Conditions (PAB & WatchDog) & Rules is a set of prepared detections (Conditions) and Rules that act upon them. They are implemented directly in NETIO PDU devices. <br />
<br />
== CR01 - WatchDog (ping) to 1 IP address | default in FW 3.2.3 ==<br />
The WatchDog functionality is used to monitor connectivity to specified IP address (or URL) by sending PING request to it.<br />
<br />
The ping in this example is sent every 60s and waits 5s for the device to respond. If the ping fails, Watchdog returns <code>false</code> and restarts (ACTION: 2 = SHORT OFF) device connected to first output. After restart, it waits 120 seconds and starts monitoring again. If the device does not respond, WatchDog remains in ERROR state until next successful ping.<br />
<br />
===WatchDog definition===<br />
<br />
WatchDog name: '''CR01_WDT'''<br />
<br />
<nowiki><br />
{<br />
"target": "192.168.1.5",<br />
"pingInterval": 60,<br />
"timeout": 5,<br />
"maxTimeouts": 0,<br />
"timeToReboot": 120,<br />
"maxRestarts": -1<br />
}</nowiki><br />
<br />
===Rule definition===<br />
<br />
Rule name: '''CR01_RULE'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"WDT/CR01_WDT/FAIL": true<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 2<br />
}<br />
}</nowiki><br />
<br />
== CR02 - Digital Inputs (Push button to Toggle Outputs 1 and 2) | default in FW 3.2.3 ==<br />
<br />
Rule is used for managing outputs in response to change of Digital Inputs (DI) state. Rule monitors state of first DI. When DI switches from OFF (0) to ON (1), Rule switches (toggles) Outputs 1 & 2 to their opposite states (ACTION 4 = TOGGLE).<br />
<br />
===Rule definition===<br />
<br />
Rule name: '''CR02_RULE'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"INPUTS/1/STATE": "on"<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 4,<br />
"OUTPUTS/2/ACTION": 4<br />
}<br />
}</nowiki><br />
<br />
== CR03 - Load Watchdog (Restart device if it's more than 2 minutes in IDLE mode) | default in FW 3.2.3 ==<br />
Rule monitors load (Watts) on Output 1. If the load is between 1-20W for at least 2 minutes, it restarts (ACTION 2 = SHORT OFF) the output.<br />
Example uses PAB (Power Analysis Block) functionality to determine if measured value (load in our case) lies in given range for a period of time. When it does, defined Rule triggers device restart.<br />
<br />
===PAB definition===<br />
<br />
PAB name: '''CR03_PAB'''<br />
<nowiki><br />
{<br />
"type": "RANGE",<br />
"source": "OUTPUTS/1/LOAD",<br />
"lowerBound": 1,<br />
"upperBound": 20,<br />
"timeHysteresis": 120<br />
}</nowiki><br />
<br />
===Rule definition===<br />
<br />
Rule name: '''CR03_RULE'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"PAB/CR03_PAB/IN": true<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 2<br />
}<br />
}</nowiki><br />
<br />
== CR04 - Load Watchdog with alarm to Cloud ==<br />
Rule monitors load (Watts) on Output 1. If the load is between 1-20W for at least 30 minutes, it restarts (ACTION 2 = SHORT OFF) the output. In addition, it triggers an alarm in NETIO Cloud, which sends a notification to specified email address.<br />
This example needs a NETIO Cloud account with Premium version active for first output. There also has to be email notification enabled for the output.<br />
<br />
Example uses PAB (Power Analysis Block) functionality to determine if measured value (load in our case) lies in given range for a period of time. When it does, defined Rule triggers device restart and sends alarm to Cloud.<br />
<br />
===PAB definition===<br />
<br />
PAB name: '''CR04_PAB'''<br />
<br />
<nowiki><br />
{<br />
"type": "RANGE",<br />
"source": "OUTPUTS/1/LOAD",<br />
"lowerBound": 1,<br />
"upperBound": 20,<br />
"timeHysteresis": 1800<br />
}</nowiki><br />
<br />
<br />
===Rule definition===<br />
<br />
Rule name: '''CR04_RULE'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"PAB/CR04_PAB/IN": true<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 2,<br />
"CLOUD/OUTPUT/1/ALARM": "${COND_RESULT}"<br />
}<br />
}</nowiki><br />
<br />
== CR05 - Load Watchdog with zones (indicate OFF / IDLE / RUN mode by switched on output)==<br />
Rule monitors load (Watts) on Output 1. Measured load is then classified to several zones defined with thresholds (limit values). Depending on the zone in which the measured load is currently located, different actions can be triggered. Load value has to be between defined threshold for at least 10seconds in order to be placed to respective zone.<br />
Example is composed of one PAB that classifies the zones and three Rules for 3 separate actions. Actions do the following:<br />
* Output 1 load lower than 1W: Output 2 = ON<br />
* Output 1 load between 1-20W: Output 3 = ON<br />
* Output 1 load between 20-200W: Output 4 = ON<br />
<br />
===PAB definition===<br />
<br />
PAB name: '''CR05_PAB'''<br />
<br />
<nowiki><br />
{<br />
"type": "ZONES",<br />
"source": "OUTPUTS/2/CURRENT",<br />
"thresholds": [<br />
1,<br />
20,<br />
200<br />
],<br />
"timeHysteresis": 10<br />
}</nowiki><br />
<br />
===Rules definitions===<br />
<br />
Rule 1 name: '''CR05_RULE_1'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"PAB/NR05_PAB/ZONE": 0<br />
},<br />
"actions": {<br />
"OUTPUTS/2/ACTION": 1,<br />
"OUTPUTS/3/ACTION": 0,<br />
"OUTPUTS/4/ACTION": 0<br />
}<br />
}</nowiki><br />
<br />
Rule 2 name: '''CR05_RULE_2'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"PAB/CR05_PAB/ZONE": 1<br />
},<br />
"actions": {<br />
"OUTPUTS/2/ACTION": 0,<br />
"OUTPUTS/3/ACTION": 1,<br />
"OUTPUTS/4/ACTION": 0<br />
}<br />
}</nowiki><br />
<br />
Rule 3 name: '''CR05_RULE_3'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"PAB/CR05_PAB/ZONE": 2<br />
},<br />
"actions": {<br />
"OUTPUTS/2/ACTION": 0,<br />
"OUTPUTS/3/ACTION": 0,<br />
"OUTPUTS/4/ACTION": 1<br />
}<br />
}</nowiki><br />
<br />
== CR06 - WatchDog for 2 IPs (Verify IP connectivity outage with 2 IPs)==<br />
The WatchDog functionality is used to monitor connectivity to specified IP address (or URL) by sending PING request to it.<br />
<br />
In this example, we monitor two IPs and we want to restart device connected to Output 1 if none of the addresses reply.<br />
The ping for both IPs is sent every 30s and waits 5s for device to respond. There are 5 consecutive timeouts tolerated before the ping is considered as failed. When the ping fails, Watchdog returns <code>false</code> and remains in ERROR state.<br />
<br />
In case both of the defined WatchDogs are in ERROR state, the Rule is triggered which then restarts Output 1.<br />
<br />
===WatchDogs definition===<br />
<br />
WatchDog name: '''CR06_WDT_1'''<br />
<br />
<nowiki><br />
{<br />
"target": "192.168.1.51",<br />
"pingInterval": 30,<br />
"timeout": 5,<br />
"maxTimeouts": 5,<br />
"timeToReboot": 120,<br />
"maxRestarts": -1<br />
}</nowiki><br />
<br />
WatchDog name: '''CR06_WDT_2'''<br />
<br />
<nowiki><br />
{<br />
"target": "192.168.1.52",<br />
"pingInterval": 60,<br />
"timeout": 5,<br />
"maxTimeouts": 5,<br />
"timeToReboot": 120,<br />
"maxRestarts": -1<br />
}</nowiki><br />
<br />
===Rule definition===<br />
<br />
Rule name: '''CR06_RULE'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"operator": "AND",<br />
"WDT/CR06_WDT_1/FAIL": true,<br />
"WDT/CR06_WDT_2/FAIL": true<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 2<br />
}<br />
}</nowiki><br />
<br />
== CR07 - Synchronized outputs states during working hours ==<br />
Rule keeps track of first output state and when it changes, it switches output 2 to the same state. However, we want this synchronization only to work during working hours. We define the time with Schedule functionality and use it as a filter (mask) in Rules. Schedule can be defined manually or imported as a configuration file.<br />
<br />
===Schedule definition===<br />
<br />
Schedule name: '''CR07_SCHEDULE'''<br />
<br />
[[File:NR07_Schedule.png|NR070 Schedule]]<br />
<br />
===Rule definition===<br />
<br />
Rule name: '''CR07_RULE'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"OUTPUTS/1/STATE": "on"<br />
},<br />
"filters": {<br />
"SCHEDULE/CR07_SCHEDULE/ACTIVE": true<br />
},<br />
"actions": {<br />
"OUTPUTS/2/ACTION": "${COND_RESULT}"<br />
}<br />
}</nowiki><br />
<br />
== CR08 - Load Watchdog -> Turn output ON after period of time ==<br />
<br />
In this example we want to measure load on output 1 and indicate when the power is abnormally low for a period of time by switching device on Output 2 ON (could be control light, sound alarm etc.).<br />
<br />
In PAB we define indication for low power usage (1-20W) that is measured for period of 30 minutes (1800 seconds).<br />
In Rule we define switching Output 2 = ON (ACTION 1 = TURN ON) based on fulfilled PAB condition. This set up counts with human interaction after the Rule action gets processed. (e.g. restarting/replacing device on Output 1 and turning Output 2 OFF).<br />
It is possible to alter this behavior in such a way that the control light (Output 2) turns automatically OFF when load on Output 1 returns to standard values, i.e. higher than 20W (device gets repaired/replaced) or drops to 0W (device was removed or Output 1 turned OFF). This setup is defined in Rule '''NR08_ALT'''<br />
<br />
===PAB definition===<br />
<br />
PAB name: '''CR08_PAB'''<br />
<nowiki><br />
{<br />
"type": "RANGE",<br />
"source": "OUTPUTS/1/LOAD",<br />
"lowerBound": 1,<br />
"upperBound": 20,<br />
"timeHysteresis": 1800<br />
}</nowiki><br />
<br />
===Rule definition===<br />
<br />
Rule name: '''CR08_RULE'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"PAB/CR08_PAB/IN": true<br />
},<br />
"actions": {<br />
"OUTPUTS/2/ACTION": 1<br />
}<br />
}</nowiki><br />
<br />
Rule name: '''CR08_RULE_ALT'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"PAB/CR08_PAB/IN": true<br />
},<br />
"actions": {<br />
"OUTPUTS/2/ACTION": "${COND_RESULT}"<br />
}<br />
}</nowiki><br />
<br />
== CR09 - Digital Inputs with Schedule ==<br />
<br />
Examples shows usage when we want to detect switching of Digital Input to ON state (1) but to (not) react only during specified hours (e.g. outside of working hours).<br />
Reaction hours are defined with Schedule functionality. Schedule can be defined manually or imported as a configuration file.<br />
<br />
===Schedule definition===<br />
<br />
Schedule name: '''CR09_SCHEDULE'''<br />
<br />
===Rule definition===<br />
<br />
Rule name: '''CR09_RULE'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"INPUTS/1/STATE": "on"<br />
},<br />
"filters": {<br />
"SCHEDULE/CR09_SCHEDULE/ACTIVE": false<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 2<br />
}<br />
}</nowiki><br />
<br />
== CR10 - TURN OFF Output 1 before midnight ==<br />
Rule in a combination with Schedule can be used to ensure a specified output will be turned off at the end of the day (or any other time).<br />
Schedule in this application is '''NOT''' assigned to the output and acts only as a "trigger" for launching the Rule action.<br />
<br />
===Schedule definition===<br />
<br />
Schedule name: '''off_before_midnight'''<br />
<br />
Schedule configuration: Schedule is configured to have '''intervals every day from 23:59 to 24:00'''. In this configuration, the output turns of at 23:59.<br />
<br />
[[File:cr10_schedule.png|CR10 Schedule]]<br />
<br />
===Rule definition===<br />
<br />
Rule name: '''CR10_RULE'''<br />
<nowiki><br />
{<br />
"conditions": {<br />
"SCHEDULE/off_before_midnight/ACTIVE": true<br />
},<br />
"filters": {<br />
"OUTPUTS/1/STATE": "on"<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 0<br />
}<br />
}</nowiki><br />
<br />
== CR11 - Total load (8QS)==<br />
CR11_PAB<br />
<br />
<nowiki><br />
{<br />
"type": "RANGE",<br />
"source": "OUTPUTS/TOTAL/LOAD",<br />
"lowerBound": 30,<br />
"upperBound": 100,<br />
"timeHysteresis": 3<br />
}</nowiki><br />
<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"operator": "OR",<br />
"PAB/total_outputs/IN": true<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 4,<br />
"CLOUD/OUTPUT/1/ALARM": 1<br />
}<br />
}</nowiki><br />
<br />
== CR12 - Negative load ==<br />
CR12_PAB<br />
<br />
<nowiki><br />
{<br />
"type": "RANGE",<br />
"source": "OUTPUTS/1/LOAD",<br />
"lowerBound": -400,<br />
"upperBound": 0,<br />
"timeHysteresis": 2<br />
}</nowiki><br />
<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"PAB/negative/IN": true<br />
},<br />
"actions": {<br />
"OUTPUTS/3/ACTION": 4,<br />
"OUTPUTS/4/ACTION": 4<br />
}<br />
}</nowiki><br />
<br />
<br />
== CR13 - Actions based on daylight <sup><code>FW 4.0.0+</code></sup>==<br />
Turns output ON/OFF based on sunrise/sunset times of set location.<br />
In this example, output 1 gets turned on one hour before (-60 minutes) sunrise and turns off one hour (60 minutes) after sunset. Location is se for NETIO Products headquarters (U pily 103, Prague, CZ). Elevation is set as 247 meters, above sea level.<br />
<br />
=== PAB definition ===<br />
PAB name: '''CR13_PAB'''<br />
<br />
<nowiki><br />
{<br />
"type": "DAYLIGHT",<br />
"longitude": "14.4129433E",<br />
"latitude": "50.0058144N",<br />
"altitude": 247,<br />
"sunriseDelay": -60,<br />
"sunsetDelay": 60<br />
}<br />
</nowiki><br />
<br />
=== Rule definition ===<br />
Rule name: '''CR13_RULE'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"PAB/CR13_PAB/DAY": true<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": "${COND_RESULT}"<br />
}<br />
}<br />
</nowiki><br />
<br />
== CR14 - Actions based on Power-UP <sup><code>FW 4.0.0+</code></sup>== <br />
<br />
This example describes rule that evaluates after device start-up. Generally, there are 2 options for setting up conditions: <br />
* SYSTEM/DEVICE_POWER_UP - device boot after power-cut<br />
<br />
Condition in rule description below reacts to device boot after power-cut. When device first starts after regaining power, it sends alarm to output 1 in NETIO Cloud service.<br />
<br />
=== Rule definition ===<br />
Rule name: '''CR14_RULE'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"SYSTEM/DEVICE_POWER_UP": true<br />
},<br />
"actions": {<br />
"CLOUD/OUTPUT/1/ALARM": "${COND_RESULT}"<br />
}<br />
}<br />
</nowiki><br />
<br />
== CR15 - Sunrise/sunset addaptive schedule with deep night off <sup><code>FW 4.0.1+</code></sup>==<br />
Control output ON/OFF based on sunrise/sunset times of set location and combine it with standard schedule using rules.<br />
<br />
In this example, output 1 gets turned on every day at 6:00 and switch off 30 minutes after sunrise and gets on again 30 minutes before sunset and turns off at midnight. This is an example of combination PAB output with standard schedule and mask the result of PAB with intervals defined in schedule.<br />
<br />
Following combination creates dynamic variable input with static scheduler overlay and the behaviour can be simply chosen by logical equations.<br />
<br />
=== 1. Configure schedule ===<br />
Create a schedule with name "christmas_off" and create intervals 00:00 to 06:00 every day. No need to activate the scheduler for any output. Just define it.<br />
<br />
[[File:CR15 schedule christmas off.png]]<br />
<br />
=== 2. Create sunrise/sunset PAB ===<br />
<br />
Following PAB will have <code>true</code> result during the day between sunrise with 30 minutes delay and 30 minutes before sunset set for location of NETIO Products headquarters (U pily 103, Prague, CZ). Elevation is set as 247 meters, above sea level. This result will be used in condition in rules to detect sunrise and sunset.<br />
<br />
PAB name: '''daylight'''<br />
<br />
<nowiki><br />
{<br />
"type": "DAYLIGHT",<br />
"longitude": "14.4129433E",<br />
"latitude": "50.0058144N",<br />
"altitude": 247,<br />
"sunriseDelay": 30,<br />
"sunsetDelay": -30<br />
}<br />
</nowiki><br />
<br />
=== 3. Create RULE for output ON ===<br />
<br />
In this rule is definition when the output 1 should be enabled (ON). It is combination of two conditions of PAB and scheduler.<br />
<br />
'''This code is saying:''' When is night ( day is false = <code>"PAB/daylight/DAY": false,</code>) and in paralel schedule is not active (set to be off = <code>"SCHEDULE/christmas_off/ACTIVE": false</code>) the result is <code>true</code> and following action (set output 1 to ON <code>"OUTPUTS/1/ACTION": 1</code>) is executed. <br />
<br />
RULE name: '''outON'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"operator": "AND",<br />
"PAB/daylight/DAY": false,<br />
"SCHEDULE/christmas_off/ACTIVE": false<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 1<br />
}<br />
}<br />
</nowiki><br />
<br />
=== 4. Create RULE for output OFF ===<br />
<br />
In this rule is definition when the output 1 should be disabled (OFF). It is again combination of two conditions of PAB and scheduler.<br />
<br />
'''This code is saying:''' When it is day now ( day is true = <code>"PAB/daylight/DAY": true,</code>) or the schedule is active (set to be on = <code>"SCHEDULE/christmas_off/ACTIVE": true</code>) the result is <code>true</code> and following action (set output 1 to OFF <code>"OUTPUTS/1/ACTION": 0</code>) is executed. <br />
<br />
RULE name: '''outOFF'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"operator": "OR",<br />
"PAB/daylight/DAY": true,<br />
"SCHEDULE/christmas_off/ACTIVE": true<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 0<br />
}<br />
}<br />
</nowiki><br />
<br />
== CR16 - Digital Inputs - External Switch ON/OFF <sup><code>FW 4.0.0+</code></sup>==<br />
Rule is used for managing outputs status in response to change of Digital Inputs (DI) state. Typical example of this solution is connection of external switch ON/OFF into Digital Input (IN) with consequence outputs action.<br />
<br />
<br />
=== External Switch OFF - All Outputs OFF ===<br />
Rule name: '''CR16_RULE''' <br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"INPUTS/1/STATE": "off"<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 0,<br />
"OUTPUTS/2/ACTION": 0<br />
}<br />
}<br />
</nowiki><br />
<br />
=== External Switch ON - All Outputs ON ===<br />
Rule name: '''CR16_RULE''' <br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"INPUTS/1/STATE": "on"<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 1,<br />
"OUTPUTS/2/ACTION": 1<br />
}<br />
}<br />
</nowiki><br />
<br />
=== External Switch ON - All outputs ON with individual Power Up Sequence === <br />
Rule name: '''CR16_RULE''' <br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"INPUTS/1/STATE": "on"<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 0,<br />
"sequence": {<br />
"repeat": 1,<br />
"actions": [<br />
{<br />
"OUTPUTS/1/ACTION": 1,<br />
"delay": 1000<br />
},<br />
{<br />
"OUTPUTS/2/ACTION": 1,<br />
"delay": 3000<br />
}<br />
]<br />
}<br />
}<br />
}<br />
<br />
</nowiki><br />
<br />
== CR17 - Digital Inputs - Connection of NETIO T1 Sensor <sup><code>FW 5.0.3+</code></sup>==<br />
Rule is used for managing outputs status in response to temperature metering connected into Digital Inputs (DI). Typical example of this solution is the temperature metering in server room. In case temperature hits specified temperature, the air-condition (AC) will turn ON. <br />
<br />
=== Temperature measurement - condition definition temperature range (15-45)℃ ===<br />
NETIO T1 Sensor connected into INPUT n.2<br />
<br />
Rule name: '''CR17_TEMP''' <br />
<br />
<nowiki><br />
{<br />
"source":"INPUTS/2/TEMP",<br />
"type":"RANGE",<br />
"upperBound":45,<br />
"lowerBound":15,<br />
"timeHysteresis":1<br />
}<br />
</nowiki><br />
<br />
=== Temperature out of spec - Output1 ON===<br />
Rule name: '''CR17_RULE_1''' <br />
<nowiki><br />
{<br />
"conditions":{<br />
"PAB/CR15_TEMP/IN":false<br />
},<br />
"actions":{<br />
"OUTPUTS/1/ACTION":1<br />
}<br />
}<br />
</nowiki><br />
=== Temperature in spec - Output1 OFF===<br />
Rule name: '''CR17_RULE_2''' <br />
<nowiki><br />
{<br />
"conditions":{<br />
"PAB/CR15_TEMP/IN":true<br />
},<br />
"actions":{<br />
"OUTPUTS/1/ACTION":0<br />
}<br />
}<br />
</nowiki></div>
Tbezstarosta
https://wiki.netio-products.com/index.php?title=Rules_Complete_Examples&diff=1050
Rules Complete Examples
2024-07-15T13:41:24Z
<p>Tbezstarosta: /* CR17 - Digital Inputs - Connection of NETIO T1 Sensor FW 5.0.3+ */</p>
<hr />
<div>The concept of NETIO Conditions (PAB & WatchDog) & Rules is a set of prepared detections (Conditions) and Rules that act upon them. They are implemented directly in NETIO PDU devices. <br />
<br />
== CR01 - WatchDog (ping) to 1 IP address | default in FW 3.2.3 ==<br />
The WatchDog functionality is used to monitor connectivity to specified IP address (or URL) by sending PING request to it.<br />
<br />
The ping in this example is sent every 60s and waits 5s for the device to respond. If the ping fails, Watchdog returns <code>false</code> and restarts (ACTION: 2 = SHORT OFF) device connected to first output. After restart, it waits 120 seconds and starts monitoring again. If the device does not respond, WatchDog remains in ERROR state until next successful ping.<br />
<br />
===WatchDog definition===<br />
<br />
WatchDog name: '''CR01_WDT'''<br />
<br />
<nowiki><br />
{<br />
"target": "192.168.1.5",<br />
"pingInterval": 60,<br />
"timeout": 5,<br />
"maxTimeouts": 0,<br />
"timeToReboot": 120,<br />
"maxRestarts": -1<br />
}</nowiki><br />
<br />
===Rule definition===<br />
<br />
Rule name: '''CR01_RULE'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"WDT/CR01_WDT/FAIL": true<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 2<br />
}<br />
}</nowiki><br />
<br />
== CR02 - Digital Inputs (Push button to Toggle Outputs 1 and 2) | default in FW 3.2.3 ==<br />
<br />
Rule is used for managing outputs in response to change of Digital Inputs (DI) state. Rule monitors state of first DI. When DI switches from OFF (0) to ON (1), Rule switches (toggles) Outputs 1 & 2 to their opposite states (ACTION 4 = TOGGLE).<br />
<br />
===Rule definition===<br />
<br />
Rule name: '''CR02_RULE'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"INPUTS/1/STATE": "on"<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 4,<br />
"OUTPUTS/2/ACTION": 4<br />
}<br />
}</nowiki><br />
<br />
== CR03 - Load Watchdog (Restart device if it's more than 2 minutes in IDLE mode) | default in FW 3.2.3 ==<br />
Rule monitors load (Watts) on Output 1. If the load is between 1-20W for at least 2 minutes, it restarts (ACTION 2 = SHORT OFF) the output.<br />
Example uses PAB (Power Analysis Block) functionality to determine if measured value (load in our case) lies in given range for a period of time. When it does, defined Rule triggers device restart.<br />
<br />
===PAB definition===<br />
<br />
PAB name: '''CR03_PAB'''<br />
<nowiki><br />
{<br />
"type": "RANGE",<br />
"source": "OUTPUTS/1/LOAD",<br />
"lowerBound": 1,<br />
"upperBound": 20,<br />
"timeHysteresis": 120<br />
}</nowiki><br />
<br />
===Rule definition===<br />
<br />
Rule name: '''CR03_RULE'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"PAB/CR03_PAB/IN": true<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 2<br />
}<br />
}</nowiki><br />
<br />
== CR04 - Load Watchdog with alarm to Cloud ==<br />
Rule monitors load (Watts) on Output 1. If the load is between 1-20W for at least 30 minutes, it restarts (ACTION 2 = SHORT OFF) the output. In addition, it triggers an alarm in NETIO Cloud, which sends a notification to specified email address.<br />
This example needs a NETIO Cloud account with Premium version active for first output. There also has to be email notification enabled for the output.<br />
<br />
Example uses PAB (Power Analysis Block) functionality to determine if measured value (load in our case) lies in given range for a period of time. When it does, defined Rule triggers device restart and sends alarm to Cloud.<br />
<br />
===PAB definition===<br />
<br />
PAB name: '''CR04_PAB'''<br />
<br />
<nowiki><br />
{<br />
"type": "RANGE",<br />
"source": "OUTPUTS/1/LOAD",<br />
"lowerBound": 1,<br />
"upperBound": 20,<br />
"timeHysteresis": 1800<br />
}</nowiki><br />
<br />
<br />
===Rule definition===<br />
<br />
Rule name: '''CR04_RULE'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"PAB/CR04_PAB/IN": true<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 2,<br />
"CLOUD/OUTPUT/1/ALARM": "${COND_RESULT}"<br />
}<br />
}</nowiki><br />
<br />
== CR05 - Load Watchdog with zones (indicate OFF / IDLE / RUN mode by switched on output)==<br />
Rule monitors load (Watts) on Output 1. Measured load is then classified to several zones defined with thresholds (limit values). Depending on the zone in which the measured load is currently located, different actions can be triggered. Load value has to be between defined threshold for at least 10seconds in order to be placed to respective zone.<br />
Example is composed of one PAB that classifies the zones and three Rules for 3 separate actions. Actions do the following:<br />
* Output 1 load lower than 1W: Output 2 = ON<br />
* Output 1 load between 1-20W: Output 3 = ON<br />
* Output 1 load between 20-200W: Output 4 = ON<br />
<br />
===PAB definition===<br />
<br />
PAB name: '''CR05_PAB'''<br />
<br />
<nowiki><br />
{<br />
"type": "ZONES",<br />
"source": "OUTPUTS/2/CURRENT",<br />
"thresholds": [<br />
1,<br />
20,<br />
200<br />
],<br />
"timeHysteresis": 10<br />
}</nowiki><br />
<br />
===Rules definitions===<br />
<br />
Rule 1 name: '''CR05_RULE_1'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"PAB/NR05_PAB/ZONE": 0<br />
},<br />
"actions": {<br />
"OUTPUTS/2/ACTION": 1,<br />
"OUTPUTS/3/ACTION": 0,<br />
"OUTPUTS/4/ACTION": 0<br />
}<br />
}</nowiki><br />
<br />
Rule 2 name: '''CR05_RULE_2'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"PAB/CR05_PAB/ZONE": 1<br />
},<br />
"actions": {<br />
"OUTPUTS/2/ACTION": 0,<br />
"OUTPUTS/3/ACTION": 1,<br />
"OUTPUTS/4/ACTION": 0<br />
}<br />
}</nowiki><br />
<br />
Rule 3 name: '''CR05_RULE_3'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"PAB/CR05_PAB/ZONE": 2<br />
},<br />
"actions": {<br />
"OUTPUTS/2/ACTION": 0,<br />
"OUTPUTS/3/ACTION": 0,<br />
"OUTPUTS/4/ACTION": 1<br />
}<br />
}</nowiki><br />
<br />
== CR06 - WatchDog for 2 IPs (Verify IP connectivity outage with 2 IPs)==<br />
The WatchDog functionality is used to monitor connectivity to specified IP address (or URL) by sending PING request to it.<br />
<br />
In this example, we monitor two IPs and we want to restart device connected to Output 1 if none of the addresses reply.<br />
The ping for both IPs is sent every 30s and waits 5s for device to respond. There are 5 consecutive timeouts tolerated before the ping is considered as failed. When the ping fails, Watchdog returns <code>false</code> and remains in ERROR state.<br />
<br />
In case both of the defined WatchDogs are in ERROR state, the Rule is triggered which then restarts Output 1.<br />
<br />
===WatchDogs definition===<br />
<br />
WatchDog name: '''CR06_WDT_1'''<br />
<br />
<nowiki><br />
{<br />
"target": "192.168.1.51",<br />
"pingInterval": 30,<br />
"timeout": 5,<br />
"maxTimeouts": 5,<br />
"timeToReboot": 120,<br />
"maxRestarts": -1<br />
}</nowiki><br />
<br />
WatchDog name: '''CR06_WDT_2'''<br />
<br />
<nowiki><br />
{<br />
"target": "192.168.1.52",<br />
"pingInterval": 60,<br />
"timeout": 5,<br />
"maxTimeouts": 5,<br />
"timeToReboot": 120,<br />
"maxRestarts": -1<br />
}</nowiki><br />
<br />
===Rule definition===<br />
<br />
Rule name: '''CR06_RULE'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"operator": "AND",<br />
"WDT/CR06_WDT_1/FAIL": true,<br />
"WDT/CR06_WDT_2/FAIL": true<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 2<br />
}<br />
}</nowiki><br />
<br />
== CR07 - Synchronized outputs states during working hours ==<br />
Rule keeps track of first output state and when it changes, it switches output 2 to the same state. However, we want this synchronization only to work during working hours. We define the time with Schedule functionality and use it as a filter (mask) in Rules. Schedule can be defined manually or imported as a configuration file.<br />
<br />
===Schedule definition===<br />
<br />
Schedule name: '''CR07_SCHEDULE'''<br />
<br />
[[File:NR07_Schedule.png|NR070 Schedule]]<br />
<br />
===Rule definition===<br />
<br />
Rule name: '''CR07_RULE'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"OUTPUTS/1/STATE": "on"<br />
},<br />
"filters": {<br />
"SCHEDULE/CR07_SCHEDULE/ACTIVE": true<br />
},<br />
"actions": {<br />
"OUTPUTS/2/ACTION": "${COND_RESULT}"<br />
}<br />
}</nowiki><br />
<br />
== CR08 - Load Watchdog -> Turn output ON after period of time ==<br />
<br />
In this example we want to measure load on output 1 and indicate when the power is abnormally low for a period of time by switching device on Output 2 ON (could be control light, sound alarm etc.).<br />
<br />
In PAB we define indication for low power usage (1-20W) that is measured for period of 30 minutes (1800 seconds).<br />
In Rule we define switching Output 2 = ON (ACTION 1 = TURN ON) based on fulfilled PAB condition. This set up counts with human interaction after the Rule action gets processed. (e.g. restarting/replacing device on Output 1 and turning Output 2 OFF).<br />
It is possible to alter this behavior in such a way that the control light (Output 2) turns automatically OFF when load on Output 1 returns to standard values, i.e. higher than 20W (device gets repaired/replaced) or drops to 0W (device was removed or Output 1 turned OFF). This setup is defined in Rule '''NR08_ALT'''<br />
<br />
===PAB definition===<br />
<br />
PAB name: '''CR08_PAB'''<br />
<nowiki><br />
{<br />
"type": "RANGE",<br />
"source": "OUTPUTS/1/LOAD",<br />
"lowerBound": 1,<br />
"upperBound": 20,<br />
"timeHysteresis": 1800<br />
}</nowiki><br />
<br />
===Rule definition===<br />
<br />
Rule name: '''CR08_RULE'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"PAB/CR08_PAB/IN": true<br />
},<br />
"actions": {<br />
"OUTPUTS/2/ACTION": 1<br />
}<br />
}</nowiki><br />
<br />
Rule name: '''CR08_RULE_ALT'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"PAB/CR08_PAB/IN": true<br />
},<br />
"actions": {<br />
"OUTPUTS/2/ACTION": "${COND_RESULT}"<br />
}<br />
}</nowiki><br />
<br />
== CR09 - Digital Inputs with Schedule ==<br />
<br />
Examples shows usage when we want to detect switching of Digital Input to ON state (1) but to (not) react only during specified hours (e.g. outside of working hours).<br />
Reaction hours are defined with Schedule functionality. Schedule can be defined manually or imported as a configuration file.<br />
<br />
===Schedule definition===<br />
<br />
Schedule name: '''CR09_SCHEDULE'''<br />
<br />
===Rule definition===<br />
<br />
Rule name: '''CR09_RULE'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"INPUTS/1/STATE": "on"<br />
},<br />
"filters": {<br />
"SCHEDULE/CR09_SCHEDULE/ACTIVE": false<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 2<br />
}<br />
}</nowiki><br />
<br />
== CR10 - TURN OFF Output 1 before midnight ==<br />
Rule in a combination with Schedule can be used to ensure a specified output will be turned off at the end of the day (or any other time).<br />
Schedule in this application is '''NOT''' assigned to the output and acts only as a "trigger" for launching the Rule action.<br />
<br />
===Schedule definition===<br />
<br />
Schedule name: '''off_before_midnight'''<br />
<br />
Schedule configuration: Schedule is configured to have '''intervals every day from 23:59 to 24:00'''. In this configuration, the output turns of at 23:59.<br />
<br />
[[File:cr10_schedule.png|CR10 Schedule]]<br />
<br />
===Rule definition===<br />
<br />
Rule name: '''CR10_RULE'''<br />
<nowiki><br />
{<br />
"conditions": {<br />
"SCHEDULE/off_before_midnight/ACTIVE": true<br />
},<br />
"filters": {<br />
"OUTPUTS/1/STATE": "on"<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 0<br />
}<br />
}</nowiki><br />
<br />
== CR11 - Total load (8QS)==<br />
CR11_PAB<br />
<br />
<nowiki><br />
{<br />
"type": "RANGE",<br />
"source": "OUTPUTS/TOTAL/LOAD",<br />
"lowerBound": 30,<br />
"upperBound": 100,<br />
"timeHysteresis": 3<br />
}</nowiki><br />
<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"operator": "OR",<br />
"PAB/total_outputs/IN": true<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 4,<br />
"CLOUD/OUTPUT/1/ALARM": 1<br />
}<br />
}</nowiki><br />
<br />
== CR12 - Negative load ==<br />
CR12_PAB<br />
<br />
<nowiki><br />
{<br />
"type": "RANGE",<br />
"source": "OUTPUTS/1/LOAD",<br />
"lowerBound": -400,<br />
"upperBound": 0,<br />
"timeHysteresis": 2<br />
}</nowiki><br />
<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"PAB/negative/IN": true<br />
},<br />
"actions": {<br />
"OUTPUTS/3/ACTION": 4,<br />
"OUTPUTS/4/ACTION": 4<br />
}<br />
}</nowiki><br />
<br />
<br />
== CR13 - Actions based on daylight <sup><code>FW 4.0.0+</code></sup>==<br />
Turns output ON/OFF based on sunrise/sunset times of set location.<br />
In this example, output 1 gets turned on one hour before (-60 minutes) sunrise and turns off one hour (60 minutes) after sunset. Location is se for NETIO Products headquarters (U pily 103, Prague, CZ). Elevation is set as 247 meters, above sea level.<br />
<br />
=== PAB definition ===<br />
PAB name: '''CR13_PAB'''<br />
<br />
<nowiki><br />
{<br />
"type": "DAYLIGHT",<br />
"longitude": "14.4129433E",<br />
"latitude": "50.0058144N",<br />
"altitude": 247,<br />
"sunriseDelay": -60,<br />
"sunsetDelay": 60<br />
}<br />
</nowiki><br />
<br />
=== Rule definition ===<br />
Rule name: '''CR13_RULE'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"PAB/CR13_PAB/DAY": true<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": "${COND_RESULT}"<br />
}<br />
}<br />
</nowiki><br />
<br />
== CR14 - Actions based on Power-UP <sup><code>FW 4.0.0+</code></sup>== <br />
<br />
This example describes rule that evaluates after device start-up. Generally, there are 2 options for setting up conditions: <br />
* SYSTEM/DEVICE_POWER_UP - device boot after power-cut<br />
<br />
Condition in rule description below reacts to device boot after power-cut. When device first starts after regaining power, it sends alarm to output 1 in NETIO Cloud service.<br />
<br />
=== Rule definition ===<br />
Rule name: '''CR14_RULE'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"SYSTEM/DEVICE_POWER_UP": true<br />
},<br />
"actions": {<br />
"CLOUD/OUTPUT/1/ALARM": "${COND_RESULT}"<br />
}<br />
}<br />
</nowiki><br />
<br />
== CR15 - Sunrise/sunset addaptive schedule with deep night off <sup><code>FW 4.0.1+</code></sup>==<br />
Control output ON/OFF based on sunrise/sunset times of set location and combine it with standard schedule using rules.<br />
<br />
In this example, output 1 gets turned on every day at 6:00 and switch off 30 minutes after sunrise and gets on again 30 minutes before sunset and turns off at midnight. This is an example of combination PAB output with standard schedule and mask the result of PAB with intervals defined in schedule.<br />
<br />
Following combination creates dynamic variable input with static scheduler overlay and the behaviour can be simply chosen by logical equations.<br />
<br />
=== 1. Configure schedule ===<br />
Create a schedule with name "christmas_off" and create intervals 00:00 to 06:00 every day. No need to activate the scheduler for any output. Just define it.<br />
<br />
[[File:CR15 schedule christmas off.png]]<br />
<br />
=== 2. Create sunrise/sunset PAB ===<br />
<br />
Following PAB will have <code>true</code> result during the day between sunrise with 30 minutes delay and 30 minutes before sunset set for location of NETIO Products headquarters (U pily 103, Prague, CZ). Elevation is set as 247 meters, above sea level. This result will be used in condition in rules to detect sunrise and sunset.<br />
<br />
PAB name: '''daylight'''<br />
<br />
<nowiki><br />
{<br />
"type": "DAYLIGHT",<br />
"longitude": "14.4129433E",<br />
"latitude": "50.0058144N",<br />
"altitude": 247,<br />
"sunriseDelay": 30,<br />
"sunsetDelay": -30<br />
}<br />
</nowiki><br />
<br />
=== 3. Create RULE for output ON ===<br />
<br />
In this rule is definition when the output 1 should be enabled (ON). It is combination of two conditions of PAB and scheduler.<br />
<br />
'''This code is saying:''' When is night ( day is false = <code>"PAB/daylight/DAY": false,</code>) and in paralel schedule is not active (set to be off = <code>"SCHEDULE/christmas_off/ACTIVE": false</code>) the result is <code>true</code> and following action (set output 1 to ON <code>"OUTPUTS/1/ACTION": 1</code>) is executed. <br />
<br />
RULE name: '''outON'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"operator": "AND",<br />
"PAB/daylight/DAY": false,<br />
"SCHEDULE/christmas_off/ACTIVE": false<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 1<br />
}<br />
}<br />
</nowiki><br />
<br />
=== 4. Create RULE for output OFF ===<br />
<br />
In this rule is definition when the output 1 should be disabled (OFF). It is again combination of two conditions of PAB and scheduler.<br />
<br />
'''This code is saying:''' When it is day now ( day is true = <code>"PAB/daylight/DAY": true,</code>) or the schedule is active (set to be on = <code>"SCHEDULE/christmas_off/ACTIVE": true</code>) the result is <code>true</code> and following action (set output 1 to OFF <code>"OUTPUTS/1/ACTION": 0</code>) is executed. <br />
<br />
RULE name: '''outOFF'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"operator": "OR",<br />
"PAB/daylight/DAY": true,<br />
"SCHEDULE/christmas_off/ACTIVE": true<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 0<br />
}<br />
}<br />
</nowiki><br />
<br />
== CR16 - Digital Inputs - External Switch ON/OFF <sup><code>FW 4.0.0+</code></sup>==<br />
Rule is used for managing outputs status in response to change of Digital Inputs (DI) state. Typical example of this solution is connection of external switch ON/OFF into Digital Input (IN) with consequence outputs action.<br />
<br />
<br />
=== External Switch OFF - All Outputs OFF ===<br />
Rule name: '''CR16_RULE''' <br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"INPUTS/1/STATE": "off"<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 0,<br />
"OUTPUTS/2/ACTION": 0<br />
}<br />
}<br />
</nowiki><br />
<br />
=== External Switch ON - All Outputs ON ===<br />
Rule name: '''CR16_RULE''' <br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"INPUTS/1/STATE": "on"<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 1,<br />
"OUTPUTS/2/ACTION": 1<br />
}<br />
}<br />
</nowiki><br />
<br />
=== External Switch ON - All outputs ON with individual Power Up Sequence === <br />
Rule name: '''CR16_RULE''' <br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"INPUTS/1/STATE": "on"<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 0,<br />
"sequence": {<br />
"repeat": 1,<br />
"actions": [<br />
{<br />
"OUTPUTS/1/ACTION": 1,<br />
"delay": 1000<br />
},<br />
{<br />
"OUTPUTS/2/ACTION": 1,<br />
"delay": 3000<br />
}<br />
]<br />
}<br />
}<br />
}<br />
<br />
</nowiki><br />
<br />
== CR17 - Digital Inputs - Connection of NETIO T1 Sensor <sup><code>FW 5.0.3+</code></sup>==<br />
Rule is used for managing outputs status in response to temperature metering connected into Digital Inputs (DI). Typical example of this solution is the temperature metering in server room. In case temperature hits specified temperature, the air-condition (AC) will turn ON. <br />
<br />
=== Temperature measurement - condition definition temperature range (15-45)℃ ===<br />
NETIO T1 Sensor connected into INPUT n.2<br />
<br />
Rule name: '''CR17_TEMP''' <br />
<br />
<nowiki><br />
{<br />
"source":"INPUTS/2/TEMP",<br />
"type":"RANGE",<br />
"upperBound":45,<br />
"lowerBound":15,<br />
"timeHysteresis":1<br />
}<br />
</nowiki><br />
<br />
=== Temperature out of limit - Output1 ON ===<br />
Rule name: '''CR17_RULE''' <br />
<nowiki><br />
{<br />
"conditions":{<br />
"PAB/CR15_TEMP/IN":false<br />
},<br />
"actions":{<br />
"OUTPUTS/1/ACTION":1<br />
}<br />
}<br />
</nowiki></div>
Tbezstarosta
https://wiki.netio-products.com/index.php?title=PAB&diff=1049
PAB
2024-07-15T13:38:24Z
<p>Tbezstarosta: </p>
<hr />
<div>The PAB (Power Analysis Block) is set of Condition & Rules (CR). It's set of most common functions available for NETIO devices. Based on each '''Condition''', subsequent [https://wiki.netio-products.com/index.php?title=Rules '''Rules'''] can be executed. <br />
User friendly examples are prepared as [https://wiki.netio-products.com/index.php?title=Rules_Complete_Examples '''CRxx Conditions & Rules - examples''']<br />
<br />
<br />
The '''Rules''' can be triggered based on a '''Condition''' - analysis of the state of one or more variables:<br />
* Current [mA]<br />
* Energy [Wh]<br />
* Load [W]<br />
* Power Factor<br />
* S0 pulses<br />
* TEMP [°C], [°F] - available from FW 5.0.3+<br />
<br />
Rules can then perform several actions described in section [https://wiki.netio-products.com/index.php?title=Rules '''Rules''']. <br />
Every PAB is internally evaluated as having a discrete state which can be used as an input to a Rule mentioned above. State value is different for each type of PAB (described below). This state is also available in JSON protocol and therefore can be read externally.<br />
<br />
There are two types of PABs available: '''RANGE''' & '''ZONES'''. Each type has different states and configuration options.<br />
<br />
<br />
= RANGE =<br />
True/False-based evaluation. Detects whether a monitored value lies in specified interval (range) for a period of time. PAB evaluates to <code>TRUE</code> or <code>FALSE</code>.<br />
Interval is specified by lower <code>lowerBound</code> and upper <code>upperBound</code> boundaries. PAB evaluates to <code>TRUE</code> if a variable defined in <code>source</code> lies within for a period of time defined in <code>timeHysteresis</code>.<br />
<br />
== Configuration Structure ==<br />
{| class="wikitable"<br />
|-<br />
! Variable<br />
! Value<br />
! Description <br />
|-<br />
| type <br />
| RANGE <br />
| PAB type<br />
|-<br />
| source <br />
| OUTPUTS/'''x'''/(LOAD/CURRENT/POWER)<br />
| The monitored variable. '''x''' indicates input / output number.<br />
|-<br />
| timeHysteresis <br />
| int <br />
| [s] Monitored value must be present in defined interval for amount of time defined here.<br />
<br />
Eg: If the time hysteresis is equal to 5, monitored value must be within a defined interval for at least 5s. Only then it will be evaluated.<br />
|-<br />
| lowerBound <br />
| int <br />
| lower bound of the monitored value <br />
|-<br />
| upperBound <br />
| int <br />
| upper bound of the monitored value <br />
|}<br />
<br />
== Examples ==<br />
<br />
=== Immediate evaluation ===<br />
PAB evaluates to <code>TRUE</code> immediately as Output 1 '''Current''' value appears '''between 100 and 200 mA'''<br />
<nowiki><br />
{<br />
"type": "RANGE",<br />
"source": "OUTPUTS/1/CURRENT",<br />
"lowerBound": 100,<br />
"upperBound": 200,<br />
"timeHysteresis": 0<br />
}</nowiki><br />
<br />
=== Evaluation with delay ===<br />
PAB evaluates to <code>TRUE</code> when Output 1 '''Load''' is '''between 200 and 300 Watts for 5s'''.<br />
<br />
<nowiki><br />
{<br />
"type": "RANGE",<br />
"source": "OUTPUTS/1/CURRENT",<br />
"lowerBound": 200,<br />
"upperBound": 300,<br />
"timeHysteresis": 5<br />
}</nowiki><br />
<br />
= ZONES =<br />
Opposed from a previous type, ZONE-type PAB detects, whether a monitored variable finds itself in a specified zone. State of PAB indicates what zone number (index) is the measured variable currently in. Zones are defined by their <code>thresholds</code> (lower bounds) and there must be at least one threshold specified.<br />
Monitored value must be present in a defined interval for period of time defined in <code>timeHysteresis</code>.<br />
<br />
== Structure ==<br />
{| class="wikitable"<br />
|-<br />
! Variable<br />
! Value<br />
! Description <br />
|-<br />
| type <br />
| ZONES<br />
| PAB type<br />
|-<br />
| source <br />
| OUTPUTS/'''x'''/(LOAD/CURRENT/POWER)<br />
| The monitored variable. '''x''' indicates input / output number.<br />
|-<br />
| timeHysteresis <br />
| int <br />
| '''[s]''' Monitored value must be present in defined interval for amount of time defined here.<br />
<br />
Eg: If the time hysteresis is equal to 5, monitored value must be within a defined interval for at least 5s. Only then it will be evaluated.<br />
|-<br />
| thresholds<br />
| list of integers <br />
| lower-bounds of individual zones intervals<br />
|}<br />
<br />
== Examples ==<br />
<br />
PAB is evaluated according to the specified zones when the Output 2 '''Current''' value is in one of the zones for 10s.<br />
Zone numbers are as following:<br />
* '''0''': 0 - 49 mA<br />
* '''1''': 50 - 99 mA<br />
* '''2''': 100 - 149 mA<br />
* '''3''': 150 - 199 mA<br />
* '''4''': 200+ mA<br />
<br />
Eg: If the Current value is 130mA for at least 10s, PAB is evaluated as 2.<br />
<br />
<nowiki><br />
{<br />
"type": "ZONES",<br />
"source": "OUTPUTS/2/CURRENT",<br />
"thresholds": [<br />
50,<br />
100,<br />
150,<br />
200<br />
],<br />
"timeHysteresis": 10<br />
}</nowiki><br />
<br />
= DAYLIGHT (sunrise / sunset) <sup><code>FW 4.0.0+</code></sup> =<br />
Enables launching actions based on sunrise / sunset of current place.<br />
<br />
== Structure ==<br />
{| class="wikitable"<br />
|-<br />
! Variable<br />
! Value<br />
! Description <br />
|-<br />
| type<br />
| DAYLIGHT<br />
| PAB type<br />
|-<br />
| longitude<br />
| str "14.4129433E" OR int -73.8390597<br />
| East/West coordinates<br />
|-<br />
| latitude<br />
| str "50.0058144N" OR int -16.5237353<br />
| North/South coordinates<br />
|-<br />
| altitude<br />
| Number of meters above sea level<br />
| 8848<br />
|-<br />
| sunriseDelay<br />
| int [min]<br />
| Delay of PAB activation/deactivation to sunrise<br />
|-<br />
| sunsetDelay<br />
| int [min] <br />
| Delay of PAB activation/deactivation to sunset<br />
|}<br />
<br />
== Examples ==<br />
<br />
=== PAB ===<br />
<br />
<nowiki><br />
{<br />
"type": "DAYLIGHT",<br />
"longitude": "14.4129433E",<br />
"latitude": "50.0058144N",<br />
"altitude": 247,<br />
"sunriseDelay": 240,<br />
"sunsetDelay": -180<br />
}<br />
</nowiki><br />
<br />
or<br />
<br />
<nowiki><br />
{<br />
"type": "DAYLIGHT",<br />
"longitude": -16.5237353,<br />
"latitude": 28.4162475,<br />
"altitude": 247,<br />
"sunriseDelay": 240,<br />
"sunsetDelay": -180<br />
}<br />
</nowiki></div>
Tbezstarosta
https://wiki.netio-products.com/index.php?title=PAB&diff=1048
PAB
2024-07-15T13:38:16Z
<p>Tbezstarosta: </p>
<hr />
<div>The PAB (Power Analysis Block) is set of Condition & Rules (CR). It's set of most common functions available for NETIO devices. Based on each '''Condition''', subsequent [https://wiki.netio-products.com/index.php?title=Rules '''Rules'''] can be executed. <br />
User friendly examples are prepared as [https://wiki.netio-products.com/index.php?title=Rules_Complete_Examples '''CRxx Conditions & Rules - examples''']<br />
<br />
<br />
The '''Rules''' can be triggered based on a '''Condition''' - analysis of the state of one or more variables:<br />
* Current [mA]<br />
* Energy [Wh]<br />
* Load [W]<br />
* Power Factor<br />
* S0 pulses<br />
* TEMP [°C],[°F] - available from FW 5.0.3+<br />
<br />
Rules can then perform several actions described in section [https://wiki.netio-products.com/index.php?title=Rules '''Rules''']. <br />
Every PAB is internally evaluated as having a discrete state which can be used as an input to a Rule mentioned above. State value is different for each type of PAB (described below). This state is also available in JSON protocol and therefore can be read externally.<br />
<br />
There are two types of PABs available: '''RANGE''' & '''ZONES'''. Each type has different states and configuration options.<br />
<br />
<br />
= RANGE =<br />
True/False-based evaluation. Detects whether a monitored value lies in specified interval (range) for a period of time. PAB evaluates to <code>TRUE</code> or <code>FALSE</code>.<br />
Interval is specified by lower <code>lowerBound</code> and upper <code>upperBound</code> boundaries. PAB evaluates to <code>TRUE</code> if a variable defined in <code>source</code> lies within for a period of time defined in <code>timeHysteresis</code>.<br />
<br />
== Configuration Structure ==<br />
{| class="wikitable"<br />
|-<br />
! Variable<br />
! Value<br />
! Description <br />
|-<br />
| type <br />
| RANGE <br />
| PAB type<br />
|-<br />
| source <br />
| OUTPUTS/'''x'''/(LOAD/CURRENT/POWER)<br />
| The monitored variable. '''x''' indicates input / output number.<br />
|-<br />
| timeHysteresis <br />
| int <br />
| [s] Monitored value must be present in defined interval for amount of time defined here.<br />
<br />
Eg: If the time hysteresis is equal to 5, monitored value must be within a defined interval for at least 5s. Only then it will be evaluated.<br />
|-<br />
| lowerBound <br />
| int <br />
| lower bound of the monitored value <br />
|-<br />
| upperBound <br />
| int <br />
| upper bound of the monitored value <br />
|}<br />
<br />
== Examples ==<br />
<br />
=== Immediate evaluation ===<br />
PAB evaluates to <code>TRUE</code> immediately as Output 1 '''Current''' value appears '''between 100 and 200 mA'''<br />
<nowiki><br />
{<br />
"type": "RANGE",<br />
"source": "OUTPUTS/1/CURRENT",<br />
"lowerBound": 100,<br />
"upperBound": 200,<br />
"timeHysteresis": 0<br />
}</nowiki><br />
<br />
=== Evaluation with delay ===<br />
PAB evaluates to <code>TRUE</code> when Output 1 '''Load''' is '''between 200 and 300 Watts for 5s'''.<br />
<br />
<nowiki><br />
{<br />
"type": "RANGE",<br />
"source": "OUTPUTS/1/CURRENT",<br />
"lowerBound": 200,<br />
"upperBound": 300,<br />
"timeHysteresis": 5<br />
}</nowiki><br />
<br />
= ZONES =<br />
Opposed from a previous type, ZONE-type PAB detects, whether a monitored variable finds itself in a specified zone. State of PAB indicates what zone number (index) is the measured variable currently in. Zones are defined by their <code>thresholds</code> (lower bounds) and there must be at least one threshold specified.<br />
Monitored value must be present in a defined interval for period of time defined in <code>timeHysteresis</code>.<br />
<br />
== Structure ==<br />
{| class="wikitable"<br />
|-<br />
! Variable<br />
! Value<br />
! Description <br />
|-<br />
| type <br />
| ZONES<br />
| PAB type<br />
|-<br />
| source <br />
| OUTPUTS/'''x'''/(LOAD/CURRENT/POWER)<br />
| The monitored variable. '''x''' indicates input / output number.<br />
|-<br />
| timeHysteresis <br />
| int <br />
| '''[s]''' Monitored value must be present in defined interval for amount of time defined here.<br />
<br />
Eg: If the time hysteresis is equal to 5, monitored value must be within a defined interval for at least 5s. Only then it will be evaluated.<br />
|-<br />
| thresholds<br />
| list of integers <br />
| lower-bounds of individual zones intervals<br />
|}<br />
<br />
== Examples ==<br />
<br />
PAB is evaluated according to the specified zones when the Output 2 '''Current''' value is in one of the zones for 10s.<br />
Zone numbers are as following:<br />
* '''0''': 0 - 49 mA<br />
* '''1''': 50 - 99 mA<br />
* '''2''': 100 - 149 mA<br />
* '''3''': 150 - 199 mA<br />
* '''4''': 200+ mA<br />
<br />
Eg: If the Current value is 130mA for at least 10s, PAB is evaluated as 2.<br />
<br />
<nowiki><br />
{<br />
"type": "ZONES",<br />
"source": "OUTPUTS/2/CURRENT",<br />
"thresholds": [<br />
50,<br />
100,<br />
150,<br />
200<br />
],<br />
"timeHysteresis": 10<br />
}</nowiki><br />
<br />
= DAYLIGHT (sunrise / sunset) <sup><code>FW 4.0.0+</code></sup> =<br />
Enables launching actions based on sunrise / sunset of current place.<br />
<br />
== Structure ==<br />
{| class="wikitable"<br />
|-<br />
! Variable<br />
! Value<br />
! Description <br />
|-<br />
| type<br />
| DAYLIGHT<br />
| PAB type<br />
|-<br />
| longitude<br />
| str "14.4129433E" OR int -73.8390597<br />
| East/West coordinates<br />
|-<br />
| latitude<br />
| str "50.0058144N" OR int -16.5237353<br />
| North/South coordinates<br />
|-<br />
| altitude<br />
| Number of meters above sea level<br />
| 8848<br />
|-<br />
| sunriseDelay<br />
| int [min]<br />
| Delay of PAB activation/deactivation to sunrise<br />
|-<br />
| sunsetDelay<br />
| int [min] <br />
| Delay of PAB activation/deactivation to sunset<br />
|}<br />
<br />
== Examples ==<br />
<br />
=== PAB ===<br />
<br />
<nowiki><br />
{<br />
"type": "DAYLIGHT",<br />
"longitude": "14.4129433E",<br />
"latitude": "50.0058144N",<br />
"altitude": 247,<br />
"sunriseDelay": 240,<br />
"sunsetDelay": -180<br />
}<br />
</nowiki><br />
<br />
or<br />
<br />
<nowiki><br />
{<br />
"type": "DAYLIGHT",<br />
"longitude": -16.5237353,<br />
"latitude": 28.4162475,<br />
"altitude": 247,<br />
"sunriseDelay": 240,<br />
"sunsetDelay": -180<br />
}<br />
</nowiki></div>
Tbezstarosta
https://wiki.netio-products.com/index.php?title=Rules_Complete_Examples&diff=1047
Rules Complete Examples
2024-07-15T13:34:18Z
<p>Tbezstarosta: </p>
<hr />
<div>The concept of NETIO Conditions (PAB & WatchDog) & Rules is a set of prepared detections (Conditions) and Rules that act upon them. They are implemented directly in NETIO PDU devices. <br />
<br />
== CR01 - WatchDog (ping) to 1 IP address | default in FW 3.2.3 ==<br />
The WatchDog functionality is used to monitor connectivity to specified IP address (or URL) by sending PING request to it.<br />
<br />
The ping in this example is sent every 60s and waits 5s for the device to respond. If the ping fails, Watchdog returns <code>false</code> and restarts (ACTION: 2 = SHORT OFF) device connected to first output. After restart, it waits 120 seconds and starts monitoring again. If the device does not respond, WatchDog remains in ERROR state until next successful ping.<br />
<br />
===WatchDog definition===<br />
<br />
WatchDog name: '''CR01_WDT'''<br />
<br />
<nowiki><br />
{<br />
"target": "192.168.1.5",<br />
"pingInterval": 60,<br />
"timeout": 5,<br />
"maxTimeouts": 0,<br />
"timeToReboot": 120,<br />
"maxRestarts": -1<br />
}</nowiki><br />
<br />
===Rule definition===<br />
<br />
Rule name: '''CR01_RULE'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"WDT/CR01_WDT/FAIL": true<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 2<br />
}<br />
}</nowiki><br />
<br />
== CR02 - Digital Inputs (Push button to Toggle Outputs 1 and 2) | default in FW 3.2.3 ==<br />
<br />
Rule is used for managing outputs in response to change of Digital Inputs (DI) state. Rule monitors state of first DI. When DI switches from OFF (0) to ON (1), Rule switches (toggles) Outputs 1 & 2 to their opposite states (ACTION 4 = TOGGLE).<br />
<br />
===Rule definition===<br />
<br />
Rule name: '''CR02_RULE'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"INPUTS/1/STATE": "on"<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 4,<br />
"OUTPUTS/2/ACTION": 4<br />
}<br />
}</nowiki><br />
<br />
== CR03 - Load Watchdog (Restart device if it's more than 2 minutes in IDLE mode) | default in FW 3.2.3 ==<br />
Rule monitors load (Watts) on Output 1. If the load is between 1-20W for at least 2 minutes, it restarts (ACTION 2 = SHORT OFF) the output.<br />
Example uses PAB (Power Analysis Block) functionality to determine if measured value (load in our case) lies in given range for a period of time. When it does, defined Rule triggers device restart.<br />
<br />
===PAB definition===<br />
<br />
PAB name: '''CR03_PAB'''<br />
<nowiki><br />
{<br />
"type": "RANGE",<br />
"source": "OUTPUTS/1/LOAD",<br />
"lowerBound": 1,<br />
"upperBound": 20,<br />
"timeHysteresis": 120<br />
}</nowiki><br />
<br />
===Rule definition===<br />
<br />
Rule name: '''CR03_RULE'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"PAB/CR03_PAB/IN": true<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 2<br />
}<br />
}</nowiki><br />
<br />
== CR04 - Load Watchdog with alarm to Cloud ==<br />
Rule monitors load (Watts) on Output 1. If the load is between 1-20W for at least 30 minutes, it restarts (ACTION 2 = SHORT OFF) the output. In addition, it triggers an alarm in NETIO Cloud, which sends a notification to specified email address.<br />
This example needs a NETIO Cloud account with Premium version active for first output. There also has to be email notification enabled for the output.<br />
<br />
Example uses PAB (Power Analysis Block) functionality to determine if measured value (load in our case) lies in given range for a period of time. When it does, defined Rule triggers device restart and sends alarm to Cloud.<br />
<br />
===PAB definition===<br />
<br />
PAB name: '''CR04_PAB'''<br />
<br />
<nowiki><br />
{<br />
"type": "RANGE",<br />
"source": "OUTPUTS/1/LOAD",<br />
"lowerBound": 1,<br />
"upperBound": 20,<br />
"timeHysteresis": 1800<br />
}</nowiki><br />
<br />
<br />
===Rule definition===<br />
<br />
Rule name: '''CR04_RULE'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"PAB/CR04_PAB/IN": true<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 2,<br />
"CLOUD/OUTPUT/1/ALARM": "${COND_RESULT}"<br />
}<br />
}</nowiki><br />
<br />
== CR05 - Load Watchdog with zones (indicate OFF / IDLE / RUN mode by switched on output)==<br />
Rule monitors load (Watts) on Output 1. Measured load is then classified to several zones defined with thresholds (limit values). Depending on the zone in which the measured load is currently located, different actions can be triggered. Load value has to be between defined threshold for at least 10seconds in order to be placed to respective zone.<br />
Example is composed of one PAB that classifies the zones and three Rules for 3 separate actions. Actions do the following:<br />
* Output 1 load lower than 1W: Output 2 = ON<br />
* Output 1 load between 1-20W: Output 3 = ON<br />
* Output 1 load between 20-200W: Output 4 = ON<br />
<br />
===PAB definition===<br />
<br />
PAB name: '''CR05_PAB'''<br />
<br />
<nowiki><br />
{<br />
"type": "ZONES",<br />
"source": "OUTPUTS/2/CURRENT",<br />
"thresholds": [<br />
1,<br />
20,<br />
200<br />
],<br />
"timeHysteresis": 10<br />
}</nowiki><br />
<br />
===Rules definitions===<br />
<br />
Rule 1 name: '''CR05_RULE_1'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"PAB/NR05_PAB/ZONE": 0<br />
},<br />
"actions": {<br />
"OUTPUTS/2/ACTION": 1,<br />
"OUTPUTS/3/ACTION": 0,<br />
"OUTPUTS/4/ACTION": 0<br />
}<br />
}</nowiki><br />
<br />
Rule 2 name: '''CR05_RULE_2'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"PAB/CR05_PAB/ZONE": 1<br />
},<br />
"actions": {<br />
"OUTPUTS/2/ACTION": 0,<br />
"OUTPUTS/3/ACTION": 1,<br />
"OUTPUTS/4/ACTION": 0<br />
}<br />
}</nowiki><br />
<br />
Rule 3 name: '''CR05_RULE_3'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"PAB/CR05_PAB/ZONE": 2<br />
},<br />
"actions": {<br />
"OUTPUTS/2/ACTION": 0,<br />
"OUTPUTS/3/ACTION": 0,<br />
"OUTPUTS/4/ACTION": 1<br />
}<br />
}</nowiki><br />
<br />
== CR06 - WatchDog for 2 IPs (Verify IP connectivity outage with 2 IPs)==<br />
The WatchDog functionality is used to monitor connectivity to specified IP address (or URL) by sending PING request to it.<br />
<br />
In this example, we monitor two IPs and we want to restart device connected to Output 1 if none of the addresses reply.<br />
The ping for both IPs is sent every 30s and waits 5s for device to respond. There are 5 consecutive timeouts tolerated before the ping is considered as failed. When the ping fails, Watchdog returns <code>false</code> and remains in ERROR state.<br />
<br />
In case both of the defined WatchDogs are in ERROR state, the Rule is triggered which then restarts Output 1.<br />
<br />
===WatchDogs definition===<br />
<br />
WatchDog name: '''CR06_WDT_1'''<br />
<br />
<nowiki><br />
{<br />
"target": "192.168.1.51",<br />
"pingInterval": 30,<br />
"timeout": 5,<br />
"maxTimeouts": 5,<br />
"timeToReboot": 120,<br />
"maxRestarts": -1<br />
}</nowiki><br />
<br />
WatchDog name: '''CR06_WDT_2'''<br />
<br />
<nowiki><br />
{<br />
"target": "192.168.1.52",<br />
"pingInterval": 60,<br />
"timeout": 5,<br />
"maxTimeouts": 5,<br />
"timeToReboot": 120,<br />
"maxRestarts": -1<br />
}</nowiki><br />
<br />
===Rule definition===<br />
<br />
Rule name: '''CR06_RULE'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"operator": "AND",<br />
"WDT/CR06_WDT_1/FAIL": true,<br />
"WDT/CR06_WDT_2/FAIL": true<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 2<br />
}<br />
}</nowiki><br />
<br />
== CR07 - Synchronized outputs states during working hours ==<br />
Rule keeps track of first output state and when it changes, it switches output 2 to the same state. However, we want this synchronization only to work during working hours. We define the time with Schedule functionality and use it as a filter (mask) in Rules. Schedule can be defined manually or imported as a configuration file.<br />
<br />
===Schedule definition===<br />
<br />
Schedule name: '''CR07_SCHEDULE'''<br />
<br />
[[File:NR07_Schedule.png|NR070 Schedule]]<br />
<br />
===Rule definition===<br />
<br />
Rule name: '''CR07_RULE'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"OUTPUTS/1/STATE": "on"<br />
},<br />
"filters": {<br />
"SCHEDULE/CR07_SCHEDULE/ACTIVE": true<br />
},<br />
"actions": {<br />
"OUTPUTS/2/ACTION": "${COND_RESULT}"<br />
}<br />
}</nowiki><br />
<br />
== CR08 - Load Watchdog -> Turn output ON after period of time ==<br />
<br />
In this example we want to measure load on output 1 and indicate when the power is abnormally low for a period of time by switching device on Output 2 ON (could be control light, sound alarm etc.).<br />
<br />
In PAB we define indication for low power usage (1-20W) that is measured for period of 30 minutes (1800 seconds).<br />
In Rule we define switching Output 2 = ON (ACTION 1 = TURN ON) based on fulfilled PAB condition. This set up counts with human interaction after the Rule action gets processed. (e.g. restarting/replacing device on Output 1 and turning Output 2 OFF).<br />
It is possible to alter this behavior in such a way that the control light (Output 2) turns automatically OFF when load on Output 1 returns to standard values, i.e. higher than 20W (device gets repaired/replaced) or drops to 0W (device was removed or Output 1 turned OFF). This setup is defined in Rule '''NR08_ALT'''<br />
<br />
===PAB definition===<br />
<br />
PAB name: '''CR08_PAB'''<br />
<nowiki><br />
{<br />
"type": "RANGE",<br />
"source": "OUTPUTS/1/LOAD",<br />
"lowerBound": 1,<br />
"upperBound": 20,<br />
"timeHysteresis": 1800<br />
}</nowiki><br />
<br />
===Rule definition===<br />
<br />
Rule name: '''CR08_RULE'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"PAB/CR08_PAB/IN": true<br />
},<br />
"actions": {<br />
"OUTPUTS/2/ACTION": 1<br />
}<br />
}</nowiki><br />
<br />
Rule name: '''CR08_RULE_ALT'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"PAB/CR08_PAB/IN": true<br />
},<br />
"actions": {<br />
"OUTPUTS/2/ACTION": "${COND_RESULT}"<br />
}<br />
}</nowiki><br />
<br />
== CR09 - Digital Inputs with Schedule ==<br />
<br />
Examples shows usage when we want to detect switching of Digital Input to ON state (1) but to (not) react only during specified hours (e.g. outside of working hours).<br />
Reaction hours are defined with Schedule functionality. Schedule can be defined manually or imported as a configuration file.<br />
<br />
===Schedule definition===<br />
<br />
Schedule name: '''CR09_SCHEDULE'''<br />
<br />
===Rule definition===<br />
<br />
Rule name: '''CR09_RULE'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"INPUTS/1/STATE": "on"<br />
},<br />
"filters": {<br />
"SCHEDULE/CR09_SCHEDULE/ACTIVE": false<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 2<br />
}<br />
}</nowiki><br />
<br />
== CR10 - TURN OFF Output 1 before midnight ==<br />
Rule in a combination with Schedule can be used to ensure a specified output will be turned off at the end of the day (or any other time).<br />
Schedule in this application is '''NOT''' assigned to the output and acts only as a "trigger" for launching the Rule action.<br />
<br />
===Schedule definition===<br />
<br />
Schedule name: '''off_before_midnight'''<br />
<br />
Schedule configuration: Schedule is configured to have '''intervals every day from 23:59 to 24:00'''. In this configuration, the output turns of at 23:59.<br />
<br />
[[File:cr10_schedule.png|CR10 Schedule]]<br />
<br />
===Rule definition===<br />
<br />
Rule name: '''CR10_RULE'''<br />
<nowiki><br />
{<br />
"conditions": {<br />
"SCHEDULE/off_before_midnight/ACTIVE": true<br />
},<br />
"filters": {<br />
"OUTPUTS/1/STATE": "on"<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 0<br />
}<br />
}</nowiki><br />
<br />
== CR11 - Total load (8QS)==<br />
CR11_PAB<br />
<br />
<nowiki><br />
{<br />
"type": "RANGE",<br />
"source": "OUTPUTS/TOTAL/LOAD",<br />
"lowerBound": 30,<br />
"upperBound": 100,<br />
"timeHysteresis": 3<br />
}</nowiki><br />
<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"operator": "OR",<br />
"PAB/total_outputs/IN": true<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 4,<br />
"CLOUD/OUTPUT/1/ALARM": 1<br />
}<br />
}</nowiki><br />
<br />
== CR12 - Negative load ==<br />
CR12_PAB<br />
<br />
<nowiki><br />
{<br />
"type": "RANGE",<br />
"source": "OUTPUTS/1/LOAD",<br />
"lowerBound": -400,<br />
"upperBound": 0,<br />
"timeHysteresis": 2<br />
}</nowiki><br />
<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"PAB/negative/IN": true<br />
},<br />
"actions": {<br />
"OUTPUTS/3/ACTION": 4,<br />
"OUTPUTS/4/ACTION": 4<br />
}<br />
}</nowiki><br />
<br />
<br />
== CR13 - Actions based on daylight <sup><code>FW 4.0.0+</code></sup>==<br />
Turns output ON/OFF based on sunrise/sunset times of set location.<br />
In this example, output 1 gets turned on one hour before (-60 minutes) sunrise and turns off one hour (60 minutes) after sunset. Location is se for NETIO Products headquarters (U pily 103, Prague, CZ). Elevation is set as 247 meters, above sea level.<br />
<br />
=== PAB definition ===<br />
PAB name: '''CR13_PAB'''<br />
<br />
<nowiki><br />
{<br />
"type": "DAYLIGHT",<br />
"longitude": "14.4129433E",<br />
"latitude": "50.0058144N",<br />
"altitude": 247,<br />
"sunriseDelay": -60,<br />
"sunsetDelay": 60<br />
}<br />
</nowiki><br />
<br />
=== Rule definition ===<br />
Rule name: '''CR13_RULE'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"PAB/CR13_PAB/DAY": true<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": "${COND_RESULT}"<br />
}<br />
}<br />
</nowiki><br />
<br />
== CR14 - Actions based on Power-UP <sup><code>FW 4.0.0+</code></sup>== <br />
<br />
This example describes rule that evaluates after device start-up. Generally, there are 2 options for setting up conditions: <br />
* SYSTEM/DEVICE_POWER_UP - device boot after power-cut<br />
<br />
Condition in rule description below reacts to device boot after power-cut. When device first starts after regaining power, it sends alarm to output 1 in NETIO Cloud service.<br />
<br />
=== Rule definition ===<br />
Rule name: '''CR14_RULE'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"SYSTEM/DEVICE_POWER_UP": true<br />
},<br />
"actions": {<br />
"CLOUD/OUTPUT/1/ALARM": "${COND_RESULT}"<br />
}<br />
}<br />
</nowiki><br />
<br />
== CR15 - Sunrise/sunset addaptive schedule with deep night off <sup><code>FW 4.0.1+</code></sup>==<br />
Control output ON/OFF based on sunrise/sunset times of set location and combine it with standard schedule using rules.<br />
<br />
In this example, output 1 gets turned on every day at 6:00 and switch off 30 minutes after sunrise and gets on again 30 minutes before sunset and turns off at midnight. This is an example of combination PAB output with standard schedule and mask the result of PAB with intervals defined in schedule.<br />
<br />
Following combination creates dynamic variable input with static scheduler overlay and the behaviour can be simply chosen by logical equations.<br />
<br />
=== 1. Configure schedule ===<br />
Create a schedule with name "christmas_off" and create intervals 00:00 to 06:00 every day. No need to activate the scheduler for any output. Just define it.<br />
<br />
[[File:CR15 schedule christmas off.png]]<br />
<br />
=== 2. Create sunrise/sunset PAB ===<br />
<br />
Following PAB will have <code>true</code> result during the day between sunrise with 30 minutes delay and 30 minutes before sunset set for location of NETIO Products headquarters (U pily 103, Prague, CZ). Elevation is set as 247 meters, above sea level. This result will be used in condition in rules to detect sunrise and sunset.<br />
<br />
PAB name: '''daylight'''<br />
<br />
<nowiki><br />
{<br />
"type": "DAYLIGHT",<br />
"longitude": "14.4129433E",<br />
"latitude": "50.0058144N",<br />
"altitude": 247,<br />
"sunriseDelay": 30,<br />
"sunsetDelay": -30<br />
}<br />
</nowiki><br />
<br />
=== 3. Create RULE for output ON ===<br />
<br />
In this rule is definition when the output 1 should be enabled (ON). It is combination of two conditions of PAB and scheduler.<br />
<br />
'''This code is saying:''' When is night ( day is false = <code>"PAB/daylight/DAY": false,</code>) and in paralel schedule is not active (set to be off = <code>"SCHEDULE/christmas_off/ACTIVE": false</code>) the result is <code>true</code> and following action (set output 1 to ON <code>"OUTPUTS/1/ACTION": 1</code>) is executed. <br />
<br />
RULE name: '''outON'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"operator": "AND",<br />
"PAB/daylight/DAY": false,<br />
"SCHEDULE/christmas_off/ACTIVE": false<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 1<br />
}<br />
}<br />
</nowiki><br />
<br />
=== 4. Create RULE for output OFF ===<br />
<br />
In this rule is definition when the output 1 should be disabled (OFF). It is again combination of two conditions of PAB and scheduler.<br />
<br />
'''This code is saying:''' When it is day now ( day is true = <code>"PAB/daylight/DAY": true,</code>) or the schedule is active (set to be on = <code>"SCHEDULE/christmas_off/ACTIVE": true</code>) the result is <code>true</code> and following action (set output 1 to OFF <code>"OUTPUTS/1/ACTION": 0</code>) is executed. <br />
<br />
RULE name: '''outOFF'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"operator": "OR",<br />
"PAB/daylight/DAY": true,<br />
"SCHEDULE/christmas_off/ACTIVE": true<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 0<br />
}<br />
}<br />
</nowiki><br />
<br />
== CR16 - Digital Inputs - External Switch ON/OFF <sup><code>FW 4.0.0+</code></sup>==<br />
Rule is used for managing outputs status in response to change of Digital Inputs (DI) state. Typical example of this solution is connection of external switch ON/OFF into Digital Input (IN) with consequence outputs action.<br />
<br />
<br />
=== External Switch OFF - All Outputs OFF ===<br />
Rule name: '''CR16_RULE''' <br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"INPUTS/1/STATE": "off"<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 0,<br />
"OUTPUTS/2/ACTION": 0<br />
}<br />
}<br />
</nowiki><br />
<br />
=== External Switch ON - All Outputs ON ===<br />
Rule name: '''CR16_RULE''' <br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"INPUTS/1/STATE": "on"<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 1,<br />
"OUTPUTS/2/ACTION": 1<br />
}<br />
}<br />
</nowiki><br />
<br />
=== External Switch ON - All outputs ON with individual Power Up Sequence === <br />
Rule name: '''CR16_RULE''' <br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"INPUTS/1/STATE": "on"<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 0,<br />
"sequence": {<br />
"repeat": 1,<br />
"actions": [<br />
{<br />
"OUTPUTS/1/ACTION": 1,<br />
"delay": 1000<br />
},<br />
{<br />
"OUTPUTS/2/ACTION": 1,<br />
"delay": 3000<br />
}<br />
]<br />
}<br />
}<br />
}<br />
<br />
</nowiki><br />
<br />
== CR17 - Digital Inputs - Connection of NETIO T1 Sensor <sup><code>FW 5.0.3+</code></sup>==<br />
Rule is used for managing outputs status in response to temperature metering connected into Digital Inputs (DI). Typical example of this solution is the temperature metering of server room. In case temperature hit specify temperature, the air-condition (AC) will turn on. As temperature come back to define temperature range, the air-condition (AC) turn off.<br />
<br />
=== Temperature measurement - condition definition temperature range (15-45)℃ ===<br />
NETIO T1 Sensor connected into INPUT n.2<br />
<br />
Rule name: '''CR17_TEMP''' <br />
<br />
<nowiki><br />
{<br />
"source":"INPUTS/2/TEMP",<br />
"type":"RANGE",<br />
"upperBound":45,<br />
"lowerBound":15,<br />
"timeHysteresis":1<br />
}<br />
</nowiki><br />
<br />
=== Temperature out of limit - Output1 ON ===<br />
Rule name: '''CR17_RULE''' <br />
<nowiki><br />
{<br />
"conditions":{<br />
"PAB/CR15_TEMP/IN":false<br />
},<br />
"actions":{<br />
"OUTPUTS/1/ACTION":1<br />
}<br />
}<br />
</nowiki></div>
Tbezstarosta
https://wiki.netio-products.com/index.php?title=Rules_Complete_Examples&diff=1046
Rules Complete Examples
2024-07-08T07:52:27Z
<p>Tbezstarosta: /* External Switch ON - All outputs ON with individual Power Up Sequence */</p>
<hr />
<div>The concept of NETIO Conditions (PAB & WatchDog) & Rules is a set of prepared detections (Conditions) and Rules that act upon them. They are implemented directly in NETIO PDU devices. <br />
<br />
== CR01 - WatchDog (ping) to 1 IP address | default in FW 3.2.3 ==<br />
The WatchDog functionality is used to monitor connectivity to specified IP address (or URL) by sending PING request to it.<br />
<br />
The ping in this example is sent every 60s and waits 5s for the device to respond. If the ping fails, Watchdog returns <code>false</code> and restarts (ACTION: 2 = SHORT OFF) device connected to first output. After restart, it waits 120 seconds and starts monitoring again. If the device does not respond, WatchDog remains in ERROR state until next successful ping.<br />
<br />
===WatchDog definition===<br />
<br />
WatchDog name: '''CR01_WDT'''<br />
<br />
<nowiki><br />
{<br />
"target": "192.168.1.5",<br />
"pingInterval": 60,<br />
"timeout": 5,<br />
"maxTimeouts": 0,<br />
"timeToReboot": 120,<br />
"maxRestarts": -1<br />
}</nowiki><br />
<br />
===Rule definition===<br />
<br />
Rule name: '''CR01_RULE'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"WDT/CR01_WDT/FAIL": true<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 2<br />
}<br />
}</nowiki><br />
<br />
== CR02 - Digital Inputs (Push button to Toggle Outputs 1 and 2) | default in FW 3.2.3 ==<br />
<br />
Rule is used for managing outputs in response to change of Digital Inputs (DI) state. Rule monitors state of first DI. When DI switches from OFF (0) to ON (1), Rule switches (toggles) Outputs 1 & 2 to their opposite states (ACTION 4 = TOGGLE).<br />
<br />
===Rule definition===<br />
<br />
Rule name: '''CR02_RULE'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"INPUTS/1/STATE": "on"<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 4,<br />
"OUTPUTS/2/ACTION": 4<br />
}<br />
}</nowiki><br />
<br />
== CR03 - Load Watchdog (Restart device if it's more than 2 minutes in IDLE mode) | default in FW 3.2.3 ==<br />
Rule monitors load (Watts) on Output 1. If the load is between 1-20W for at least 2 minutes, it restarts (ACTION 2 = SHORT OFF) the output.<br />
Example uses PAB (Power Analysis Block) functionality to determine if measured value (load in our case) lies in given range for a period of time. When it does, defined Rule triggers device restart.<br />
<br />
===PAB definition===<br />
<br />
PAB name: '''CR03_PAB'''<br />
<nowiki><br />
{<br />
"type": "RANGE",<br />
"source": "OUTPUTS/1/LOAD",<br />
"lowerBound": 1,<br />
"upperBound": 20,<br />
"timeHysteresis": 120<br />
}</nowiki><br />
<br />
===Rule definition===<br />
<br />
Rule name: '''CR03_RULE'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"PAB/CR03_PAB/IN": true<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 2<br />
}<br />
}</nowiki><br />
<br />
== CR04 - Load Watchdog with alarm to Cloud ==<br />
Rule monitors load (Watts) on Output 1. If the load is between 1-20W for at least 30 minutes, it restarts (ACTION 2 = SHORT OFF) the output. In addition, it triggers an alarm in NETIO Cloud, which sends a notification to specified email address.<br />
This example needs a NETIO Cloud account with Premium version active for first output. There also has to be email notification enabled for the output.<br />
<br />
Example uses PAB (Power Analysis Block) functionality to determine if measured value (load in our case) lies in given range for a period of time. When it does, defined Rule triggers device restart and sends alarm to Cloud.<br />
<br />
===PAB definition===<br />
<br />
PAB name: '''CR04_PAB'''<br />
<br />
<nowiki><br />
{<br />
"type": "RANGE",<br />
"source": "OUTPUTS/1/LOAD",<br />
"lowerBound": 1,<br />
"upperBound": 20,<br />
"timeHysteresis": 1800<br />
}</nowiki><br />
<br />
<br />
===Rule definition===<br />
<br />
Rule name: '''CR04_RULE'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"PAB/CR04_PAB/IN": true<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 2,<br />
"CLOUD/OUTPUT/1/ALARM": "${COND_RESULT}"<br />
}<br />
}</nowiki><br />
<br />
== CR05 - Load Watchdog with zones (indicate OFF / IDLE / RUN mode by switched on output)==<br />
Rule monitors load (Watts) on Output 1. Measured load is then classified to several zones defined with thresholds (limit values). Depending on the zone in which the measured load is currently located, different actions can be triggered. Load value has to be between defined threshold for at least 10seconds in order to be placed to respective zone.<br />
Example is composed of one PAB that classifies the zones and three Rules for 3 separate actions. Actions do the following:<br />
* Output 1 load lower than 1W: Output 2 = ON<br />
* Output 1 load between 1-20W: Output 3 = ON<br />
* Output 1 load between 20-200W: Output 4 = ON<br />
<br />
===PAB definition===<br />
<br />
PAB name: '''CR05_PAB'''<br />
<br />
<nowiki><br />
{<br />
"type": "ZONES",<br />
"source": "OUTPUTS/2/CURRENT",<br />
"thresholds": [<br />
1,<br />
20,<br />
200<br />
],<br />
"timeHysteresis": 10<br />
}</nowiki><br />
<br />
===Rules definitions===<br />
<br />
Rule 1 name: '''CR05_RULE_1'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"PAB/NR05_PAB/ZONE": 0<br />
},<br />
"actions": {<br />
"OUTPUTS/2/ACTION": 1,<br />
"OUTPUTS/3/ACTION": 0,<br />
"OUTPUTS/4/ACTION": 0<br />
}<br />
}</nowiki><br />
<br />
Rule 2 name: '''CR05_RULE_2'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"PAB/CR05_PAB/ZONE": 1<br />
},<br />
"actions": {<br />
"OUTPUTS/2/ACTION": 0,<br />
"OUTPUTS/3/ACTION": 1,<br />
"OUTPUTS/4/ACTION": 0<br />
}<br />
}</nowiki><br />
<br />
Rule 3 name: '''CR05_RULE_3'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"PAB/CR05_PAB/ZONE": 2<br />
},<br />
"actions": {<br />
"OUTPUTS/2/ACTION": 0,<br />
"OUTPUTS/3/ACTION": 0,<br />
"OUTPUTS/4/ACTION": 1<br />
}<br />
}</nowiki><br />
<br />
== CR06 - WatchDog for 2 IPs (Verify IP connectivity outage with 2 IPs)==<br />
The WatchDog functionality is used to monitor connectivity to specified IP address (or URL) by sending PING request to it.<br />
<br />
In this example, we monitor two IPs and we want to restart device connected to Output 1 if none of the addresses reply.<br />
The ping for both IPs is sent every 30s and waits 5s for device to respond. There are 5 consecutive timeouts tolerated before the ping is considered as failed. When the ping fails, Watchdog returns <code>false</code> and remains in ERROR state.<br />
<br />
In case both of the defined WatchDogs are in ERROR state, the Rule is triggered which then restarts Output 1.<br />
<br />
===WatchDogs definition===<br />
<br />
WatchDog name: '''CR06_WDT_1'''<br />
<br />
<nowiki><br />
{<br />
"target": "192.168.1.51",<br />
"pingInterval": 30,<br />
"timeout": 5,<br />
"maxTimeouts": 5,<br />
"timeToReboot": 120,<br />
"maxRestarts": -1<br />
}</nowiki><br />
<br />
WatchDog name: '''CR06_WDT_2'''<br />
<br />
<nowiki><br />
{<br />
"target": "192.168.1.52",<br />
"pingInterval": 60,<br />
"timeout": 5,<br />
"maxTimeouts": 5,<br />
"timeToReboot": 120,<br />
"maxRestarts": -1<br />
}</nowiki><br />
<br />
===Rule definition===<br />
<br />
Rule name: '''CR06_RULE'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"operator": "AND",<br />
"WDT/CR06_WDT_1/FAIL": true,<br />
"WDT/CR06_WDT_2/FAIL": true<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 2<br />
}<br />
}</nowiki><br />
<br />
== CR07 - Synchronized outputs states during working hours ==<br />
Rule keeps track of first output state and when it changes, it switches output 2 to the same state. However, we want this synchronization only to work during working hours. We define the time with Schedule functionality and use it as a filter (mask) in Rules. Schedule can be defined manually or imported as a configuration file.<br />
<br />
===Schedule definition===<br />
<br />
Schedule name: '''CR07_SCHEDULE'''<br />
<br />
[[File:NR07_Schedule.png|NR070 Schedule]]<br />
<br />
===Rule definition===<br />
<br />
Rule name: '''CR07_RULE'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"OUTPUTS/1/STATE": "on"<br />
},<br />
"filters": {<br />
"SCHEDULE/CR07_SCHEDULE/ACTIVE": true<br />
},<br />
"actions": {<br />
"OUTPUTS/2/ACTION": "${COND_RESULT}"<br />
}<br />
}</nowiki><br />
<br />
== CR08 - Load Watchdog -> Turn output ON after period of time ==<br />
<br />
In this example we want to measure load on output 1 and indicate when the power is abnormally low for a period of time by switching device on Output 2 ON (could be control light, sound alarm etc.).<br />
<br />
In PAB we define indication for low power usage (1-20W) that is measured for period of 30 minutes (1800 seconds).<br />
In Rule we define switching Output 2 = ON (ACTION 1 = TURN ON) based on fulfilled PAB condition. This set up counts with human interaction after the Rule action gets processed. (e.g. restarting/replacing device on Output 1 and turning Output 2 OFF).<br />
It is possible to alter this behavior in such a way that the control light (Output 2) turns automatically OFF when load on Output 1 returns to standard values, i.e. higher than 20W (device gets repaired/replaced) or drops to 0W (device was removed or Output 1 turned OFF). This setup is defined in Rule '''NR08_ALT'''<br />
<br />
===PAB definition===<br />
<br />
PAB name: '''CR08_PAB'''<br />
<nowiki><br />
{<br />
"type": "RANGE",<br />
"source": "OUTPUTS/1/LOAD",<br />
"lowerBound": 1,<br />
"upperBound": 20,<br />
"timeHysteresis": 1800<br />
}</nowiki><br />
<br />
===Rule definition===<br />
<br />
Rule name: '''CR08_RULE'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"PAB/CR08_PAB/IN": true<br />
},<br />
"actions": {<br />
"OUTPUTS/2/ACTION": 1<br />
}<br />
}</nowiki><br />
<br />
Rule name: '''CR08_RULE_ALT'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"PAB/CR08_PAB/IN": true<br />
},<br />
"actions": {<br />
"OUTPUTS/2/ACTION": "${COND_RESULT}"<br />
}<br />
}</nowiki><br />
<br />
== CR09 - Digital Inputs with Schedule ==<br />
<br />
Examples shows usage when we want to detect switching of Digital Input to ON state (1) but to (not) react only during specified hours (e.g. outside of working hours).<br />
Reaction hours are defined with Schedule functionality. Schedule can be defined manually or imported as a configuration file.<br />
<br />
===Schedule definition===<br />
<br />
Schedule name: '''CR09_SCHEDULE'''<br />
<br />
===Rule definition===<br />
<br />
Rule name: '''CR09_RULE'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"INPUTS/1/STATE": "on"<br />
},<br />
"filters": {<br />
"SCHEDULE/CR09_SCHEDULE/ACTIVE": false<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 2<br />
}<br />
}</nowiki><br />
<br />
== CR10 - TURN OFF Output 1 before midnight ==<br />
Rule in a combination with Schedule can be used to ensure a specified output will be turned off at the end of the day (or any other time).<br />
Schedule in this application is '''NOT''' assigned to the output and acts only as a "trigger" for launching the Rule action.<br />
<br />
===Schedule definition===<br />
<br />
Schedule name: '''off_before_midnight'''<br />
<br />
Schedule configuration: Schedule is configured to have '''intervals every day from 23:59 to 24:00'''. In this configuration, the output turns of at 23:59.<br />
<br />
[[File:cr10_schedule.png|CR10 Schedule]]<br />
<br />
===Rule definition===<br />
<br />
Rule name: '''CR10_RULE'''<br />
<nowiki><br />
{<br />
"conditions": {<br />
"SCHEDULE/off_before_midnight/ACTIVE": true<br />
},<br />
"filters": {<br />
"OUTPUTS/1/STATE": "on"<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 0<br />
}<br />
}</nowiki><br />
<br />
== CR11 - Total load (8QS)==<br />
CR11_PAB<br />
<br />
<nowiki><br />
{<br />
"type": "RANGE",<br />
"source": "OUTPUTS/TOTAL/LOAD",<br />
"lowerBound": 30,<br />
"upperBound": 100,<br />
"timeHysteresis": 3<br />
}</nowiki><br />
<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"operator": "OR",<br />
"PAB/total_outputs/IN": true<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 4,<br />
"CLOUD/OUTPUT/1/ALARM": 1<br />
}<br />
}</nowiki><br />
<br />
== CR12 - Negative load ==<br />
CR12_PAB<br />
<br />
<nowiki><br />
{<br />
"type": "RANGE",<br />
"source": "OUTPUTS/1/LOAD",<br />
"lowerBound": -400,<br />
"upperBound": 0,<br />
"timeHysteresis": 2<br />
}</nowiki><br />
<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"PAB/negative/IN": true<br />
},<br />
"actions": {<br />
"OUTPUTS/3/ACTION": 4,<br />
"OUTPUTS/4/ACTION": 4<br />
}<br />
}</nowiki><br />
<br />
<br />
== CR13 - Actions based on daylight <sup><code>FW 4.0.0+</code></sup>==<br />
Turns output ON/OFF based on sunrise/sunset times of set location.<br />
In this example, output 1 gets turned on one hour before (-60 minutes) sunrise and turns off one hour (60 minutes) after sunset. Location is se for NETIO Products headquarters (U pily 103, Prague, CZ). Elevation is set as 247 meters, above sea level.<br />
<br />
=== PAB definition ===<br />
PAB name: '''CR13_PAB'''<br />
<br />
<nowiki><br />
{<br />
"type": "DAYLIGHT",<br />
"longitude": "14.4129433E",<br />
"latitude": "50.0058144N",<br />
"altitude": 247,<br />
"sunriseDelay": -60,<br />
"sunsetDelay": 60<br />
}<br />
</nowiki><br />
<br />
=== Rule definition ===<br />
Rule name: '''CR13_RULE'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"PAB/CR13_PAB/DAY": true<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": "${COND_RESULT}"<br />
}<br />
}<br />
</nowiki><br />
<br />
== CR14 - Actions based on Power-UP <sup><code>FW 4.0.0+</code></sup>== <br />
<br />
This example describes rule that evaluates after device start-up. Generally, there are 2 options for setting up conditions: <br />
* SYSTEM/DEVICE_POWER_UP - device boot after power-cut<br />
<br />
Condition in rule description below reacts to device boot after power-cut. When device first starts after regaining power, it sends alarm to output 1 in NETIO Cloud service.<br />
<br />
=== Rule definition ===<br />
Rule name: '''CR14_RULE'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"SYSTEM/DEVICE_POWER_UP": true<br />
},<br />
"actions": {<br />
"CLOUD/OUTPUT/1/ALARM": "${COND_RESULT}"<br />
}<br />
}<br />
</nowiki><br />
<br />
== CR15 - Sunrise/sunset addaptive schedule with deep night off <sup><code>FW 4.0.1+</code></sup>==<br />
Control output ON/OFF based on sunrise/sunset times of set location and combine it with standard schedule using rules.<br />
<br />
In this example, output 1 gets turned on every day at 6:00 and switch off 30 minutes after sunrise and gets on again 30 minutes before sunset and turns off at midnight. This is an example of combination PAB output with standard schedule and mask the result of PAB with intervals defined in schedule.<br />
<br />
Following combination creates dynamic variable input with static scheduler overlay and the behaviour can be simply chosen by logical equations.<br />
<br />
=== 1. Configure schedule ===<br />
Create a schedule with name "christmas_off" and create intervals 00:00 to 06:00 every day. No need to activate the scheduler for any output. Just define it.<br />
<br />
[[File:CR15 schedule christmas off.png]]<br />
<br />
=== 2. Create sunrise/sunset PAB ===<br />
<br />
Following PAB will have <code>true</code> result during the day between sunrise with 30 minutes delay and 30 minutes before sunset set for location of NETIO Products headquarters (U pily 103, Prague, CZ). Elevation is set as 247 meters, above sea level. This result will be used in condition in rules to detect sunrise and sunset.<br />
<br />
PAB name: '''daylight'''<br />
<br />
<nowiki><br />
{<br />
"type": "DAYLIGHT",<br />
"longitude": "14.4129433E",<br />
"latitude": "50.0058144N",<br />
"altitude": 247,<br />
"sunriseDelay": 30,<br />
"sunsetDelay": -30<br />
}<br />
</nowiki><br />
<br />
=== 3. Create RULE for output ON ===<br />
<br />
In this rule is definition when the output 1 should be enabled (ON). It is combination of two conditions of PAB and scheduler.<br />
<br />
'''This code is saying:''' When is night ( day is false = <code>"PAB/daylight/DAY": false,</code>) and in paralel schedule is not active (set to be off = <code>"SCHEDULE/christmas_off/ACTIVE": false</code>) the result is <code>true</code> and following action (set output 1 to ON <code>"OUTPUTS/1/ACTION": 1</code>) is executed. <br />
<br />
RULE name: '''outON'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"operator": "AND",<br />
"PAB/daylight/DAY": false,<br />
"SCHEDULE/christmas_off/ACTIVE": false<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 1<br />
}<br />
}<br />
</nowiki><br />
<br />
=== 4. Create RULE for output OFF ===<br />
<br />
In this rule is definition when the output 1 should be disabled (OFF). It is again combination of two conditions of PAB and scheduler.<br />
<br />
'''This code is saying:''' When it is day now ( day is true = <code>"PAB/daylight/DAY": true,</code>) or the schedule is active (set to be on = <code>"SCHEDULE/christmas_off/ACTIVE": true</code>) the result is <code>true</code> and following action (set output 1 to OFF <code>"OUTPUTS/1/ACTION": 0</code>) is executed. <br />
<br />
RULE name: '''outOFF'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"operator": "OR",<br />
"PAB/daylight/DAY": true,<br />
"SCHEDULE/christmas_off/ACTIVE": true<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 0<br />
}<br />
}<br />
</nowiki><br />
<br />
== CR16 - Digital Inputs - External Switch ON/OFF <sup><code>FW 4.0.0+</code></sup>==<br />
Rule is used for managing outputs status in response to change of Digital Inputs (DI) state. Typical example of this solution is connection of external switch ON/OFF into Digital Input (IN) with consequence outputs action.<br />
<br />
<br />
=== External Switch OFF - All Outputs OFF ===<br />
Rule name: '''CR16_RULE''' <br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"INPUTS/1/STATE": "off"<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 0,<br />
"OUTPUTS/2/ACTION": 0<br />
}<br />
}<br />
</nowiki><br />
<br />
=== External Switch ON - All Outputs ON ===<br />
Rule name: '''CR16_RULE''' <br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"INPUTS/1/STATE": "on"<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 1,<br />
"OUTPUTS/2/ACTION": 1<br />
}<br />
}<br />
</nowiki><br />
<br />
=== External Switch ON - All outputs ON with individual Power Up Sequence === <br />
Rule name: '''CR16_RULE''' <br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"INPUTS/1/STATE": "on"<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 0,<br />
"sequence": {<br />
"repeat": 1,<br />
"actions": [<br />
{<br />
"OUTPUTS/1/ACTION": 1,<br />
"delay": 1000<br />
},<br />
{<br />
"OUTPUTS/2/ACTION": 1,<br />
"delay": 3000<br />
}<br />
]<br />
}<br />
}<br />
}<br />
<br />
</nowiki></div>
Tbezstarosta
https://wiki.netio-products.com/index.php?title=Rules_Complete_Examples&diff=1045
Rules Complete Examples
2024-07-08T07:45:12Z
<p>Tbezstarosta: </p>
<hr />
<div>The concept of NETIO Conditions (PAB & WatchDog) & Rules is a set of prepared detections (Conditions) and Rules that act upon them. They are implemented directly in NETIO PDU devices. <br />
<br />
== CR01 - WatchDog (ping) to 1 IP address | default in FW 3.2.3 ==<br />
The WatchDog functionality is used to monitor connectivity to specified IP address (or URL) by sending PING request to it.<br />
<br />
The ping in this example is sent every 60s and waits 5s for the device to respond. If the ping fails, Watchdog returns <code>false</code> and restarts (ACTION: 2 = SHORT OFF) device connected to first output. After restart, it waits 120 seconds and starts monitoring again. If the device does not respond, WatchDog remains in ERROR state until next successful ping.<br />
<br />
===WatchDog definition===<br />
<br />
WatchDog name: '''CR01_WDT'''<br />
<br />
<nowiki><br />
{<br />
"target": "192.168.1.5",<br />
"pingInterval": 60,<br />
"timeout": 5,<br />
"maxTimeouts": 0,<br />
"timeToReboot": 120,<br />
"maxRestarts": -1<br />
}</nowiki><br />
<br />
===Rule definition===<br />
<br />
Rule name: '''CR01_RULE'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"WDT/CR01_WDT/FAIL": true<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 2<br />
}<br />
}</nowiki><br />
<br />
== CR02 - Digital Inputs (Push button to Toggle Outputs 1 and 2) | default in FW 3.2.3 ==<br />
<br />
Rule is used for managing outputs in response to change of Digital Inputs (DI) state. Rule monitors state of first DI. When DI switches from OFF (0) to ON (1), Rule switches (toggles) Outputs 1 & 2 to their opposite states (ACTION 4 = TOGGLE).<br />
<br />
===Rule definition===<br />
<br />
Rule name: '''CR02_RULE'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"INPUTS/1/STATE": "on"<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 4,<br />
"OUTPUTS/2/ACTION": 4<br />
}<br />
}</nowiki><br />
<br />
== CR03 - Load Watchdog (Restart device if it's more than 2 minutes in IDLE mode) | default in FW 3.2.3 ==<br />
Rule monitors load (Watts) on Output 1. If the load is between 1-20W for at least 2 minutes, it restarts (ACTION 2 = SHORT OFF) the output.<br />
Example uses PAB (Power Analysis Block) functionality to determine if measured value (load in our case) lies in given range for a period of time. When it does, defined Rule triggers device restart.<br />
<br />
===PAB definition===<br />
<br />
PAB name: '''CR03_PAB'''<br />
<nowiki><br />
{<br />
"type": "RANGE",<br />
"source": "OUTPUTS/1/LOAD",<br />
"lowerBound": 1,<br />
"upperBound": 20,<br />
"timeHysteresis": 120<br />
}</nowiki><br />
<br />
===Rule definition===<br />
<br />
Rule name: '''CR03_RULE'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"PAB/CR03_PAB/IN": true<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 2<br />
}<br />
}</nowiki><br />
<br />
== CR04 - Load Watchdog with alarm to Cloud ==<br />
Rule monitors load (Watts) on Output 1. If the load is between 1-20W for at least 30 minutes, it restarts (ACTION 2 = SHORT OFF) the output. In addition, it triggers an alarm in NETIO Cloud, which sends a notification to specified email address.<br />
This example needs a NETIO Cloud account with Premium version active for first output. There also has to be email notification enabled for the output.<br />
<br />
Example uses PAB (Power Analysis Block) functionality to determine if measured value (load in our case) lies in given range for a period of time. When it does, defined Rule triggers device restart and sends alarm to Cloud.<br />
<br />
===PAB definition===<br />
<br />
PAB name: '''CR04_PAB'''<br />
<br />
<nowiki><br />
{<br />
"type": "RANGE",<br />
"source": "OUTPUTS/1/LOAD",<br />
"lowerBound": 1,<br />
"upperBound": 20,<br />
"timeHysteresis": 1800<br />
}</nowiki><br />
<br />
<br />
===Rule definition===<br />
<br />
Rule name: '''CR04_RULE'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"PAB/CR04_PAB/IN": true<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 2,<br />
"CLOUD/OUTPUT/1/ALARM": "${COND_RESULT}"<br />
}<br />
}</nowiki><br />
<br />
== CR05 - Load Watchdog with zones (indicate OFF / IDLE / RUN mode by switched on output)==<br />
Rule monitors load (Watts) on Output 1. Measured load is then classified to several zones defined with thresholds (limit values). Depending on the zone in which the measured load is currently located, different actions can be triggered. Load value has to be between defined threshold for at least 10seconds in order to be placed to respective zone.<br />
Example is composed of one PAB that classifies the zones and three Rules for 3 separate actions. Actions do the following:<br />
* Output 1 load lower than 1W: Output 2 = ON<br />
* Output 1 load between 1-20W: Output 3 = ON<br />
* Output 1 load between 20-200W: Output 4 = ON<br />
<br />
===PAB definition===<br />
<br />
PAB name: '''CR05_PAB'''<br />
<br />
<nowiki><br />
{<br />
"type": "ZONES",<br />
"source": "OUTPUTS/2/CURRENT",<br />
"thresholds": [<br />
1,<br />
20,<br />
200<br />
],<br />
"timeHysteresis": 10<br />
}</nowiki><br />
<br />
===Rules definitions===<br />
<br />
Rule 1 name: '''CR05_RULE_1'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"PAB/NR05_PAB/ZONE": 0<br />
},<br />
"actions": {<br />
"OUTPUTS/2/ACTION": 1,<br />
"OUTPUTS/3/ACTION": 0,<br />
"OUTPUTS/4/ACTION": 0<br />
}<br />
}</nowiki><br />
<br />
Rule 2 name: '''CR05_RULE_2'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"PAB/CR05_PAB/ZONE": 1<br />
},<br />
"actions": {<br />
"OUTPUTS/2/ACTION": 0,<br />
"OUTPUTS/3/ACTION": 1,<br />
"OUTPUTS/4/ACTION": 0<br />
}<br />
}</nowiki><br />
<br />
Rule 3 name: '''CR05_RULE_3'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"PAB/CR05_PAB/ZONE": 2<br />
},<br />
"actions": {<br />
"OUTPUTS/2/ACTION": 0,<br />
"OUTPUTS/3/ACTION": 0,<br />
"OUTPUTS/4/ACTION": 1<br />
}<br />
}</nowiki><br />
<br />
== CR06 - WatchDog for 2 IPs (Verify IP connectivity outage with 2 IPs)==<br />
The WatchDog functionality is used to monitor connectivity to specified IP address (or URL) by sending PING request to it.<br />
<br />
In this example, we monitor two IPs and we want to restart device connected to Output 1 if none of the addresses reply.<br />
The ping for both IPs is sent every 30s and waits 5s for device to respond. There are 5 consecutive timeouts tolerated before the ping is considered as failed. When the ping fails, Watchdog returns <code>false</code> and remains in ERROR state.<br />
<br />
In case both of the defined WatchDogs are in ERROR state, the Rule is triggered which then restarts Output 1.<br />
<br />
===WatchDogs definition===<br />
<br />
WatchDog name: '''CR06_WDT_1'''<br />
<br />
<nowiki><br />
{<br />
"target": "192.168.1.51",<br />
"pingInterval": 30,<br />
"timeout": 5,<br />
"maxTimeouts": 5,<br />
"timeToReboot": 120,<br />
"maxRestarts": -1<br />
}</nowiki><br />
<br />
WatchDog name: '''CR06_WDT_2'''<br />
<br />
<nowiki><br />
{<br />
"target": "192.168.1.52",<br />
"pingInterval": 60,<br />
"timeout": 5,<br />
"maxTimeouts": 5,<br />
"timeToReboot": 120,<br />
"maxRestarts": -1<br />
}</nowiki><br />
<br />
===Rule definition===<br />
<br />
Rule name: '''CR06_RULE'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"operator": "AND",<br />
"WDT/CR06_WDT_1/FAIL": true,<br />
"WDT/CR06_WDT_2/FAIL": true<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 2<br />
}<br />
}</nowiki><br />
<br />
== CR07 - Synchronized outputs states during working hours ==<br />
Rule keeps track of first output state and when it changes, it switches output 2 to the same state. However, we want this synchronization only to work during working hours. We define the time with Schedule functionality and use it as a filter (mask) in Rules. Schedule can be defined manually or imported as a configuration file.<br />
<br />
===Schedule definition===<br />
<br />
Schedule name: '''CR07_SCHEDULE'''<br />
<br />
[[File:NR07_Schedule.png|NR070 Schedule]]<br />
<br />
===Rule definition===<br />
<br />
Rule name: '''CR07_RULE'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"OUTPUTS/1/STATE": "on"<br />
},<br />
"filters": {<br />
"SCHEDULE/CR07_SCHEDULE/ACTIVE": true<br />
},<br />
"actions": {<br />
"OUTPUTS/2/ACTION": "${COND_RESULT}"<br />
}<br />
}</nowiki><br />
<br />
== CR08 - Load Watchdog -> Turn output ON after period of time ==<br />
<br />
In this example we want to measure load on output 1 and indicate when the power is abnormally low for a period of time by switching device on Output 2 ON (could be control light, sound alarm etc.).<br />
<br />
In PAB we define indication for low power usage (1-20W) that is measured for period of 30 minutes (1800 seconds).<br />
In Rule we define switching Output 2 = ON (ACTION 1 = TURN ON) based on fulfilled PAB condition. This set up counts with human interaction after the Rule action gets processed. (e.g. restarting/replacing device on Output 1 and turning Output 2 OFF).<br />
It is possible to alter this behavior in such a way that the control light (Output 2) turns automatically OFF when load on Output 1 returns to standard values, i.e. higher than 20W (device gets repaired/replaced) or drops to 0W (device was removed or Output 1 turned OFF). This setup is defined in Rule '''NR08_ALT'''<br />
<br />
===PAB definition===<br />
<br />
PAB name: '''CR08_PAB'''<br />
<nowiki><br />
{<br />
"type": "RANGE",<br />
"source": "OUTPUTS/1/LOAD",<br />
"lowerBound": 1,<br />
"upperBound": 20,<br />
"timeHysteresis": 1800<br />
}</nowiki><br />
<br />
===Rule definition===<br />
<br />
Rule name: '''CR08_RULE'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"PAB/CR08_PAB/IN": true<br />
},<br />
"actions": {<br />
"OUTPUTS/2/ACTION": 1<br />
}<br />
}</nowiki><br />
<br />
Rule name: '''CR08_RULE_ALT'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"PAB/CR08_PAB/IN": true<br />
},<br />
"actions": {<br />
"OUTPUTS/2/ACTION": "${COND_RESULT}"<br />
}<br />
}</nowiki><br />
<br />
== CR09 - Digital Inputs with Schedule ==<br />
<br />
Examples shows usage when we want to detect switching of Digital Input to ON state (1) but to (not) react only during specified hours (e.g. outside of working hours).<br />
Reaction hours are defined with Schedule functionality. Schedule can be defined manually or imported as a configuration file.<br />
<br />
===Schedule definition===<br />
<br />
Schedule name: '''CR09_SCHEDULE'''<br />
<br />
===Rule definition===<br />
<br />
Rule name: '''CR09_RULE'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"INPUTS/1/STATE": "on"<br />
},<br />
"filters": {<br />
"SCHEDULE/CR09_SCHEDULE/ACTIVE": false<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 2<br />
}<br />
}</nowiki><br />
<br />
== CR10 - TURN OFF Output 1 before midnight ==<br />
Rule in a combination with Schedule can be used to ensure a specified output will be turned off at the end of the day (or any other time).<br />
Schedule in this application is '''NOT''' assigned to the output and acts only as a "trigger" for launching the Rule action.<br />
<br />
===Schedule definition===<br />
<br />
Schedule name: '''off_before_midnight'''<br />
<br />
Schedule configuration: Schedule is configured to have '''intervals every day from 23:59 to 24:00'''. In this configuration, the output turns of at 23:59.<br />
<br />
[[File:cr10_schedule.png|CR10 Schedule]]<br />
<br />
===Rule definition===<br />
<br />
Rule name: '''CR10_RULE'''<br />
<nowiki><br />
{<br />
"conditions": {<br />
"SCHEDULE/off_before_midnight/ACTIVE": true<br />
},<br />
"filters": {<br />
"OUTPUTS/1/STATE": "on"<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 0<br />
}<br />
}</nowiki><br />
<br />
== CR11 - Total load (8QS)==<br />
CR11_PAB<br />
<br />
<nowiki><br />
{<br />
"type": "RANGE",<br />
"source": "OUTPUTS/TOTAL/LOAD",<br />
"lowerBound": 30,<br />
"upperBound": 100,<br />
"timeHysteresis": 3<br />
}</nowiki><br />
<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"operator": "OR",<br />
"PAB/total_outputs/IN": true<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 4,<br />
"CLOUD/OUTPUT/1/ALARM": 1<br />
}<br />
}</nowiki><br />
<br />
== CR12 - Negative load ==<br />
CR12_PAB<br />
<br />
<nowiki><br />
{<br />
"type": "RANGE",<br />
"source": "OUTPUTS/1/LOAD",<br />
"lowerBound": -400,<br />
"upperBound": 0,<br />
"timeHysteresis": 2<br />
}</nowiki><br />
<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"PAB/negative/IN": true<br />
},<br />
"actions": {<br />
"OUTPUTS/3/ACTION": 4,<br />
"OUTPUTS/4/ACTION": 4<br />
}<br />
}</nowiki><br />
<br />
<br />
== CR13 - Actions based on daylight <sup><code>FW 4.0.0+</code></sup>==<br />
Turns output ON/OFF based on sunrise/sunset times of set location.<br />
In this example, output 1 gets turned on one hour before (-60 minutes) sunrise and turns off one hour (60 minutes) after sunset. Location is se for NETIO Products headquarters (U pily 103, Prague, CZ). Elevation is set as 247 meters, above sea level.<br />
<br />
=== PAB definition ===<br />
PAB name: '''CR13_PAB'''<br />
<br />
<nowiki><br />
{<br />
"type": "DAYLIGHT",<br />
"longitude": "14.4129433E",<br />
"latitude": "50.0058144N",<br />
"altitude": 247,<br />
"sunriseDelay": -60,<br />
"sunsetDelay": 60<br />
}<br />
</nowiki><br />
<br />
=== Rule definition ===<br />
Rule name: '''CR13_RULE'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"PAB/CR13_PAB/DAY": true<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": "${COND_RESULT}"<br />
}<br />
}<br />
</nowiki><br />
<br />
== CR14 - Actions based on Power-UP <sup><code>FW 4.0.0+</code></sup>== <br />
<br />
This example describes rule that evaluates after device start-up. Generally, there are 2 options for setting up conditions: <br />
* SYSTEM/DEVICE_POWER_UP - device boot after power-cut<br />
<br />
Condition in rule description below reacts to device boot after power-cut. When device first starts after regaining power, it sends alarm to output 1 in NETIO Cloud service.<br />
<br />
=== Rule definition ===<br />
Rule name: '''CR14_RULE'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"SYSTEM/DEVICE_POWER_UP": true<br />
},<br />
"actions": {<br />
"CLOUD/OUTPUT/1/ALARM": "${COND_RESULT}"<br />
}<br />
}<br />
</nowiki><br />
<br />
== CR15 - Sunrise/sunset addaptive schedule with deep night off <sup><code>FW 4.0.1+</code></sup>==<br />
Control output ON/OFF based on sunrise/sunset times of set location and combine it with standard schedule using rules.<br />
<br />
In this example, output 1 gets turned on every day at 6:00 and switch off 30 minutes after sunrise and gets on again 30 minutes before sunset and turns off at midnight. This is an example of combination PAB output with standard schedule and mask the result of PAB with intervals defined in schedule.<br />
<br />
Following combination creates dynamic variable input with static scheduler overlay and the behaviour can be simply chosen by logical equations.<br />
<br />
=== 1. Configure schedule ===<br />
Create a schedule with name "christmas_off" and create intervals 00:00 to 06:00 every day. No need to activate the scheduler for any output. Just define it.<br />
<br />
[[File:CR15 schedule christmas off.png]]<br />
<br />
=== 2. Create sunrise/sunset PAB ===<br />
<br />
Following PAB will have <code>true</code> result during the day between sunrise with 30 minutes delay and 30 minutes before sunset set for location of NETIO Products headquarters (U pily 103, Prague, CZ). Elevation is set as 247 meters, above sea level. This result will be used in condition in rules to detect sunrise and sunset.<br />
<br />
PAB name: '''daylight'''<br />
<br />
<nowiki><br />
{<br />
"type": "DAYLIGHT",<br />
"longitude": "14.4129433E",<br />
"latitude": "50.0058144N",<br />
"altitude": 247,<br />
"sunriseDelay": 30,<br />
"sunsetDelay": -30<br />
}<br />
</nowiki><br />
<br />
=== 3. Create RULE for output ON ===<br />
<br />
In this rule is definition when the output 1 should be enabled (ON). It is combination of two conditions of PAB and scheduler.<br />
<br />
'''This code is saying:''' When is night ( day is false = <code>"PAB/daylight/DAY": false,</code>) and in paralel schedule is not active (set to be off = <code>"SCHEDULE/christmas_off/ACTIVE": false</code>) the result is <code>true</code> and following action (set output 1 to ON <code>"OUTPUTS/1/ACTION": 1</code>) is executed. <br />
<br />
RULE name: '''outON'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"operator": "AND",<br />
"PAB/daylight/DAY": false,<br />
"SCHEDULE/christmas_off/ACTIVE": false<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 1<br />
}<br />
}<br />
</nowiki><br />
<br />
=== 4. Create RULE for output OFF ===<br />
<br />
In this rule is definition when the output 1 should be disabled (OFF). It is again combination of two conditions of PAB and scheduler.<br />
<br />
'''This code is saying:''' When it is day now ( day is true = <code>"PAB/daylight/DAY": true,</code>) or the schedule is active (set to be on = <code>"SCHEDULE/christmas_off/ACTIVE": true</code>) the result is <code>true</code> and following action (set output 1 to OFF <code>"OUTPUTS/1/ACTION": 0</code>) is executed. <br />
<br />
RULE name: '''outOFF'''<br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"operator": "OR",<br />
"PAB/daylight/DAY": true,<br />
"SCHEDULE/christmas_off/ACTIVE": true<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 0<br />
}<br />
}<br />
</nowiki><br />
<br />
== CR16 - Digital Inputs - External Switch ON/OFF <sup><code>FW 4.0.0+</code></sup>==<br />
Rule is used for managing outputs status in response to change of Digital Inputs (DI) state. Typical example of this solution is connection of external switch ON/OFF into Digital Input (IN) with consequence outputs action.<br />
<br />
<br />
=== External Switch OFF - All Outputs OFF ===<br />
Rule name: '''CR16_RULE''' <br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"INPUTS/1/STATE": "off"<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 0,<br />
"OUTPUTS/2/ACTION": 0<br />
}<br />
}<br />
</nowiki><br />
<br />
=== External Switch ON - All Outputs ON ===<br />
Rule name: '''CR16_RULE''' <br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"INPUTS/1/STATE": "on"<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 1,<br />
"OUTPUTS/2/ACTION": 1<br />
}<br />
}<br />
</nowiki><br />
<br />
=== External Switch ON - All outputs ON with individual Power Up Sequence ===<br />
Rule name: '''CR16_RULE''' <br />
<br />
<nowiki><br />
{<br />
"conditions": {<br />
"INPUTS/1/STATE": "on"<br />
},<br />
"actions": {<br />
"OUTPUTS/1/ACTION": 0,<br />
"sequence": {<br />
"repeat": 1,<br />
"actions": [<br />
{<br />
"OUTPUTS/1/ACTION": 1,<br />
"delay": 1000<br />
},<br />
{<br />
"OUTPUTS/2/ACTION": 1,<br />
"delay": 3000<br />
}<br />
]<br />
}<br />
}<br />
}<br />
<br />
</nowiki></div>
Tbezstarosta