NETIO Specific Reference manual - Revision history

Admin: /* Socket System Management */

2019-07-11T18:45:33Z

‎Socket System Management

Admin: /* Script triggers */

2019-07-11T18:44:27Z

‎Script triggers

Bbakala: /* Script triggers */

2019-07-11T16:53:05Z

‎Script triggers

Bbakala: Created page with "== Script triggers == * Power measurements changed * Global power characteristics changed * Schedule..."

2019-07-11T16:51:10Z

Created page with "== Script triggers == * Power measurements changed * Global power characteristics changed * Schedule..."

New page

== Script triggers ==
* [[Power measurements changed|Power measurements changed]]
* [[Global power characteristics changed|Global power characteristics changed]]
* [[Schedule has started or stopped|Schedule has started or stopped]]
* [[Incoming URL API request|Incoming URL API request]]
* [[System started up|System started up]]
* [[Mqtt was disconnected from the broker|Mqtt was disconnected from the broker]]
* [[Mqtt received message on subscribed topic|Mqtt received message on subscribed topic]]
* [[System variables updated|System variables updated]]
* [[Mqtt has connected to the broker|Mqtt has connected to the broker]]
* [[DO state changed|DO state changed]]

== Outlet Management ==
<big> devices.system </big>
* function [[Function devices.system.SetOut()|.SetOut()]] - turns the outlet on or off
* function [[Function devices.system.ResetOut()|.ResetOut()]] - turns the outlet off and then resets its previous state
* string [[String devices.system.output1_state|.output1_state]] - outlet's state
* number [[Number devices.system.output1_consumption|.output1_consumption]] - outlet's consumption (in Watts)
* number [[Number devices.system.output1_cumulatedConsumption|.output1_cumulatedConsumption]] - outlet's consumed energy (in Watthours)
* function [[Function devices.system.resetCumulativeConsumption()|.resetCumulativeConsumption()]] - resets outlet's energy counter
* string [[String devices.system.output1_consumptionStart|.output1_consumptionStart]] - date and time since the last energy counter reset

== Socket System Management ==
<big> devices.system </big>
* number [[number devices.system.averageLoad|.averageLoad]] - socket's CPU load
* function [[Function devices.system.Reboot()|.Reboot()]] - reboot socket's system
* number [[Number devices.system.sessionCount|.sessionCount]] - number of connected users
* number [[Number devices.system.freeSpace|.freeSpace]] - free disk space
* number [[Number devices.system.totalSpace|.totalSpace]] - total disk space
* string [[String devices.system.serialNumber|.serialNumber]] <code>3.3.1</code> - returns serial number of the device (Eth Interface MAC address)
* number [[Number devices.system.voltage|.voltage]] - socket's voltage
* number [[Number devices.system.overallPowerFactor|.overallPowerFactor]] - overall power factor
* number [[Number devices.system.frequency|.frequency]] - socket's frequency
* number [[Number devices.system.totalCurrent|.totalCurrent]] - total current through socket
* number [[Number devices.system.totalLoad|.totalLoad]] - total load on socket
* number [[Number devices.system.totalEnergy|.totalEnergy]] - total energy consumed by socket
* string [[Number devices.system.energyStart|.energyStart]] - time of last consumption reset

== Socket Communication ==
* function [[Function ping()|ping()]] - tests socket's network responsivity
* function [[Function mail()|mail()]] - sends e-mail
* function [[Function devices.system.CustomCGI()|devices.system.CustomCGI()]] - send HTTP request
* function [[Function cgiGet()|cgiGet()]] <code>2.3.5</code> - send HTTP request and receive response
* table [[Table event.args|event.args]] - HTTP GET /event variables table
* function [[Function snmpGet()|snmpGet()]] <code>3.3.1</code> - send SNMP request

