01 Lua script function
1 Interface Description
1.1 Data type definition
Type | Description |
---|---|
nil | Null |
boolean | Boolean, the value is true or false |
number | Integer or floating point, signed or unsigned |
string | String |
table | Table |
function | Functions |
1.2 Built-in function library clipping
Full features supported: coroutine/debug/ math/ package/ string/ table/ utf8
Some features supported (available in []): os[clock/ date/ difftime/ time]
Not supported: io/ file
1.3 Return value description
The function return type multi means multiple return values (at least 2), usually:
1st: nil;
2nd: the error message;
1.4 Function parameter description
Assume the function prototype:
student(string name, number age[, number class]) Function: Register a student Parameters: name: student name age: student age [class=1]: Student class Return: Succeed: true Failed: multi |
Comment
1.string name indicates that the first parameter name is a string
2.number age indicates that the second parameter age is numeric
3. [, number class] indicates that the third parameter class is a numeric value, and it is optional. Specify the default class in class 1 in the parameter description.
4. Any parameter in the brackets of [] is considered to be an optional parameter, and may not be transmitted when called. The default value will be given in the parameter description.
Call example
print(student("foo", 18)) -- foo, 18 years old, assigned to class 1 by default print(student("bar", 19, 2)) --bar, 19 years old, assigned to class 2 print(student("bar", 18)) --bar, 18 years old, assigned to class 1 by default local stat, err = student("bar", 18) -- Call again, use err to capture error messages print(stat, err) |
Output results
true true nil student bar registered nil student bar registered |
Comment
1.From the print result, the second line of the first line is successfully called and returns true; the third line fails the call, the error message is translated as: the bar student has been registered, and there is indeed an error in the code.
2.The fourth line of code uses two variables to receive the return value. The call failed, the first variable stat is nil, and the second variable err stores the error message. Then print it out using print, which is the output of the third line. This example shows how to capture and view the error message.
1.5 Modification of the Print Function
For the convenience of remote development, the print data is sent to the front end (web page) by means of network transmission, and the user can see the result of the debug output, because it consumes certain data and occupies the bandwidth of the server (or occupies server resources). So make the following restrictions:
1.Interval limit: When debugging, transfer once every 2~3 seconds;
2.Data limit: The transfer data cannot be larger than 1.5KB, and the extra part will be ignored;
3.Transmission limit: The data transmission will be stopped automatically after the debugging windows is not closed normally. Only when it is in the debugging window and the switch is on, there is data transmission;
Users should pay attention to avoid printing a lot of useless information, should minimize the debug output
In addition, please refer to the front-end documentation for how to use view debugging.
2 Address Operation
Form 2.1
16-bit data formal | HLword | 32-bit data formal | HLword | 64-bit data formal | HLword |
12(Default) | 0 | 1234(Default) | 0 | 12345678(Default) | 0 |
21 | 6 | 3412(High and low word conversion) | 2 | 34127856 (High and low word conversion) | 2 |
2143 | 3 | 21436587 | 3 | ||
4321 | 6 | 87654321 | 6 | ||
78563412 | 7 | ||||
56781234 | 8 | ||||
65872143 | 9 | ||||
43218765 | 10 |
- If HLword enters any other value, it will be treated as invalid.
Demo: Reads a 32-bit floating-point number at position D0 of PLC
2.1 addr_getshort(string addr[, number type, number hlword])
Function:
Read 16-bit signed decimal address
Parameters:
addr: address
num: value
[type = 0] not read through 1: read through
[hlword = 0] Don't convert,See Form 2.1
Return:
Succeed: Single word signed decimal value
Failed: multi
2.2 addr_setshort(string addr, number num[, number type, number hlword])
Function:
Write 16-bit signed decimal address
Parameters:
addr: address
num: value
[type = 0]not read through 1: read through
[hlword = 0] Don't convert,See Form 2.1
Return:
Succeed: true
Failed: multi
2.3 addr_getword(string addr[, number type, number hlword])
Function:
Read 16-bit unsigned decimal address
Parameters:
addr: address
[type = 0]not read through 1: read through
[hlword = 0] Don't convert,See Form 2.1
Return:
Succeed: Single word unsigned decimal value
Failed: multi
2.4 addr_setword(string addr, number num[, number type, number hlword])
Function:
Write 16-bit unsigned decimal address
Parameters:
addr: address
num: value
[type = 0]not read through 1: read through
[hlword = 0] Don't convert,See Form 2.1
Return:
Succeed: true
Failed: multi
2.5 addr_getint(string addr[, number type, number hlword])
Function:
Read 32-bit signed decimal address
Parameters:
addr: address
[type = 0]not read through 1: read through
[hlword = 0] Don't convert,See Form 2.1
Return:
Succeed: Double word signed decimal value
Failed: multi
2.6 addr_setint(string addr, number num[, number type, number hlword])
Function:
Write 32-bit signed decimal address
Parameters:
addr: address
num: value
[type = 0]not read through 1: read through
[hlword = 0] Don't convert,See Form 2.1
Return:
Succeed: true
Failed: multi
2.7 addr_getdword(string addr[, number type, number hlword])
Function:
Read 32-bit unsigned decimal address
Parameters:
addr: address
[type = 0]not read through 1: read through
[hlword = 0] Don't convert,See Form 2.1
Return:
Succeed: Double word unsigned decimal value
Failed: multi
2.8 addr_setdword(string addr, number num[, number type, number hlword])
Function:
Write 32-bit unsigned decimal address
Parameters:
addr: address
num: value
[type = 0]not read through 1: read through
[hlword = 0] Don't convert,See Form 2.1
Return:
Succeed: true
Failed: multi
2.9 addr_getbit(string addr[, number type])
Function:
Read a bit of the register address
Parameters:
addr: address
[type = 0]not read through 1: read through
[hlword = 0] Don't convert,See Form 2.1
Return:
Succeed: Bit address value
Failed: multi
2.10 addr_setbit(string addr, number num[, number type])
Function:
Write a bit of the register address
Parameters:
addr: address
num: value
[type = 0]not read through 1: read through
[hlword = 0] Don't convert,See Form 2.1
Return:
Succeed: true
Failed: multi
2.11 addr_getfloat(string addr[, number type, number hlword])
Function:
Read 32-bit floating address
Parameters:
addr: address
[type = 0]not read through 1: read through
[hlword = 0] Don't convert,See Form 2.1
Return:
Succeed: 32-bit floating point value
Failed: multi
2.12 addr_setfloat(string addr, number num[, number type, number hlword])
Function:
Write 32-bit floating address
Parameters:
addr: address
num: value
[type = 0]not read through 1: read through
[hlword = 0] Don't convert,See Form 2.1
Return:
Succeed: true
Failed: multi
2.13 addr_getdouble(string addr[, number type, number hlword])
Function:
Read 64-bit floating address
Parameters:
addr: address
[type = 0]not read through 1: read through
[hlword = 0] Don't convert,See Form 2.1
Return:
Succeed: 64-bit floating point value
Failed: multi
2.14 addr_setdouble(string addr, number num[, number type, number hlword])
Function:
Write 64-bit floating address
Parameters:
addr: address
num: value
[type = 0]not read through 1: read through
[hlword = 0] Don't convert,See Form 2.1
Return:
Succeed: true
Failed: multi
2.15 addr_getstring(string addr, number length[, number type, number hlbyte])
Function:
Read the specified length string from address
Parameters:
addr: address
length: length
[type = 0]not read through 1: read through
[hlbyte = 0] Don't convert,3:High and low byte conversion, 4:GBK, 5:GBK And the first byte is the length
Return:
Succeed: specified length string
Failed: multi
2.16 addr_setstring(string addr, string str[, number type, number hlbyte])
Function:
Write the specified length string to address
Parameters:
addr: address
str: string
[type = 0]not read through 1: read through
[hlbyte = 0] Don't convert,3:High and low byte conversion, 4:GBK, 5:GBK And the first byte is the length
Return:
Succeed: true
Failed: multi
2.17 addr_bmov(string dst, string src, number length)
Function:
Copy data from source address to destination address
Parameters:
dst: destination address
src: source address
length: length
Return:
Succeed: true
Failed: multi
2.18 addr_fill(string addr, number num, number length)
Function:
Write the same value to consecutive addresses
Parameters:
addr: address
num: value
length:continuous length
Return:
Succeed: true
Failed: multi
2.19 addr_newnoaddr(string addr, number offset)
Function:
Offset address value relative to addr
Parameters:
addr: address
offset: offset value
Return:
Succeed: New address after offset
Failed: multi
2.20 addr_newstataddr(string addr, number offset)
Function:
Offset station number relative to addr station number
Parameters:
addr: address
offset: offset value
Return:
Succeed: New station number after offset
Failed: multi
2.21 addr_gethex64(string addr[, number type, number hlword])
Function:
Read 64-bit hexadecimal numbers
Parameters:
addr: address
[type = 0]not read through 1: read through
[hlword = 0] Don't convert,See Form 2.1
Return:
Succeed: 64-bit floating-point values
Failed: multi
2.22 addr_sethex64(string addr, number num[, number type, number hlword])
Function:
Write 64-bit hexadecimal addresses
Parameters:
addr: address
[type = 0]not write through 1: write through
[hlword = 0] Don't convert,See Form 2.1
Return:
Succeed: true
Failed: multi
3 Serial port operation
Operations on the serial port such as read, write, etc. must use ':' for full mode calls, ie operations on an open serial object.
Serial port name and mode:
The serial port configured in the communication configuration window cannot be configured again using the script. RS232 and RS458 (or RS422) can be used simultaneously, but RS422 and RS485 are mutually exclusive.For example, when the communication port is configured with COM1-485, the script can only open COM1-232, but not COM1-485/422. Similarly, when the communication port is configured with COM2-485, the script can only open COM2-232, but not COM2-485.
Attempting to use a script to open a serial port in an unsupported mode will result in an error directly, as below
local setup = { name = "COM2", mode = 422, -- COM2 does not support RS422 ... } serial.open(setup) |
Data bit:
- When the data bit is 7, the maximum value of data transmission is 127 (0x7F), and non-ASCII characters will be truncated, resulting in data errors and garbled characters.
- When the data bit is 8, the maximum value of data transmission is 255 (0xFF), which supports the transmission of any character.
3.1 serial.open(table setup)
Function:
Enable one serial port
Parameters:
Setup is a Lua table; it needs to contain the following fields
String setup.name, serial port name, such as: COM1/COM2 (requires uppercase)
number setup.mode, mode: RS232/RS485/RS422
number setup.baud_rate, such as 115200
number setup.stop_bit, stop bit: 1 or 2
number setup.data_len, data bit: 7 or 8
string setup.check_bit, check bit: NONE/ODD/EVEN/SPACE
number [setup.wait_timeout=300], waiting timeout
number [setup.recv_timeout=50], receive wait timeout
number [setup.flow_control=0], Flow control method, 0:XON/XOFF, 2:DSR/ER
Supported baud rate
1200/2400/4800/9600/14400/19200/38400/43000/57600/76800/115200/128000/230400/256000/460800/961000
Return:
Succeed: serial object
Failed: multi
3.2 serial.close(serial obj)
Function:
Disable the serial port
Parameters:
Obj is the object returned by serial.open
Return:
Succeed: true
Failed: multi
3.3 serial:read(number bytes[, number timeout])
Function:
Read the specified byte length serial port data
Parameters:
bytes: number of bytes
[timeout=50]: timeout for reading, in milliseconds
Return:
Succeed: true
Failed: multi
3.4 serial:write(string data)
Function:
Write the specified byte length to serial port data
Parameters:
data: serial port data
Return:
Succeed: true
Failed: multi
3.5 serial:flush([number flag])
Function:
Clear the serial port buffer
Parameters:
[flag=2] clear option: 0: read, 1: write, 2: read-write
Return:
Succeed: true
Failed: multi
3.6 serial:close()
Function:
Close the serial port object
Parameters:
None
Return:
Succeed: true
Failed: multi
4 MQTT operation
Operations on MQTT such as connect, subscribe, etc. must use ':' for full mode calls, that is, operate on a created MQTT object.
Both MQTT subscriptions and publications are asynchronous implementations that require the user to implement a callback function.
QoS value:
0: Only push messages once, messages may be lost or duplicated. It can be used for environmental sensor data, it doesn't matter if lose a record, because there will be a second push message soon. This method is mainly used for normal APP push, but if the user smart device is not connected when the message is pushed, the message will be discarded, and the smart device will not be received when it is networked again.
1: The message is delivered at least once, but the message may be delivered repeatedly.
2: The message was delivered exactly once. This level can be used in a billing system. In a billing system, repeated or missing messages can lead to incorrect results. This highest quality message push service can also be used for instant messaging APP pushes, ensuring that users only receive messages once.
Retain flag:
0: not reserved;
1: reserved
4.1 mqtt.create(string serverurl, string clientid)
Function:
Create an MQTT object
Parameters:
serverurl Server url
Format: "protocol://host:port"
protocol: tcp/ssl
host: Host name/IP
port: such as 1883
clientid: Client ID
Return:
Succeed: MQTT object
Failed: multi
4.2 mqtt.close(mqtt obj)
Function:
Close the specified MQTT object (if the connected server will be disconnected automatically)
Parameters:
Obj is the objeced returned by mqtt.create
Return:
Succeed: true
Failed: multi
4.3 mqtt:connect(table conn[, table lwt, table cart])
Function:
Establish a connection to the server
Parameters:
conn is a Lua table and needs to contain the following fields
string conn.username, user name
string conn.password, password
number [conn.netway=0], networking method, if set error number will use Ethernet method
- 0: Ethernet
- 1: WIFI
- 2: 4G
- 3: 2G
number [conn.keepalive=60], keep connected heartbeat interval, in seconds
number [conn.cleansession=1], empty the session as described below:
This function is used to control the behavior when connecting and disconnecting, and the client and server will retain the session information. This information is used to guarantee "at least once" and "accurately once" delivery, as well as the subject of the client subscription, the user can choose to keep or ignore the session message, set as follows:
- 1 (Empty): If a session exists and is 1, the previous session messages on the client and server are emptied.
- 0 (reserved): Conversely, both the client and the server use the previous session. If the previous session does not exist, start a new session.
lwt (Last Will and Testament) is a Lua table and needs to contain the following fields
string lwt.topic, topic
string lwt.message, message
number [lwt.qos=0], qos value
number [lwt.retain=0], retain flag
Return:
Succeed: true
Failed: multi
4.4 mqtt:disconnect([number timeout])
Function:
Disconnect from the MQTT server
Parameters:
[timeout=10000] Disconnect waiting timeout, in milliseconds
Return:
Succeed: true
Failed: multi
4.5 mqtt:isconnected()
Function:
Test whether or not a client is currently connected to the MQTT server
Parameters:
None
Return:
Succeed: true --Connected
Failed: false -- Unconnected and other unknowns
4.6 mqtt:subscribe(string topic, number qos)
Function:
Subscribe to the topic (before the subscription, the user must first call the connect method to connect to the server)
Parameters:
topic, topic name
qos, quality of service
Return:
Succeed: true
Failed: multi
4.7 mqtt:unsubscribe(string topic)
Function:
Unsubscribe topic
Parameters:
topic, topic name
Return:
Succeed: true
Failed: multi
4.8 mqtt:publish(string topic, string message, number qos, number retain[, number timeout])
Function:
Publish message
Parameters:
topic, topic name
message, message
qos, quality of service
retain, retain flag
[timeout=1000], waiting for response timeout, in milliseconds (only valid when qos is greater than 0)
Return:
Succeed: true
Failed: multi
4.9 mqtt:close()
Function:
Close the mqtt object (the connection to the server will be automatically disconnected)
Parameters:
None
Return:
Succeed: true
Failed: multi
4.10 mqtt:on(string method, function callback)
Function:
Register event callback function
Parameters:
method, It can be message/arrived/offline, these 3 types of events
callback, It is a callback function that needs to pass in a function
1."message" will call this function after receiving the message
Callback prototype: function (string topic, string message)
Parameter:
Topic, topic name
Message, content
2."arrived" is published by publish, this function will be called after the publication arrives
Callback prototype: function ()
Parameter:
None
3.This function will be called after the "offline" connection is lost
Callback prototype: function (string cause)
Parameter:
cause, reason for loss of connection
Return:
Succeed: true
Failed: multi
4.11 mqtt:setup_cfg()
Function:
Cloud mode interface, to obtain MQTT information configured by the cloud platform
Parameters:
None
Return:
serverurl, clientid, conn, lwt, cart (5 returns, respectively, server address, client ID, connection table, last word table, certificate table)
conn is the first parameter of the mqtt:connect method, which is fixed to table. If not configured, the information in the table is an empty string
LWT Last Words configuration is not yet open for setting, lwt is fixed to nil
If ssl is not enabled, cart is nil, otherwise cart is table
5 JSON operation
Lua only has a table data structure, so all arrays and key-value objects of json will be returned as a table.
5.1 json.encode( lua_object )
Function:
Convert lua data type to json string
Parameters:
Lua data type (including boolean, number, string, table)
Return:
Json format string
5.2 json.decode(string json_string)
Function:
Convert json string to lua data type
Parameters:
json_string, string of json data structure
Return:
Lua data type
5.3 json.null
Function:
This method is used when assembling json data, which is equivalent to null in json. If the user directly uses json.null() to return the address of the function, it must be valid with the use of encode.
Parameters:
None
Return:
None
6 Cloud mode
The cloud interface is only used in cloud mode, and V-NET mode is not available.
6.1 bns_get_alldata()
Function:
Obtain all monitoring points (point table) data configured by the end user
Note: Assuming there are timing scripts A and B with a period of 1 second, if this function is called in script A, the data will not be obtained if called in script B
Parameters:
None
Return:
Succeed: table two-dimensional array, the structure is as follows
Each item is a monitoring point, which contains 5 attributes:
(1 ID, 2 status, 3 tag name, 4 value, 5 custom)
The status contains 3 enumerated values (0: offline, 1: online, 2: timeout)
If there is no custom configuration, return an empty table, otherwise, return with "field name/field content"
E.g:
{
[1]= {[1]=1234, [2]=1, [3]='temp', [4]='23.5', [5]={"fruit"="apple"}},
[2]= {[1]=1235, [2]=1, [3]='humi', [4]='67', [5]={"fruit"="pear"}},
...
[n]= {[1]=xxxx, [2]=x, [3]='xxxx', [4]='xx.x', [5]={}},
}
Failed: table empty table
6.2 bns_get_config(string from)
Function:
Obtain custom configuration parameters with the specified from type
parameter:
from type, there are the following two categories, the string must be all lowercase
'user': terminal parameters, that is, custom parameters configured by the user
'bind': binding parameters, which are custom parameters that need to be input
when the user binds V-BOX
Return:
Succeed: table field name/field content table in organization form
Failed: table empty table
6.3 bns_get_data(string name, string data)
Function:
write data to the name of the monitoring point
parameter:
name The name of the monitoring point
data the data to be written
Return:
Succede: string value before the monitoring point is written
Failed: nil
6.4 bns_get_data(string name)
Function:
Read the data of the monitoring point name
parameter:
name The name of the monitoring point
Return:
Succeed: string, table 2 results: the value of the monitoring point, custom content
Failed: nil
6.5 bns_get_datadesc()
Function:
Obtain all configured communication ports and monitoring point information
Parameters:
None
Return:
Succeed: table three-dimensional array, the structure is as follows
Each item is a communication port, which contains 3 attributes (1 monitoring point array, 2 ID, 3 name)
The monitoring point array contains 4 attributes (1 ID, 2 name, 3 read and write attributes, 4 types)
Read and write attributes (1: read only, 2: write only, 3: read and write)
Type (1: switch, 2: number, 3: string)
E.g:
{
[1]={--The first communication port
[1]={--monitoring point array of the first communication port
[1]={[1]=11,[2]='data1',[3]=3,[4]=2},
[2]={[1]=12,[2]='data2',[3]=3,[4]=2},
...
[n]={[1]=xx,[2]='datan',[3]=x,[4]=x},--n monitoring points
},
[2]=14, --ID
[3]='Modbus TCP' --n monitoring points
},
[2]={--The second communication port
[1]={},--The monitoring point of the second communication port is not configured and is empty
[2]=15, --ID
[3]='WECON' --communication protocol name
},
...n communication ports and so on
}
Failed: table empty table
6.6 bns_get_machineinfo()
Function:
get machine information
Parameters:
None
Return:
Succeed: 3 string type results (model, machine code, software version)
Failed: nil
6.7 bns_get_groupdata(string name)
Function:
Get all monitoring point data under the specified group name
parameter:
Name group name
Return:
Succeed: table two-dimensional array, the structure is consistent with section 6.1
Failed: table empty table
6.8 bns_get_groupdesc()
Function:
Get all group information
Parameters:
None
Return:
Succeed: table two-dimensional array, the structure is as follows
Each item represents a group, which contains 3 attributes (1 collection type, 2 name, 3 cycles)
Acquisition type (0: change acquisition, 1: word trigger, 2: no trigger, 3: trigger by time and conditions, 4: reset after trigger, 5: not reset after trigger)
Some collection types do not have a period, the period is -1
Failed: table empty table
6.9 bns_get_onecache(string msg)
Function:
Save a message to the cache file, which can be stored after power failure. Store up to 2000 items, delete the old and save the new in a rolling manner when it is full.
Parameters:
msg String
Return:
Succeed: true
Failed: nil
6.10 bns_get_allcache()
Function:
Get all the cached content (once the internal cache file will be emptied)
Parameters:
None
Return:
Succeed: table one-dimensional array
E.g:
{
[1]="This is the oldest message", - the first is the oldest message
[2]="This is a test",
...
[n]="This is the latest message", - the last is the latest message
}
Failede: nil
7 HTTP operation
Network communication includes Http request interface, this document does not provide interface description, please refer to the online document for how to use it.
7.1 http request
http://w3.impa.br/~diego/software/luasocket/http.html#request
8 Internal register
The internal registers of the box are divided into bit addresses and word addresses, which can be accessed in two ways (taking HDW as an example):
1. Access by word, prefix @W_HDW,
For example: @W_HDW0 represents the first word of the system data area, @W_HDW1 represents the second word of the system data area.
2. Access in bit mode, the prefix is @B_HDX, the number in front of "." indicates the number of the word, and the number behind is the bit number of the word.
For example: @B_HDX1020.12, its meaning is to access the system data area in bit mode, the specific location is the 13th bit of the 1020th word.
✎Note:
1. The address in @B_HDX is taken from the word in @W_HDW, so pay special attention when using the address.
For example, @B_HDX1020.12 is to access the 13th bit of the 1020th word. The value of this bit is the same as the word obtained by @W_HDW001020. The 13th bit of this word is actually the same bit as @B_HDX1020.12.
2.The address of the bit address @B_HDX has a decimal point, while the word address is an integer.
8.1 Data storage area(HDW/HDX)
The system storage area (HDW) of the V-BOX is used to store temporary data:
1. Access by word, the number range is: "@W_HDW0"-"@W_HDW299999".
2. Access in bit mode, the number range is: "@B_HDX0.0"-"@B_HDX299999.15".
8.2 Special data area (HSW/HSX)
✎Note:
HSW is a system special register, so please refer to the system special register table during use. Do not use addresses that are not mentioned in the table, and use the addresses stated in the table with caution (example: restart ("@W_HSW0") Writing a value of 1 will cause V-BOX to restart).
Without any conditions. Direct use ("@W_HSW0") will cause the V-BOX to restart continuously. When using ("@W_HSW0") address, please add judgment conditions, such as: connection to MQTT fails, there is no network, the value of a PLC address meets the condition or counts to a certain value.
1.The system data area (HSW) of the box is used for system special registers (system reserved). Use addr_getword to obtain the following register information:
address | function | Read and write status: read only, write only, read and write |
@W_HSW0 | restart | read and write |
@W_HSW1 | Box time: year | read and write |
@W_HSW2 | Box time: month | read and write |
@W_HSW3 | Box time: day | read and write |
@W_HSW4 | Box time: hour | read and write |
@W_HSW5 | Box time: minute | read and write |
@W_HSW6 | Box time: second | read and write |
@W_HSW7 | Box time: week | read and write |
@W_HSW8 | Ethernet IP1 | read only |
@W_HSW9 | Ethernet IP2 | read only |
@W_HSW10 | Ethernet IP3 | read only |
@W_HSW11 | Ethernet IP4 | read only |
@W_HSW12 | Ethernet Mask 1 | read only |
@W_HSW13 | Ethernet Mask 2 | read only |
@W_HSW14 | Ethernet Mask 3 | read only |
@W_HSW15 | Ethernet Mask 4 | read only |
@W_HSW16 | Ethernet Gateway 1 | read only |
@W_HSW17 | Ethernet Gateway 2 | read only |
@W_HSW18 | Ethernet Gateway 3 | read only |
@W_HSW19 | Ethernet Gateway 4 | read only |
@W_HSW21 | Ethernet MAC1 | read only |
@W_HSW22 | Ethernet MAC2 | read only |
@W_HSW23 | Ethernet MAC3 | read only |
@W_HSW24 | Ethernet MAC4 | read only |
@W_HSW25 | Ethernet MAC3 | read only |
@W_HSW26 | Ethernet MAC4 | read only |
@W_HSW128 | WIFI IP1 | read only |
@W_HSW129 | WIFI IP2 | read only |
@W_HSW130 | WIFI IP3 | read only |
@W_HSW131 | WIFI IP4 | read only |
@W_HSW132 | WIFI Mask 1 | read only |
@W_HSW133 | WIFI Mask 2 | read only |
@W_HSW134 | WIFI Mask 3 | read only |
@W_HSW135 | WIFI Mask 4 | read only |
@W_HSW136 | WIFI Gateway 1 | read only |
@W_HSW137 | WIFI Gateway 2 | read only |
@W_HSW138 | WIFI Gateway 3 | read only |
@W_HSW139 | WIFI Gateway 4 | read only |
@W_HSW140 | WIFI MAC1 | read only |
@W_HSW141 | WIFI MAC2 | read only |
@W_HSW142 | WIFI MAC3 | read only |
@W_HSW143 | WIFI MAC4 | read only |
@W_HSW144 | WIFI MAC5 | read only |
@W_HSW145 | WIFI MAC6 | read only |
@W_HSW146 | WIFI Signal value | read only |
@W_HSW148 | 4G IP1 | read only |
@W_HSW149 | 4G IP2 | read only |
@W_HSW150 | 4G IP3 | read only |
@W_HSW151 | 4G IP4 | read only |
@W_HSW152 | 4G Mask 1 | read only |
@W_HSW153 | 4G Mask 2 | read only |
@W_HSW154 | 4G Mask 3 | read only |
@W_HSW155 | 4G Mask 4 | read only |
@W_HSW156 | 4G Gateway 1 | read only |
@W_HSW157 | 4G Gateway 2 | read only |
@W_HSW158 | 4G Gateway 3 | read only |
@W_HSW159 | 4G Gateway 4 | read only |
@W_HSW160 | 4G MAC1 | read only |
@W_HSW161 | 4G MAC2 | read only |
@W_HSW162 | 4G MAC3 | read only |
@W_HSW163 | 4G MAC4 | read only |
@W_HSW164 | 4G MAC5 | read only |
@W_HSW165 | 4G MAC6 | read only |
@W_HSW166 | 4G Signal value | read only |
2. Other
2.1 Access password: addr_getstring("@W_HSW27", 16)
2.2 Machine code: addr_getstring("@W_HSW60", 64)
2.3 Positioning method (@W_HSW167): (read only)
1. Latitude and longitude
Longitude: addr_getdouble("@W_HSW168") (read only)
Latitude: addr_getdouble("@W_HSW172") (read only)
2. Base station positioning
LAC: addr_getdword("@W_HSW168") (read only)
CI: addr_getdword("@W_HSW172") (read only)
2.4 Convert base station to latitude and longitude via API
Longitude: addr_getdouble("@W_HSW187") (read only)
Latitude: addr_getdouble("@W_HSW183") (read only)
2.5 Operator information: addr_getdword("@W_HSW181") (read only)
2.6 Networking mode: addr_getword("@W_HSW177") (read only)
0: Ethernet, 1: WIFI, 2: 4G, 3: 2G
2.7 Map fence flag: addr_getword("@W_HSW178") (read only)
0: No map fence is drawn
1: Draw a map fence and the box is in the fence
2: Draw a map fence and the box is not in the fence
2.8 SIM card status addr_getword("@W_HSW179") (read only)
1: No card detected
2: Card insertion detected
3: The card status is abnormal
2.9 MQTT status addr_getword("@W_HSW180") (read only)
1: online, 2: offline
2.10 IO interface, X is read only, Y is read and write (H series)
addr_getbit(addr1), addr_setbit(addr2)
addr1:"@B_Y0" "@B_Y1" "@B_X0" "@B_X1"
addr2:"@B_Y0" "@B_Y1"
9 General Functions
9.1 send_sms_ira(string number, string message)
Function:
Use IRA character set to send English text messages
Parameters:
number: number (up to 32 characters, the excess will be discarded)
message: SMS content (up to 160 English characters, including special symbols, the part exceeding 160 characters will be discarded, and no characters in other languages should appear in the content)
Return:
Succeed: SMS corresponding id, used to get whether the SMS was sent successfully
Failed: multi
9.2 send_sms_ucs2(string number, string message)
Function:
Use UCS2 character set to send SMS in Chinese and other languages, such as Korean, Japanese, etc.
Parameters:
number: number (up to 32 characters, the excess will be discarded)
message: SMS content (Only 70 Chinese characters at most, the part exceeding the length will be discarded)
Return:
Succeed: SMS corresponding id, used to get whether the SMS was sent successfully
Failed: multi
9.3 sms_get_state(number id)
Function:
Get the status of the SMS
parameter:
id: SMS corresponding id
Return:
Succeed: SMS status (1: not sent, 2: sent successfully, 3: failed to send)
Failed: multi
9.4 jwt_encode(table head, table payload, string aud, number iat, number exp, string key, int jwttype)
Function:
Convert data to JWT format
parameter:
aud: project name
iat: The valid period start timestamp of the JWT data format
exp: the expiration time stamp of the JWT data format
head: head information table
key: key in JSON format
value: value in JSON format
type:value type, 0:string,1:integer,2:number,3:boolean
{
{key="test1",value="test1",type="0"}
}
payload: payload information table
The format is consistent with the header information table
{
{key="test",value="test",type="0"}
}
jwttype: encryption type
0:RS256 1:RS384 2:RS512
3: PS256 4: PS384 5: PS512
6:HS256 7:HS384 8:HS512
9:ES256 10:ES384 11:ES512
key: the private key required for encryption
For example:
function jwt.main()
local PRIVATE_KEY = [[-- Please enter the secret key--]]
local JWTType=0
local payload = {{key="test1",value="test1",type="0"},
{key="test",value="123122131",type="1"}}
local head = {{ key="name",value="data",type="0"},
{key="test2",value="test2",type="0"}}
local aud = "project"
local iat = 123122131
local exp1 = 123122331
local en = jwt_encode(head,payload,aud,iat,exp1,PRIVATE_KEY,JWTType);
print(en)
End
9.5 convertohex(number type, number value)
Function:
Convert data into hexadecimal data
parameter:
type: incoming data type 0:word 1:dword 2:float
value: the data to be converted
Return:
Succeed: the converted hexadecimal data
Failed: multi
9.6 set_network(table config)
Function:
Set V-BOX network, take effect after restart
parameter:
config: incoming network configuration table
- connectMode: the way V-BOX connects to the server, 0: Ethernet, 1: WIFI, 2: 4G, 3: 2G, it is not allowed to be empty.
- ethernetEnable: Whether to enable Ethernet, 1: enable, 0: disable, and it is not allowed to be empty.
- ethernetLanIp: Set the LAN IP address. Only V-BOX with three network ports support this configuration, and other models of V-BOX do not support setting LAN IP. This item is allowed to be empty.
- ethernetIpMode: Whether to enable Ethernet static IP, 1: Enable static IP, 0: DHCP, not allowed to be empty.
- ethernetIp: The IP address needs to be configured when the Ethernet static IP is used, and it is not allowed to be empty.
- ethernetNetmask: The subnet mask needs to be configured when Ethernet static IP is used, and it is not allowed to be empty.
- ethernetGateway: The gateway can be configured when Ethernet static IP is used.
- When using the Ethernet network, if the Gateway is empty, V-BOX will not connect to the server.
- If you only use Ethernet to directly connect to the PLC for communication, you do not need to configure a gateway.
- ethernetFirstDns: You can configure the preferred DNS server when the Ethernet static IP is used, and it is allowed to be empty. If you use the Ethernet network and do not fill in the DNS server, V-BOX will not be connected to the server.
- ethernetSpareDns: Alternate DNS server can be configured when the Ethernet static IP is used, and it is allowed to be empty.
- wifiEnable: Whether to enable WIFI, 1: enable, 0: disable, it is not allowed to be empty. If it is a model that does not include WIFI, directly disable it.
- wifiName: WIFI name, if WIFI is enabled, it is not allowed to be empty.
- wifiPassword: WIFI password, it is allowed to be empty.
- wifiIpMode: Whether to enable WIFI static IP, 1: Enable static IP, 0: DHCP, not allowed to be empty.
- wifiIp: IP address needs to be configured when WIFI static IP is used, it is not allowed to be empty.
- wifiNetmask: The subnet mask needs to be configured when WIFI static IP is used, and it is not allowed to be empty.
- wifiGateway: The gateway can be configured when WIFI static IP is used, and it is not allowed to be empty.
- wifiFirstDns: You can configure the preferred DNS server when the WIFI static IP is used, and it is allowed to be empty. If you use the WIFI network and do not fill in the DNS server, V-BOX will not be connected to the server.
- wifiSpareDns: Alternate DNS server can be configured when the WIFI static IP is used, and it is allowed to be empty.
- mobileEnable: Whether to enable the mobile network, 1: enable, 0: disable, it is not allowed to be empty, if it does not include 4G models, directly disable it.
- mobileApnMode: Whether to manually configure the APN, 0: Use the default APN, 1: Manually configure the APN, it is not allowed to be empty.
- apnName: APN name, if you choose to manually configure APN, it is not allowed to be empty.
- apnPassword: APN username, it is allowed to be empty.
- apnUserName: APN number, it is allowed to be empty.
- apnNumber: APN number, it is allowed to be empty.
Return:
Succeed: true
Faied: multi
9.7 remote_com_start(string config)
Function:
start serial port pass-through
Parameter:
config: incoming serial port parameter configuration, JSON format
- type:0, serial port pass-through
- port: serial port number marked on the V-BOX
- comtype:0-RS232, 1-RS485, 2-RS422
- baudrate: Baud Rate
- data_length: Data Bits
- stop_bit: Stop Bit
- check_bit: Check Bit
Return:
Succeed: true
Failed: multi
9.8 remote_com_stop()
Function:
close serial port pass-through
Return:
Succeed: true
Failed: multi
9.9 remote_com_state()
Function:
query the serial port pass-through status and pass-through server domain name and port
Return:
Succeed:
- number, current pass-through status: 0-none 1,2-starting pass-through 3-penetrating 4,5-finishing pass-through 6-pass-through error
- string, pass-through server domain name and port number, xxxx (domain name): xxx (port number)
Failed: multi