Reference

Before using the Lua script function, you should understand the basic grammar, and master how to use the script.

For the description of Lua syntax and functions, please refer to Lua Reference Manual.

Common function

Here is a list of commonly used functions to facilitate quick search

• basic Basic functions: English
• string String processing: English
• table Table processing: English
• math Mathematical calculation: English

Built-In library

Removed the Lua built-in functions (Including libraries), the details are as follows

• Completely remove: debug
• Partial removal:

Lua extension

On the basis of Lua, combined with the characteristics of HMI, some functional expansions have been made to assist in completing some more complex business requirements

General class

Custom object class

Realize the drawing and display of charts through custom parts + functions

Network communication

Debug

At present, it can only be debugged by the printing function print. There are two situations for debugging.

How to use HMI debugging

• Open the debug window, add the print_debug(1) in falling script to new Lua object
• Close the debug window, add the print_debug(0) in falling script to new Lua object

Coding environment

Like the Lua standard, the encoding environment of the simulator and the HMI is unified with the encoding of UTF8, including the definition and processing of strings

If you need to print strings in Chinese or other languages into the debugging window, please use we_u8ta for transcoding output

Appendix: editor shortcut hotkeys

Basic function

Address class

How to read or write address

Path class

Usage Notice

Screen class

Others

Address class

How to read or write address

Let HDW0 store a 32-bit integer value, the macro instruction reads/writes the address like following:

How to do in Lua:

• Same point: The address is expressed in the same form, but Lua needs to be enclosed in double quotation marks. The address read and write functions, its address parameters are the same as VB, or use the combination key ctrl+W in the editor to insert the word address, ctrl+BInsert bit address
• Different point: In Lua, you need to call the interface function to complete the operation address, there is no equal sign assignment method like macro instruction

You can find all the interface functions available for reading /writing address operations from this list>>path:#listaddress]]

we_bas_getshort

Prototype: we_bas_getshort(address [, type])

Function: Read single-word(16bits) signed Decimal

Parameters:

• address(string):address
• type(number):type, type=1 is for read-through

Return:

• Success: Single word signed decimal value
• Failure: nil

Example:

we_bas_setshort

Prototype: we_bas_setshort(address, value [, type])

Function: Write single-word(16bits) signed Decimal

Parameters:

• address(string):address
• value(number):value
• type(number):type，type=1 is for write-through

Return:

• Success: true
• Failure: nil

Example:

we_bas_getword

Prototype: we_bas_getword(address [, type])

Function: Read single-word(16bits) unsigned Decimal

Parameters:

• address(string):address
• type(number):type，type=1 is for read-through

Return:

• Success: single-word(16bits) unsigned Decimal value
• Failure: nil

Example:

we_bas_setword

Prototype: we_bas_setword(address, value [, type])

Function: Write single-word(16bits) unsigned Decimal

Parameters:

• address(string):address
• value(number):value
• type(number):type，type = 1 is for write-through

Return:

• Success: true
• Failure: nil

Example:

we_bas_getint

Prototype: we_bas_getint(address [, type])

Function: Read double-word(32bits) signed Decimal

Parameters:

• address(string):address
• type(number):type，type=1 is for read-through

Return:

• Success: Read double-word(32bits) signed Decimal value
• Failure: nil

Example:

we_bas_setint

Prototype: we_bas_setint(address, value [, type])

Function: Write double-word(32bits) signed Decimal

Parameters:

• address(string):address
• value(number):value
• type(number):type，type=1 is for write-through

Return:

• Success: true
• Failure: nil

Example:

we_bas_getdword

Prototype: we_bas_getdword(address [, type])

Function: Read double-word(32bits) unsigned Decimal

Parameters:

• address(string):address
• type(number):type，type=1 is for read-through

Return:

• Success: Read double-word(32bits) unsigned Decimal value
• Failure: nil

Example:

we_bas_setdword

Prototype: we_bas_setdword(address, value [, type])

Function: Write double-word(32bits) unsigned Decimal

Parameters:

• address(string):address
• value(number):value
• type(number):type，type=1为write-through

Return:

• Success: true
• Failure: nil

Example:

we_bas_getfloat

Prototype: we_bas_getfloat(address [, type])

Function: Read 32bits Floating

Parameters:

• address(string):address
• type(number):type，type=1 is for read-through

Return:

• Success: 32bits Floating value
• Failure: nil

Example:

we_bas_setfloat

Prototype: we_bas_setfloat(address, value [, type])

Function: Write 32bits Floating

Parameters:

• address(string):address
• value(number):value
• type(number):type，type=1 is for write-through

Return:

• Success: true
• Failure: nil

Example:

we_bas_getdouble

Prototype: we_bas_getdouble(address [, type])

Function: Read 64bits Floating

Parameters:

• address(string):address
• type(number):type，type=1is for read-through

Return:

• Success: Read 64bits Floating value
• Failure: nil

Example:

we_bas_setdouble

Prototype: we_bas_setdouble(address, value [, type])

Function: Write 64bits Floating

Parameters:

• address(string):address
• value(number):value
• type(number):type，type=1为write-through

Return:

• Success: true
• Failure: nil

Example:

we_bas_getbit

Prototype: we_bas_getbit(address [, type])

Function: Read one bit

Parameters:

• address(string):address
• type(number):type，type=1is for read-through

Return:

• Success: Single-word signed decimal value
• Failure: nil

Example:

we_bas_setbit

Prototype: we_bas_setbit(address, value [, type])

Function: Write one bit

Parameters:

• address(string):address
• value(number):value，value=0 is off，value=1 is on
• type(number):type，type=1 is for write-through

Return:

• Success: true
• Failure: nil

Example:

we_bas_getstring

Prototype: we_bas_getstring(address, len)

Function: Read string

Parameters:

• address(string):address
• len(number):length，Unit: byte

Return:

• Success: the designated length of the string
• Failure: nil

Example:

we_bas_setstring

Prototype: we_bas_setstring(address, str [, len])

Function: Write string

Parameters:

• address(string):address
• str(string):string
• len(number):length, if not set, it will be the bytes of the string

Return:

• Success: true
• Failure: nil

Example:

we_bas_bmov

Prototype: we_bas_bmov(dstAddress, srcAddress, len[, type])

Function: Copy data of the designated length from the source address to the target address

Parameters:

• dstAddress(string): Target address
• srcAddress(string): Source address
• len(number): designated length
• type(number): read-write type, if type=1, it means write through

Return:

• Success: true
• Failure: nil

Example:

we_bas_fill

Prototype: we_bas_fill(address, value, len)