== XML Processing <code>2.3.6</code> ==
<big>xml</big>
* function [[Function xml.escape()|.escape()]] - escapes XML string to fit xml node contents
* function [[Function xml.check()|.check()]] - tests if string is well-formed XML
* function [[Function xml.parse()|.parse()]] - parses XML string into [[Function xml.parse()#XmlElement|XmlElement]] object

== JSON Processing <code>3.3.1</code> ==
<big>json</big>
* function [[Function json.decode()|.decode()]] - parse json string into obj table
* function [[Function json.encode()|.encode()]] - generate JSON string from table

(based on [http://dkolf.de/src/dkjson-lua.fsl/home dkjson])

== Modbus <code>3.3.1</code>==
<big>Read functions</big>
* function [[Function modbusReadCoil()|modbusReadCoil()]] - read value from coil
* function [[Function modbusReadDiscreteInput()|modbusReadDiscreteInput()]] - read value from discrete input
* function [[Function modbusReadHoldingRegister()|modbusReadHoldingRegister()]] - read value from holding register
* function [[Function modbusReadInputRegister()|modbusReadInputRegister()]] - read value from input register

<big>Write functions</big>
* function [[Function modbusWriteSingleCoil()|modbusWriteSingleCoil()]] - write value to single coil
* function [[Function modbusWriteSingleRegister()|modbusWriteSingleRegister()]] - write value to single register

== MQTT <code>3.3.1</code>==
* function [[Function devices.system.MqttLuaSubscribe()|.MqttLuaSubscribe()]] - subscribe to MQTT topic
* function [[Function devices.system.MqttPublish()|.MqttPublish()]] - send message to MQTT topic

== Standard Lua Functions ==
* function [https://www.lua.org/pil/8.3.html assert(), error()] issues an error
* function [https://www.lua.org/pil/7.3.html ipairs(), pairs(), next()] traverse tables
* function [https://www.lua.org/pil/2.4.html tonumber(), tostring()] data type conversion
* function [https://www.lua.org/pil/8.4.html pcall()] protected call function (handles error inside the function)
* function [https://www.lua.org/pil/5.2.html select()] selects from multiple return value
* function [https://www.lua.org/pil/2.html unpack] converts table into multiple values
* function [https://www.lua.org/pil/2.html type()] returns variable type
* function [https://www.lua.org/pil/22.1.html os.date(), os.time()] system date and time
* function os.difftime() returns time span between two times

== Miscellaneous ==
* function [[Function log()|log()]] - insert a record to the socket's event log
* function [[Function logf()|logf()]] - insert a formated record (incl. numbers) to the socket's event log
* function [[Function delay()|delay()]] - execute function with delay (seconds)
* function [[Function milliDelay()|milliDelay()]] - execute function with delay (milliseconds)
* function [[Function toboolean()|toboolean()]] - converts any variable to boolean type

@@ Line 29: / Line 29: @@
 * number [[Number devices.system.totalSpace|.totalSpace]] - total disk space
 * string [[String devices.system.serialNumber|.serialNumber]] <sup><code>3.3.1</code></sup> - returns serial number of the device (Eth Interface MAC address)
-* number [[Number devices.system.voltage|.voltage]] - socket's voltage
+* number [[Number devices.system.voltage|.voltage]] <sup><code>3.0.0</code></sup> - socket's voltage
-* number [[Number devices.system.overallPowerFactor|.overallPowerFactor]] - overall power factor
+* number [[Number devices.system.overallPowerFactor|.overallPowerFactor]] <sup><code>3.0.0</code></sup> - overall power factor
-* number [[Number devices.system.frequency|.frequency]] - socket's frequency
+* number [[Number devices.system.frequency|.frequency]] <sup><code>3.0.0</code></sup> - socket's frequency
-* number [[Number devices.system.totalCurrent|.totalCurrent]] - total current through socket
+* number [[Number devices.system.totalCurrent|.totalCurrent]] <sup><code>3.0.0</code></sup> - total current through socket
-* number [[Number devices.system.totalLoad|.totalLoad]] - total load on socket
+* number [[Number devices.system.totalLoad|.totalLoad]] <sup><code>3.0.0</code></sup> - total load on socket
-* number [[Number devices.system.totalEnergy|.totalEnergy]] - total energy consumed by socket
+* number [[Number devices.system.totalEnergy|.totalEnergy]] <sup><code>3.0.0</code></sup> - total energy consumed by socket
-* string [[Number devices.system.energyStart|.energyStart]] - time of last consumption reset
+* string [[Number devices.system.energyStart|.energyStart]] <sup><code>3.0.0</code></sup> - time of last consumption reset
 == Socket Communication ==

@@ Line 1: / Line 1: @@
 == Script triggers ==
-* [[Power measurements changed|Power measurements changed]]
+* [[Power measurements changed|Power measurements changed]]<sup><code>3.3.1</code></sup>
-* [[Global power characteristics changed|Global power characteristics changed]]
+* [[Global power characteristics changed|Global power characteristics changed]]<sup><code>3.3.1</code></sup>
 * [[Schedule has started or stopped|Schedule has started or stopped]]
 * [[Incoming URL API request|Incoming URL API request]]
 * [[System started up|System started up]]
-* [[Mqtt was disconnected from the broker|Mqtt was disconnected from the broker]]
+* [[Mqtt was disconnected from the broker|Mqtt was disconnected from the broker]]<sup><code>3.3.1</code></sup>
-* [[Mqtt received message on subscribed topic|Mqtt received message on subscribed topic]]
+* [[Mqtt received message on subscribed topic|Mqtt received message on subscribed topic]]<sup><code>3.3.1</code></sup>
 * [[System variables updated|System variables updated]]
-* [[Mqtt has connected to the broker|Mqtt has connected to the broker]]
+* [[Mqtt has connected to the broker|Mqtt has connected to the broker]]<sup><code>3.3.1</code></sup>
 * [[DO state changed|DO state changed]]