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

NETIO Lua Tips & Philosophy

2019-10-17T10:57:34Z

Phrych:

== Script starting ==
LUA Scripts in NETIO are event driven. That means if some [[NETIO Lua Reference| event]] is triggered the script run exactly once. One of "triggers" is for example [[System started up|System started up]]. You can find list of all events called "triggers" in [[NETIO Lua Reference|NETIO Lua Reference]].

== Periodical scipts ==
In NETIO there is no way for triggering scripts periodically (e.g. every 10 seconds) usng standard triggers. For such scripts the trigger [[System started up|System started up]] and the function [[delay()|delay()]] must be used. This function calls itself and allows to run some procedures periodically.
*Example switching output 1 every 10 seconds:

local doPeriod = 10 -- repeat period in seconds
-------------------------------------------------
function doPeriodically()
-- your periodical code
-- your periodical code
-- your periodical code
-- your periodical code
-- your periodical code
-- your periodical code
delay(doPeriod,function() doPeriodically() end)
end

doPeriodically()

*This script can be launch using e.g. [[System started up|System started up]] trigger.
*Only way how to disable these scripts is restart of NETIO, or usage of global variables.

== Debugging ==
To debug your code, use [[Function log()|log()]] and [[Function logf()|logf()]] functions. See the output in system events log.

== Global variables ==
For sharing variables between scripts, their initialization must be done without keyword '''local'''. Conventions in Lua specify that global variables should start with '''_G.''' (e.q. '''_G.globalVariable = true'''). After initialization global variable is available in all scripts. After restarting device, all global variables are deleted. It is recommended to use different names for local and global variables.

== Deactivating scripts using global variables ==
Periodical scripts described above can be paused using global variables. The only necessary thing is adding '''if-else''' condition at the beginning of callback function. This condition is checking state of global variable and based on its state it may pause the script. Value of global variable may be changed in another script triggered for example by URL API request.

Example of a periodical script which can be paused by second script. Second script should be triggered by URL API request. Main script is then paused by: ''http://<NETIO_IP>/event?globalVariable=0'' and resumed by ''http://<NETIO_IP>/event?globalVariable=1''.

Main script:

local doPeriod = 10 -- repeat period in seconds
globalVariable = true -- initialization of global variable
-------------------------------------------------
function doPeriodically()
if globalVariable == true then
-- your periodical code
-- your periodical code
-- your periodical code
-- your periodical code
-- your periodical code
-- your periodical code
end
delay(doPeriod,function() doPeriodically() end)
end

doPeriodically()

Controling script (trigger: Incoming URL API request):

if event.args.globalVariable == "0" then
globalVariable = false
elseif event.args.globalVariable == "1" then
globalVariable = true
end

NETIO Lua Tips & Philosophy

2019-10-17T09:13:43Z

Phrych:

NETIO Lua Tips & Philosophy

2019-10-17T09:13:26Z

Phrych:

NETIO Lua Manual

2019-07-11T15:50:34Z

Phrych:

== Script triggering ==
Scripts in NETIO are launched with "triggers" such as [[System started up|System started up]]. List of all triggers is in [[NETIO Lua Reference|NETIO Lua Reference]].

== Periodical scipts ==
In NETIO there is no way for triggering scripts periodically (e.g. every 10 seconds). For such scripts a function [[delay()|delay()]] must be used. This function allows to run some procedures periodically.
*Example switching output 1 every 10 seconds:
function switch()
if devices.system.output1_state == 'on' then
devices.system.SetOut{output=1,value=false}
else
devices.system.SetOut{output=1, value=true}
end
delay(10,function() switch() end)
end

switch()

*This script can be launch using e.g. [[System started up|System started up]] trigger.
*Only way how to disable these scripts is restart of NETIO, or usage of global variables.

== Debugging ==
To debug your code, use [[Function log()|log()]] and [[Function logf()|logf()]] functions. See the output in system events log.

== Data types and variables ==
Lua supports these data types:
* nil (to assign nil value effectively deletes the variable)
* boolean (falsy values are nil and false only; "" and 0 evaluates as true)
* number (decimals only in standard Lua, integers only in Netio Lua)
* string (same strings share same address, so equality operator measures both address and value)
* tables are associative arrays. (Tables with numeric indices are, well, just arrays.)

local numbers = {2,3,7,5} -- array (first index = 1)
local dictionary = {one=1, two=2, three=3} -- table
local numbersZeroBased = {[0]=2,3,7,5} -- array (first index = 0)

local keyword limits the variable scope to the block (ended by end) where it is declared. To access an upvalue (variable defined outside of the scope), just omit the local keyword.

== Operators ==
Lua has its own manners:
* <code>~=</code> is inequality operator
* <code>..</code> is string concatenation (don't use plus)
* <code><s>i++</s></code> no increment/decrement operator <code>i = i + 1</code>
* <code><s>max = a</code> no ternary operator. Use (and get used to) and idiom instead: <code>max = (a<b) and b or a</code>
* or idiom works: <code>x = x or 42</code> is equivalent to <code>if not x then x = 42 end</code>

== Conditions ==
Lua conditions has casual syntax, see [https://www.lua.org/pil/4.3.1.html here]. Just keep in mind to merge <code>else</code> and <code>if</code> to <code>elseif</code> or multiple <code>end</code>s are required.

Note that falsy values are nil and false only. Empty string and 0 evaluates as true. If you come from C, you might be surprised by following snippet:

if devices.system.output1_consumption then
-- always happens, even if the consumption is 0
log("Outlet 1 supplies power")
end

if not devices.system.output1_consumption then
-- never happens, even if the consumption is 0
log("Outlet 1 is idle")
end

== Loops ==
Lua has <code>break</code> statement, but no <code>continue</code> (use condition inside loop instead). Additionally, Netio Lua implementation limits the loop iterations to 32k.

=== While ===
While syntax is not different to other languages:
local i = 0
while i~=3 do
i = i + 1
logf("%d",i)
end

=== Repeat until ===
Repeat until syntax is the same as Pascal's, other languages have similar do-while loops:
local i = 0
repeat
i = i + 1
logf("%d",i)
until i==3

=== Numeric for ===
Arrays in Lua are one-based (in indices are not specified, the first one is 1, not 0).
local arr = {2,3,7,5}
for i=1,#arr do logf("%d",arr[i]) end
<code>for initVar,limit,increment do</code>
* number assignment <code>initVar</code> inits loop-local variable
* number <code>limit</code> loops until initVar reaches this value
* optional number <code>increment</code> after each loop initVar increment by this value (default 1)

=== Generic for ===
Is rather sophisticated. Most common example (the order of elements in <code>pairs()</code> is not guaranteed):
local tab = {one=1, two=2, three=3}
for key,val in pairs(tab) do logf("%s:%d",key,val) end
Generic for syntax
for var_1, ..., var_n in explist do block end
is equivalent to (Full explanation [https://www.lua.org/pil/7.2.html here].)
do
local _f, _s, _var = explist
while true do
local var_1, ... , var_n = _f(_s, _var)
_var = var_1
if _var == nil then break end
block
end
end

Iterator closure that holds its state
function iter(a)
local i = 0
return function()
i = i+1
return a[i]
end
end

local arr = {2,3,7,5}
for value in iter(arr) do
logf("%d",value)
end

Stateless iterator (in this case returns variable list: key and value)
function iter(a,i)
i = i+1
if a[i] then return i,a[i] end
end

local arr = {2,3,7,5}
for k,v in iter,arr,0 do
logf("%d:%d",k,v)
end

Same effect using <code>ipairs()</code> Lua function (without initial state)
for k,v in ipairs(arr) do
logf("%d:%d",k,v)
end

Now return to the most common example above using <code>pairs()</code> Lua function and read about <code>pairs()</code> and <code>ipairs()</code> implementation [https://www.lua.org/pil/7.3.html here].

== Functions ==

Lua allows multiple results (comma separated):

function diskSpace()
return devices.system.freeSpace, devices.system.totalSpace
end

logf("Free space: %d MB", diskSpace()) -- only first return value is used
local free,total = diskSpace() -- values are stored into LHS var-list
logf("Free space: %d %%", 100*free/total)

Variable-length arguments are also available:

function sum(...)
local result = 0
for _,v in ipairs(arg) do
result = result + v
end
return result
end

logf("Sum: %d", sum(2,3,5))

NETIO Lua Manual

2019-07-11T15:49:13Z

Phrych:

== Script triggering ==
Scripts in NETIO are launched with "triggers" such as [[System started up|System started up]]. List of all triggers is in [[NETIO Lua Reference|NETIO Lua Reference]].

== Periodical scipts ==
In NETIO there is no way for triggering scripts periodically (e.g. every 10 seconds). For such scripts a function [[delay()|delay()]] must be used. This function allows to run some procedures periodically.
*Example switching output 1 every 10 seconds:
function switch()
if devices.system.output1_state == 'on' then
devices.system.SetOut{output=1,value=false}
else
devices.system.SetOut{output=1, value=true}
end
delay(10,function() switch() end)
end

switch()

*This script can be launch using e.g. [[System started up|System started up]] trigger.

== Debugging ==
To debug your code, use [[Function log()|log()]] and [[Function logf()|logf()]] functions. See the output in system events log.

== Data types and variables ==
Lua supports these data types:
* nil (to assign nil value effectively deletes the variable)
* boolean (falsy values are nil and false only; "" and 0 evaluates as true)
* number (decimals only in standard Lua, integers only in Netio Lua)
* string (same strings share same address, so equality operator measures both address and value)
* tables are associative arrays. (Tables with numeric indices are, well, just arrays.)

local numbers = {2,3,7,5} -- array (first index = 1)
local dictionary = {one=1, two=2, three=3} -- table
local numbersZeroBased = {[0]=2,3,7,5} -- array (first index = 0)

local keyword limits the variable scope to the block (ended by end) where it is declared. To access an upvalue (variable defined outside of the scope), just omit the local keyword.

== Operators ==
Lua has its own manners:
* <code>~=</code> is inequality operator
* <code>..</code> is string concatenation (don't use plus)
* <code><s>i++</s></code> no increment/decrement operator <code>i = i + 1</code>
* <code><s>max = a</code> no ternary operator. Use (and get used to) and idiom instead: <code>max = (a<b) and b or a</code>
* or idiom works: <code>x = x or 42</code> is equivalent to <code>if not x then x = 42 end</code>

== Conditions ==
Lua conditions has casual syntax, see [https://www.lua.org/pil/4.3.1.html here]. Just keep in mind to merge <code>else</code> and <code>if</code> to <code>elseif</code> or multiple <code>end</code>s are required.

Note that falsy values are nil and false only. Empty string and 0 evaluates as true. If you come from C, you might be surprised by following snippet:

if devices.system.output1_consumption then
-- always happens, even if the consumption is 0
log("Outlet 1 supplies power")
end

if not devices.system.output1_consumption then
-- never happens, even if the consumption is 0
log("Outlet 1 is idle")
end

== Loops ==
Lua has <code>break</code> statement, but no <code>continue</code> (use condition inside loop instead). Additionally, Netio Lua implementation limits the loop iterations to 32k.

=== While ===
While syntax is not different to other languages:
local i = 0
while i~=3 do
i = i + 1
logf("%d",i)
end

=== Repeat until ===
Repeat until syntax is the same as Pascal's, other languages have similar do-while loops:
local i = 0
repeat
i = i + 1
logf("%d",i)
until i==3

=== Numeric for ===
Arrays in Lua are one-based (in indices are not specified, the first one is 1, not 0).
local arr = {2,3,7,5}
for i=1,#arr do logf("%d",arr[i]) end
<code>for initVar,limit,increment do</code>
* number assignment <code>initVar</code> inits loop-local variable
* number <code>limit</code> loops until initVar reaches this value
* optional number <code>increment</code> after each loop initVar increment by this value (default 1)

=== Generic for ===
Is rather sophisticated. Most common example (the order of elements in <code>pairs()</code> is not guaranteed):
local tab = {one=1, two=2, three=3}
for key,val in pairs(tab) do logf("%s:%d",key,val) end
Generic for syntax
for var_1, ..., var_n in explist do block end
is equivalent to (Full explanation [https://www.lua.org/pil/7.2.html here].)
do
local _f, _s, _var = explist
while true do
local var_1, ... , var_n = _f(_s, _var)
_var = var_1
if _var == nil then break end
block
end
end

Iterator closure that holds its state
function iter(a)
local i = 0
return function()
i = i+1
return a[i]
end
end

local arr = {2,3,7,5}
for value in iter(arr) do
logf("%d",value)
end

Stateless iterator (in this case returns variable list: key and value)
function iter(a,i)
i = i+1
if a[i] then return i,a[i] end
end

local arr = {2,3,7,5}
for k,v in iter,arr,0 do
logf("%d:%d",k,v)
end

Same effect using <code>ipairs()</code> Lua function (without initial state)
for k,v in ipairs(arr) do
logf("%d:%d",k,v)
end

Now return to the most common example above using <code>pairs()</code> Lua function and read about <code>pairs()</code> and <code>ipairs()</code> implementation [https://www.lua.org/pil/7.3.html here].

== Functions ==

Lua allows multiple results (comma separated):

function diskSpace()
return devices.system.freeSpace, devices.system.totalSpace
end

logf("Free space: %d MB", diskSpace()) -- only first return value is used
local free,total = diskSpace() -- values are stored into LHS var-list
logf("Free space: %d %%", 100*free/total)

Variable-length arguments are also available:

function sum(...)
local result = 0
for _,v in ipairs(arg) do
result = result + v
end
return result
end

logf("Sum: %d", sum(2,3,5))

DO state changed

2019-07-11T15:29:02Z

Phrych: Created page with "{{DISPLAYTITLE:Script trigger DO state changed}} Triggered when output state is changed. Arguments are stored in table <code>event.args</code> === Arguments === * <code>outpu..."

{{DISPLAYTITLE:Script trigger DO state changed}}
Triggered when output state is changed. Arguments are stored in table <code>event.args</code>

=== Arguments ===
* <code>outputX_state</code> current state of changed output (on/off)

=== Print arguments ===
-- print all arguments
for i, v in pairs(event.args) do
logf("%s: %s",tostring(i),tostring(v))
end

Mqtt has connected to the broker

2019-07-11T15:27:25Z

Phrych: Created page with "{{DISPLAYTITLE:Script trigger Mqtt has connected to the broker}} Triggered when NETIO connects to the MQTT broker. Arguments are stored in table <code>event.args</code> === A..."

{{DISPLAYTITLE:Script trigger Mqtt has connected to the broker}}
Triggered when NETIO connects to the MQTT broker. Arguments are stored in table <code>event.args</code>

=== Arguments ===
* <code>mqttConnected</code> always 1

=== Print arguments ===
-- print all arguments
for i, v in pairs(event.args) do
logf("%s: %s",tostring(i),tostring(v))
end

System variables updated

2019-07-11T15:25:08Z

Phrych: Created page with "{{DISPLAYTITLE:Script trigger System variables updated}} Triggered when system variables are updated (approximately every 10 seconds). Arguments are stored in table <code>even..."

{{DISPLAYTITLE:Script trigger System variables updated}}
Triggered when system variables are updated (approximately every 10 seconds). Arguments are stored in table <code>event.args</code>

=== Arguments ===
* <code>freeSpace</code>
* <code>swapTotal</code>
* <code>outgoingTraffic</code>
* <code>cpuLoad</code>
* <code>incomingTraffic</code>
* <code>cpuIoWait</code>
* <code>totalSpace</code>
* <code>averageLoad</code>
* <code>sessionCount</code>

=== Print arguments ===
-- print all arguments
for i, v in pairs(event.args) do
logf("%s: %s",tostring(i),tostring(v))
end

Mqtt received message on subscribed topic

2019-07-11T15:22:40Z

Phrych: Created page with "{{DISPLAYTITLE:Script trigger Mqtt received message on subscribed topic}} Triggered when message is published on subscribed topic. Arguments are stored in table <code>event.ar..."

{{DISPLAYTITLE:Script trigger Mqtt received message on subscribed topic}}
Triggered when message is published on subscribed topic. Arguments are stored in table <code>event.args</code>

=== Arguments ===
* <code>payload</code> published message
* <code>topic</code> topic name

=== Print arguments ===
-- print all arguments
for i, v in pairs(event.args) do
logf("%s: %s",tostring(i),tostring(v))
end

System started up

2019-07-11T15:21:01Z

Phrych: Created page with "{{DISPLAYTITLE:Script trigger System started up}} Triggered when NETIO starts. This trigger has no arguments."

{{DISPLAYTITLE:Script trigger System started up}}
Triggered when NETIO starts. This trigger has no arguments.

Incoming URL API request

2019-07-11T15:19:01Z

Phrych: Created page with "{{DISPLAYTITLE:Script trigger Incoming URL API request}} Trigged when NETIO recieves URL API request. Arguments are given in url. Arguments are stored in table <code>event.arg..."

{{DISPLAYTITLE:Script trigger Incoming URL API request}}
Trigged when NETIO recieves URL API request. Arguments are given in url. Arguments are stored in table <code>event.args</code>

=== Example ===
URL: http://192.168.101.139/event?arg1=25&arg2=hello

Argument 1:
*key: arg1
*value: 25

Argument 2:
*key: arg2
*value: hello

=== Print arguments ===
-- print all arguments
for i, v in pairs(event.args) do
logf("%s: %s",tostring(i),tostring(v))
end

Schedule has started or stopped

2019-07-11T15:12:39Z

Phrych: Created page with "{{DISPLAYTITLE:Script trigger Schedule has started or stopped}} Triggered when selected schedule starts. Arguments are stored in table <code>event.args</code> === Arguments =..."

{{DISPLAYTITLE:Script trigger Schedule has started or stopped}}
Triggered when selected schedule starts. Arguments are stored in table <code>event.args</code>

=== Arguments ===
* <code>scheduleActive</code> true when schedule is active, false otherwise
* <code>scheduleId</code> schedule ID

=== Print arguments ===
-- print all arguments
for i, v in pairs(event.args) do
logf("%s: %s",tostring(i),tostring(v))
end

Global power characteristics changed

2019-07-11T15:09:07Z

Phrych: Created page with "{{DISPLAYTITLE:Script trigger Global power characteristics changed}} Triggered by change of global power characteristics (voltage, frequency). Arguments are stored in table <c..."

{{DISPLAYTITLE:Script trigger Global power characteristics changed}}
Triggered by change of global power characteristics (voltage, frequency). Arguments are stored in table <code>event.args</code>

=== Arguments ===
* <code>frequency</code> NETIO frequency [Hz] * 1000
* <code>voltage</code> NETIO voltage [V] * 1000

=== Print arguments ===
-- print all arguments
for i, v in pairs(event.args) do
logf("%s: %s",tostring(i),tostring(v))
end

Power measurements changed

2019-07-11T14:49:10Z

Phrych: Created page with "{{DISPLAYTITLE:Script trigger Power measurements changed}} Triggered by any change of measured variable on any output. Values in arguments are only for changed output. Argumen..."

{{DISPLAYTITLE:Script trigger Power measurements changed}}
Triggered by any change of measured variable on any output. Values in arguments are only for changed output. Arguments are stored in table <code>event.args</code>

=== Arguments ===
* <code>outputX_powerFactor</code> output power factor [-] * 100
* <code>totalLoad</code> NETIO load [W]
* <code>outputX_cumulatedConsumption</code> cumulated consumption of output [Wh]
* <code>outputX_consumption</code> output load [W]
* <code>overallPowerFactor</code> NETIO power factor [-] * 100
* <code>outputX_current</code> current in output [mA]
* <code>totalEnergy</code> total energy consumed by NETIO [Wh]
* <code>totalCurrent</code> current in NETIO [mA]

=== Print arguments ===
-- print all arguments
for i, v in pairs(event.args) do
logf("%s: %s",tostring(i),tostring(v))
end

NETIO Lua Reference

2019-07-11T14:20:11Z

Phrych:

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

Function devices.system.MqttPublish()

2019-07-11T12:50:37Z

Phrych: Created page with "{{DISPLAYTITLE:function devices.system.MqttPublish()}} Publish a message to MQTT topic nil devices.system.MqttPublish(table <code>config</code>) === Pa..."

{{DISPLAYTITLE:function devices.system.MqttPublish()}}
Publish a message to MQTT topic

nil devices.system.MqttPublish(table <code>config</code>)

=== Parameters ===
table config{<code>topic</code>}
* string <code>topic</code> name of topic
* string <code>payload</code> message to be sent

=== Return value ===
nil

=== Usage ===
-- send information about first output on topic luaHole
local topic = "luaHole"
local message = devices.system["output" .. 1 .. "_state"]
devices.system.MqttPublish{topic=topic,payload=string.format(message)}

=== Requirements ===
Netio FirmWare 3.3.1+

__NOTOC__

Function devices.system.MqttLuaSubscribe()

2019-07-11T12:45:24Z

Phrych: Created page with "{{DISPLAYTITLE:function devices.system.MqttLuaSubscribe()}} Function for subscribing to certain MQTT topic. nil devices.system.MqttLuaSubscribe(table <c..."

{{DISPLAYTITLE:function devices.system.MqttLuaSubscribe()}}
Function for subscribing to certain MQTT topic.

nil devices.system.MqttLuaSubscribe(table <code>config</code>)

=== Parameters ===
table config{<code>topic</code>}
* string <code>topic</code> name of subscribed topic

=== Return value ===
nil

=== Usage ===
-- Subscribe to topic luaHole
devices.system.MqttLuaSubscribe{topic="luaHole"}

=== Requirements ===
Netio FirmWare 3.3.1+

__NOTOC__

NETIO Lua Reference

2019-07-11T12:33:13Z

Phrych:

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

NETIO Lua Reference

2019-07-11T12:31:32Z

Phrych:

== 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 devices.system.MqttLuaSubscribe()|.MqttLuaSubscribe()]] - subscribe to MQTT topic
* function [[Function devices.system.MqttPublish()|.MqttPublish()]] - send message to MQTT topic

== MQTT <code>3.3.1</code>==
* function [[Function devices.system.Reboot()|.Reboot()]] - reboot socket's system
* function [[Function devices.system.Reboot()|.Reboot()]] - reboot socket's system

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

Function cgiGet()

2019-07-11T11:54:28Z

Phrych:

{{DISPLAYTITLE:function cgiGet()}}
Execute HTTP GET call to given url and read the response. The call is asynchronous: the code execution proceeds immediately and when the response arrives, callback function is called. To perform simple HTTP GET call without response handling, use simpler [[Devices.system.CustomCGI()|devices.system.CustomCGI()]]

nil cgiGet(table <code>config</code>)

=== Parameters ===
table config{<code>url</code>, <code>callback</code>, <code style="color: #777">timeout</code>, <code style="color: #777">bufferSize</code>}
* string <code>url</code> address to call
* function{response} <code>callback</code> this function is called when response arrives
* optional number <code>timeout</code> maximum seconds to wait for response (default 30)
* optional number <code>bufferSize</code> bytes of memory to allocate for response (min. 4k, max 1M)

=== Callback Parameters ===
table response{<code>result</code>, <code>errInfo</code>, <code>received</code>, <code>buffer</code>}
* number <code>result</code> error code of the response (see below)
* string <code>errInfo</code> error description (if result>0)
* number <code>received</code> response length
* string <code>buffer</code> response body

=== Error Code of the response ===
* 0 success, response HTTP/GET 2xx
* 22 response HTTP/GET 4xx
* 27 buffer overflow
* 28 response is timed out

=== Return value ===
nil

=== Usage ===
function logOurIp(o)
if o.result == 0 then
log(string.format("our ip is %s", string.match(o.buffer,"(%d+.%d+.%d+.%d+)")))
else
log(string.format("cgi to get our ip failed with error %d: %s", o.result, o.errorInfo))
end
end

-- send HTTP request and handle response
cgiGet{url="http://httpbin.org/ip", timeout=2, callback=logOurIp}

=== Requirements ===
Netio FirmWare 2.3.5+

=== See also ===
* [[Devices.system.CustomCGI()|devices.system.CustomCGI()]] to send HTTP request without response handling

__NOTOC__

Function modbusWriteSingleRegister()

2019-06-20T13:08:05Z

Phrych:

{{DISPLAYTITLE:function modbusWriteSingleRegister()}}
Write value to single register using modbus protocol. The call is asynchronous: the code execution proceeds immediately and when the response arrives, callback function is called.

nil modbusWriteSingleRegister(table <code>config</code>)

=== Parameters ===
table config{<code>deviceAddress</code>, <code>callback</code>, <code>address</code>, <code>value</code>, <code style="color: #777">port</code>, <code style="color: #777">timeout</code>}
* string <code>deviceAddress</code> IP address of device
* function{response} <code>callback</code> this function is called when response arrives
* string <code>address</code> number of the register
* number <code>value</code> the value to be written
* optional number <code>port</code> numer of port (default 502)
* optional number <code>timeout</code> maximum seconds to wait for response (default 30)

=== Callback Parameters ===
table response{<code>result</code>, <code>errInfo</code>, <code>address</code>}
* number <code>result</code> error code of the response (0 is success)
* string <code>errInfo</code> error description (if result>0)
* number <code>address</code> number of the input register

=== Return value ===
nil

=== Usage ===
-- Switch state of all outputs on NETIO with IP 10.0.0.105 and port 505
local function modbusWriteCallback(data)
log(string.format("addr %d, result %d", data.address, data.result))
end

for i = 101,104 do
modbusWriteSingleRegister{deviceAddress='10.0.0.105', port=505, timeout=6, address=i, value=4, callback=modbusWriteCallback}
end

=== Requirements ===
Netio FirmWare 3.3.0+

__NOTOC__

Function modbusWriteSingleCoil()

2019-06-20T13:07:30Z

Phrych: Created page with "{{DISPLAYTITLE:function modbusWriteSingleCoil()}} Write value to single coil using modbus protocol. The call is asynchronous: the code execution proceeds immediately and when..."

{{DISPLAYTITLE:function modbusWriteSingleCoil()}}
Write value to single coil using modbus protocol. The call is asynchronous: the code execution proceeds immediately and when the response arrives, callback function is called.

nil modbusWriteSingleCoil(table <code>config</code>)

=== Parameters ===
table config{<code>deviceAddress</code>, <code>callback</code>, <code>address</code>, <code>value</code>, <code style="color: #777">port</code>, <code style="color: #777">timeout</code>}
* string <code>deviceAddress</code> IP address of device
* function{response} <code>callback</code> this function is called when response arrives
* string <code>address</code> number of the coil
* boolean <code>value</code> the value to be written
* optional number <code>port</code> numer of port (default 502)
* optional number <code>timeout</code> maximum seconds to wait for response (default 30)

=== Callback Parameters ===
table response{<code>result</code>, <code>errInfo</code>, <code>address</code>}
* number <code>result</code> error code of the response (0 is success)
* string <code>errInfo</code> error description (if result>0)
* number <code>address</code> number of the input register

=== Return value ===
nil

=== Usage ===
-- Turn on all outputs on NETIO with IP 10.0.0.105 and port 505
local function modbusWriteCallback(data)
log(string.format("addr %d, result %d", data.address, data.result))
end

for i = 101,104 do
modbusWriteSingleCoil{deviceAddress='10.0.0.105', port=505, timeout=6, address=true, value=4, callback=modbusWriteCallback}
end

=== Requirements ===
Netio FirmWare 3.3.0+

__NOTOC__

Function modbusWriteSingleRegister()

2019-06-20T13:04:12Z

Phrych: Created page with "{{DISPLAYTITLE:function modbusWriteSingleRegister()}} Write value from to single register using modbus protocol. The call is asynchronous: the code execution proceeds immediat..."

{{DISPLAYTITLE:function modbusWriteSingleRegister()}}
Write value from to single register using modbus protocol. The call is asynchronous: the code execution proceeds immediately and when the response arrives, callback function is called.

nil modbusWriteSingleRegister(table <code>config</code>)

=== Parameters ===
table config{<code>deviceAddress</code>, <code>callback</code>, <code>address</code>, <code>value</code>, <code style="color: #777">port</code>, <code style="color: #777">timeout</code>}
* string <code>deviceAddress</code> IP address of device
* function{response} <code>callback</code> this function is called when response arrives
* string <code>address</code> number of the register
* number <code>value</code> the value to be written
* optional number <code>port</code> numer of port (default 502)
* optional number <code>timeout</code> maximum seconds to wait for response (default 30)

=== Callback Parameters ===
table response{<code>result</code>, <code>errInfo</code>, <code>address</code>, <code>value</code>}
* number <code>result</code> error code of the response (0 is success)
* string <code>errInfo</code> error description (if result>0)
* number <code>address</code> number of the input register

=== Return value ===
nil

=== Usage ===
-- Switch state of all outputs on NETIO with IP 10.0.0.105 and port 505
local function modbusWriteCallback(data)
log(string.format("addr %d, result %d", data.address, data.result))
end

for i = 101,104 do
modbusWriteSingleRegister{deviceAddress='10.0.0.105', port=505, timeout=6, address=i, value=4, callback=modbusWriteCallback}
end

=== Requirements ===
Netio FirmWare 3.3.0+

__NOTOC__

Function modbusReadInputRegister()

2019-06-20T12:57:21Z

Phrych:

{{DISPLAYTITLE:function modbusReadInputRegister()}}
Read value from single input register using modbus protocol. The call is asynchronous: the code execution proceeds immediately and when the response arrives, callback function is called.

nil modbusReadInputRegister(table <code>config</code>)

=== Parameters ===
table config{<code>deviceAddress</code>, <code>callback</code>, <code>address</code>,<code style="color: #777">port</code>, <code style="color: #777">timeout</code>}
* string <code>deviceAddress</code> IP address of device
* function{response} <code>callback</code> this function is called when response arrives
* string <code>address</code> number of the input register
* optional number <code>port</code> numer of port (default 502)
* optional number <code>timeout</code> maximum seconds to wait for response (default 30)

=== Callback Parameters ===
table response{<code>result</code>, <code>errInfo</code>, <code>address</code>, <code>value</code>}
* number <code>result</code> error code of the response (0 is success)
* string <code>errInfo</code> error description (if result>0)
* number <code>address</code> number of the input register
* string <code>value</code> value of the input register

=== Return value ===
nil

=== Usage ===
-- Read value of voltage (*10) from NETIO with IP address 10.0.0.105 and port 505
function modbusReadCallback(data)
if data.result == 0 then
log(string.format("modbus addr %d, got %s", data.address, tostring(data.value)))
else
log(string.format("modbus coil addr %d failed with error %d: %s", data.address, data.result, data.errorInfo))
end
end

modbusReadInputRegister{deviceAddress='10.0.0.105', port=505, timeout=6, address=1, callback=modbusReadCallback}

=== Requirements ===
Netio FirmWare 3.3.0+

__NOTOC__

Function modbusReadInputRegister()

2019-06-20T12:56:54Z

Phrych: Created page with "{{DISPLAYTITLE:function modbusReadInputRegister()}} Read value from single input register using modbus protocol. The call is asynchronous: the code execution proceeds immediat..."

{{DISPLAYTITLE:function modbusReadInputRegister()}}
Read value from single input register using modbus protocol. The call is asynchronous: the code execution proceeds immediately and when the response arrives, callback function is called.

nil modbusReadInputRegister(table <code>config</code>)

=== Parameters ===
table config{<code>deviceAddress</code>, <code>callback</code>, <code>address</code>,<code style="color: #777">port</code>, <code style="color: #777">timeout</code>}
* string <code>deviceAddress</code> IP address of device
* function{response} <code>callback</code> this function is called when response arrives
* string <code>address</code> number of the input register
* optional number <code>port</code> numer of port (default 502)
* optional number <code>timeout</code> maximum seconds to wait for response (default 30)

=== Callback Parameters ===
table response{<code>result</code>, <code>errInfo</code>, <code>address</code>, <code>value</code>}
* number <code>result</code> error code of the response (0 is success)
* string <code>errInfo</code> error description (if result>0)
* number <code>address</code> number of the input register
* string <code>value</code> value of the input register

=== Return value ===
nil

=== Usage ===
-- Read value about voltage (*10) from NETIO with IP address 10.0.0.105 and port 505
function modbusReadCallback(data)
if data.result == 0 then
log(string.format("modbus addr %d, got %s", data.address, tostring(data.value)))
else
log(string.format("modbus coil addr %d failed with error %d: %s", data.address, data.result, data.errorInfo))
end
end

modbusReadInputRegister{deviceAddress='10.0.0.105', port=505, timeout=6, address=1, callback=modbusReadCallback}

=== Requirements ===
Netio FirmWare 3.3.0+

__NOTOC__

Function modbusReadHoldingRegister()

2019-06-20T12:49:57Z

Phrych: Created page with "{{DISPLAYTITLE:function modbusReadHoldingRegister()}} Read value from single holding register using modbus protocol. The call is asynchronous: the code execution proceeds imme..."

{{DISPLAYTITLE:function modbusReadHoldingRegister()}}
Read value from single holding register using modbus protocol. The call is asynchronous: the code execution proceeds immediately and when the response arrives, callback function is called.

nil modbusReadHoldingRegister(table <code>config</code>)

=== Parameters ===
table config{<code>deviceAddress</code>, <code>callback</code>, <code>address</code>,<code style="color: #777">port</code>, <code style="color: #777">timeout</code>}
* string <code>deviceAddress</code> IP address of device
* function{response} <code>callback</code> this function is called when response arrives
* string <code>address</code> number of the holding register
* optional number <code>port</code> numer of port (default 502)
* optional number <code>timeout</code> maximum seconds to wait for response (default 30)

=== Callback Parameters ===
table response{<code>result</code>, <code>errInfo</code>, <code>address</code>, <code>value</code>}
* number <code>result</code> error code of the response (0 is success)
* string <code>errInfo</code> error description (if result>0)
* number <code>address</code> number of the holding register
* string <code>value</code> value of the holding register

=== Return value ===
nil

=== Usage ===
-- Read value of all outputs from NETIO with IP 10.0.0.105 on port 505
function modbusReadCallback(data)
if data.result == 0 then
log(string.format("modbus addr %d, got %s", data.address, tostring(data.value)))
else
log(string.format("modbus coil addr %d failed with error %d: %s", data.address, data.result, data.errorInfo))
end
end

for i = 101,104 do
modbusReadHoldingRegister{deviceAddress='10.0.0.105', port=505, timeout=6, address=i, callback=modbusReadCallback}
end

=== Requirements ===
Netio FirmWare 3.3.0+

__NOTOC__

Function modbusReadCoil()

2019-06-20T12:45:43Z

Phrych:

{{DISPLAYTITLE:function modbusReadCoil()}}
Read value from single coil using modbus protocol. The call is asynchronous: the code execution proceeds immediately and when the response arrives, callback function is called.

nil modbusReadCoil(table <code>config</code>)

=== Parameters ===
table config{<code>deviceAddress</code>, <code>callback</code>, <code>address</code>,<code style="color: #777">port</code>, <code style="color: #777">timeout</code>}
* string <code>deviceAddress</code> IP address of device
* function{response} <code>callback</code> this function is called when response arrives
* string <code>address</code> number of the coil
* optional number <code>port</code> numer of port (default 502)
* optional number <code>timeout</code> maximum seconds to wait for response (default 30)

=== Callback Parameters ===
table response{<code>result</code>, <code>errInfo</code>, <code>address</code>, <code>value</code>}
* number <code>result</code> error code of the response (0 is success)
* string <code>errInfo</code> error description (if result>0)
* number <code>address</code> number of the coil
* boolean <code>value</code> value of the coil

=== Return value ===
nil

=== Usage ===
-- Read value of all outputs from NETIO with IP 10.0.0.105 on port 505
function modbusReadCallback(data)
if data.result == 0 then
log(string.format("modbus addr %d, got %s", data.address, tostring(data.value)))
else
log(string.format("modbus coil addr %d failed with error %d: %s", data.address, data.result, data.errorInfo))
end
end

for i = 101,104 do
modbusReadCoil{deviceAddress='10.0.0.105', port=505, timeout=6, address=i, callback=modbusReadCallback}
end

=== Requirements ===
Netio FirmWare 3.3.0+

__NOTOC__

Function modbusReadDiscreteInput()

2019-06-20T12:45:18Z

Phrych: Created page with "{{DISPLAYTITLE:function modbusReadDiscreteInput()}} Read value from discrete input using modbus protocol. The call is asynchronous: the code execution proceeds immediately and..."

{{DISPLAYTITLE:function modbusReadDiscreteInput()}}
Read value from discrete input using modbus protocol. The call is asynchronous: the code execution proceeds immediately and when the response arrives, callback function is called.

nil modbusReadDiscreteInput(table <code>config</code>)

=== Parameters ===
table config{<code>deviceAddress</code>, <code>callback</code>, <code>address</code>,<code style="color: #777">port</code>, <code style="color: #777">timeout</code>}
* string <code>deviceAddress</code> IP address of device
* function{response} <code>callback</code> this function is called when response arrives
* string <code>address</code> number of the coil
* optional number <code>port</code> numer of port (default 502)
* optional number <code>timeout</code> maximum seconds to wait for response (default 30)

=== Callback Parameters ===
table response{<code>result</code>, <code>errInfo</code>, <code>address</code>, <code>value</code>}
* number <code>result</code> error code of the response (0 is success)
* string <code>errInfo</code> error description (if result>0)
* number <code>address</code> number of the coil
* boolean <code>value</code> value of the coil

=== Return value ===
nil

=== Usage ===
-- Read value of discrete input on IP address 10.0.0.105, on port 505 with address 102
function modbusReadCallback(data)
if data.result == 0 then
log(string.format("modbus addr %d, got %s", data.address, tostring(data.value)))
else
log(string.format("modbus addr %d failed with error %d: %s", data.address, data.result, data.errorInfo))
end
end

modbusReadCoil{deviceAddress='10.0.0.105', port=505, timeout=6, address=102, callback=modbusReadCallback}

=== Requirements ===
Netio FirmWare 3.3.0+

__NOTOC__

Function modbusReadCoil()

2019-06-20T12:36:40Z

Phrych: Created page with "{{DISPLAYTITLE:function modbusReadCoil()}} Read value from single coil using modbus protocol. The call is asynchronous: the code execution proceeds immediately and when the re..."

{{DISPLAYTITLE:function modbusReadCoil()}}
Read value from single coil using modbus protocol. The call is asynchronous: the code execution proceeds immediately and when the response arrives, callback function is called.

nil modbusReadCoil(table <code>config</code>)

=== Parameters ===
table config{<code>deviceAddress</code>, <code>callback</code>, <code>address</code>,<code style="color: #777">port</code>, <code style="color: #777">timeout</code>}
* string <code>deviceAddress</code> IP address of device
* function{response} <code>callback</code> this function is called when response arrives
* string <code>address</code> number of the coil
* optional number <code>port</code> numer of port (default 502)
* optional number <code>timeout</code> maximum seconds to wait for response (default 30)

=== Callback Parameters ===
table response{<code>result</code>, <code>errInfo</code>, <code>address</code>, <code>value</code>}
* number <code>result</code> error code of the response (0 is success)
* string <code>errInfo</code> error description (if result>0)
* number <code>address</code> number of the coil
* boolean <code>value</code> value of the coil

=== Return value ===
nil

=== Usage ===
-- Read value of all outputs from NETIO with IP 10.0.0.105 on port 505
local function modbusReadCallback(data)
if data.result == 0 then
log(string.format("modbus addr %d, got %s", data.address, tostring(data.value)))
else
log(string.format("modbus coil addr %d failed with error %d: %s", data.address, data.result, data.errorInfo))
end
end

for i = 101,104 do
modbusReadCoil{deviceAddress='10.0.0.105', port=505, timeout=6, address=i, callback=modbusReadCallback}
end

=== Requirements ===
Netio FirmWare 3.3.0+

__NOTOC__

Function snmpGet()

2019-06-20T10:26:47Z

Phrych:

{{DISPLAYTITLE:function snmpGet()}}
Execute SNMP GET call to given host and oid to read the response. The call is asynchronous: the code execution proceeds immediately and when the response arrives, callback function is called.

nil snmpGet(table <code>config</code>)

=== Parameters ===
table config{<code>host</code>, <code>oid</code>, <code>callback</code>, <code>snmpVersion</code>,<code>community</code>, <code style="color: #777">timeout</code>}
* string <code>host</code> host IP adress, may contain transport protocol and port (for example tcp:myhost.com:162)
* string <code>oid</code> object identifier
* function{response} <code>callback</code> this function is called when response arrives
* string <code>snmpVersion</code> version of SNMP (SNMP_VERSION.Snmp1 or SNMP_VERSION.Snmp2c)
* string <code>community</code> SNMP community string
* optional number <code>timeout</code> maximum seconds to wait for response (default 30)

=== Callback Parameters ===
table response{<code>result</code>, <code>errorInfo</code>, <code>oid</code>, <code>value</code>}
* number <code>result</code> error code of the response (0 is success)
* string <code>errorInfo</code> error description (if result>0)
* string <code>oid</code> oid we got
* string <code>value</code> value for the oid

=== Return value ===
nil

=== Usage ===
-- switch all outputs on NETIO with IP in 'host' parameter
local function snmpcallback(data)
if data.result == 0 then
output=tonumber(string.sub(data.oid, -1))
outputStatus=tonumber(data.value)
devices.system.SetOut{output=output, value=(outputStatus == 0)}
else
log(string.format("snmpget failed with error %d: %s", data.result, data.errorInfo))
end
end

for i = 1,4 do
snmpGet{host='10.0.0.102', timeout=6, oid=string.format(".1.3.6.1.4.1.47952.1.1.1.3.%d", i), snmpVersion=SNMP_VERSION.Snmp1, community='public', callback=snmpcallback}
end

=== Requirements ===
Netio FirmWare 3.3.0+

__NOTOC__

NETIO Lua Reference

2019-06-20T10:19:28Z

Phrych:

== 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.0</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()]] - 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.0</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 ==
<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

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

String devices.system.serialNumber

2019-06-19T15:41:30Z

Phrych: /* Usage */

{{DISPLAYTITLE:number devices.system.serialNumber}}
Returns the serial number of the socket. The property is read only!

number <code>devices.system.serialNumber</code>

=== Value ===
string serial number of socket

=== Usage ===
-- log serial number of the socket
logf("serial number: %s", devices.system.serialNumber)

String devices.system.serialNumber

2019-06-19T15:40:56Z

Phrych: Created page with "{{DISPLAYTITLE:number devices.system.serialNumber}} Returns the serial number of the socket. The property is read only! number <code>devices.system.serialNumbe..."

Number devices.system.energyStart

2019-06-19T15:38:42Z

Phrych: Created page with "{{DISPLAYTITLE:number devices.system.energyStart}} Date and time since the last reset of the consumption counter. See Function devices.system.resetCumulativeConsumption()|.r..."

{{DISPLAYTITLE:number devices.system.energyStart}}
Date and time since the last reset of the consumption counter. See [[Function devices.system.resetCumulativeConsumption()|.resetCumulativeConsumption()]] The property is read only!

string <code>devices.system.energyStart</code>

=== Value ===
The format is space separated date and time
YYYY-MM-DD hh:mm:ss

=== Usage ===
-- log voltage of the socket
logf("Measurment start: %s", devices.system.energyStart)

Number devices.system.totalEnergy

2019-06-19T15:34:04Z

Phrych: Created page with "{{DISPLAYTITLE:number devices.system.totalEnergy}} Returns the total energy (in Wh) consumed by socket from last consumption restart (Function devices.system.resetCumulative..."

{{DISPLAYTITLE:number devices.system.totalEnergy}}
Returns the total energy (in Wh) consumed by socket from last consumption restart ([[Function devices.system.resetCumulativeConsumption()|.resetCumulativeConsumption()]]). The property is read only!

number <code>devices.system.totalEnergy</code>

=== Value ===
number total energy consumed by socket (in Wh)

=== Usage ===
-- log energy consumed by the socket
logf("voltage: %d", devices.system.totalEnergy)

Number devices.system.totalLoad

2019-06-19T15:31:31Z

Phrych: Created page with "{{DISPLAYTITLE:number devices.system.totalLoad}} Returns the total load (in watts) of the socket. The property is read only! number <code>devices.system.totalL..."

{{DISPLAYTITLE:number devices.system.totalLoad}}
Returns the total load (in watts) of the socket. The property is read only!

number <code>devices.system.totalLoad</code>

=== Value ===
number total load of socket (in watts)

=== Usage ===
-- log total load of the socket
logf("voltage: %d", devices.system.totalLoad)

Number devices.system.totalCurrent

2019-06-19T15:26:45Z

Phrych: Created page with "{{DISPLAYTITLE:number devices.system.totalCurrent}} Returns the current (in milliamperes) on the socket. The property is read only! number <code>devices.system..."

{{DISPLAYTITLE:number devices.system.totalCurrent}}
Returns the current (in milliamperes) on the socket. The property is read only!

number <code>devices.system.totalCurrent</code>

=== Value ===
number total current on socket (in milliamperes)

=== Usage ===
-- log current of the socket
logf("total current: %d", devices.system.totalCurrent)

Number devices.system.frequency

2019-06-19T15:24:41Z

Phrych: Created page with "{{DISPLAYTITLE:number devices.system.frequency}} Returns the frequency (in millihertz) on the socket. The property is read only! number <code>devices.system.fr..."

{{DISPLAYTITLE:number devices.system.frequency}}
Returns the frequency (in millihertz) on the socket. The property is read only!

number <code>devices.system.frequency</code>

=== Value ===
number frequency on socket (in millihertz)

=== Usage ===
-- log frequency of the socket
logf("frequency: %d", devices.system.frequency)

Number devices.system.overallPowerFactor

2019-06-19T15:20:19Z

Phrych: Created page with "{{DISPLAYTITLE:number devices.system.overallPowerFactor}} Returns the power factor of socket times 1000. The property is read only! number <code>devices.system..."

{{DISPLAYTITLE:number devices.system.overallPowerFactor}}
Returns the power factor of socket times 1000. The property is read only!

number <code>devices.system.overallPowerFactor</code>

=== Value ===
number power factor of socket * 1000

=== Usage ===
-- log power factor of the socket
logf("power factor: %d", devices.system.overallPowerFactor)

Function snmpGet()

2019-06-19T14:25:52Z

Phrych: Created page with "{{DISPLAYTITLE:function snmpGet()}} Execute SNMP GET call to given host and oid to read the response. The call is asynchronous: the code execution proceeds immediately and whe..."

{{DISPLAYTITLE:function snmpGet()}}
Execute SNMP GET call to given host and oid to read the response. The call is asynchronous: the code execution proceeds immediately and when the response arrives, callback function is called.

nil devices.system.snmpGet(table <code>config</code>)

=== Parameters ===
table config{<code>host</code>, <code>oid</code>, <code>callback</code>, <code>snmpVersion</code>,<code>community</code>, <code style="color: #777">timeout</code>}
* string <code>host</code> host IP adress, may contain transport protocol and port (for example tcp:myhost.com:162)
* string <code>oid</code> object identifier
* function{response} <code>callback</code> this function is called when response arrives
* string <code>snmpVersion</code> version of SNMP (SNMP_VERSION.Snmp1 or SNMP_VERSION.Snmp2c)
* string <code>community</code> SNMP community string
* optional number <code>timeout</code> maximum seconds to wait for response (default 30)

=== Callback Parameters ===
table response{<code>result</code>, <code>errorInfo</code>, <code>oid</code>, <code>value</code>}
* number <code>result</code> error code of the response (0 is success)
* string <code>errorInfo</code> error description (if result>0)
* string <code>oid</code> oid we got
* string <code>value</code> value for the oid

=== Return value ===
nil

=== Usage ===
-- switch all outputs on NETIO with IP in 'host' parameter
local function snmpcallback(data)
if data.result == 0 then
output=tonumber(string.sub(data.oid, -1))
outputStatus=tonumber(data.value)
devices.system.SetOut{output=output, value=(outputStatus == 0)}
else
log(string.format("snmpget failed with error %d: %s", data.result, data.errorInfo))
end
end

for i = 1,4 do
snmpGet{host='10.0.0.102', timeout=6, oid=string.format(".1.3.6.1.4.1.47952.1.1.1.3.%d", i), snmpVersion=SNMP_VERSION.Snmp1, community='public', callback=snmpcallback}
end

=== Requirements ===
Netio FirmWare 3.3.0+

__NOTOC__

NETIO Lua Reference

2019-06-19T13:54:23Z

Phrych: /* Socket Communication */

== 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.0</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()]] - 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.0</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])

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

NETIO Lua Reference

2019-06-19T13:53:45Z

Phrych: /* Socket Communication */

== 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.0</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()]] - 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.0</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])

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

Number devices.system.voltage

2019-06-19T13:47:34Z

Phrych: Created page with "{{DISPLAYTITLE:number devices.system.voltage}} Returns the voltage (in millivolts) on the socket. The property is read only! number <code>devices.system.voltag..."

{{DISPLAYTITLE:number devices.system.voltage}}
Returns the voltage (in millivolts) on the socket. The property is read only!

number <code>devices.system.voltage</code>

=== Value ===
number voltage on socket (in millivolts)

=== Usage ===
-- log voltage of the socket
logf("voltage: %d", devices.system.voltage)

NETIO Lua Reference

2019-06-19T13:38:23Z

Phrych:

== 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.0</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

== 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.0</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])

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

NETIO Lua Reference

2019-06-19T13:35:38Z

Phrych:

== 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.0</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
* number [[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

== 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.0</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])

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

Function cgiGet()

2018-02-01T10:24:26Z

Phrych: /* Usage */

{{DISPLAYTITLE:function cgiGet()}}
Execute HTTP GET call to given url and read the response. The call is asynchronous: the code execution proceeds immediately and when the response arrives, callback function is called. To perform simple HTTP GET call without response handling, use simpler [[Devices.system.CustomCGI()|devices.system.CustomCGI()]]

nil devices.system.cgiGet(table <code>config</code>)

=== Parameters ===
table config{<code>url</code>, <code>callback</code>, <code style="color: #777">timeout</code>, <code style="color: #777">bufferSize</code>}
* string <code>url</code> address to call
* function{response} <code>callback</code> this function is called when response arrives
* optional number <code>timeout</code> maximum seconds to wait for response (default 30)
* optional number <code>bufferSize</code> bytes of memory to allocate for response (min. 4k, max 1M)

=== Callback Parameters ===
table response{<code>result</code>, <code>errInfo</code>, <code>received</code>, <code>buffer</code>}
* number <code>result</code> error code of the response (see below)
* string <code>errInfo</code> error description (if result>0)
* number <code>received</code> response length
* string <code>buffer</code> response body

=== Error Code of the response ===
* 0 success, response HTTP/GET 2xx
* 22 response HTTP/GET 4xx
* 27 buffer overflow
* 28 response is timed out

=== Return value ===
nil

=== Usage ===
-- callback function to read the response
local function getResponse(response)
if response.result > 0 then
logf("response failed with error code %d.", response.result)
else
logf("current credit is %d", tonumber(response.buffer))
end
end

-- sends HTTP request and handles the response
devices.system.CgiGet{url="http://example.com/getcredit?id=42", callback=getResponse}

=== Requirements ===
Netio FirmWare 2.3.5+

=== See also ===
* [[Devices.system.CustomCGI()|devices.system.CustomCGI()]] to send HTTP request without response handling

__NOTOC__

Mail()

2016-11-21T09:43:02Z

Phrych:

<big>Funkce sloužící k poslání emailu</big>

'''Kategorie:''' Systémová funkce

'''Klíčová slova:''' email, mail, oznámení, zpráva

'''Syntaxe:''' mail("my.email@example.com", "subject", "message content", limit)

'''Parametry:'''
* emailová adresa příjemce
* předmět zprávy
* text zprávy
* čas(sekundy), za který bude možné odeslat další email (nepovinný)

Poznámka: všechny parametry jsou string, musí tedy být v uvozovkách

'''Example:'''
Odeslání emailu na adresu frantisek.dobrota@email.cz. Předmět zprávy: Netio. Text zprávy: Email z mojí zásuvky.
mail("frantisek.dobrota@email.cz", "Netio", "Email z mojí zásuvky.")

'''Podporovaná verze firmwaru:'''
2.3.2 a vyšší

'''Použito v:'''
*AN02 - Hlídání spotřeby zásuvky
*AN03 - dalsi note

Devices.system.outputN state

2016-10-24T11:47:39Z

Phrych:

<big>Funkce sloužící k zjištění stavu zásuvky</big>