Function: Assign the same value to continuous addresses

Parameters:

• address(string):address
• value(number):value
• len(number):continuous length（Unit:word）

Return:

• Success: true
• Failure: nil

Example:

we_bas_newnoaddr

Prototype: we_bas_newnoaddr(address, len)

Function: External address offset

Parameters:

• address(string):address
• len(number):length

Return:

• Success: offset address(string)
• Failure: nil

Example:

we_bas_newstataddr

Prototype: we_bas_newstataddr(address, len)

Function: External station number offset

Parameters:

• address(string):address
• len(number):length

Return:

• Success: offset address(string)
• Failure: nil

Example:

we_bas_getdatas

Prototype: we_bas_getdatas(address,quantity,type[,rwtype,hilorever])

Function: Read continous address

Data type table

Parameters:

• address(string): address
• quantity(number): number
• type(number): data type, please refer to the data type table above
• rwtype(number): Read values directly from the device.  When type=1,  read values directly from the device.
• hilorever (number): high and low words. When type=1, high words are in front.

Return:

• Success: Return data table
• Failure: nil

Example:

we_bas_setdatas

Prototype: we_bas_setdatas(address,data,quantity,type[,rwtype,hilorever])

Function: Read continous address

Parameters:

• address(string): address
• quantity(number): Data table name
• type(number): data type, please refer to the following data type table
• rwtype(number): Read-write type, if set type=1,  enable write through. 
• hilorever (number): high and low words. When type=1, high words are in front.

Data type table

Return:

• Success: 1
• Failure: nil

Example:

Path class

Usage Notice

Before using this type of interface,you need to understand the structure of the File System inside the HMI.

we_bas_getscriptpath(HMI)

Prototype: we_bas_getscriptpath()

Function: Get project script path

Parameters: None

Return:

• Success: The path of script(string)
• Failure: nil

Example:

we_bas_getcustompath(HMI)

Prototype: we_bas_getcustompath()

Function: Get the available internal flash path

Parameters:None

Return:

• Success: Internal Flash path(string)
• Failure: nil

Example:

we_bas_getusbpath(HMI)

Prototype: we_bas_getusbpath()

Function: Detect USB, if detected, Return USB path (premise: support U disk Function)

Parameters: None

Return:

• Success: The path of USB
• Failure: nil

Example:

we_bas_getsdpath(HMI)

Prototype: we_bas_getsdpath()

Function: Detect SD card, if detected, return SD card path (premise: support SD card Function)

Parameters: None

Return:

• Success: The path of SD card
• Failure: nil

Example:

we_bas_file_exist(HMI)

Prototype: we_bas_file_exist(filepath)

Function: Does the file exist

Parameters:

• filepath(string):File path

Return:

• Success: true --exist
• Failure: false --not exist or error

Example:

we_bas_path_exist(HMI)

Prototype: we_bas_path_exist(dirpath)

Function: Does the folder exist

Parameters:

• dirpath(string): Folder path

Return:

• Success: true --exist
• Failure: false --not exist or error

Example:

Screen class

we_bas_jumpscreen(HMI)

Prototype: we_bas_jumpscreen(screenid)

Function: Main screen jump

Parameters:

• screenid(number): Main screen No.

Return:

• Success: true
• Failure: false

Example:

we_bas_popscreen(HMI)

Prototype: we_bas_popscreen(subscreenid, x, y)

Function: Pop up a sub-screen, if a built-in screen like keyboard pops up, the screen cannot be used

Parameters:

• subscreenid(number): Sub-screen No.
• x(number):The X coordinate of upper left corner of the screen
• y(number):The Y coordinate of upper left corner of the screen

Return:

• Success: true
• Failure: false

Example:

we_bas_closescreen(HMI)

Prototype: we_bas_closescreen(subscreenid)

Function: Close sub-screen

Parameters:

• subscreenid(number): Sub-screen No.

Return:

• Success: true
• Failure: false

Example:

Others

we_bas_gettickcount

Prototype: we_bas_gettickcount()

Function: Get milliseconds that have passed since the operating system was started

Parameters: None

Return: Time

Example:

we_bas_sleep

Prototype: we_bas_sleep(millisecond)

Function: Sleep，would block the running of the script

Parameters:

• millisecond(number): Sleep milliseconds

Return: None；

Example:

we_bas_beep

Prototype: we_bas_beep()

Function: Beep

Parameters: None

Return: None

Example:

we_atu8

Prototype: we_atu8(str)

Function: Character set conversion, windows to utf8

Note: Only effective for the simulator, no conversion in the real HMI

Parameters:

• str(string): string of windows character set

Return:

• Success: string of utf8 character set
• Failure: nil

Example:Reference

we_u8ta

Prototype: we_u8ta(str)

Function: Character set conversion, utf8 to windows

Note: Only effective for the simulator, no conversion in the real HMI

Parameters:

• str(string): string of utf8 character set

Return:

• Success: string of windows character set
• Failure: nil

Example:Reference

we_bas_getmachineinfo

Prototype: we_bas_getmachineinfo()

Function: Get HMI machine information

Parameters: None

Return: 

• Success: Model, Machine code, Image list
• Failure: nil

Example:

Lua object operation

Description

The library is mainly added for Lua Object , used to control various states of Lua Object

The prefix name of the library is: we_part_xxx

we_part_setstate(HMI)

Prototype: we_part_setstate(partname, value)

Function: Set the status of object

Parameter:

• partname(string): object name
• value(number): the status value of the object

Return:

• Success: true
• Failure: false

Example:

we_part_getstate(HMI)

Prototype: we_part_getstate(partname)

Function: Get the status value of the object

Parameter:

• partname(string): object name

Return:

• Success: Status value (number)
• Failure: nil

Example:

we_part_settchenable(HMI)

Prototype: we_part_settchenable(partname)

Function: Set the object allowed to click

Parameter:

• partname(string): object name

Return:

• Success: true
• Failure: false

Example:

we_part_settchunable(HMI)

Prototype: we_part_settchunable(partname)

Function: Set object not allowed to click

Parameter:

• partname(string): object name

Return:

• Success: true
• Failure: false

Example:

we_part_gettchstate(HMI)

Prototype: we_part_gettchstate(partname)

Function: Get whether the object is allowed to be clicked

Parameter:

• partname(string): object name

Return:

• Success: true allowed to click, false not allowed to click
• Failure: nil

Example:

we_part_sethidestate(HMI)

Prototype: we_part_sethidestate(partname, value)

Function: set the hidden value of the object

Parameter:

• partname(string): object name
• value(number): set value
   0: No special processing is performed, according to the Hide function controlled by the object’s control address
  1: Display and not be affected by the Hide function of the object's control address
  2: Hidden and not affected by the Hide function of the object's control address

Return:

• Success: true
• Failure: false

Example:

we_part_gethidestate(HMI)

Prototype: we_part_gethidestate(partname)

Function: Get the hidden value of the object

Parameter:

• partname(string): object name

Return:

• Success: true object is hidden, false object is displayed
• Failure: nil

we_part_clickdown(HMI)

Prototype: we_part_clickdown(partname)

Function: Send a click-- down message to the specified component, and execute the click-- down script

Parameter:

• partname(string): object name

Return:

• Success: true
• Failure: false

we_part_clickup(HMI)

Prototype: we_part_clickup(partname)

Function: Send a click-- up message to the specified component, and execute the click-- up script

Parameter:

• partname(string): object name

Return:

• Success: true
• Failure: false

we_part_setcurrc(HMI)

Prototype: we_part_setcurrc(partname, left, top, right, bottom)

Function: Set the current contour info of the object

Parameter:

• partname(string): object name
• left(number): coordinate value of the left side of the object
• top(number): coordinate value of the left side of the object
• right(number): coordinate value of the right side of the object
• bottom(number): coordinate value of the bottom of the object

Return:

• Success: true
• Failure: false

Example:

we_part_getcurrc(HMI)

Prototype: we_part_getcurrc(partname)

Function: Get the current contour info of the object

Parameter:

• partname(string): object name

Return:

• Success: left, top, right, bottom (number), four values
• Failure: nil

Example:

we_part_getoriginalrc(HMI)

Prototype: we_part_getoriginalrc(partname)

Function: Get the original contour info of the object

Parameter:

• partname(string): object name

Return：

• Success: left, top, right, bottom (number), four values
• Failure: nil

Example:

Timer

Description

The timer function is similar to the timing script of the Macro, which has the effect of timing execution. The difference is that Macro executes one script, while Lua executes one function.

The name of the library is: timer

Features

• Trigger execution when timing arrives
• Dynamic switching enable, can disable or enable during operation
• The timing interval is variable, and the interval value can be modified during operation

✎Note:

• If multiple timers are registered in one screen, they will be executed out of order, and timing arrives will be executed first
• The function registered by the timer cannot be written in an endless loop, otherwise it will be stuck in all operations, including the execution of screen polling wescrpoll_x

List

Parameter Requirements:

The value range of screen number in the function parameters is:

• -1: Global background
• [0,99999]: the corresponding screen number

The ID in the function parameters must be unique in every screen, and also unique in the global, but each screen is independent of each other. For example, a timer with ID=[1,2,3] is created on screen 0, screen 1 can also have a timer with ID=[1,2,3], and the global background can also have ID=[1,2, 3] these timers are independent and unique

timer.create

Prototype: timer.create(screenid, id, interval, f)

Function: Create a timer, execute the registered function when the timer arrives, and automatically start to run after it is created by default

Parameter:

• screenid(number): screen number
• id(number): ID
• interval(number): interval
• f(function): registered execution function

Return:

• Success: true
• Failure: nil

Example:

timer.set_status

Prototype: timer.set_status(screenid, id, value)

Function: enable timer

Parameter:

• screenid(number): screen number
• id(number): ID
• value(number): value, 0: off, 1: on

Return:

• Success: true
• Failure: nil

Example:

timer.get_status

Prototype: timer.get_status(screenid, id)

Function: Get timer status

Parameter:

• screenid(number): screen number
• id(number): ID

Return:

• Success: 0: off, 1: on (number)
• Failure: nil

Example:

timer.set_interval

Prototype: timer.set_interval(screenid, id, num)

Function: modify the interval value of the timer

Parameter:

• screenid(number): screen number
• id(number): ID
• num(number): value, unit: ms

Return:

• Success: true
• Failure: nil

Example:

timer.get_interval

Prototype: timer.get_interval(screenid, id)

Function: Get the interval value of the timer

Parameter:

• screenid(number): screen number
• id(number): ID

Return:

• Success: Interval value (number)
• Failure: nil

Example:

timer.get_func

Prototype: timer.get_func(screenid, id)

Function: Get the execution function associated with the timer

Parameter:

• screenid(number): screen number
• id(number): ID

Return:

• Success: function
• Failure: nil

Example:

Trigger

Description

The trigger function is similar to the trigger script of Macro, which has the effect of triggering execution. The difference is that Macro executes a script, while Lua executes a function.

The name of the library is: trigger

Support 5 trigger types:

1. TRUE: trigger.type_true
2. FALSE: trigger.type_false
3. Bit change: trigger.type_change
4. Rising edge: trigger.type_raise
5. Falling edge: trigger.type_fall

Features

• Bit address condition triggers execution
• Dynamic switching enable, which can enable or disable during operation
• Variable trigger conditions, trigger conditions can be modified during operation

✎Note:

• If multiple triggers are registered in one screen, the address monitoring will be executed out of order
• The function registered by the trigger cannot be written in an endless loop, otherwise it will be stuck in all operations, including the execution of screen polling wescrpoll_x

Parameter Requirements:

The value range of screen number in the function parameters is:

• -1: Global background
• [0,99999]: the corresponding screen number

The ID in the function parameters must be unique in every screen, and also unique in the global, but each screen is independent of each other. For example, a trigger with ID=[1,2,3] is created on screen 0, screen 1 can also have a trigger with ID=[1,2,3], and the global background can also have ID=[1,2, 3] , these triggers are independent and unique

trigger.create

Prototype: trigger.create(screenid, id, triggertype, address, f)

Function: Create a trigger, execute the registered function when the trigger condition is met, and automatically start monitoring after it is created by default

Parameter:

• screenid(number): screen number
• id(number): ID
• triggertype(number): trigger condition type
• address(string): the bit address to be monitored and triggered
• f(function): registered execution function

Return:

• Success: true
• Failure: nil

Example:

trigger.set_status

Prototype: trigger.set_status(screenid, id, value)

Function: Enable trigger

Parameter:

• screenid(number): screen number
• id(number): ID
• value(number): value, 0: off, 1: on

Return:

• Success: true
• Failure: nil

Example:

trigger.get_status

Prototype: trigger.get_status(screenid, id)

Function: Get trigger status

Parameter:

• screenid(number): screen number
• id(number): ID

Return:

• Success: 0: off, 1: on(number)
• Failure: nil

Example:

trigger.set_type

Prototype: trigger.set_type(screenid, id, num)

Function: modify the trigger type of the trigger

Parameter:

• screenid(number): screen number
• id(number): ID
• num(number): type value

Return:

• Success: true
• Failure: nil

Example:

trigger.get_type

Prototype: trigger.get_type(screenid, id)

Function: Get the trigger type of the trigger

Parameter:

• screenid(number): screen number
• id(number): ID

Return:

• Success: trigger type value (number)
• Failure: nil

Example:

trigger.get_func

Prototype: trigger.get_func(screenid, id)

Function: Get the execution function associated with the trigger

Parameter:

• screenid(number): screen number
• id(number): ID

Return:

• Success: function
• Failure: nil

Example:

Flash Read&Write

Description

Lua's io/os library doesn’t support operating the internal Flash of the HMI. There is another interface for Flash that can implement common operations for files and folders.

The name of the library is: flash

The path format of the system is drive letter: location, and the available drive letters have the following 4 types:

• User directory: "user:"
• User script: "script:"
• U Disk: "udisk:"
• SD card: "sdcard:"

The following shows how to express the path:

• Example 1: If a file named 1.txt exists in the root directory of the U disk, the path expression is: udisk:1.txt
• Example 2: If a folder named dir exists in the root directory of the U disk, the path expression is: udisk:dir

✎Note:

• In order to prolong the service life, there is a limited control for writing, and only 1M is allowed to be written within 1 minute. If it exceeds, an error message will be prompted
• The storage space is limited. This part of the space for reading and writing in Lua is shared with Data recording, Historical data and other functions. If the recording data is full, it may be impossible to use Lua scripts to write files, and vice versa

flash.file_write

Prototype: flash.file_write(filepath, mode, data)

Function: Write data to a file, and you can write a file to the internal Flash through this interface

Parameter:

• filepath(string): file path
• mode(string): open mode, it can be non-- r mode,
• data(string): the data to be written

Return:

• Success: true
• Failure: nil

Example: "w" is written once and "a" is written multiple times.

flash.file_copy

Prototype: flash.file_copy(srcpath, dstpath, failifexists)

Function: Copy files, you can copy files from the peripheral to the internal Flash through this interface, and can also be used to export

Parameter:

• srcpath(string): source file path
• dstpath(string): target file path
• failifexists(boolean): whether it fails if the target file already exists
  • true if the target file exists, copy fails
  • false If the target file exists, overwrite copy

Return:

• Success: true
• Failure: nil

Example:

flash.file_rename

Prototype: flash.file_rename(oldname, newname)

Function: Rename file

Parameter:

• oldname(string): old file name path
• newname(string): new file name path

Return:

• Success: true
• Failure: false

Example:

flash.file_remove

Prototype: flash.file_remove(filepath)

Function: delete files

Parameter:

• filepath(string): file name path

Return:

• Success: true
• Failure: false

Example:

flash.file_filter

Prototype: flash.file_filter(dirpath, format)

Function: traverse folders and return all file names that conform to the file format

Parameter:

• dirpath(string): folder path
• format(string): file format

Return:

• Success: an array of file names (table)
• Failure: nil

Example:

Output：

flash.dir_make

Prototype: flash.dir_make(dirpath)

Function: Recursively create folders

Parameter:

• dirpath(string): folder path

Return:

• Success: true
• Failure: false

Example:

flash.dir_remove

Prototype: flash.dir_remove(dirpath)

Function: delete folders recursively, including files in the folder

Parameter:

• dirpath(string): folder path

Return:

• Success: true
• Failure: false

Example:

flash.file_u8ta

Prototype: flash.file_u8ta(u8file, gbfile)

Function: File character set conversion, UTF8 to GB2312

Parameter:

• u8file(string): utf8 file to convert
• gbfile(string): Save gb2312 file of converted data (Only files in a Udisk or sd card supported)

Return:

• = 0：Succeed
• =-1：Function parameter error
• =-2：File path error
• =-3：Failed to read utf8 file data
• =-4：utf8 file data exception
• =-5：Insufficient space
• =-6：Data conversion failure
• =-7：Failed to write the GB2312 file

Example:

flash.file_atu8

Prototype: flash.file_atu8(gbfile, u8file)

Function: File character set conversion, UTF8 to GB2312

Parameter:

• u8file(string): gb2312 file to convert
• gbfile(string): Save utf8 file of converted data (Only files in a Udisk or sd card supported)

Return:

• = 0：Succeed
• =-1：Function parameter error
• =-2：File path error
• =-3：Failed to read gb2312 file data
• =-4：utf8 file data exception
• =-5：Insufficient space
• =-6：Data conversion failure
• =-7：Failed to write the utf8 file

Example:

flash.file_save

Prototype: flash.file_save(filePath)

Function: File saved immediately.

Parameter:

• filePath(string): File name that needs to save immediately.

Return:

• = 0：Succeed

Example:

Other functions

Description

The library provides operations for folder traversal, creation, and deletion

The name of the library is: lfs

List

lfs.attributes

Prototype: lfs.attributes(filepath [, aname])

Function: Get properties and return a table with file properties corresponding to the file path. If the second parameter is given, only the value of the naming property will be returned

Parameter:

• filepath(string): file path
• aname(string): file attribute

Return:

• Success: table
• Failure: nil

Example:

lfs.dir

Prototype: lfs.dir(dirpath)

Function: traverse the folder, this is an iterator function, need to use the for statement

Note: This interface function is planned to be deprecated in the future, it is recommended to use the flash.file_filter function

Parameter:

• dirpath(string): folder path

Return:

• Success: file name (string)
• Failure: nil

Example:

lfs.mkdir

Prototype: lfs.mkdir(dirpath)

Function: Create a folder (recursion is not supported)

Notice: This interface function is planned to be deprecated in the future, it is recommended to use the flash.dir_make function

Parameter:

• dirpath(string): folder path

Return:

• Success: true
• Failure: nil

Example:

lfs.rmdir

Prototype: lfs.rmdir(dirpath)

Function: Delete folder (recursion is not supported)

Note: This interface function is planned to be deprecated in the future. It is recommended to use the flash.dir_remove function

Parameter:

• dirpath(string): folder path

Return:

• Success: true
• Failure: nil

Example:

Table drawing

Description

The name of the library is: cus_table

The following interface example assumes that there is a object named 0_CST_0 on screen 0

List

cus_table.set_cell(HMI)

Prototype: cus_table.set_cell(part, row, col[, ratio])

Function: Set the number of rows and columns of the table

• part(string): object name
• row(number): number of rows
• col(number): number of columns
• ratio(string): optional parameter (default equal width), the ratio of column width

Return:

• Success: true
• Failure: nil, error message

Example:

cus_table.set_head(HMI)

Prototype: custable.sethead(part, head)

Function: set header text

• part(string): object name
• head(table): array, head[1] position represents column 1, and so on

Return:

• Success: true
• Failure: nil, error message

Example:

cus_table.set_mode(HMI)

Prototype: cus_table.set_mode(part, mode)

Function: Set the display mode, you can display in ascending or descending order, the default is ascending order

• part(string): object name
• mode(number): 0 ascending order, 1 descending order

Return:

• Success: true
• Failure: nil, error message

Example:

cus_table.page_up(HMI)

Prototype: cus_table.page_up(part)

Function: execute page up

• part(string): object name

Return:

• Success:
  • true turn page up successfully
  • false has reached the top page
• Failure: nil, error message

Example:

cus_table.page_down(HMI)

Prototype: cus_table.page_down(part)

Function: Execute page down

• part(string): object name

Return:

• Success:
  • true turn page down successfully
  • false to the bottom page
• Failure: nil, error message

Example:

cus_table.get_index(HMI)

Prototype: cus_table.get_index(part)

Function: Get the currently selected index

• part(string): object name

Return:

• Success: Index (number)
• Failure: nil, error message

Example:

cus_table.get_page(HMI)

Prototype: cus_table.get_page(part)

Function: Get the current page and the total number of pages

• part(string): object name

Return:

• Success: current page (number), total page number (number)
• Failure: nil, error message

Example:

cus_table.refresh(HMI)

Prototype: cus_table.refresh(part, data)

Function: Refresh the object, after performing page turning and modifying the data source, you need to call this function once to refresh the object display

• part(string): object name
• data(table): data source, two-- dimensional array, data[1][1] position represents the content of the first row and the first column

Return:

• Success: true
• Failure: nil, error message

Example:

cus_table.reset(HMI)

Prototype: cus_table.reset(part)

Function: reset object, clear all settings

• part(string): object name

Return:

• Success: true
• Failure: nil, error message

Example:

Example

Use Lua object, add table_test() in the press script, compile and run to see the effect

Curve drawing

Description

The name of the library is: cus_curve

The following interface example assumes that there is a object named 0_CST_0 on screen 0

List

cus_curve.init(HMI)

Prototype: cus_curve.init(part, x, y)

Function: Set the number of x and y major scale divisions

• part(string): part name
• x(number): The number of major scale on the x-- axis [1, 10]
• y(number): the number of major scale on the y-- axis [1, 10]

Return:

• Success: true
• Failure: nil, error message

Example:

cus_curve.set_range(HMI)

Prototype: cus_curve.set_range(part, axis, min, max)

Function: Set the range of the specified axis

• part(string): object name
• axis(string): specify the axis, x or y
• min(number): minimum value
• max(number): maximum value

Return:

• Success: true
• Failure: nil, error message

Example:

cus_curve.get_range(HMI)

Prototype: cus_curve.get_range(part, axis)

Function: Get the range of the specified axis

• part(string): object name
• axis(string): specify the axis, x or y

Return:

• Success: minimum (number), maximum (number)
• Failure: nil, error message

Example:

cus_curve.set_scale(HMI)

Prototype: cus_curve.set_scale(part, axis, style)

Function: Set the major scale style of the specified axis

• part(string): object name
• axis(string): specify the axis, x or y
• style(table): style sheet, format

Return:

• Success: true
• Failure: nil, error message

Example:

cus_curve.get_scale(HMI)

Prototype: cus_curve.get_scale(part, axis)

Function: Get the major scale style of the specified axis

• part(string): object name
• axis(string): specify the axis, x or y

Return:

• Success: style sheet (table)
• Failure: nil, error message

Example:

cus_curve.set_grid(HMI)

Prototype: cus_curve.set_grid(part, axis, style)

Function: Set the main grid style of the specified axis

• part(string): object name
• axis(string): specify the axis, x or y
• style(table): style sheet, format

Return:

• Success: true
• Failure: nil, error message

Example:

cus_curve.get_grid(HMI)

Prototype: cus_curve.get_grid(part, axis)

Function: Get the main grid style of the specified axis

• part(string): object name
• axis(string): specify the axis, x or y

Return:

• Success: style sheet (table)
• Failure: nil, error message

Example:

cus_curve.set_line(HMI)

Prototype: cus_curve.set_line(part, id, num, style)

Function: Set the number of points and style of the curve

• part(string): object name
• id(number): curve ID
• num(number): The number of points that can be [0, 1000] for each curve
• style(table): style sheet, see the beginning of this section for the format

Return:

• Success: true
• Failure: nil, error message

Example:

cus_curve.get_line(HMI)

Prototype: cus_curve.get_line(part, id)

Function: Get the number of points and style of the curve

• part(string): object name
• id(number): curve ID

Return:

• Success: points (number), style sheet (table)
• Failure: nil, error message

Example:

cus_curve.set_visible(HMI)

Prototype: cus_curve.set_visible(part, id, visible)

Function: Set the visibility of the curve

• part(string): object name
• id(number): curve ID
• visible(number):visibility

Return:

• Success: true
• Failure: nil, error message

Example:

cus_curve.get_visible(HMI)

Prototype: cus_curve.get_visible(part, id)

Function: Get the visibility of the curve

• part(string): object name
• id(number): curve ID

Return:

• Success: visibility (number)
• Failure: nil, error message

Example:

cus_curve.set_refer(HMI)

Prototype: cus_curve.set_refer(part, axis, id, num, style)

Function: Set a reference line

• part(string): object name
• axis(string): specify the axis, x or y
• id(number): reference line ID
• num(number): the value of the reference line
• style(table): style sheet

Return:

• Success: true
• Failure: nil, error message

Example:

cus_curve.set_cursor(HMI)

Prototype: cus_curve.set_cursor(part, mode, style)

Function: Set the display of the click event cursor

• part(string): object name
• mode(number): display mode, 0 integer value, 1 floating value
• style(table): style sheet, see the beginning of this section for the format

Return:

• Success: true
• Failure: nil, error message

Example:

cus_curve.draw_line(HMI)

Prototype: cus_curve.draw_line(part, id, data)

Function: Draw a curve and connect all the coordinates into a line in the increasing order of the array

• part(string): object name
• id(number): curve ID
• data(table): a one-- dimensional data table, odd-- numbered index represents x, even-- numbered index represents y, such as:
   (data[1], data[2]) represents the first coordinate (x1, y1),
   (data[3], data[4]) represents the second coordinate (x2, y2),

Return:

• Success: true
• Failure: nil, error message

Example:

cus_curve.refresh(HMI)

Prototype: cus_curve.refresh(part)

Function: Refresh the object, call this interface after setting the scale, grid, label and line drawing to refresh the curve object and display it

• part(string): object name

Return:

• Success: true
• Failure: nil, error message

Example:

cus_curve.reset(HMI)

Prototype: cus_curve.reset(part)

Function: reset object, clear all settings

• part(string): object name

Return:

• Success: true
• Failure: nil, error message

Example:

cus_curve.set_slider

Prototype: cus_curve.set_slider(part [, config] )

Function: Set curve slider and display the data selected by the slider.

• part(string): object name
• config(table): Slider configuration option

Note:

Example (For details, see Example 2)：

Example

example 1

Use Lua object, add curve_test() in the falling script, compile and run to see the effect

example 2

 Use the Lua widget, add sldierRun() to the press script or init script, and compile.

MQTT

Description

The library provides the MQTT client function, which can let HMI connect to the MQTT server

The name of the library is: mqtt

Safety Authentication

Only supports the method of username/password authentication

mqtt.setup_cfg

Prototype: mqtt.setup_cfg()

Function: Get the user MQTT parameters configured in the “Cloud" in the record settings

Parameters: None

Return:

• Success: 4 results
    Server address (string)
    Client ID (string)
    Connection (table)
    Will message (table)
• Failure: nil

Example: Example 2

mqtt.create

Prototype: mqtt.create(serverurl, clientid)

Function: Create mqtt client object

Parameter:

• serverurl(string): server address, format: "protocol://host:port"
   protocol: tcp
   host: Hostname/IP address
   port: such as 1883
• clientid(string): client ID

Return:

• Success: mqtt object (mqtt)
• Failure: nil, err

Example: Example 1

mqtt.close

Prototype: mqtt.close(obj)

Function: close the mqtt client object

Parameter:

• obj(mqtt): obj is the object created and returned by mqtt.create

Return:

• Success: true
• Failure: nil

Example:

mqtt:connect

Prototype: mqtt:connect(conn[, lwt])

Function: establish connection with the server

Parameter:

• conn(table): table, require the following fields
   conn.username(string): username
   conn.password(string): password
   conn.keepalive(number): Keep-Alive Interval, unit: second, default 60 seconds
   conn.cleansession(number): Clean Session, default 1
   This function is used to control the behavior when connecting & disconnecting. Both client and server retain session information. This information is used to ensure arrived "at least once" and "accurately once" , and includes the topic subscribed by the client. You can choose to reserve or ignore the session message. The settings are as follows:
   1 (Clean): If the session exists previously and is 1, then all messages from session on the client and server are cleaned.
   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(table): Will message, also called Last Will and Testament, require the following fields
   lwt.topic(string): Topic
   lwt.message(string): Message body
   lwt.qos(number): QoS value, default 0
   lwt.retain(number): Reserved flag bit, default 0

Return:

• Success: true
• Failure: nil, err

Example: Example 1

mqtt:disconnect

Prototype: mqtt:disconnect([timeout])

Function: Disconnect from the server

Parameter:

-timeout(number): Connection Timeout, unit: milliseconds, the default is 10000 milliseconds

Return:

• Success: true
• Failure: nil

Example: Example 1

mqtt:isconnected

Prototype: mqtt:isconnected()

Function: Whether connect to the server

Parameters: None

Return:

• Success: true Connected
• Failure: false Not connected, other unknown situations also return false

Example: Example 1

mqtt:close

Prototype: mqtt:close()

Function: Close the object of mqtt client (If it is connected to the server and not manually disconnected, it will be automatically disconnected)

Parameters: None

Return:

• Success: true
• Failure: nil, err

Example: Example 1

mqtt:subscribe

Prototype: mqtt:subscribe(topic, qos)

Function: Subscribe topic

Parameter:

• topic(string): Topic name
• qos(number): QoS value

Return:

• Success: true
• Failure: nil, err

Example: Example 1

mqtt:unsubscribe

Prototype: mqtt:unsubscribe(topic)

Function: Unsubscribed topic

Parameter:

• topic(string): Topic name

Return:

• Success: true
• Failure: nil, err

Example: Example 1

mqtt:publish

Prototype: mqtt:publish(topic, message, qos, retain[, timeout])

Function: Publish message

Parameter:

• topic(string): Topic name
• message(string): Message body
• qos(number): QoS value
• retain(number): Reserved flag
• timeout(number): Waiting Timeout of publish response, unit: milliseconds (only works when QoS > 0)

Return:

• Success: true
• Failure: nil, err

Example: Example 1

mqtt:on

Prototype: mqtt:on(method, callback)

Function: Register message callback function

Parameter:

• method(string): Totally 3 types of events (Message/Arrived/Offline)

1.message: This function will be called when a message is received

• Function prototype: function(string topic, string message)
• Parameters:
  •  topic Topic name
     message Message content

2.arrived: This function will be called after the publication is arrived

• Function prototype: function()
• Parameters: None

3.offline: This function will be called after the connection is lost

• Function prototype: function(string cause)
• Function:
  •  cause Reason of loss connection
• callback(function): callback function, call this function once after the event is triggered

Return:

• Success: true
• Failure: nil, err

Example: Example 1

Example 1

Effect: Demonstrate that the mqtt client sends and receives print data spontaneously

The operation steps are as follows:

1. Create a new file named mqdemo.lua, and copy the following code to the file
2. Modify the configuration parameters in the function mqtt.create and the variable local config in the script
3. Place a Lua object on screen No.0, and fill in mqtt_test() in the falling type script
4. Compile and click object, let the object execute the function mqtt_test(), observe the debug console

Example 2

Goal: Learn to use the interface function to get configuration parameters

Effect: Demonstrate that mqtt client sends and receives print data spontaneously, same as example 1

The operation steps are as follows:

1. Confirm that the User MQTT parameters are configured in the “Cloud"
2. Create a new file named mqdemo.lua, copy the following code to the file
3. Modify the configuration parameters in the function mqtt.create and the variable local config in the script
4. Place a Lua object on screen No.0, and fill in mqtt_test() in the falling type script
5. Compile and click object, let it execute the function mqtt_test(), observe the debug output

Cloud interface

Description

The library provides the function of getting data collected by "Cloud".

In the configuration interface of the "Cloud", there is a checkbox for the tags for upload selection. If you make the following selections:

1. Check upload to Cloud: the real-time data, Data records, and Alarm record of the tags will be pushed to the Cloud.
2. Check upload to User MQTT: the real-time data, Data records, and Alarm record of the tags will all be transmitted through the lua callback function, and the user can upload these data to the third-party server.

That is, the choice of the upload selection of the data, can only choose one from two.

For example, if you choose upload to Cloud, all interfaces of this library can be considered invalid and cannot be used.

The name of the library is: cloud, some of which are callback functions

Data type table

Function table

cloud.get_history_def(HMI)

Prototype: cloud.get_history_def()

Function: Get the configuration of Data record from HMI, only get channels with the Cloud checked

Parameters: None

Return:

• Success: three-dimensional array (table)
• Failure: nil

Example:

cloud_history_data(HMI)

Prototype: cloud_history_data(gid, ts, data)

Function: Data Record collection callback function, when the collection conditions are met, the collection is triggered and this interface function is called

Parameter:

• gid(number): group ID
• ts(string): time format string, for example: "2021-03-01 14:35:38"
• data(table): two-dimensional array, collected data
   The first layer is the number of data
   The second layer is the specific information of the data

Return: None

Example:

cloud.get_alarm_def(HMI)Lua Script

Prototype: cloud.get_alarm_def()

Function: Get the configuration of the Alarm record from HMI, only get channels with the Cloud checked

Parameters: None

Return:

• Success: two-dimensional array (table)
• Failure: nil

Example:

cloud_alarm_data(HMI)Lua Script

Prototype: cloud_alarm_data(data)

Function: Alarm data callback function, call this interface function when an alarm occurs

Parameter:

• data(table): two-dimensional array, Alarm data
   The first level is the number of Alarm
   The second layer is the specific information of the Alarm

Return: None

Example:

cloud.get_groupdesc

Prototype: cloud.get_groupdesc()

Function: Get the configurations of all groups.

Parameter: None

Return: 

• Success: table two-dimensional array

  {

  [1] = {[1] = Trigger type, [2] = Group name, [3] = Cycle},

  ...

  [n] = {[1] = xx, [2] = xx, [3] = xx},

  }
  Trigger type:

  0: Change triggered

  1: Word triggered

  2: No trigger (sampling by time)

  3: Bit triggers record (sampling by time)

  4: Bit triggers a record and resets

  5:Bit triggers a record and does not reset

  Cycle: Some tags type have no cycle (Unit: ms)，then the cycle is -1.

• Failure: table empty

Example:

cloud.get_datadesc

Prototype: cloud.get_datadesc()

Function: Get the configurations of all collection points

Parameter: None

Return: 

• Success: table three-dimensional array

  {

  [1]={------First group

  [1]={------The tag array of first group

  ?[1] = {[1] = Collection pointID, [2] = Collection point name, [3] = Read-write property, [4] = Type},

   ...

  [n] = {[1] = xx, [2] =xx [3] = xx, [4] = xx}

  },

  [2] = Group ID,

  [3] = Group name

  },

  ......n groups and so on

  }

  Read-write property: 0: read-only, 1: write-only, 2: read and write

  Type: 1: switch, 2: numerical, 3: strings

• Failure: table empty

Example:

cloud.get_groupdata

Prototype: cloud.get_groupdata(name)

Function: Get the collection point information of one group 

Parameter: 

• name: group name

Return: 

• Success: table two-dimensional array

  {

  [1]= {[1]=Collection point ID, [2]=status, [3]=Collect pointion name, [4]=Numeric value, [5]={Cunstom content}},

  ...

  [n] = {[1] = xx, [2] = xx, [3] = xx, [4] = xx, [5] = {xx}}

  }

  Status: 0: Online, -1: Write-only, -2: Offline,

• Failure: table empty

Example:

cloud.set_data

Prototype: cloud.set_data(name, data)

Function: Set a collection point

Parameter: 

• name: collection point name
• data: value (only be string）

Return: 

• Success: The set value

• Failure: nil

Example:

cloud.get_data

Prototype: cloud.get_data(name)

Function: Get the configurations of a collection point

Parameter: 

• name: collection point name

Return: 

• Success: The value of collection point, the custom content of collection point

• Failure: nil

Example:

cloud.get_alldata

Prototype: cloud.get_alldata()

Function: Get all the collection points that meet the conditions 

Parameter: None

Return: 

• Success: table two-dimensional array

  {

  [1]= {[1]=Collection point ID, [2]=status, [3]=Collect pointion name, [4]=Numeric value, [5]={Cunstom content}},

  ...

  [n] = {[1] = xx, [2] = xx, [3] = xx, [4] = xx, [5] = {xx}}

  }

  Status: 0: Online, -1: Write-only, -2: Offline,

• Failure: table empty

Example:

cloud.set_onecache

Prototype: cloud.set_onecache(data)

Function: Save a piece of data to the cache (30 seconds to write cached data to flash)

Parameter: 

• data: the data to the cache

Return: 

• Success: TRUE

• Failure: nil

Example:

cloud.get_allcache

Prototype: cloud.get_allcache()

Function: Getdata from the cache (The cache data and flash data will be cleared after fetching))

Parameter: None

Return: 

• Success: table two-dimensional array

  {

  [1]="This is the oldest message", ------ The first one is the oldest message

  ......

  [n]="This is the latest message", ------ The last one is the latest message

  }

• Failure: nil

Example:

json

Description

The library provides the conversion function from json string data to lua table data

The name of the library is: json

json.encode

Prototype: json.encode(object)

Function: convert lua data type to json string

Parameter:

• object(boolean, number, string, table): lua data

Return:

• Success: json format string (string)
• Failure: nil

json.decode

Prototype: json.decode(json_string)

Function: json string to lua data type

Parameter:

• json_string(string): string on json data structure

Return:

• Success: lua data type
• Failure: nil

json.null

Prototype: json.null()

Function: This function is used when encapsulating json data, which is equivalent to null in json. If you use json.null() directly, it will directly return the address of the function, please use it with encode function together

Parameters: None

Return: None

Example

Output:

WLAN

The library provides WLAN configuration function.

The name of the library is: hmiwifi

List

hmiwifi.open

Prototype: hmiwif.open()

Function: Enable wifi function

Parameters: None

Return: 

• Success: ture
• Failure: nil, err

hmiwifi.close

Prototype: hmiwif.close()

Function: Disnable wifi function

Parameters: None

Return: 

• Success: ture
• Failure: nil, err

hmiwifi.config

Prototype: hmiwif.close(ssid, passwd)

Function: Configure wifi

Parameters: 

• ssid(string) hotspot name format: length 1~32 bytes
• Passwd(streing) hotspot password format: length is 0 or greater 8

Return: 

• Success: ture
• Failure: nil, err

Example

Output:

FtpServer

The library provides the FtpServer password change function.

Library name: ftpserver

ftpserver.changePsd(oldPsd,newPsd)

Prototype: ftpserver.changePsd(oldPsd,newPsd)

Function: change the server password

Parameters:

• oldPsd(string) old password   format: length in 1 to 32 bytes
• newPsd(string) new password   format: Only letters, numbers, and underscores are allowed，and the length must be 6 to 8 bits.

Return：

• Success: true
• Failure: nil,err

Example

Output: 

SIM

Instruction:

This library provides SIM card configuration information.

The name of the library is: sim.

sim.getCCID

Prototype: sim.getCCID()

Function: Get CCID string

Parameters:

• None

Returns:

• Success: CCID string
• Failure: nil

sim.getIMEI

Prototype: sim.getIMEI()

Function: Get IMEI string

Parameters:

• None

Returns:

• Success: IMEI string
• Failure: nil

Example:

 Output:

SMS

Instruction:

This library provides relevant functions for sending SMS.

The name of the library is: sms.

sms.send_sms_ira

Prototype: sms.send_sms_ira(number, message)

Function: Send English SMS using the IRA character set

Parameter:

• number(string): number(Only 32 characters at most, the exceed character will be discarded)
• message(string): SMS content(Only 160 English characters at most, including special sign, the exceed character will be discarded, do not use characters from other languages in the content)

Return

• Success: Message id, is used for obtain corresponding SMS status
• Failure: nil

Example:

sms.send_sms_ucs2

Prototype: sms.send_sms_ucs2(number, message)

Function: Send other languages' SMS using the UCS2 character set, such as Chinese, Japanese, Korean, etc.

Parameter:

• number(string): number(Only 32 characters at most, the exceed character will be discarded)
• message(string): SMS content(Only 70 characters for other languages at most, the exceed character will be discarded)

Return

• Success: Message id, is used for obtain corresponding SMS status
• Failure: nil

Example:

sms.sms_get_state

Prototype: sms.sms_get_state(id)

Function: Obtain corresponding SMS status

Parameter:

• id(number): Message id returned from function sms.send_sms_ira or sms.send_sms_ucs2

Return:

• Success: SMS status(1: Not sent, 2: Successfully sent, 3: Failed to send)
• Failure: nil

Example:

LuaSocket

It is the network programming module of Lua, and can be used for secondary development according to requirements.

It include the following contents: 

1. socket: Network basic module: basic parameter and baisic fuction
2. dns: DNS module
3. TCP: TCP protocol object
4. UDP: UDP protocol object
5. ftp: ftp protocal API: Used for file transfer. This module only supports FTP client API, and does not support server API.
6. http: http protocol API
7. https: https protocol API
8. smtp: smtp protocol API: Used for third-party email services
9. Other auxiliary modules: It is the extented function of module including ltn12 auxiliary module and mime auxiliary module.
10. Appendix: ftp parameter list

✎Note:

Modules

Socket module parameter

Socket basic function

dns module

✎Note:

• DNS resolution in HMI is not supported due to internal changes in HMI. Therefore, only offline simulation is supported.
• dns is a part of data socket basic module. To use the contents of this module, you need to quote the followings.

TCP module

This module is a part of socket. It is the object created by socket.tcp() 、socket.tcp4() 、socket.tcp6().

This module divides Tcp objects into three types of objects: masterTcp、clientTcp、serverTcp.

Different Tcp objects have corresponding methods.

• masterTcp: close
• clientTcp: send, receive, getsockname, getpeername, settimeout and close
• serverTcp: accept, getsockname, setoption, settimeout and close

UDP module

This module is a part of socket. It is the object created by socket.udp(), socket.udp4(), socket.udp6().

This module divides UDP objects into twotypes: connect and connected. The difference is whether remote ports and addresses are bound to the generated object. Please refer to the following table.

FTP module

• This is submodule of socket. To use the contents of this module, you need to quote the followings.

local ftp = require("socket.ftp")

For details about FTP commands, see "appendix".

http module

This is submodule of socket. To use the contents of this module, you need to quote the followings.

local http = require("socket.http")

https module

This is submodule of socket. To use the contents of this module, you need to quote the followings.

local https = require("socket.https")

SMTP module

This is submodule of socket. To use the contents of this module, you need to quote the followings.

local smtp = require("socket.smtp")

Auxiliary Module

LTN12 module

This is auxiliary Module of socket. To use the contents of this module, you need to quote the followings.

local LTN12 = require("socket.ltn12")

filter

sink (acceptor)

MIME module

This is auxiliary Module of socket. To use the contents of this module, you need to quote the followings.

local mime = require("socket.mime")

Socket basic function

socket.bind()

Prototype: socket.bind(address, port [, backlog])

Function: A shortcut function that encapsulates tcp's bind, accept, and listen calling processes. Creates and returns a TCP server object bound to a local address and port.

Parameters: 

• address — local address
• port — Port
• backlog — Specifies the number of client connections that can be queued for service. If the queue is full and another client tries to connect, the connection will be rejected. (This parameter is optional. The default value is 32)

Return: 

• Success: return tcp server object
• Failure: return nil and error

Example

socket.connect4()

Prototype: socket.connect4(address, port [, locaddr] [, locport] )

Function: This function is a shortcut that creates and returns a TCP client object connected to the remote (ipv4) address of a given port.

Parameters: 

• address(string) : Remote server address
• port(number) : Remote server port
• locaddr(string) : Local address
• locport(number) : Local port

Return: 

• Success: return tcp client object
• Failure: nil, error

Example

socket.connect6()

Prototype: socket.connect6(address, port [, locaddr] [, locport])

Function: This function is a shortcut that creates and returns a TCP client object connected to the remote (ipv6) address of a given port.

Parameters: 

• address(string) : Remote server address
• port(number) : Remote server port
• locaddr(string) : Local address
• locport(number) : Local port

Return: 

• Success: return tcp client object
• Failure: nil, error

Example

socket.gettime()

Prototype: socket.gettime()

Function: Get the system time in seconds, from January 1970.

Parameters: None

Return: 

• systemtime(number): system time: second

Example

socket.newtry()

Prototype: socket.newtry(finalizer)

Function: Creates and returns a try function that allows the exception to be cleaned up before it is thrown.

Parameters: 

• finalizer(function): Finalizer is a function that will be called before newtry throws an exception.

Return: