Difference between revisions of "NETIO Lua Reference"
Jump to navigation
Jump to search
XML Processing
JSON Processing
Modbus
Line 16: | Line 16: | ||
* number [[Number devices.system.freeSpace|.freeSpace]] - free disk space | * number [[Number devices.system.freeSpace|.freeSpace]] - free disk space | ||
* number [[Number devices.system.totalSpace|.totalSpace]] - total disk space | * number [[Number devices.system.totalSpace|.totalSpace]] - total disk space | ||
− | * string [[String devices.system.serialNumber|.serialNumber]] <sup><code>3.3. | + | * string [[String devices.system.serialNumber|.serialNumber]] <sup><code>3.3.1</code></sup> - returns serial number of the device (Eth Interface MAC address) |
* number [[Number devices.system.voltage|.voltage]] - socket's voltage | * number [[Number devices.system.voltage|.voltage]] - socket's voltage | ||
* number [[Number devices.system.overallPowerFactor|.overallPowerFactor]] - overall power factor | * number [[Number devices.system.overallPowerFactor|.overallPowerFactor]] - overall power factor | ||
Line 32: | Line 32: | ||
* function [[Function cgiGet()|cgiGet()]] <sup><code>2.3.5</code></sup> - send HTTP request and receive response | * function [[Function cgiGet()|cgiGet()]] <sup><code>2.3.5</code></sup> - send HTTP request and receive response | ||
* table [[Table event.args|event.args]] - HTTP GET /event variables table | * table [[Table event.args|event.args]] - HTTP GET /event variables table | ||
− | * function [[Function snmpGet()|snmpGet()]] - send SNMP request | + | * function [[Function snmpGet()|snmpGet()]] <sup><code>3.3.0</code></sup> - send SNMP request |
== XML Processing <sup><code>2.3.6</code></sup> == | == XML Processing <sup><code>2.3.6</code></sup> == | ||
Line 40: | Line 40: | ||
* function [[Function xml.parse()|.parse()]] - parses XML string into [[Function xml.parse()#XmlElement|XmlElement]] object | * function [[Function xml.parse()|.parse()]] - parses XML string into [[Function xml.parse()#XmlElement|XmlElement]] object | ||
− | == JSON Processing <sup><code>3.3. | + | == JSON Processing <sup><code>3.3.1</code></sup> == |
<big><b>json</b></big> | <big><b>json</b></big> | ||
* function [[Function json.decode()|.decode()]] - parse json string into obj table | * function [[Function json.decode()|.decode()]] - parse json string into obj table | ||
Line 47: | Line 47: | ||
(based on [http://dkolf.de/src/dkjson-lua.fsl/home dkjson]) | (based on [http://dkolf.de/src/dkjson-lua.fsl/home dkjson]) | ||
− | == Modbus == | + | == Modbus <sup><code>3.3.0</code></sup>== |
<big><b>Read functions</b></big> | <big><b>Read functions</b></big> | ||
* function [[Function modbusReadCoil()|modbusReadCoil()]] - read value from coil | * function [[Function modbusReadCoil()|modbusReadCoil()]] - read value from coil |
Revision as of 14:04, 8 July 2019
Contents
Outlet Management
devices.system
- function .SetOut() - turns the outlet on or off
- function .ResetOut() - turns the outlet off and then resets its previous state
- string .output1_state - outlet's state
- number .output1_consumption - outlet's consumption (in Watts)
- number .output1_cumulatedConsumption - outlet's consumed energy (in Watthours)
- function .resetCumulativeConsumption() - resets outlet's energy counter
- string .output1_consumptionStart - date and time since the last energy counter reset
Socket System Management
devices.system
- number .averageLoad - socket's CPU load
- function .Reboot() - reboot socket's system
- number .sessionCount - number of connected users
- number .freeSpace - free disk space
- number .totalSpace - total disk space
- string .serialNumber
3.3.1
- returns serial number of the device (Eth Interface MAC address) - number .voltage - socket's voltage
- number .overallPowerFactor - overall power factor
- number .frequency - socket's frequency
- number .totalCurrent - total current through socket
- number .totalLoad - total load on socket
- number .totalEnergy - total energy consumed by socket
- string .energyStart - time of last consumption reset
Socket Communication
- function ping() - tests socket's network responsivity
- function mail() - sends e-mail
- function devices.system.CustomCGI() - send HTTP request
- function cgiGet()
2.3.5
- send HTTP request and receive response - table event.args - HTTP GET /event variables table
- function snmpGet()
3.3.0
- send SNMP request
XML Processing 2.3.6
xml
- function .escape() - escapes XML string to fit xml node contents
- function .check() - tests if string is well-formed XML
- function .parse() - parses XML string into XmlElement object
JSON Processing 3.3.1
json
- function .decode() - parse json string into obj table
- function .encode() - generate JSON string from table
(based on dkjson)
Modbus 3.3.0
Read functions
- function modbusReadCoil() - read value from coil
- function modbusReadDiscreteInput() - read value from discrete input
- function modbusReadHoldingRegister() - read value from holding register
- function modbusReadInputRegister() - read value from input register
Write functions
- function modbusWriteSingleCoil() - write value to single coil
- function modbusWriteSingleRegister() - write value to single register
Standard Lua Functions
- function assert(), error() issues an error
- function ipairs(), pairs(), next() traverse tables
- function tonumber(), tostring() data type conversion
- function pcall() protected call function (handles error inside the function)
- function select() selects from multiple return value
- function unpack converts table into multiple values
- function type() returns variable type
- function os.date(), os.time() system date and time
- function os.difftime() returns time span between two times
Miscellaneous
- function log() - insert a record to the socket's event log
- function logf() - insert a formated record (incl. numbers) to the socket's event log
- function delay() - execute function with delay (seconds)
- function milliDelay() - execute function with delay (milliseconds)
- function toboolean() - converts any variable to boolean type