'''Kategorie:''' Systémová funkce

'''Klíčová slova:''' stav zásuvky, stav, output

'''Návratová hodnota:''' String on pokud je zásuvka zapnutá, v opačném případě funkce vrátí string off

'''Syntaxe:''' devices.system.outputN_state

'''Poznámka:'''
* místo "N" je nutné uvést číslo zásuvky
'''Example'''

Zjištění stavu zásuvky 1
devices.system.output1_state
Zjištění stavu zásuvky 2
devices.system.output2_state
Zjištění stavu zásuvky 3
devices.system.output3_state
Zjištění stavu zásuvky 4
devices.system.output4_state
Použití funkce pro zjištění stavu zásuvky 1 a jeho změny
if devices.system.output1_state == 'on' then
devices.system.SetOut{output=1,value=false}
else
devices.system.SetOut{output=1, value=true}
end

'''Podporovaná verze firmwaru:'''
2.3.2 a vyšší

'''Použito v:'''
*AN01 - Ovládání NETIO4 zásuvek URL adresou
*AN02 - dalsi note
*AN03 - dalsi note

Toboolean()

2016-10-17T15:53:29Z

Phrych:

<big>Funkce sloužící k převedení proměnné na boolean/big>

'''Kategorie:''' Systémová funkce

'''Klíčova slova:''' boolean, convert to boolean, převod na boolean

'''Syntaxe:''' toboolean(promenna)

'''Paramtery:'''

{| class="wikitable"
|+ Pro převod proměnných platí následující pravidla:
|-
! type !! conversion rule !! examples
|-
| číslo
| všechna nenulová čísla jsou true
| <source lang="lua">
toboolean(1) --> true
toboolean(0) --> false
toboolean(-1) --> true (-1 je nenulové)
</source>
|-
| boolean
| false je false, true je true
| <source lang="lua">
toboolean(true) --> true
toboolean(false) --> false
</source>
|-
| string
| všechny neprázné stringy jsou true
| <source lang="lua">
toboolean('hello') --> true
toboolean('false') --> true (neprázdný string)
toboolean('') --> false
</source>
|-
| tabulka
| neprázdné tabulky jsou true
| <source lang="lua">
toboolean({1}) --> true (neprázdná tabulka)
toboolean({false}) --> true (neprázdná tabulka)
toboolean({}) --> false
</source>
|-
| nil
| speciální hodnota nil je false
| <source lang="lua">
toboolean(nil) --> false
</source>
|-
| ostatní
| všechny ostatní hodnoty jsou true
| <source lang="lua">
toboolean(function() return false end) --> true
</source>
|}

'''Example'''
Následující kód převede proměnnou "number" na boolean "bool"
local number = 5
local bool = toboolean(number)

'''Podporovaná verze firmwaru:'''
2.3.2 a vyšší

'''Použito v:'''

Devices.system.SetOut()

2016-10-17T13:34:31Z

Phrych:

<big>Funkce sloužící k zapínání a vypínání zásuvky</big>

'''Kategorie:''' Systémová funkce

'''Klíčova slova:''' zapnutí zásuvky, vypnutí zásuvky, zapnout, vypnout, system, out, output, value, on, off

'''Syntaxe:''' devices.system.SetOut{output=1, value=true}

'''Paramtery:'''
* output - 1,2,3,4
** číslo zásuvky
* value - true/false
** true pro zapnutí
** false pro vypnutí
'''Example'''
Následující kód zapíná zásuvku číslo 3
devices.system.SetOut{output=3, value=true}

'''Podporovaná verze firmwaru:'''
2.3.2 a vyšší

'''Použito v:'''
*AN01 - Ovládání NETIO4 zásuvek URL adresou
*AN02 - dalsi note
*AN03 - dalsi note