1 Interface description

Data type definition

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

Return value description

The function return type multi means multiple return values (at least 2), usually:

1st: nil

2nd: the error message

Suppose a function prototype is defined:

Explanation

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 [] 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

Output results

Comment

1. From the print result, the first line and the second line are 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.

Modification of 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 the following restrictions are made.

1. Interval limit: When debugging, transfer once every 2~3 seconds;
2. Data limit: The transfer data cannot be larger than 1.5KB in a single transmission, otherwise 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.

 Table 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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Function: Copy data from source address to destination address

Parameters:

dst: destination address

src: source address

length: length

Return：

Succeed: true

Failed: multi

Function: Write the same value to consecutive addresses

Parameters:

addr: address

num: value

length:continuous length

Return：

Succeed: true

Failed: multi

Function: Offset address value relative to addr

Parameters:

addr: address

offset: offset value

Return：

Succeed: New address after offset

Failed: multi

Function: Offset station number relative to addr station number

Parameters:

addr: address

offset: offset value

Return：

Succeed: New station number after offset

Failed: multi

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

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

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.

Data bit:

1. 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.
2. When the data bit is 8, the maximum value of data transmission is 255 (0xFF), which supports the transmission of any character.

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

Function: Disable the serial port

Parameters: Obj is the object returned by serial.open

Return：

Succeed: true

Failed: multi

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

Function: Write the specified byte length to serial port data

Parameters: 

data: serial port data

Return：

Succeed: true

Failed: multi

Function: Clear the serial port buffer

Parameters:

[flag=2] clear option: 0: read, 1: write, 2: read-write

Return：

Succeed: true

Failed: multi

Function: Close the serial port object

Parameters: None

Return：

Succeed: true

Failed: multi

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

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

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

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

Function: Disconnect from the MQTT server

Parameters: [timeout=10000] Disconnect waiting timeout, in milliseconds 

Return：

Succeed: true

Failed: multi

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

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

Function: Unsubscribe topic

Parameters:

topic, topic name

Return：

Succeed: true

Failed: multi

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

Function: Close the mqtt object (the connection to the server will be automatically disconnected)

Parameters: None

Return：

Succeed: true

Failed: multi

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

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

Lua only has a table data structure, so all arrays and key-value objects of json will be returned as a table.

Function: Convert lua data type to json string

Parameters: Lua data type (including boolean, number, string, table)

Return： Json format string

Function: Convert json string to lua data type

Parameters: json_string, string of json data structure

Return: Lua data type

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.

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"

For example:

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

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

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

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)

For example:

Failed: table empty table

Function: get machine information

Parameters: None

Return:

Succeed: 3 string type results (model, machine code, software version)

Failed: nil

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

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

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

Function: Get all the cached content (once the internal cache file will be emptied)

Parameters: None

Return:

Succeed: table one-dimensional array

For example:

Failede: nil

Network communication includes Http request interface, this document does not provide interface description, please refer to the online document for how to use it.

http://w3.impa.br/~diego/software/luasocket/http.html#request

https request

For example:

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

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

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

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

crc.init(table prarm)

Function: Initialize the CRC

Parameters:

prarm is a Lua table and needs to contain the following fields.

• string prarm name, see table 9-1 for details of the parameter model name When this parameter is passed in, the default table parameters are used and the poly,init,xorout,refin,and refout passed in are invalid.
• number prarm.width: the width, i.e. the number of CRC bits.
• number [prarm.poly]: short for the generated item in hexadecimal. For example, CRC-32 is 0x04C11DB7, ignoring the highest bit "1", i.e., the complete generation item is 0x104C11DB7.
• number [prarm.init]: the initialization preset value of the register (crc) at the beginning of the algorithm in hexadecimal.
• number [prarm.xorout]: the final CRC value obtained after heterodyning the calculation result with this parameter.
• number [prarm.refin]: whether each byte of the data to be measured is inverted by bit, true or false.
• number [prarm.refout]: after the calculation or before the heterodyning output, whether the whole data is inverted by bit, true or false.

Return:

Success: crc object

Failure: multi, error code

For example:

9 Special function for V-NET

normal_get_alldata()

Function: Obtain the data of all the monitoring points

Parameter: None

Return:

Succeed: table two-dimensional arrays, as follows:

• Each item is a monitoring point and contains 4 attributes:
  • 1: ID
  • 2: status
  • 3: tag name
  • 4: value
• Status contains 3 enumerated values
  • 0: offline
  • 1: online
  • 2: timeout
• Customization returns an empty table if there is no configuration, otherwise returns "field name/field content"

For example:

normal_setdata_byname(string name, string data)

Function: Write data to the monitoring point name

Parameter:

name: the name of monitoring point

data: the data to be written

Return:

Succeed: string: The value of the monitor point before it is written

Failed: nil

normal_getdata_byname(string name)

Function: Read the data of the monitoring point name

Parameter:

name: the name of monitoring point

Return:

Succeed: string

Failed: nil

10 Message summary algorithm

hmac(string hash_func, string key, string message)

Function: HMAC calculate

Function name

hash_func:

• [md5, sha1, sha224, sha256, sha384, sha512]
• [sha512_224, sha512_256, sha3_224, sha3_256]
• [sha3_384, sha3_512]

Parameter:

key: the key

message: message content

Return:

Succeed: string, calculation result

Failed: nil

For example:

sha(string message

Function: SHA calculate

Function name:

sha: 

•  sha1, sha224, sha256, sha384, sha512]
• [sha512_224, sha512_256, sha3_224, sha3_256]
• [sha3_384, sha3_512]

Parameter:

key: the key

message: message content

Return:

Succeed: string, calculation result

Failed: nil

For example: