01 Lua Functions

1. [, 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.

62

1. **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.**

63

**Call example**

|(((

//print(student("foo", 18)) //~-~- foo, 18 years old, assigned to class 1 by default

68

69

//print(student("bar", 19, 2))// ~-~-bar, 19 years old, assigned to class 2

70

71

//print(student("bar", 18)) //~-~-bar, 18 years old, assigned to class 1 by default

72

73

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

86

87

//nil student bar registered//

)))

**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.

93

1. 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.

94

95

== **Modification of print function** ==

96

97

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.

98

99

1. **Interval limit: **When debugging, transfer once every 2~~3 seconds;

100

1. **Data limit: **The transfer data cannot be larger than 1.5KB in a single transmission, otherwise the extra part will be ignored;

101

1. **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;

102

103

Users should pay attention to avoid printing a lot of useless information, should minimize the debug output

104

105

In addition, please refer to the front-end documentation for how to use view debugging.

106

107

(((

108

= **2 Address operation** =

)))

|12（Default）|0|1234（Default）|0|(((

12345678(Default)

)))|(((

0

)))

|21|6|(((

3412(High and low word conversion)

119

)))|2|(((

120

34127856 (High and low word conversion)

)))|2

| | |2143|3|(((

21436587

)))|3

| | |4321|6|(((

87654321

)))|6

| | | | |(((

78563412

)))|7

| | | | |(((

56781234

)))|8

| | | | |(((

65872143

)))|9

| | | | |(((

43218765

)))|10

Table 2-1

(% class="box infomessage" %)

144

(((

145

**✎Note: **If HLword enters any other value, it will be treated as invalid.

146

)))

147

148

== **addr_getshort(string addr[, number type, number hlword])** ==

149

150

**Function:** Read 16-bit signed decimal address

**Parameters:**

//addr//: address

//num//: value

[type = 0] not read through 1: read through

159

160

[hlword = 0] Don't convert，See Form 2.1

**Return：**

Succeed: Single word signed decimal value

Failed: multi

(((

== **addr_setshort(string addr, number num[, number type, number hlword])** ==

170

)))

171

172

**Function:** Write 16-bit signed decimal address

**Parameters:**

//addr//: address

//num//: value

[type = 0]not read through 1: read through

181

182

[hlword = 0] Don't convert，See Form 2.1

**Return：**

Succeed: true

Failed: multi

(((

== **addr_getword(string addr[, number type, number hlword])** ==

192

)))

193

194

**Function:** Read 16-bit unsigned decimal address

**Parameters:**

//addr//: address

[type = 0]not read through 1: read through

201

202

[hlword = 0] Don't convert，See Form 2.1

**Return：**

Succeed: Single word unsigned decimal value

Failed: multi

(((

== **addr_setword(string addr, number num[, number type, number hlword])** ==

212

)))

213

214

**Function:**Write 16-bit unsigned decimal address

**Parameters:**

//addr//: address

//num//: value

[type = 0]not read through 1: read through

223

224

[hlword = 0] Don't convert，See Form 2.1

**Return：**

Succeed: true

Failed: multi

(((

== **addr_getint(string addr[, number type, number hlword])** ==

234

)))

235

236

**Function:** Read 32-bit signed decimal address

**Parameters:**

//addr//: address

[type = 0]not read through 1: read through

243

244

[hlword = 0] Don't convert，See Form 2.1

**Return：**

Succeed: Double word signed decimal value

Failed: multi

(((

== **addr_setint(string addr, number num[, number type, number hlword])** ==

254

)))

255

256

**Function:** Write 32-bit signed decimal address

**Parameters:**

//addr//: address

//num//: value

[type = 0]not read through 1: read through

265

266

[hlword = 0] Don't convert，See Form 2.1

**Return：**

Succeed: true

Failed: multi

(((

== **addr_getdword(string addr[, number type, number hlword])** ==

276

)))

277

278

**Function:** Read 32-bit unsigned decimal address

**Parameters:**

//addr//: address

[type = 0]not read through 1: read through

285

286

[hlword = 0] Don't convert，See Form 2.1

**Return：**

Succeed: Double word unsigned decimal value

Failed: multi

(((

== **addr_setdword(string addr, number num[, number type, number hlword])** ==

296

)))

297

298

**Function:** Write 32-bit unsigned decimal address

**Parameters:**

//addr//: address

//num//: value

[type = 0]not read through 1: read through

307

308

[hlword = 0] Don't convert，See Form 2.1

**Return：**

Succeed: true

Failed: multi

(((

== **addr_getbit(string addr[, number type])** ==

318

)))

319

320

**Function:** Read a bit of the register address

**Parameters:**

//addr//: address

[type = 0]not read through 1: read through

327

328

[hlword = 0] Don't convert，See Form 2.1

**Return：**

Succeed: Bit address value

Failed: multi

(((

== **addr_setbit(string addr, number num[, number type])** ==

338

)))

339

340

**Function:** Write a bit of the register address

**Parameters:**

//addr//: address

//num//: value

[type = 0]not read through 1: read through

349

350

[hlword = 0] Don't convert，See Form 2.1

**Return：**

Succeed: true

Failed: multi

(((

== **addr_getfloat(string addr[, number type, number hlword])** ==

360

)))

361

362

**Function:** Read 32-bit floating address

**Parameters:**

//addr//: address

[type = 0]not read through 1: read through

369

370

[hlword = 0] Don't convert，See Form 2.1

**Return：**

Succeed: 32-bit floating point value

Failed: multi

(((

== **addr_setfloat(string addr, number num[, number type, number hlword])** ==

380

)))

381

382

**Function:** Write 32-bit floating address

**Parameters:**

//addr//: address

//num//: value

[type = 0]not read through 1: read through

391

392

[hlword = 0] Don't convert，See Form 2.1

**Return：**

Succeed: true

Failed: multi

(((

== **addr_getdouble(string addr[, number type, number hlword])** ==

402

)))

403

404

**Function:** Read 64-bit floating address

**Parameters:**

//addr//: address

[type = 0]not read through 1: read through

411

412

[hlword = 0] Don't convert，See Form 2.1

**Return：**

Succeed: 64-bit floating point value

Failed: multi

(((

== **addr_setdouble(string addr, number num[, number type, number hlword])** ==

422

)))

423

424

**Function:** Write 64-bit floating address

**Parameters:**

addr: address

num: value

[type = 0]not read through //1//: read through

433

434

[hlword = 0] Don't convert，See Form 2.1

**Return：**

Succeed: true

Failed: multi

(((

== **addr_getstring(string addr, number length[, number type, number hlbyte])** ==

444

)))

445

446

**Function:** Read the specified length string from address

**Parameters:**

//addr//: address

//length//: length

[type = 0]not read through 1: read through

455

456

[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

(((

== **addr_setstring(string addr, string str[, number type, number hlbyte])** ==

466

)))

467

468

**Function:** Write the specified length string to address

**Parameters:**

//addr//: address

//str//: string

[type = 0]not read through 1: read through

477

478

[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

(((

== **addr_bmov(string dst, string src, number length)** ==

488

)))

489

490

**Function:** Copy data from source address to destination address

**Parameters:**

//dst//: destination address

495

496

//src//: source address

//length//: length

**Return：**

Succeed: true

**Failed: multi**

(((

== **addr_fill(string addr, number num, number length)** ==

508

)))

509

510

**Function:** Write the same value to consecutive addresses

**Parameters:**

//addr//: address

//num//: value

//length//:continuous length

**Return：**

Succeed: true

Failed: multi

(((

== **addr_newnoaddr(string addr, number offset)** ==

528

)))

529

530

**Function:** Offset address value relative to //addr//

**Parameters:**

//addr//: address

//offset//: offset value

**Return：**

Succeed: New address after offset

Failed: multi

(((

== **addr_newstataddr(string addr, number offset)** ==

546

)))

547

548

**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])** ==

563

564

**Function:** Read 64-bit hexadecimal numbers

**Parameters:**

//addr//: address

[type = 0]not read through 1: read through

571

572

[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])** ==

581

582

**Function:** Write 64-bit hexadecimal addresses

**Parameters:**

//addr//: address

[type = 0]not write through 1: write through

589

590

[hlword = 0] Don't convert，See Form 2.1

**Return：**

Succeed: true

Failed: multi

(((

= **3 Serial port operation** =

600

)))

601

602

Operations on the serial port such as read, write, etc. must use ':' for full mode calls, ie operations on an open serial object.

603

604

**Serial port name and mode**

605

606

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.

607

608

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

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.

629

1. When the data bit is 8, the maximum value of data transmission is 255 (0xFF), which supports the transmission of any character.

630

631

(((

632

== **serial.open(table setup)** ==

633

)))

634

635

**Function:** Enable one serial port

**Parameters:**

//Setup// is a Lua table; it needs to contain the following fields

640

641

//String setup.name//,// //serial port name, such as: COM1/COM2 (requires uppercase)

642

643

//number setup.mode//, mode: RS232/RS485/RS422

644

645

//number setup.baud_rate//, such as 115200

646

647

//number setup.stop_bit//, stop bit: 1 or 2

648

649

//number setup.data_len//, data bit: 7 or 8

650

651

//string setup.check_bit//, check bit: NONE/ODD/EVEN/SPACE

652

653

//number [setup.wait_timeout=300]//, waiting timeout

654

655

//number [setup.recv_timeout=50]//, receive wait timeout

656

657

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

(((

== **serial.close(serial obj)** ==

671

)))

672

673

**Function:** Disable the serial port

674

675

**Parameters: **//Obj //is the object returned by serial.open

**Return：**

Succeed: true

Failed: multi

(((

== **serial:read(number bytes[, number timeout])** ==

685

)))

686

687

**Function:** Read the specified byte length serial port data

**Parameters:**

//bytes//: number of bytes

692

693

//[timeout=50]//: timeout for reading, in milliseconds

**Return：**

Succeed: true

Failed: multi

(((

== **serial:write(string data)** ==

703

)))

704

705

**Function:** Write the specified byte length to serial port data

**Parameters: **

//data//: serial port data

**Return：**

Succeed: true

Failed: multi

(((

== **serial:flush([number flag])** ==

719

)))

720

721

**Function:** Clear the serial port buffer

**Parameters:**

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

**Return：**

Succeed: true

Failed: multi

(((

== **serial:close()** ==

735

)))

736

737

**Function:** Close the serial port object

**Parameters:** None

**Return：**

Succeed: true

Failed: multi

(((

= **4 MQTT operation** =

749

)))

750

751

Operations on MQTT such as connect, subscribe, etc. must use ':' for full mode calls, that is, operate on a created MQTT object.

752

753

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.

758

* 1: The message is delivered at least once, but the message may be delivered repeatedly.

759

* 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

(((

== **mqtt.create(string serverurl, string clientid)** ==

769

)))

770

771

**Function:** Create an MQTT object

**Parameters:**

//serverurl //Server url

776

777

Format: "//protocol:~/~/host:port//"

778

779

//protocol//: tcp/ssl

780

781

//host//: Host name/IP

782

783

//port//: such as 1883

784

785

//clientid//: Client ID

**Return：**

Succeed: MQTT object

Failed: multi

(((

== **mqtt.close(mqtt obj)** ==

795

)))

796

797

**Function:** Close the specified MQTT object (if the connected server will be disconnected automatically)

798

799

**Parameters: **//Obj //is the objeced returned by mqtt.create

**Return：**

Succeed: true

Failed: multi

(((

== **mqtt:connect(table conn[, table lwt, table cart])** ==

809

)))

810

811

**Function:**Establish a connection to the server

**Parameters:**

//conn //is a Lua table and needs to contain the following fields

816

817

* //string conn.username//, user name

818

* //string conn.password//, password

819

* //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

825

* //number [conn.cleansession=1]//, empty the session as described below:

826

827

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:

828

829

* 1 (Empty): If a session exists and is 1, the previous session messages on the client and server are emptied.

830

* 0 (reserved): Conversely, both the client and the server use the previous session. If the previous session does not exist, start a new session.

831

832

//lwt// (Last Will and Testament) is a Lua table and needs to contain the following fields

833

834

* //string lwt.topic//, topic

835

* //string lwt.message//, message

836

* //number [lwt.qos=0]//, qos value

837

* //number [lwt.retain=0]//, retain flag

**Return：**

Succeed: true

Failed: multi

(((

== **mqtt:disconnect([number timeout])** ==

847

)))

848

849

**Function:** Disconnect from the MQTT server

850

851

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

**Return：**

Succeed: true

Failed: multi

(((

== **mqtt:isconnected()** ==

861

)))

862

863

**Function:** Test whether or not a client is currently connected to the MQTT server

**Parameters:** None

**Return：**

Succeed: true ~-~-Connected

870

871

Failed: false ~-~- Unconnected and other unknowns

872

873

(((

874

== **mqtt:subscribe(string topic, number qos)** ==

875

)))

876

877

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

882

883

//qos//, quality of service

**Return：**

Succeed: true

Failed: multi

(((

== **mqtt:unsubscribe(string topic)** ==

893

)))

894

895

**Function:** Unsubscribe topic

**Parameters:**

//topic//, topic name

**Return：**

Succeed: true

Failed: multi

(((

== **mqtt:publish(string topic, string message, number qos, number retain[, number timeout])** ==

909

)))

910

911

**Function:** Publish message

**Parameters:**

//topic//, topic name

//message//, message

//qos//, quality of service

920

921

//retain//, retain flag

922

923

//[timeout=1000]//, waiting for response timeout, in milliseconds (only valid when qos is greater than 0)

**Return：**

Succeed: true

Failed: multi

(((

== **mqtt:close()** ==

933

)))

934

935

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

**Parameters:** None

**Return：**

Succeed: true

Failed: multi

(((

== **mqtt:on(string method, function callback)** ==

947

)))

948

949

**Function:** Register event callback function

**Parameters:**

//method//, It can be message/arrived/offline, these 3 types of events

954

955

//callback//, It is a callback function that needs to pass in a function

956

957

**1.**"message" will call this function after receiving the message

958

959

//Callback// prototype~:// function (string topic, string message)//

Parameter:

* //Topic//, topic name

964

* //Message//, content

965

966

**2."arrived" is published by publish, this function will be called after the publication arrives**

967

968

//Callback// prototype~:// function ()//

Parameter: None

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

973

974

//Callback// prototype~:// function (string cause)//

Parameter:

//cause//, reason for loss of connection

**Return：**

Succeed: true

Failed: multi

(((

== **mqtt:setup_cfg()** ==

988

)))

989

990

**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)

997

998

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

999

1000

//LWT// Last Words configuration is not yet open for setting, //lw//t is fixed to nil

1001

1002

If ssl is not enabled, //cart// is nil, otherwise //cart// is table

1003

1004

(((

1005

= **5 JSON operation** =

1006

)))

1007

1008

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

1009

1010

(((

1011

== **json.encode( lua_object )** ==

1012

)))

1013

1014

**Function: **Convert lua data type to json string

1015

1016

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

1017

1018

**Return：** Json format string

1019

1020

(((

1021

== **json.decode(string json_string)** ==

1022

)))

1023

1024

**Function:** Convert json string to lua data type

1025

1026

**Parameters: **//json_string//, string of json data structure

1027

1028

**Return: **Lua data type

(((

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

1045

1046

(((

1047

== **bns_get_alldata()** ==

1048

)))

1049

1050

**Function:** Obtain all monitoring points (point table) data configured by the end user

1051

1052

**✎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

1059

1060

Each item is a monitoring point, which contains 5 attributes:

1061

1062

(1 ID, 2 status, 3 tag name, 4 value, 5 custom)

1063

1064

The status contains 3 enumerated values (0: offline, 1: online, 2: timeout)

1065

1066

If there is no custom configuration, return an empty table, otherwise, return with "field name/field content"

**For example:**

{

[1]= {[1]=1234, [2]=1, [3]='temp', [4]='23.5', [5]={"fruit"="apple"}},

1074

1075

[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

(((

== **bns_get_config(string from)** ==

1088

)))

1089

1090

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

1095

1096

'user': terminal parameters, that is, custom parameters configured by the user

1097

1098

'bind': binding parameters, which are custom parameters that need to be input

1099

1100

when the user binds V-BOX

**Return:**

Succeed: table field name/field content table in organization form

1105

1106

Failed~:// table// empty table

1107

1108

(((

1109

== **bns_get_data(string name, string data)** ==

1110

)))

1111

1112

**Function:**write data to the name of the monitoring point

**parameter:**

//name //The name of the monitoring point

1117

1118

//data// the data to be written

**Return:**

Succede: //string // value before the monitoring point is written

Failed: nil

(((

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

(((

== **bns_get_datadesc()** ==

1146

)))

1147

1148

**Function: **Obtain all configured communication ports and monitoring point information

**Parameters:** None

**Return:**

Succeed: table three-dimensional array, the structure is as follows

1155

1156

Each item is a communication port, which contains 3 attributes (1 monitoring point array, 2 ID, 3 name)

1157

1158

The monitoring point array contains 4 attributes (1 ID, 2 name, 3 read and write attributes, 4 types)

1159

1160

Read and write attributes (1: read only, 2: write only, 3: read and write)

1161

1162

Type (1: switch, 2: number, 3: string)

**For example:**

{

[1]={--The first communication port

1170

1171

[1]={--monitoring point array of the first communication port

1172

1173

[1]={[1]=11,[2]='data1',[3]=3,[4]=2},

1174

1175

[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

1190

1191

[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

1205

1206

(((

1207

== **bns_get_machineinfo()** ==

1208

)))

1209

1210

**Function:** get machine information

**Parameters:** None

**Return:**

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

Failed: nil

(((

== **bns_get_groupdata(string name)** ==

1222

)))

1223

1224

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

1233

1234

Failed: //table// empty table

1235

1236

(((

1237

== **bns_get_groupdesc()** ==

1238

)))

1239

1240

**Function:** Get all group information

**Parameters:** None

**Return:**

Succeed: //table// two-dimensional array, the structure is as follows

1247

1248

Each item represents a group, which contains 3 attributes (1 collection type, 2 name, 3 cycles)

1249

1250

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)

1251

1252

Some collection types do not have a period, the period is -1

1253

1254

Failed: //table // empty table

1255

1256

(((

1257

== **bns_get_onecache(string msg)** ==

1258

)))

1259

1260

**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.

1261

1262

**Parameters: **//msg// String

**Return:**

Succeed: true

Failed: nil

(((

== **bns_get_allcache()** ==

1272

)))

1273

1274

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

**Parameters:** None

**Return:**

Succeed: //table// one-dimensional array

**For example:**

{

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

1288

1289

[2]="This is a test",

...

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

}

Failede: nil

(((

= **7 HTTP operation** =

1302

)))

1303

1304

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

1305

1306

(((

1307

== **http request** ==

1308

)))

1309

1310

[[http:~~/~~/w3.impa.br/~~~~diego/software/luasocket/http.html#request>>url:http://w3.impa.br/~~diego/software/luasocket/http.html#request]]

1311

1312

== **https request** ==

**For example:**

local json = require("json")

1318

1319

local https = require("https")

1320

1321

functions https_demo.main()

1322

1323

local url = "https://XXXXXXXXXXXXXXXXXXXXXXXXXX"

local body = {}

body["XXXXXX"] = "XXXXX"

1328

1329

body["XXXXXXX"] = "XXXXXXXXXXX"

1330

1331

local bodyJson = json.encode(body)

local header = {}

header["content-type"] = "application/json"

1336

1337

local result_table, code, headers, status = https.request(url,

bodyJson)

if code == 200 then

print("https suc")

return true

else

print("https fail")

return nil

end

end

(((

= **8 Internal register** =

1360

)))

1361

1362

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

1363

1364

**Access by word, prefix @W_HDW.**

1365

1366

For example: @W_HDW0 represents the first word of the system data area, @W_HDW1 represents the second word of the system data area.

1367

1368

**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.**

1369

1370

**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.

1371

1372

(% class="box infomessage" %)

(((

**✎Note: **

* The address in @B_HDX is taken from the word in @W_HDW, so pay special attention when using the address.

1377

** 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.

1378

* The address of the bit address @B_HDX has a decimal point, while the word address is an integer.

)))

(((

== **Data storage area（HDW/HDX）** ==

1384

)))

1385

1386

The system storage area (HDW) of the V-BOX is used to store temporary data:

1387

1388

1. Access by word, the number range is: "@W_HDW0"-"@W_HDW299999".

1389

1. Access in bit mode, the number range is: "@B_HDX0.0"-"@B_HDX299999.15".

1390

1391

(((

1392

== **Special data area (HSW/HSX)** ==

1393

1394

(% class="box infomessage" %)

(((

**✎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).

1399

* //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.

)))

)))

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:

1404

1405

(% class="table-bordered" %)

1406

|=(% style="width: 151px;" %)address|=(% style="width: 169px;" %)function|=(% style="width: 456px;" %)Read and write status: read only, write only, read and write

1407

|(% style="width:151px" %)@W_HSW0|(% style="width:169px" %)restart|(% style="width:456px" %)read and write

1408

|(% style="width:151px" %)@W_HSW1|(% style="width:169px" %)Box time: year|(% style="width:456px" %)read and write

1409

|(% style="width:151px" %)@W_HSW2|(% style="width:169px" %)Box time: month|(% style="width:456px" %)read and write

1410

|(% style="width:151px" %)@W_HSW3|(% style="width:169px" %)Box time: day|(% style="width:456px" %)read and write

1411

|(% style="width:151px" %)@W_HSW4|(% style="width:169px" %)Box time: hour|(% style="width:456px" %)read and write

1412

|(% style="width:151px" %)@W_HSW5|(% style="width:169px" %)Box time: minute|(% style="width:456px" %)read and write

1413

|(% style="width:151px" %)@W_HSW6|(% style="width:169px" %)Box time: second|(% style="width:456px" %)read and write

1414

|(% style="width:151px" %)@W_HSW7|(% style="width:169px" %)Box time: week|(% style="width:456px" %)read and write

1415

|(% style="width:151px" %)@W_HSW8|(% style="width:169px" %)Ethernet IP1|(% style="width:456px" %)read only

1416

|(% style="width:151px" %)@W_HSW9|(% style="width:169px" %)Ethernet IP2|(% style="width:456px" %)read only

1417

|(% style="width:151px" %)@W_HSW10|(% style="width:169px" %)Ethernet IP3|(% style="width:456px" %)read only

1418

|(% style="width:151px" %)@W_HSW11|(% style="width:169px" %)Ethernet IP4|(% style="width:456px" %)read only

1419

|(% style="width:151px" %)@W_HSW12|(% style="width:169px" %)Ethernet Mask 1|(% style="width:456px" %)read only

1420

|(% style="width:151px" %)@W_HSW13|(% style="width:169px" %)Ethernet Mask 2|(% style="width:456px" %)read only

1421

|(% style="width:151px" %)@W_HSW14|(% style="width:169px" %)Ethernet Mask 3|(% style="width:456px" %)read only

1422

|(% style="width:151px" %)@W_HSW15|(% style="width:169px" %)Ethernet Mask 4|(% style="width:456px" %)read only

1423

|(% style="width:151px" %)@W_HSW16|(% style="width:169px" %)Ethernet Gateway 1|(% style="width:456px" %)read only

1424

|(% style="width:151px" %)@W_HSW17|(% style="width:169px" %)Ethernet Gateway 2|(% style="width:456px" %)read only

1425

|(% style="width:151px" %)@W_HSW18|(% style="width:169px" %)Ethernet Gateway 3|(% style="width:456px" %)read only

1426

|(% style="width:151px" %)@W_HSW19|(% style="width:169px" %)Ethernet Gateway 4|(% style="width:456px" %)read only

1427

|(% style="width:151px" %)@W_HSW21|(% style="width:169px" %)Ethernet MAC1|(% style="width:456px" %)read only

1428

|(% style="width:151px" %)@W_HSW22|(% style="width:169px" %)Ethernet MAC2|(% style="width:456px" %)read only

1429

|(% style="width:151px" %)@W_HSW23|(% style="width:169px" %)Ethernet MAC3|(% style="width:456px" %)read only

1430

|(% style="width:151px" %)@W_HSW24|(% style="width:169px" %)Ethernet MAC4|(% style="width:456px" %)read only

1431

|(% style="width:151px" %)@W_HSW25|(% style="width:169px" %)Ethernet MAC3|(% style="width:456px" %)read only

1432

|(% style="width:151px" %)@W_HSW26|(% style="width:169px" %)Ethernet MAC4|(% style="width:456px" %)read only

1433

|(% style="width:151px" %)@W_HSW128|(% style="width:169px" %)WIFI IP1|(% style="width:456px" %)read only

1434

|(% style="width:151px" %)@W_HSW129|(% style="width:169px" %)WIFI IP2|(% style="width:456px" %)read only

1435

|(% style="width:151px" %)@W_HSW130|(% style="width:169px" %)WIFI IP3|(% style="width:456px" %)read only

1436

|(% style="width:151px" %)@W_HSW131|(% style="width:169px" %)WIFI IP4|(% style="width:456px" %)read only

1437

|(% style="width:151px" %)@W_HSW132|(% style="width:169px" %)WIFI Mask 1|(% style="width:456px" %)read only

1438

|(% style="width:151px" %)@W_HSW133|(% style="width:169px" %)WIFI Mask 2|(% style="width:456px" %)read only

1439

|(% style="width:151px" %)@W_HSW134|(% style="width:169px" %)WIFI Mask 3|(% style="width:456px" %)read only

1440

|(% style="width:151px" %)@W_HSW135|(% style="width:169px" %)WIFI Mask 4|(% style="width:456px" %)read only

1441

|(% style="width:151px" %)@W_HSW136|(% style="width:169px" %)WIFI Gateway 1|(% style="width:456px" %)read only

1442

|(% style="width:151px" %)@W_HSW137|(% style="width:169px" %)WIFI Gateway 2|(% style="width:456px" %)read only

1443

|(% style="width:151px" %)@W_HSW138|(% style="width:169px" %)WIFI Gateway 3|(% style="width:456px" %)read only

1444

|(% style="width:151px" %)@W_HSW139|(% style="width:169px" %)WIFI Gateway 4|(% style="width:456px" %)read only

1445

|(% style="width:151px" %)@W_HSW140|(% style="width:169px" %)WIFI MAC1|(% style="width:456px" %)read only

1446

|(% style="width:151px" %)@W_HSW141|(% style="width:169px" %)WIFI MAC2|(% style="width:456px" %)read only

1447

|(% style="width:151px" %)@W_HSW142|(% style="width:169px" %)WIFI MAC3|(% style="width:456px" %)read only

1448

|(% style="width:151px" %)@W_HSW143|(% style="width:169px" %)WIFI MAC4|(% style="width:456px" %)read only

1449

|(% style="width:151px" %)@W_HSW144|(% style="width:169px" %)WIFI MAC5|(% style="width:456px" %)read only

1450

|(% style="width:151px" %)@W_HSW145|(% style="width:169px" %)WIFI MAC6|(% style="width:456px" %)read only

1451

|(% style="width:151px" %)@W_HSW146|(% style="width:169px" %)WIFI Signal value|(% style="width:456px" %)read only

1452

|(% style="width:151px" %)@W_HSW148|(% style="width:169px" %)4G IP1|(% style="width:456px" %)read only

1453

|(% style="width:151px" %)@W_HSW149|(% style="width:169px" %)4G IP2|(% style="width:456px" %)read only

1454

|(% style="width:151px" %)@W_HSW150|(% style="width:169px" %)4G IP3|(% style="width:456px" %)read only

1455

|(% style="width:151px" %)@W_HSW151|(% style="width:169px" %)4G IP4|(% style="width:456px" %)read only

1456

|(% style="width:151px" %)@W_HSW152|(% style="width:169px" %)4G Mask 1|(% style="width:456px" %)read only

1457

|(% style="width:151px" %)@W_HSW153|(% style="width:169px" %)4G Mask 2|(% style="width:456px" %)read only

1458

|(% style="width:151px" %)@W_HSW154|(% style="width:169px" %)4G Mask 3|(% style="width:456px" %)read only

1459

|(% style="width:151px" %)@W_HSW155|(% style="width:169px" %)4G Mask 4|(% style="width:456px" %)read only

1460

|(% style="width:151px" %)@W_HSW156|(% style="width:169px" %)4G Gateway 1|(% style="width:456px" %)read only

1461

|(% style="width:151px" %)@W_HSW157|(% style="width:169px" %)4G Gateway 2|(% style="width:456px" %)read only

1462

|(% style="width:151px" %)@W_HSW158|(% style="width:169px" %)4G Gateway 3|(% style="width:456px" %)read only

1463

|(% style="width:151px" %)@W_HSW159|(% style="width:169px" %)4G Gateway 4|(% style="width:456px" %)read only

1464

|(% style="width:151px" %)@W_HSW160|(% style="width:169px" %)4G MAC1|(% style="width:456px" %)read only

1465

|(% style="width:151px" %)@W_HSW161|(% style="width:169px" %)4G MAC2|(% style="width:456px" %)read only

1466

|(% style="width:151px" %)@W_HSW162|(% style="width:169px" %)4G MAC3|(% style="width:456px" %)read only

1467

|(% style="width:151px" %)@W_HSW163|(% style="width:169px" %)4G MAC4|(% style="width:456px" %)read only

1468

|(% style="width:151px" %)@W_HSW164|(% style="width:169px" %)4G MAC5|(% style="width:456px" %)read only

1469

|(% style="width:151px" %)@W_HSW165|(% style="width:169px" %)4G MAC6|(% style="width:456px" %)read only

1470

|(% style="width:151px" %)@W_HSW166|(% style="width:169px" %)4G Signal value|(% style="width:456px" %)read only

**Others**

* Access password: addr_getstring("@W_HSW27", 16)

1475

* Machine code: addr_getstring("@W_HSW60", 64)

1476

* Positioning method (@W_HSW167): (read only)

1477

** Latitude and longitude

1478

*** Longitude: addr_getdouble("@W_HSW168") (read only)

1479

*** Latitude: addr_getdouble("@W_HSW172") (read only)

1480

** Base station positioning

1481

*** LAC: addr_getdword("@W_HSW168") (read only)

1482

*** CI: addr_getdword("@W_HSW172") (read only)

1483

* Convert base station to latitude and longitude via API

1484

** Longitude: addr_getdouble("@W_HSW187") (read only)

1485

** Latitude: addr_getdouble("@W_HSW183") (read only)

1486

* Operator information: addr_getdword("@W_HSW181") (read only)

1487

* Networking mode: addr_getword("@W_HSW177") (read only)

** 0: Ethernet

** 1: WIFI

** 2: 4G

** 3: 2G

* Map fence flag: addr_getword("@W_HSW178") (read only)

1493

** 0: No map fence is drawn

1494

** 1: Draw a map fence and the box is in the fence

1495

** 2: Draw a map fence and the box is not in the fence

1496

* SIM card status addr_getword("@W_HSW179") (read only)

1497

** 1: No card detected

1498

** 2: Card insertion detected

1499

** 3: The card status is abnormal

1500

* MQTT status addr_getword("@W_HSW180") (read only)

1501

** 1: online, 2: offline

1502

* IO interface, X is read only, Y is read and write (H series)

1503

** addr_getbit(addr1), addr_setbit(addr2)

1504

** addr1:"@B_Y0" "@B_Y1" "@B_X0" "@B_X1"

1505

** addr2:"@B_Y0" "@B_Y1"

1506

* Obtaining IMEI (read only)

1507

** addr_getstring("@W_HSW191",17)

1508

* Obtaining ICCID (read only)

1509

** addr_getstring("@W_HSW225",15)

1510

* (((

1511

TSAP settings of Siemens LOGO PLC*

1512

1513

(((

1514

addr_setword("@W_0#HSW1200",8192) means set the Local TSAP as 20.00

)))

* (((

addr_setword("@W_0#HSW1201",4096) means set the Remote TSAP as 10.00

)))

)))

(((

== **Power-down storage area (HAW/HAX)** ==

1524

1525

The system storage area (HAW) is used for the system power-down hold registers:

1526

1527

1. Accessed as a word, numbered in the range: "@W_HAW0"-"@W_HAW199999".

1528

1. Accessed by bit, the numbering range is: "@B_HAX0.0"-"@B_HAX199999.15".

1529

1530

(% class="box infomessage" %)

1531

(((

1532

**✎Note:** HAW/HAX is a power-down hold, that is, the registers of this type can retain the data before power-down in case of power-down.

1533

)))

1534

1535

= **9 General Functions** =

)))

(((

== **send_sms_ira(string number, string message)** ==

1540

)))

1541

1542

**Function:** Use IRA character set to send English text messages

**Parameters:**

//number: //number (up to 32 characters, the excess will be discarded)

1547

1548

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

(((

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

1567

1568

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

(((

== **sms_get_state(number id)** ==

1578

)))

1579

1580

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

(((

== **jwt_encode(table head, table payload, string aud, number iat, number exp, string key, int jwttype)** ==

1594

)))

1595

1596

**Function:** Convert data to JWT format

**parameter:**

//aud: //project name

1601

1602

//iat: //The valid period start timestamp of the JWT data format

1603

1604

//exp~:// the expiration time stamp of the JWT data format

1605

1606

//head~:// head information table

1607

1608

key: key in JSON format

1609

1610

value: value in JSON format

1611

1612

type:value type, 0:string,1:integer,2:number,3:boolean

{

{key="test1",value="test1",type="0"}

}

payload: payload information table

1621

1622

The format is consistent with the header information table

{

{key="test",value="test",type="0"}

}

//jwttype: //encryption type

1631

1632

0:RS256 1:RS384 2:RS512

1633

1634

3: PS256 4: PS384 5: PS512

1635

1636

6:HS256 7:HS384 8:HS512

1637

1638

9:ES256 10:ES384 11:ES512

1639

1640

//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"},

1652

1653

{key="test",value="123122131",type="1"}}

1654

1655

local head = {{ key="name",value="data",type="0"},

1656

1657

{key="test2",value="test2",type="0"}}

1658

1659

local aud = "project"

1660

1661

local iat = 123122131

1662

1663

local exp1 = 123122331

1664

1665

local en = jwt_encode(head,payload,aud,iat,exp1,PRIVATE_KEY,JWTType);

print(en)

End

(((

== **convertohex(number type, number value)** ==

1674

)))

1675

1676

**Function:** Convert data into hexadecimal data

**parameter:**

//type~:// incoming data type 0:word 1:dword 2:float

1681

1682

//value~:// the data to be converted

**Return:**

Succeed: the converted hexadecimal data

Failed: multi

== **crc.init(table prarm)** ==

1691

1692

**Function:** Initialize the CRC

**Parameters:**

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

1697

1698

* 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.

1699

* number prarm.width: the width, i.e. the number of CRC bits.

1700

* 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.

1701

* number [prarm.init]: the initialization preset value of the register (crc) at the beginning of the algorithm in hexadecimal.

1702

* number [prarm.xorout]: the final CRC value obtained after heterodyning the calculation result with this parameter.

1703

* number [prarm.refin]: whether each byte of the data to be measured is inverted by bit, true or false.

1704

* 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

(((

|crc8|0x07|0x00|0x00|false|false

1715

|crc8_cdma2000|0x9B|0xFF|0x00|false|false

1716

|crc8_darc|0x39|0x00|0x00|true|true

1717

|crc8_dvb_s2|0xD5|0x00|0x00|false|false

1718

|crc8_ebu|0x1D|0xFF|0x00|true|true

1719

|crc8_i_code|0x1D|0xFD|0x00|false|false

1720

|crc8_itu|0x07|0x00|0x55|false|false

1721

|crc8_maxim|0x31|0x00|0x00|true|true

1722

|crc8_rohc|0x07|0xFF|0x00|true|true

1723

|crc8_wcdma|0x9B|0x00|0x00|true|true

1724

|crc8_sae_j1850|0x1D|0xFF|0xFF|false|false

1725

|crc8_opensafety|0x2F|0x00|0x00|false|false

1726

|crc16_tms37157|0x1021|0x3791|0x0000|true|true

1727

|crc16_a|0x1021|0x6363|0x0000|true|true

1728

|crc16_riello|0x1021|0x554D|0x0000|true|true

1729

1730

|crc16_arc|0x8005|0x0000|0x0000|true|true

1731

|crc16_arc_ccitt|0x1021|0x1D0F|0x0000|false|false

1732

|crc16_buypass|0x8005|0x0000|0x0000|false|false

1733

1734

|crc16_dds110|0x8005|0x800D|0x0000|false|false

1735

|crc16_dect_r|0x0589|0x0000|0x0001|false|false

1736

|crc16_dect_x|0x0589|0x0000|0x0000|false|false

|crc16_t10_dif|0x8BB7|0x0000|0x0000|false|false

1743

|crc16_teledisk|0xA097|0x0000|0x0000|false|false

1744

1745

|crc16_kermit|0x1021|0x0000|0x0000|true|true

1746

1747

(% class="wikigeneratedid" %)

1748

Table 9-1

1749

1750

== **crc:calc(string crcValue)** ==

1751

1752

**Function:** Calculate CRC result

**Parameter:**

crcValue: the value to be calculated

**Return:**

Succeed: calculated result

1761

1762

Failed: multi, error code

)))

**For example:**

function crcTest.main()

local param = {

name = '',

width = 64,

poly = 0x42F0E1EBA9EA3693,

1777

1778

init = 0xFFFFFFFFFFFFFFFF,

1779

1780

xorout = 0xFFFFFFFFFFFFFFFF,

refin = 1,

refout = 1

}

crc64,err = crc.init(param)

if not crc64 then

print("Crc init failed:", err)

1793

else

1794

1795

crcvalue = crc64:calc("123456789")

1796

1797

print(string.format("crc64 calc :0X%16X", crcvalue))

end

end

= **10 Special function for V-NET** =

1805

1806

== **normal_get_alldata()** ==

1807

1808

**Function: **Obtain the data of all the monitoring points

**Parameter: None**

**Return:**

Succeed: table two-dimensional arrays, as follows:

1815

1816

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

{

[1]= {[1]=1234, [2]=1, [3]='temp', [4]='23.5'},

1833

1834

[2]= {[1]=1235, [2]=1, [3]='humi', [4]='67'},

...

[n]= {[1]=xxxx, [2]=x, [3]='xxxx', [4]='xx.x'},

}

Failed: table, empty table

1843

1844

1845

== **normal_setdata_byname(string name, string data)** ==

1846

1847

**Function:** Write data to the monitoring point name

**Parameter:**

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

1862

1863

**Function:** Read the data of the monitoring point name

**Parameter:**

**Return:**

Succeed: string

Failed: nil

= (% style="font-size:14px" %) (%%) =

1876

1877

= **12 Message summary algorithm** =

1878

1879

== **hmac(string hash_func, string key, string message)** ==

1880

1881

**Function:** HMAC calculate

**Function name**

hash_func:

* [md5, sha1, sha224, sha256, sha384, sha512]

1888

* [sha512_224, sha512_256, sha3_224, sha3_256]

1889

* [sha3_384, sha3_512]

**Parameter:**

key: the key

message: message content

**Return:**

Succeed: string, calculation result

Failed: nil

**For example:**

local sha = require"sha2"

1907

1908

function hmac_test.main()

1909

1910

local hmac = sha.hmac

print(hmac(sha.sha1,

"your key", "your message"))

end

== **sha(string message** ==

1920

1921

**Function:** SHA calculate

**Function name:**

sha:

* sha1, sha224, sha256, sha384, sha512]

1928

* [sha512_224, sha512_256, sha3_224, sha3_256]

1929

* [sha3_384, sha3_512]

**Parameter:**

key: the key

message: message content

**Return:**

Succeed: string, calculation result

Failed: nil

For example:

local sha = require"sha2"

1947

1948

function sha_test.main()

1949

1950

local sha256 = sha.sha256

1951

1952

print(sha256("your message"))

1953

1954

end

1955

Wiki source code of 01 Lua Functions