Changes for page 01 Lua Functions
Last modified by Theodore Xu on 2023/10/26 10:51
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -1,4 +1,4 @@ 1 -= **1 Interface description** =1 += **1 Interface Description** = 2 2 3 3 == **Data type definition** == 4 4 ... ... @@ -92,7 +92,7 @@ 92 92 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 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 94 95 -== **Modification of printfunction** ==95 +== **Modification of the Print Function** == 96 96 97 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 98 ... ... @@ -105,7 +105,9 @@ 105 105 In addition, please refer to the front-end documentation for how to use view debugging. 106 106 107 107 ((( 108 -= **2 Address operation** = 108 += **2 Address Operation** = 109 + 110 + 109 109 ))) 110 110 111 111 |=16-bit data formal|=HLword|=32-bit data formal|=HLword|= 64-bit data formal|=HLword ... ... @@ -138,17 +138,20 @@ 138 138 43218765 139 139 )))|10 140 140 141 - Table2-1143 +* If HLword enters any other value, it will be treated as invalid. 142 142 143 -(% class="box errormessage" %) 144 -((( 145 -**✎Note: **If HLword enters any other value, it will be treated as invalid. 146 -))) 145 + Demo: Reads a 32-bit floating-point number at position D0 of PLC 147 147 148 -== **addr_getshort(string addr[, number type, number hlword])** == 149 149 150 -**Function:** Read 16-bit signed decimal address 151 151 149 +[[image:企业微信截图_20210506180640.png||height="301" width="600" class="img-thumbnail"]] 150 + 151 +== **2.1 addr_getshort(string addr[, number type, number hlword])** == 152 + 153 +**Function:** 154 + 155 +Read 16-bit signed decimal address 156 + 152 152 **Parameters:** 153 153 154 154 //addr//: address ... ... @@ -166,11 +166,13 @@ 166 166 Failed: multi 167 167 168 168 ((( 169 -== **addr_setshort(string addr, number num[, number type, number hlword])** == 174 +== **2.2 addr_setshort(string addr, number num[, number type, number hlword])** == 170 170 ))) 171 171 172 -**Function:** Write 16-bit signed decimal address177 +**Function:** 173 173 179 +Write 16-bit signed decimal address 180 + 174 174 **Parameters:** 175 175 176 176 //addr//: address ... ... @@ -188,11 +188,13 @@ 188 188 Failed: multi 189 189 190 190 ((( 191 -== **addr_getword(string addr[, number type, number hlword])** == 198 +== **2.3 addr_getword(string addr[, number type, number hlword])** == 192 192 ))) 193 193 194 -**Function:** Read 16-bit unsigned decimal address201 +**Function:** 195 195 203 +Read 16-bit unsigned decimal address 204 + 196 196 **Parameters:** 197 197 198 198 //addr//: address ... ... @@ -208,11 +208,13 @@ 208 208 Failed: multi 209 209 210 210 ((( 211 -== **addr_setword(string addr, number num[, number type, number hlword])** == 220 +== **2.4 addr_setword(string addr, number num[, number type, number hlword])** == 212 212 ))) 213 213 214 -**Function:** Write 16-bit unsigned decimal address223 +**Function:** 215 215 225 +Write 16-bit unsigned decimal address 226 + 216 216 **Parameters:** 217 217 218 218 //addr//: address ... ... @@ -230,11 +230,13 @@ 230 230 Failed: multi 231 231 232 232 ((( 233 -== **addr_getint(string addr[, number type, number hlword])** == 244 +== **2.5 addr_getint(string addr[, number type, number hlword])** == 234 234 ))) 235 235 236 -**Function:** Read 32-bit signed decimal address247 +**Function:** 237 237 249 +Read 32-bit signed decimal address 250 + 238 238 **Parameters:** 239 239 240 240 //addr//: address ... ... @@ -250,11 +250,13 @@ 250 250 Failed: multi 251 251 252 252 ((( 253 -== **addr_setint(string addr, number num[, number type, number hlword])** == 266 +== **2.6 addr_setint(string addr, number num[, number type, number hlword])** == 254 254 ))) 255 255 256 -**Function:** Write 32-bit signed decimal address269 +**Function:** 257 257 271 +Write 32-bit signed decimal address 272 + 258 258 **Parameters:** 259 259 260 260 //addr//: address ... ... @@ -272,11 +272,13 @@ 272 272 Failed: multi 273 273 274 274 ((( 275 -== **addr_getdword(string addr[, number type, number hlword])** == 290 +== **2.7 addr_getdword(string addr[, number type, number hlword])** == 276 276 ))) 277 277 278 -**Function:** Read 32-bit unsigned decimal address293 +**Function:** 279 279 295 +Read 32-bit unsigned decimal address 296 + 280 280 **Parameters:** 281 281 282 282 //addr//: address ... ... @@ -292,11 +292,13 @@ 292 292 Failed: multi 293 293 294 294 ((( 295 -== **addr_setdword(string addr, number num[, number type, number hlword])** == 312 +== **2.8 addr_setdword(string addr, number num[, number type, number hlword])** == 296 296 ))) 297 297 298 -**Function:** Write 32-bit unsigned decimal address315 +**Function:** 299 299 317 +Write 32-bit unsigned decimal address 318 + 300 300 **Parameters:** 301 301 302 302 //addr//: address ... ... @@ -314,11 +314,13 @@ 314 314 Failed: multi 315 315 316 316 ((( 317 -== **addr_getbit(string addr[, number type])** == 336 +== **2.9 addr_getbit(string addr[, number type])** == 318 318 ))) 319 319 320 -**Function:** Read a bit of the register address339 +**Function:** 321 321 341 +Read a bit of the register address 342 + 322 322 **Parameters:** 323 323 324 324 //addr//: address ... ... @@ -334,11 +334,13 @@ 334 334 Failed: multi 335 335 336 336 ((( 337 -== **addr_setbit(string addr, number num[, number type])** == 358 +== **2.10 addr_setbit(string addr, number num[, number type])** == 338 338 ))) 339 339 340 -**Function:** Write a bit of the register address361 +**Function:** 341 341 363 +Write a bit of the register address 364 + 342 342 **Parameters:** 343 343 344 344 //addr//: address ... ... @@ -356,11 +356,13 @@ 356 356 Failed: multi 357 357 358 358 ((( 359 -== **addr_getfloat(string addr[, number type, number hlword])** == 382 +== **2.11 addr_getfloat(string addr[, number type, number hlword])** == 360 360 ))) 361 361 362 -**Function:** Read 32-bit floating address385 +**Function:** 363 363 387 +Read 32-bit floating address 388 + 364 364 **Parameters:** 365 365 366 366 //addr//: address ... ... @@ -376,11 +376,13 @@ 376 376 Failed: multi 377 377 378 378 ((( 379 -== **addr_setfloat(string addr, number num[, number type, number hlword])** == 404 +== **2.12 addr_setfloat(string addr, number num[, number type, number hlword])** == 380 380 ))) 381 381 382 -**Function:** Write 32-bit floating address407 +**Function:** 383 383 409 +Write 32-bit floating address 410 + 384 384 **Parameters:** 385 385 386 386 //addr//: address ... ... @@ -398,11 +398,13 @@ 398 398 Failed: multi 399 399 400 400 ((( 401 -== **addr_getdouble(string addr[, number type, number hlword])** == 428 +== **2.13 addr_getdouble(string addr[, number type, number hlword])** == 402 402 ))) 403 403 404 -**Function:** Read 64-bit floating address431 +**Function:** 405 405 433 +Read 64-bit floating address 434 + 406 406 **Parameters:** 407 407 408 408 //addr//: address ... ... @@ -418,11 +418,13 @@ 418 418 Failed: multi 419 419 420 420 ((( 421 -== **addr_setdouble(string addr, number num[, number type, number hlword])** == 450 +== **2.14 addr_setdouble(string addr, number num[, number type, number hlword])** == 422 422 ))) 423 423 424 -**Function:** Write 64-bit floating address453 +**Function:** 425 425 455 +Write 64-bit floating address 456 + 426 426 **Parameters:** 427 427 428 428 addr: address ... ... @@ -440,11 +440,13 @@ 440 440 Failed: multi 441 441 442 442 ((( 443 -== **addr_getstring(string addr, number length[, number type, number hlbyte])** == 474 +== **2.15 addr_getstring(string addr, number length[, number type, number hlbyte])** == 444 444 ))) 445 445 446 -**Function:** Read the specified length string from address477 +**Function:** 447 447 479 +Read the specified length string from address 480 + 448 448 **Parameters:** 449 449 450 450 //addr//: address ... ... @@ -462,11 +462,13 @@ 462 462 Failed: multi 463 463 464 464 ((( 465 -== **addr_setstring(string addr, string str[, number type, number hlbyte])** == 498 +== **2.16 addr_setstring(string addr, string str[, number type, number hlbyte])** == 466 466 ))) 467 467 468 -**Function:** Write the specified length string to address501 +**Function:** 469 469 503 +Write the specified length string to address 504 + 470 470 **Parameters:** 471 471 472 472 //addr//: address ... ... @@ -484,11 +484,13 @@ 484 484 Failed: multi 485 485 486 486 ((( 487 -== **addr_bmov(string dst, string src, number length)** == 522 +== **2.17 addr_bmov(string dst, string src, number length)** == 488 488 ))) 489 489 490 -**Function:** Copy data from source address to destination address525 +**Function:** 491 491 527 +Copy data from source address to destination address 528 + 492 492 **Parameters:** 493 493 494 494 //dst//: destination address ... ... @@ -504,11 +504,13 @@ 504 504 **Failed: multi** 505 505 506 506 ((( 507 -== **addr_fill(string addr, number num, number length)** == 544 +== **2.18 addr_fill(string addr, number num, number length)** == 508 508 ))) 509 509 510 -**Function:** Write the same value to consecutive addresses547 +**Function:** 511 511 549 +Write the same value to consecutive addresses 550 + 512 512 **Parameters:** 513 513 514 514 //addr//: address ... ... @@ -524,11 +524,13 @@ 524 524 Failed: multi 525 525 526 526 ((( 527 -== **addr_newnoaddr(string addr, number offset)** == 566 +== **2.19 addr_newnoaddr(string addr, number offset)** == 528 528 ))) 529 529 530 -**Function:** Offset address value relative to //addr//569 +**Function:** 531 531 571 +Offset address value relative to //addr// 572 + 532 532 **Parameters:** 533 533 534 534 //addr//: address ... ... @@ -542,11 +542,13 @@ 542 542 Failed: multi 543 543 544 544 ((( 545 -== **addr_newstataddr(string addr, number offset)** == 586 +== **2.20 addr_newstataddr(string addr, number offset)** == 546 546 ))) 547 547 548 -**Function:** Offset station number relative to //addr //station number589 +**Function:** 549 549 591 +Offset station number relative to //addr //station number 592 + 550 550 **Parameters:** 551 551 552 552 //addr//: address ... ... @@ -559,10 +559,12 @@ 559 559 560 560 Failed: multi 561 561 562 -== **addr_gethex64(string addr[, number type, number hlword])** == 605 +== **2.21 addr_gethex64(string addr[, number type, number hlword])** == 563 563 564 -**Function:** Read 64-bit hexadecimal numbers607 +**Function:** 565 565 609 +Read 64-bit hexadecimal numbers 610 + 566 566 **Parameters:** 567 567 568 568 //addr//: address ... ... @@ -577,10 +577,12 @@ 577 577 578 578 Failed: multi 579 579 580 -== **addr_sethex64(string addr, number num[, number type, number hlword])** == 625 +== **2.22 addr_sethex64(string addr, number num[, number type, number hlword])** == 581 581 582 -**Function:** Write 64-bit hexadecimal addresses627 +**Function:** 583 583 629 +Write 64-bit hexadecimal addresses 630 + 584 584 **Parameters:** 585 585 586 586 //addr//: address ... ... @@ -601,11 +601,11 @@ 601 601 602 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 603 604 -**Serial port name and mode** 651 +**Serial port name and mode:** 605 605 606 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 607 608 -Attempting to use a script to open a serial port in an unsupported mode will result in an error directly, as below .655 +Attempting to use a script to open a serial port in an unsupported mode will result in an error directly, as below 609 609 610 610 |((( 611 611 local setup = { ... ... @@ -627,11 +627,13 @@ 627 627 1. When the data bit is 8, the maximum value of data transmission is 255 (0xFF), which supports the transmission of any character. 628 628 629 629 ((( 630 -== **serial.open(table setup)** == 677 +== **3.1 serial.open(table setup)** == 631 631 ))) 632 632 633 -**Function:** Enable one serial port680 +**Function:** 634 634 682 +Enable one serial port 683 + 635 635 **Parameters:** 636 636 637 637 //Setup// is a Lua table; it needs to contain the following fields ... ... @@ -665,13 +665,17 @@ 665 665 Failed: multi 666 666 667 667 ((( 668 -== **serial.close(serial obj)** == 717 +== **3.2 serial.close(serial obj)** == 669 669 ))) 670 670 671 -**Function:** Disable the serial port720 +**Function:** 672 672 673 - **Parameters: **//Obj //isthe objectreturnedbyserial.open722 +Disable the serial port 674 674 724 +**Parameters:** 725 + 726 +//Obj //is the object returned by serial.open 727 + 675 675 **Return:** 676 676 677 677 Succeed: true ... ... @@ -679,11 +679,13 @@ 679 679 Failed: multi 680 680 681 681 ((( 682 -== **serial:read(number bytes[, number timeout])** == 735 +== **3.3 serial:read(number bytes[, number timeout])** == 683 683 ))) 684 684 685 -**Function:** Read the specified byte length serial port data738 +**Function:** 686 686 740 +Read the specified byte length serial port data 741 + 687 687 **Parameters:** 688 688 689 689 //bytes//: number of bytes ... ... @@ -697,13 +697,15 @@ 697 697 Failed: multi 698 698 699 699 ((( 700 -== **serial:write(string data)** == 755 +== **3.4 serial:write(string data)** == 701 701 ))) 702 702 703 -**Function:** Write the specified byte length to serial port data758 +**Function:** 704 704 705 - **Parameters:**760 +Write the specified byte length to serial port data 706 706 762 +**Parameters:** 763 + 707 707 //data//: serial port data 708 708 709 709 **Return:** ... ... @@ -713,11 +713,13 @@ 713 713 Failed: multi 714 714 715 715 ((( 716 -== **serial:flush([number flag])** == 773 +== **3.5 serial:flush([number flag])** == 717 717 ))) 718 718 719 -**Function:** Clear the serial port buffer776 +**Function:** 720 720 778 +Clear the serial port buffer 779 + 721 721 **Parameters:** 722 722 723 723 //[flag=2]// clear option: 0: read, 1: write, 2: read-write ... ... @@ -729,13 +729,17 @@ 729 729 Failed: multi 730 730 731 731 ((( 732 -== **serial:close()** == 791 +== **3.6 serial:close()** == 733 733 ))) 734 734 735 -**Function:** Close the serial port object794 +**Function:** 736 736 737 - **Parameters:** None796 +Close the serial port object 738 738 798 +**Parameters:** 799 + 800 +None 801 + 739 739 **Return:** 740 740 741 741 Succeed: true ... ... @@ -752,10 +752,12 @@ 752 752 753 753 **QoS value:** 754 754 755 -* 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. 756 -* 1: The message is delivered at least once, but the message may be delivered repeatedly. 757 -* 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. 818 +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 758 820 +1: The message is delivered at least once, but the message may be delivered repeatedly. 821 + 822 +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. 823 + 759 759 **Retain flag:** 760 760 761 761 0: not reserved; ... ... @@ -763,11 +763,13 @@ 763 763 1: reserved 764 764 765 765 ((( 766 -== **mqtt.create(string serverurl, string clientid)** == 831 +== **4.1 mqtt.create(string serverurl, string clientid)** == 767 767 ))) 768 768 769 -**Function:** Create an MQTT object834 +**Function:** 770 770 836 +Create an MQTT object 837 + 771 771 **Parameters:** 772 772 773 773 //serverurl //Server url ... ... @@ -789,13 +789,17 @@ 789 789 Failed: multi 790 790 791 791 ((( 792 -== **mqtt.close(mqtt obj)** == 859 +== **4.2 mqtt.close(mqtt obj)** == 793 793 ))) 794 794 795 -**Function:** Close the specified MQTT object (if the connected server will be disconnected automatically)862 +**Function:** 796 796 797 - **Parameters:**//Obj//isthebjecedturnedby mqtt.create864 +Close the specified MQTT object (if the connected server will be disconnected automatically) 798 798 866 +**Parameters:** 867 + 868 +//Obj //is the objeced returned by mqtt.create 869 + 799 799 **Return:** 800 800 801 801 Succeed: true ... ... @@ -803,25 +803,32 @@ 803 803 Failed: multi 804 804 805 805 ((( 806 -== **mqtt:connect(table conn[, table lwt, table cart])** == 877 +== **4.3 mqtt:connect(table conn[, table lwt, table cart])** == 807 807 ))) 808 808 809 -**Function:** Establish a connection to the server880 +**Function:** 810 810 882 +Establish a connection to the server 883 + 811 811 **Parameters:** 812 812 813 813 //conn //is a Lua table and needs to contain the following fields 814 814 815 -* //string conn.username//, user name 816 -* //string conn.password//, password 817 -* //number [conn.netway=0]//, networking method, if set error number will use Ethernet method 818 -** 0: Ethernet 819 -** 1: WIFI 820 -** 2: 4G 821 -** 3: 2G 822 -* //number [conn.keepalive=60]//, keep connected heartbeat interval, in seconds 823 -* //number [conn.cleansession=1]//, empty the session as described below: 888 +//string conn.username//, user name 824 824 890 +//string conn.password//, password 891 + 892 +//number [conn.netway=0]//, networking method, if set error number will use Ethernet method 893 + 894 +* 0: Ethernet 895 +* 1: WIFI 896 +* 2: 4G 897 +* 3: 2G 898 + 899 +//number [conn.keepalive=60]//, keep connected heartbeat interval, in seconds 900 + 901 +//number [conn.cleansession=1]//, empty the session as described below: 902 + 825 825 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: 826 826 827 827 * 1 (Empty): If a session exists and is 1, the previous session messages on the client and server are emptied. ... ... @@ -829,11 +829,14 @@ 829 829 830 830 //lwt// (Last Will and Testament) is a Lua table and needs to contain the following fields 831 831 832 -* //string lwt.topic//, topic 833 -* //string lwt.message//, message 834 -* //number [lwt.qos=0]//, qos value 835 -* //number [lwt.retain=0]//, retain flag 910 +//string lwt.topic//, topic 836 836 912 +//string lwt.message//, message 913 + 914 +//number [lwt.qos=0]//, qos value 915 + 916 +//number [lwt.retain=0]//, retain flag 917 + 837 837 **Return:** 838 838 839 839 Succeed: true ... ... @@ -841,13 +841,17 @@ 841 841 Failed: multi 842 842 843 843 ((( 844 -== **mqtt:disconnect([number timeout])** == 925 +== **4.4 mqtt:disconnect([number timeout])** == 845 845 ))) 846 846 847 -**Function:** Disconnect from the MQTT server928 +**Function:** 848 848 849 - **Parameters: **//[timeout=10000] //Disconnectwaitingtimeout,inmilliseconds930 +Disconnect from the MQTT server 850 850 932 +**Parameters:** 933 + 934 +//[timeout=10000] //Disconnect waiting timeout, in milliseconds 935 + 851 851 **Return:** 852 852 853 853 Succeed: true ... ... @@ -855,13 +855,17 @@ 855 855 Failed: multi 856 856 857 857 ((( 858 -== **mqtt:isconnected()** == 943 +== **4.5 mqtt:isconnected()** == 859 859 ))) 860 860 861 -**Function:** Test whether or not a client is currently connected to the MQTT server946 +**Function:** 862 862 863 - **Parameters:** None948 +Test whether or not a client is currently connected to the MQTT server 864 864 950 +**Parameters:** 951 + 952 +None 953 + 865 865 **Return:** 866 866 867 867 Succeed: true ~-~-Connected ... ... @@ -869,11 +869,13 @@ 869 869 Failed: false ~-~- Unconnected and other unknowns 870 870 871 871 ((( 872 -== **mqtt:subscribe(string topic, number qos)** == 961 +== **4.6 mqtt:subscribe(string topic, number qos)** == 873 873 ))) 874 874 875 -**Function: Subscribe to the topic (before the subscription, the user must first call the connect method to connect to the server)964 +**Function:** 876 876 966 +Subscribe to the topic (before the subscription, the user must first call the connect method to connect to the server) 967 + 877 877 **Parameters:** 878 878 879 879 //topic//, topic name ... ... @@ -887,11 +887,13 @@ 887 887 Failed: multi 888 888 889 889 ((( 890 -== **mqtt:unsubscribe(string topic)** == 981 +== **4.7 mqtt:unsubscribe(string topic)** == 891 891 ))) 892 892 893 -**Function:** Unsubscribe topic984 +**Function:** 894 894 986 +Unsubscribe topic 987 + 895 895 **Parameters:** 896 896 897 897 //topic//, topic name ... ... @@ -903,11 +903,13 @@ 903 903 Failed: multi 904 904 905 905 ((( 906 -== **mqtt:publish(string topic, string message, number qos, number retain[, number timeout])** == 999 +== **4.8 mqtt:publish(string topic, string message, number qos, number retain[, number timeout])** == 907 907 ))) 908 908 909 -**Function:** Publish message1002 +**Function:** 910 910 1004 +Publish message 1005 + 911 911 **Parameters:** 912 912 913 913 //topic//, topic name ... ... @@ -927,13 +927,17 @@ 927 927 Failed: multi 928 928 929 929 ((( 930 -== **mqtt:close()** == 1025 +== **4.9 mqtt:close()** == 931 931 ))) 932 932 933 -**Function:** Close the mqtt object (the connection to the server will be automatically disconnected)1028 +**Function:** 934 934 935 - **Parameters:** None1030 +Close the mqtt object (the connection to the server will be automatically disconnected) 936 936 1032 +**Parameters:** 1033 + 1034 +None 1035 + 937 937 **Return:** 938 938 939 939 Succeed: true ... ... @@ -941,11 +941,13 @@ 941 941 Failed: multi 942 942 943 943 ((( 944 -== **mqtt:on(string method, function callback)** == 1043 +== **4.10 mqtt:on(string method, function callback)** == 945 945 ))) 946 946 947 -**Function:** Register event callback function1046 +**Function:** 948 948 1048 +Register event callback function 1049 + 949 949 **Parameters:** 950 950 951 951 //method//, It can be message/arrived/offline, these 3 types of events ... ... @@ -958,17 +958,20 @@ 958 958 959 959 Parameter: 960 960 961 -* //Topic//, topic name 962 -* //Message//, content 1062 +//Topic//, topic name 963 963 964 - **2."arrived" ispublished by publish,this functionwill be called after the publicationarrives**1064 +//Message//, content 965 965 1066 +**2.**"arrived" is published by publish, this function will be called after the publication arrives 1067 + 966 966 //Callback// prototype~:// function ()// 967 967 968 -Parameter: None1070 +Parameter: 969 969 970 - **3.This functionwill becalled after the "offline" connection is lost**1072 +None 971 971 1074 +**3.**This function will be called after the "offline" connection is lost 1075 + 972 972 //Callback// prototype~:// function (string cause)// 973 973 974 974 Parameter: ... ... @@ -982,13 +982,17 @@ 982 982 Failed: multi 983 983 984 984 ((( 985 -== **mqtt:setup_cfg()** == 1089 +== **4.11 mqtt:setup_cfg()** == 986 986 ))) 987 987 988 -**Function:** Cloud mode interface, to obtain MQTT information configured by the cloud platform1092 +**Function:** 989 989 990 - **Parameters:** None1094 +Cloud mode interface, to obtain MQTT information configured by the cloud platform 991 991 1096 +**Parameters:** 1097 + 1098 +None 1099 + 992 992 **Return:** 993 993 994 994 //serverurl, clientid, conn, lwt, cart //(5 returns, respectively, server address, client ID, connection table, last word table, certificate table) ... ... @@ -1006,27 +1006,39 @@ 1006 1006 Lua only has a table data structure, so all arrays and key-value objects of json will be returned as a table. 1007 1007 1008 1008 ((( 1009 -== **json.encode( lua_object )** == 1117 +== **5.1 json.encode( lua_object )** == 1010 1010 ))) 1011 1011 1012 -**Function: Convert lua data type to json string1120 +**Function:** 1013 1013 1014 - **Parameters:**Lua data type(includingboolean,number,string, table)1122 +Convert lua data type to json string 1015 1015 1016 -** Return:**Json format string1124 +**Parameters:** 1017 1017 1126 +Lua data type (including boolean, number, string, table) 1127 + 1128 +**Return:** 1129 + 1130 +Json format string 1131 + 1018 1018 ((( 1019 -== **json.decode(string json_string)** == 1133 +== **5.2 json.decode(string json_string)** == 1020 1020 ))) 1021 1021 1022 -**Function:** Convert json string to lua data type1136 +**Function:** 1023 1023 1024 - **Parameters:**//json_string//,string ofjsondatastructure1138 +Convert json string to lua data type 1025 1025 1026 -** Return:Lua data type1140 +**Parameters:** 1027 1027 1142 +//json_string//, string of json data structure 1143 + 1144 +**Return:** 1145 + 1146 +Lua data type 1147 + 1028 1028 ((( 1029 -== **json.null** == 1149 +== **5.3 json.null** == 1030 1030 ))) 1031 1031 1032 1032 **Function:** ... ... @@ -1033,24 +1033,32 @@ 1033 1033 1034 1034 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. 1035 1035 1036 -**Parameters:** None1156 +**Parameters:** 1037 1037 1038 - **Return: **None1158 +None 1039 1039 1160 +**Return:** 1161 + 1162 +None 1163 + 1040 1040 = **6 Cloud mode** = 1041 1041 1042 1042 The cloud interface is only used in cloud mode, and V-NET mode is not available. 1043 1043 1044 1044 ((( 1045 -== **bns_get_alldata()** == 1169 +== **6.1 bns_get_alldata()** == 1046 1046 ))) 1047 1047 1048 -**Function:** Obtain all monitoring points (point table) data configured by the end user1172 +**Function:** 1049 1049 1050 - **✎Note: **Assumingtherearetiming scripts A and B with a period of 1 second,ifthisfunctionis called inscriptA,the datawill not beobtainedif calledinscript B1174 +Obtain all monitoring points (point table) data configured by the end user 1051 1051 1052 - **Parameters:** None1176 +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 1053 1053 1178 +**Parameters:** 1179 + 1180 +None 1181 + 1054 1054 **Return:** 1055 1055 1056 1056 Succeed: table two-dimensional array, the structure is as follows ... ... @@ -1080,11 +1080,13 @@ 1080 1080 Failed: //table// empty table 1081 1081 1082 1082 ((( 1083 -== **bns_get_config(string from)** == 1211 +== **6.2 bns_get_config(string from)** == 1084 1084 ))) 1085 1085 1086 -**Function:** Obtain custom configuration parameters with the specified from type1214 +**Function:** 1087 1087 1216 +Obtain custom configuration parameters with the specified from type 1217 + 1088 1088 **parameter:** 1089 1089 1090 1090 from type, there are the following two categories, the string must be all lowercase ... ... @@ -1102,11 +1102,13 @@ 1102 1102 Failed~:// table// empty table 1103 1103 1104 1104 ((( 1105 -== **bns_get_data(string name, string data)** == 1235 +== **6.3 bns_get_data(string name, string data)** == 1106 1106 ))) 1107 1107 1108 -**Function:** write data to the name of the monitoring point1238 +**Function:** 1109 1109 1240 +write data to the name of the monitoring point 1241 + 1110 1110 **parameter:** 1111 1111 1112 1112 //name //The name of the monitoring point ... ... @@ -1120,7 +1120,7 @@ 1120 1120 Failed: nil 1121 1121 1122 1122 ((( 1123 -== **bns_get_data(string name)** == 1255 +== **6.4 bns_get_data(string name)** == 1124 1124 ))) 1125 1125 1126 1126 **Function:** ... ... @@ -1138,13 +1138,17 @@ 1138 1138 Failed: nil 1139 1139 1140 1140 ((( 1141 -== **bns_get_datadesc()** == 1273 +== **6.5 bns_get_datadesc()** == 1142 1142 ))) 1143 1143 1144 -**Function: Obtain all configured communication ports and monitoring point information1276 +**Function:** 1145 1145 1146 - **Parameters:** None1278 +Obtain all configured communication ports and monitoring point information 1147 1147 1280 +**Parameters:** 1281 + 1282 +None 1283 + 1148 1148 **Return:** 1149 1149 1150 1150 Succeed: table three-dimensional array, the structure is as follows ... ... @@ -1197,13 +1197,17 @@ 1197 1197 Failed~:// table// empty table 1198 1198 1199 1199 ((( 1200 -== **bns_get_machineinfo()** == 1336 +== **6.6 bns_get_machineinfo()** == 1201 1201 ))) 1202 1202 1203 -**Function:** get machine information1339 +**Function:** 1204 1204 1205 - **Parameters:** None1341 +get machine information 1206 1206 1343 +**Parameters:** 1344 + 1345 +None 1346 + 1207 1207 **Return:** 1208 1208 1209 1209 Succeed: 3 string type results (model, machine code, software version) ... ... @@ -1211,11 +1211,13 @@ 1211 1211 Failed: nil 1212 1212 1213 1213 ((( 1214 -== **bns_get_groupdata(string name)** == 1354 +== **6.7 bns_get_groupdata(string name)** == 1215 1215 ))) 1216 1216 1217 -**Function:** Get all monitoring point data under the specified group name1357 +**Function:** 1218 1218 1359 +Get all monitoring point data under the specified group name 1360 + 1219 1219 **parameter:** 1220 1220 1221 1221 //Name // group name ... ... @@ -1227,13 +1227,17 @@ 1227 1227 Failed: //table// empty table 1228 1228 1229 1229 ((( 1230 -== **bns_get_groupdesc()** == 1372 +== **6.8 bns_get_groupdesc()** == 1231 1231 ))) 1232 1232 1233 -**Function:** Get all group information1375 +**Function:** 1234 1234 1235 - **Parameters:** None1377 +Get all group information 1236 1236 1379 +**Parameters:** 1380 + 1381 +None 1382 + 1237 1237 **Return:** 1238 1238 1239 1239 Succeed: //table// two-dimensional array, the structure is as follows ... ... @@ -1247,13 +1247,17 @@ 1247 1247 Failed: //table // empty table 1248 1248 1249 1249 ((( 1250 -== **bns_get_onecache(string msg)** == 1396 +== **6.9 bns_get_onecache(string msg)** == 1251 1251 ))) 1252 1252 1253 -**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.1399 +**Function:** 1254 1254 1255 - **Parameters:**//msg//String1401 +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. 1256 1256 1403 +**Parameters:** 1404 + 1405 +//msg// String 1406 + 1257 1257 **Return:** 1258 1258 1259 1259 Succeed: true ... ... @@ -1261,13 +1261,17 @@ 1261 1261 Failed: nil 1262 1262 1263 1263 ((( 1264 -== **bns_get_allcache()** == 1414 +== **6.10 bns_get_allcache()** == 1265 1265 ))) 1266 1266 1267 -**Function:** Get all the cached content (once the internal cache file will be emptied)1417 +**Function:** 1268 1268 1269 - **Parameters:** None1419 +Get all the cached content (once the internal cache file will be emptied) 1270 1270 1421 +**Parameters:** 1422 + 1423 +None 1424 + 1271 1271 **Return:** 1272 1272 1273 1273 Succeed: //table// one-dimensional array ... ... @@ -1295,232 +1295,194 @@ 1295 1295 Network communication includes Http request interface, this document does not provide interface description, please refer to the online document for how to use it. 1296 1296 1297 1297 ((( 1298 -== **http request** == 1452 +== **7.1 http request** == 1299 1299 ))) 1300 1300 1301 1301 [[http:~~/~~/w3.impa.br/~~~~diego/software/luasocket/http.html#request>>url:http://w3.impa.br/~~diego/software/luasocket/http.html#request]] 1302 1302 1303 -== **https request** == 1457 +((( 1458 += **8 Internal register** = 1459 +))) 1304 1304 1305 - Example:1461 +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): 1306 1306 1307 -{{code language="LUA"}} 1308 -local json = require("json") 1463 +**~1. **Access by word, prefix @W_HDW, 1309 1309 1310 - local https=require("https")1465 +For example: @W_HDW0 represents the first word of the system data area, @W_HDW1 represents the second word of the system data area. 1311 1311 1312 - functionshttps_demo.main()1467 +**2. **Access in bit mode, the prefix is @B_HDX, the number in front of "." indicates the number of the word, and the number behind is the bit number of the word. 1313 1313 1314 -loca lurl="https://XXXXXXXXXXXXXXXXXXXXXXXXXX"1469 +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. 1315 1315 1316 - localbody = {}1471 +**✎Note: ** 1317 1317 1318 - body["XXXXXX"]="XXXXX"1473 +**~1. **The address in @B_HDX is taken from the word in @W_HDW, so pay special attention when using the address. 1319 1319 1320 -body ["XXXXXXX"]="XXXXXXXXXXX"1475 +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. 1321 1321 1322 - localbodyJson=json.encode(body)1477 +**2.**The address of the bit address @B_HDX has a decimal point, while the word address is an integer. 1323 1323 1324 -local header = {} 1479 +((( 1480 +== **8.1 Data storage area(HDW/HDX)** == 1481 +))) 1325 1325 1326 -hea der["content-type"]= "application/json"1483 +The system storage area (HDW) of the V-BOX is used to store temporary data: 1327 1327 1328 - localresult_table,code, headers,status= https.request(url,1485 +~1. Access by word, the number range is: "@W_HDW0"-"@W_HDW299999". 1329 1329 1330 -bod yJson)1487 +2. Access in bit mode, the number range is: "@B_HDX0.0"-"@B_HDX299999.15". 1331 1331 1332 -if code == 200 then 1489 +((( 1490 +== **8.2 Special data area (HSW/HSX)** == 1491 +))) 1333 1333 1334 - print("httpssuc")1493 +**✎Note: ** 1335 1335 1336 -return true 1495 +//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). 1337 1337 1338 -else 1497 +//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. 1339 1339 1340 -pri nt("https fail")1499 +1.The system data area (HSW) of the box is used for system special registers (system reserved). Use //addr_getword// to obtain the following register information: 1341 1341 1342 -return nil 1501 +(% class="table-bordered" %) 1502 +|address|function|Read and write status: read only, write only, read and write 1503 +|@W_HSW0|restart|read and write 1504 +|@W_HSW1|Box time: year|read and write 1505 +|@W_HSW2|Box time: month|read and write 1506 +|@W_HSW3|Box time: day|read and write 1507 +|@W_HSW4|Box time: hour|read and write 1508 +|@W_HSW5|Box time: minute|read and write 1509 +|@W_HSW6|Box time: second|read and write 1510 +|@W_HSW7|Box time: week|read and write 1511 +|@W_HSW8|Ethernet IP1|read only 1512 +|@W_HSW9|Ethernet IP2|read only 1513 +|@W_HSW10|Ethernet IP3|read only 1514 +|@W_HSW11|Ethernet IP4|read only 1515 +|@W_HSW12|Ethernet Mask 1|read only 1516 +|@W_HSW13|Ethernet Mask 2|read only 1517 +|@W_HSW14|Ethernet Mask 3|read only 1518 +|@W_HSW15|Ethernet Mask 4|read only 1519 +|@W_HSW16|Ethernet Gateway 1|read only 1520 +|@W_HSW17|Ethernet Gateway 2|read only 1521 +|@W_HSW18|Ethernet Gateway 3|read only 1522 +|@W_HSW19|Ethernet Gateway 4|read only 1523 +|@W_HSW21|Ethernet MAC1|read only 1524 +|@W_HSW22|Ethernet MAC2|read only 1525 +|@W_HSW23|Ethernet MAC3|read only 1526 +|@W_HSW24|Ethernet MAC4|read only 1527 +|@W_HSW25|Ethernet MAC3|read only 1528 +|@W_HSW26|Ethernet MAC4|read only 1529 +|@W_HSW128|WIFI IP1|read only 1530 +|@W_HSW129|WIFI IP2|read only 1531 +|@W_HSW130|WIFI IP3|read only 1532 +|@W_HSW131|WIFI IP4|read only 1533 +|@W_HSW132|WIFI Mask 1|read only 1534 +|@W_HSW133|WIFI Mask 2|read only 1535 +|@W_HSW134|WIFI Mask 3|read only 1536 +|@W_HSW135|WIFI Mask 4|read only 1537 +|@W_HSW136|WIFI Gateway 1|read only 1538 +|@W_HSW137|WIFI Gateway 2|read only 1539 +|@W_HSW138|WIFI Gateway 3|read only 1540 +|@W_HSW139|WIFI Gateway 4|read only 1541 +|@W_HSW140|WIFI MAC1|read only 1542 +|@W_HSW141|WIFI MAC2|read only 1543 +|@W_HSW142|WIFI MAC3|read only 1544 +|@W_HSW143|WIFI MAC4|read only 1545 +|@W_HSW144|WIFI MAC5|read only 1546 +|@W_HSW145|WIFI MAC6|read only 1547 +|@W_HSW146|WIFI Signal value|read only 1548 +|@W_HSW148|4G IP1|read only 1549 +|@W_HSW149|4G IP2|read only 1550 +|@W_HSW150|4G IP3|read only 1551 +|@W_HSW151|4G IP4|read only 1552 +|@W_HSW152|4G Mask 1|read only 1553 +|@W_HSW153|4G Mask 2|read only 1554 +|@W_HSW154|4G Mask 3|read only 1555 +|@W_HSW155|4G Mask 4|read only 1556 +|@W_HSW156|4G Gateway 1|read only 1557 +|@W_HSW157|4G Gateway 2|read only 1558 +|@W_HSW158|4G Gateway 3|read only 1559 +|@W_HSW159|4G Gateway 4|read only 1560 +|@W_HSW160|4G MAC1|read only 1561 +|@W_HSW161|4G MAC2|read only 1562 +|@W_HSW162|4G MAC3|read only 1563 +|@W_HSW163|4G MAC4|read only 1564 +|@W_HSW164|4G MAC5|read only 1565 +|@W_HSW165|4G MAC6|read only 1566 +|@W_HSW166|4G Signal value|read only 1343 1343 1344 -e nd1568 +2. Other 1345 1345 1346 -end 1347 -{{/code}} 1570 +2.1 Access password: addr_getstring("@W_HSW27", 16) 1348 1348 1349 -((( 1350 -= **8 Internal register** = 1351 -))) 1572 +2.2 Machine code: addr_getstring("@W_HSW60", 64) 1352 1352 1353 - Theinternal registersof the box are divided into bit addresses andword addresses, which can be accessedin two ways(takingHDW asanexample):1574 +2.3 Positioning method (@W_HSW167): (read only) 1354 1354 1355 - **Accessbyword, prefix @W_HDW.**1576 +~1. Latitude and longitude 1356 1356 1357 - For example: @W_HDW0 represents the firstwordof thesystem data area,@W_HDW1 represents the secondword of the system data area.1578 +Longitude: addr_getdouble("@W_HSW168") (read only) 1358 1358 1359 - **Accessin bitmode,the prefix is @B_HDX, thenumber in front of"."indicates the numberof theword,andthe number behind is the bit numberof the word.**1580 +Latitude: addr_getdouble("@W_HSW172") (read only) 1360 1360 1361 - For example: @B_HDX1020.12,its meaning isto accessthesystem data areainbit mode, thespecific locations the 13th bit of the 1020th word.1582 +2. Base station positioning 1362 1362 1363 -(% class="box infomessage" %) 1364 -((( 1365 -**✎Note: ** 1584 +LAC: addr_getdword("@W_HSW168") (read only) 1366 1366 1367 -* The address in @B_HDX is taken from the word in @W_HDW, so pay special attention when using the address. 1368 -** 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. 1369 -* The address of the bit address @B_HDX has a decimal point, while the word address is an integer. 1370 -))) 1586 +CI: addr_getdword("@W_HSW172") (read only) 1371 1371 1588 +2.4 Convert base station to latitude and longitude via API 1372 1372 1373 -((( 1374 -== **Data storage area(HDW/HDX)** == 1375 -))) 1590 +Longitude: addr_getdouble("@W_HSW187") (read only) 1376 1376 1377 - The system storage area(HDW)of theV-BOX is usedtostore temporarydata:1592 +Latitude: addr_getdouble("@W_HSW183") (read only) 1378 1378 1379 -1. Access by word, the number range is: "@W_HDW0"-"@W_HDW299999". 1380 -1. Access in bit mode, the number range is: "@B_HDX0.0"-"@B_HDX299999.15". 1594 +2.5 Operator information: addr_getdword("@W_HSW181") (read only) 1381 1381 1382 -((( 1383 -== **8.2 Special data area (HSW/HSX)** == 1596 +2.6 Networking mode: addr_getword("@W_HSW177") (read only) 1384 1384 1385 -(% class="box infomessage" %) 1386 -((( 1387 -**✎Note: ** 1598 +0: Ethernet, 1: WIFI, 2: 4G, 3: 2G 1388 1388 1389 -* //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). 1390 -* //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. 1391 -))) 1392 -))) 1600 +2.7 Map fence flag: addr_getword("@W_HSW178") (read only) 1393 1393 1394 - Thesystemdataarea (HSW) ofthebox is usedfor system special registers(system reserved). Use //addr_getword// to obtain the following register information:1602 +0: No map fence is drawn 1395 1395 1396 -(% class="table-bordered" %) 1397 -|=(% style="width: 151px;" %)address|=(% style="width: 169px;" %)function|=(% style="width: 456px;" %)Read and write status: read only, write only, read and write 1398 -|(% style="width:151px" %)@W_HSW0|(% style="width:169px" %)restart|(% style="width:456px" %)read and write 1399 -|(% style="width:151px" %)@W_HSW1|(% style="width:169px" %)Box time: year|(% style="width:456px" %)read and write 1400 -|(% style="width:151px" %)@W_HSW2|(% style="width:169px" %)Box time: month|(% style="width:456px" %)read and write 1401 -|(% style="width:151px" %)@W_HSW3|(% style="width:169px" %)Box time: day|(% style="width:456px" %)read and write 1402 -|(% style="width:151px" %)@W_HSW4|(% style="width:169px" %)Box time: hour|(% style="width:456px" %)read and write 1403 -|(% style="width:151px" %)@W_HSW5|(% style="width:169px" %)Box time: minute|(% style="width:456px" %)read and write 1404 -|(% style="width:151px" %)@W_HSW6|(% style="width:169px" %)Box time: second|(% style="width:456px" %)read and write 1405 -|(% style="width:151px" %)@W_HSW7|(% style="width:169px" %)Box time: week|(% style="width:456px" %)read and write 1406 -|(% style="width:151px" %)@W_HSW8|(% style="width:169px" %)Ethernet IP1|(% style="width:456px" %)read only 1407 -|(% style="width:151px" %)@W_HSW9|(% style="width:169px" %)Ethernet IP2|(% style="width:456px" %)read only 1408 -|(% style="width:151px" %)@W_HSW10|(% style="width:169px" %)Ethernet IP3|(% style="width:456px" %)read only 1409 -|(% style="width:151px" %)@W_HSW11|(% style="width:169px" %)Ethernet IP4|(% style="width:456px" %)read only 1410 -|(% style="width:151px" %)@W_HSW12|(% style="width:169px" %)Ethernet Mask 1|(% style="width:456px" %)read only 1411 -|(% style="width:151px" %)@W_HSW13|(% style="width:169px" %)Ethernet Mask 2|(% style="width:456px" %)read only 1412 -|(% style="width:151px" %)@W_HSW14|(% style="width:169px" %)Ethernet Mask 3|(% style="width:456px" %)read only 1413 -|(% style="width:151px" %)@W_HSW15|(% style="width:169px" %)Ethernet Mask 4|(% style="width:456px" %)read only 1414 -|(% style="width:151px" %)@W_HSW16|(% style="width:169px" %)Ethernet Gateway 1|(% style="width:456px" %)read only 1415 -|(% style="width:151px" %)@W_HSW17|(% style="width:169px" %)Ethernet Gateway 2|(% style="width:456px" %)read only 1416 -|(% style="width:151px" %)@W_HSW18|(% style="width:169px" %)Ethernet Gateway 3|(% style="width:456px" %)read only 1417 -|(% style="width:151px" %)@W_HSW19|(% style="width:169px" %)Ethernet Gateway 4|(% style="width:456px" %)read only 1418 -|(% style="width:151px" %)@W_HSW21|(% style="width:169px" %)Ethernet MAC1|(% style="width:456px" %)read only 1419 -|(% style="width:151px" %)@W_HSW22|(% style="width:169px" %)Ethernet MAC2|(% style="width:456px" %)read only 1420 -|(% style="width:151px" %)@W_HSW23|(% style="width:169px" %)Ethernet MAC3|(% style="width:456px" %)read only 1421 -|(% style="width:151px" %)@W_HSW24|(% style="width:169px" %)Ethernet MAC4|(% style="width:456px" %)read only 1422 -|(% style="width:151px" %)@W_HSW25|(% style="width:169px" %)Ethernet MAC3|(% style="width:456px" %)read only 1423 -|(% style="width:151px" %)@W_HSW26|(% style="width:169px" %)Ethernet MAC4|(% style="width:456px" %)read only 1424 -|(% style="width:151px" %)@W_HSW128|(% style="width:169px" %)WIFI IP1|(% style="width:456px" %)read only 1425 -|(% style="width:151px" %)@W_HSW129|(% style="width:169px" %)WIFI IP2|(% style="width:456px" %)read only 1426 -|(% style="width:151px" %)@W_HSW130|(% style="width:169px" %)WIFI IP3|(% style="width:456px" %)read only 1427 -|(% style="width:151px" %)@W_HSW131|(% style="width:169px" %)WIFI IP4|(% style="width:456px" %)read only 1428 -|(% style="width:151px" %)@W_HSW132|(% style="width:169px" %)WIFI Mask 1|(% style="width:456px" %)read only 1429 -|(% style="width:151px" %)@W_HSW133|(% style="width:169px" %)WIFI Mask 2|(% style="width:456px" %)read only 1430 -|(% style="width:151px" %)@W_HSW134|(% style="width:169px" %)WIFI Mask 3|(% style="width:456px" %)read only 1431 -|(% style="width:151px" %)@W_HSW135|(% style="width:169px" %)WIFI Mask 4|(% style="width:456px" %)read only 1432 -|(% style="width:151px" %)@W_HSW136|(% style="width:169px" %)WIFI Gateway 1|(% style="width:456px" %)read only 1433 -|(% style="width:151px" %)@W_HSW137|(% style="width:169px" %)WIFI Gateway 2|(% style="width:456px" %)read only 1434 -|(% style="width:151px" %)@W_HSW138|(% style="width:169px" %)WIFI Gateway 3|(% style="width:456px" %)read only 1435 -|(% style="width:151px" %)@W_HSW139|(% style="width:169px" %)WIFI Gateway 4|(% style="width:456px" %)read only 1436 -|(% style="width:151px" %)@W_HSW140|(% style="width:169px" %)WIFI MAC1|(% style="width:456px" %)read only 1437 -|(% style="width:151px" %)@W_HSW141|(% style="width:169px" %)WIFI MAC2|(% style="width:456px" %)read only 1438 -|(% style="width:151px" %)@W_HSW142|(% style="width:169px" %)WIFI MAC3|(% style="width:456px" %)read only 1439 -|(% style="width:151px" %)@W_HSW143|(% style="width:169px" %)WIFI MAC4|(% style="width:456px" %)read only 1440 -|(% style="width:151px" %)@W_HSW144|(% style="width:169px" %)WIFI MAC5|(% style="width:456px" %)read only 1441 -|(% style="width:151px" %)@W_HSW145|(% style="width:169px" %)WIFI MAC6|(% style="width:456px" %)read only 1442 -|(% style="width:151px" %)@W_HSW146|(% style="width:169px" %)WIFI Signal value|(% style="width:456px" %)read only 1443 -|(% style="width:151px" %)@W_HSW148|(% style="width:169px" %)4G IP1|(% style="width:456px" %)read only 1444 -|(% style="width:151px" %)@W_HSW149|(% style="width:169px" %)4G IP2|(% style="width:456px" %)read only 1445 -|(% style="width:151px" %)@W_HSW150|(% style="width:169px" %)4G IP3|(% style="width:456px" %)read only 1446 -|(% style="width:151px" %)@W_HSW151|(% style="width:169px" %)4G IP4|(% style="width:456px" %)read only 1447 -|(% style="width:151px" %)@W_HSW152|(% style="width:169px" %)4G Mask 1|(% style="width:456px" %)read only 1448 -|(% style="width:151px" %)@W_HSW153|(% style="width:169px" %)4G Mask 2|(% style="width:456px" %)read only 1449 -|(% style="width:151px" %)@W_HSW154|(% style="width:169px" %)4G Mask 3|(% style="width:456px" %)read only 1450 -|(% style="width:151px" %)@W_HSW155|(% style="width:169px" %)4G Mask 4|(% style="width:456px" %)read only 1451 -|(% style="width:151px" %)@W_HSW156|(% style="width:169px" %)4G Gateway 1|(% style="width:456px" %)read only 1452 -|(% style="width:151px" %)@W_HSW157|(% style="width:169px" %)4G Gateway 2|(% style="width:456px" %)read only 1453 -|(% style="width:151px" %)@W_HSW158|(% style="width:169px" %)4G Gateway 3|(% style="width:456px" %)read only 1454 -|(% style="width:151px" %)@W_HSW159|(% style="width:169px" %)4G Gateway 4|(% style="width:456px" %)read only 1455 -|(% style="width:151px" %)@W_HSW160|(% style="width:169px" %)4G MAC1|(% style="width:456px" %)read only 1456 -|(% style="width:151px" %)@W_HSW161|(% style="width:169px" %)4G MAC2|(% style="width:456px" %)read only 1457 -|(% style="width:151px" %)@W_HSW162|(% style="width:169px" %)4G MAC3|(% style="width:456px" %)read only 1458 -|(% style="width:151px" %)@W_HSW163|(% style="width:169px" %)4G MAC4|(% style="width:456px" %)read only 1459 -|(% style="width:151px" %)@W_HSW164|(% style="width:169px" %)4G MAC5|(% style="width:456px" %)read only 1460 -|(% style="width:151px" %)@W_HSW165|(% style="width:169px" %)4G MAC6|(% style="width:456px" %)read only 1461 -|(% style="width:151px" %)@W_HSW166|(% style="width:169px" %)4G Signal value|(% style="width:456px" %)read only 1604 +1: Draw a map fence and the box is in the fence 1462 1462 1463 - **Others**1606 +2: Draw a map fence and the box is not in the fence 1464 1464 1465 -* Access password: addr_getstring("@W_HSW27", 16) 1466 -* Machine code: addr_getstring("@W_HSW60", 64) 1467 -* Positioning method (@W_HSW167): (read only) 1468 -** Latitude and longitude 1469 -*** Longitude: addr_getdouble("@W_HSW168") (read only) 1470 -*** Latitude: addr_getdouble("@W_HSW172") (read only) 1471 -** Base station positioning 1472 -*** LAC: addr_getdword("@W_HSW168") (read only) 1473 -*** CI: addr_getdword("@W_HSW172") (read only) 1474 -* Convert base station to latitude and longitude via API 1475 -** Longitude: addr_getdouble("@W_HSW187") (read only) 1476 -** Latitude: addr_getdouble("@W_HSW183") (read only) 1477 -* Operator information: addr_getdword("@W_HSW181") (read only) 1478 -* Networking mode: addr_getword("@W_HSW177") (read only) 1479 -** 0: Ethernet 1480 -** 1: WIFI 1481 -** 2: 4G 1482 -** 3: 2G 1483 -* Map fence flag: addr_getword("@W_HSW178") (read only) 1484 -** 0: No map fence is drawn 1485 -** 1: Draw a map fence and the box is in the fence 1486 -** 2: Draw a map fence and the box is not in the fence 1487 -* SIM card status addr_getword("@W_HSW179") (read only) 1488 -** 1: No card detected 1489 -** 2: Card insertion detected 1490 -** 3: The card status is abnormal 1491 -* MQTT status addr_getword("@W_HSW180") (read only) 1492 -** 1: online, 2: offline 1493 -* IO interface, X is read only, Y is read and write (H series) 1494 -** addr_getbit(addr1), addr_setbit(addr2) 1495 -** addr1:"@B_Y0" "@B_Y1" "@B_X0" "@B_X1" 1496 -** addr2:"@B_Y0" "@B_Y1" 1497 -* Obtaining IMEI (read only) 1498 -** addr_getstring("@W_HSW191",17) 1499 -* Obtaining ICCID (read only) 1500 -** addr_getstring("@W_HSW225",15) 1608 +2.8 SIM card status addr_getword("@W_HSW179") (read only) 1501 1501 1502 -((( 1503 -== **Power-down storage area (HAW/HAX)** == 1610 +1: No card detected 1504 1504 1505 - Thesystem storage area(HAW)isused forhe system power-downholdregisters:1612 +2: Card insertion detected 1506 1506 1507 -1. Accessed as a word, numbered in the range: "@W_HAW0"-"@W_HAW199999". 1508 -1. Accessed by bit, the numbering range is: "@B_HAX0.0"-"@B_HAX199999.15". 1614 +3: The card status is abnormal 1509 1509 1510 -(% class="box infomessage" %) 1511 -((( 1512 -**✎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. 1513 -))) 1616 +2.9 MQTT status addr_getword("@W_HSW180") (read only) 1514 1514 1618 +1: online, 2: offline 1619 + 1620 +2.10 IO interface, X is read only, Y is read and write (H series) 1621 + 1622 +addr_getbit(addr1), addr_setbit(addr2) 1623 + 1624 +addr1:"@B_Y0" "@B_Y1" "@B_X0" "@B_X1" 1625 + 1626 +addr2:"@B_Y0" "@B_Y1" 1627 + 1628 +((( 1515 1515 = **9 General Functions** = 1516 1516 ))) 1517 1517 1518 1518 ((( 1519 -== **send_sms_ira(string number, string message)** == 1633 +== **9.1 send_sms_ira(string number, string message)** == 1520 1520 ))) 1521 1521 1522 -**Function:** Use IRA character set to send English text messages1636 +**Function:** 1523 1523 1638 +Use IRA character set to send English text messages 1639 + 1524 1524 **Parameters:** 1525 1525 1526 1526 //number: //number (up to 32 characters, the excess will be discarded) ... ... @@ -1554,11 +1554,13 @@ 1554 1554 Failed: multi 1555 1555 1556 1556 ((( 1557 -== **sms_get_state(number id)** == 1673 +== **9.3 sms_get_state(number id)** == 1558 1558 ))) 1559 1559 1560 -**Function:** Get the status of the SMS1676 +**Function:** 1561 1561 1678 +Get the status of the SMS 1679 + 1562 1562 **parameter:** 1563 1563 1564 1564 //id~:// SMS corresponding id ... ... @@ -1570,11 +1570,13 @@ 1570 1570 Failed: multi 1571 1571 1572 1572 ((( 1573 -== **jwt_encode(table head, table payload, string aud, number iat, number exp, string key, int jwttype)** == 1691 +== **9.4 jwt_encode(table head, table payload, string aud, number iat, number exp, string key, int jwttype)** == 1574 1574 ))) 1575 1575 1576 -**Function:** Convert data to JWT format1694 +**Function:** 1577 1577 1696 +Convert data to JWT format 1697 + 1578 1578 **parameter:** 1579 1579 1580 1580 //aud: //project name ... ... @@ -1619,20 +1619,19 @@ 1619 1619 1620 1620 //key~:// the private key required for encryption 1621 1621 1622 - **For example:**1742 +For example: 1623 1623 1624 -{{code language="LUA"}} 1625 1625 function jwt.main() 1626 1626 1627 -local PRIVATE_KEY = [[-- Please enter the secret key--]] 1746 +local PRIVATE_KEY = ~[~[~-~- Please enter the secret key~-~-]] 1628 1628 1629 1629 local JWTType=0 1630 1630 1631 -local payload = {{key="test1",value="test1",type="0"}, 1750 +local payload = ~{~{key="test1",value="test1",type="0"}, 1632 1632 1633 1633 {key="test",value="123122131",type="1"}} 1634 1634 1635 -local head = {{ key="name",value="data",type="0"}, 1754 +local head = ~{~{ key="name",value="data",type="0"}, 1636 1636 1637 1637 {key="test2",value="test2",type="0"}} 1638 1638 ... ... @@ -1647,14 +1647,15 @@ 1647 1647 print(en) 1648 1648 1649 1649 End 1650 -{{/code}} 1651 1651 1652 1652 ((( 1653 -== **convertohex(number type, number value)** == 1771 +== **9.5 convertohex(number type, number value)** == 1654 1654 ))) 1655 1655 1656 -**Function:** Convert data into hexadecimal data1774 +**Function:** 1657 1657 1776 +Convert data into hexadecimal data 1777 + 1658 1658 **parameter:** 1659 1659 1660 1660 //type~:// incoming data type 0:word 1:dword 2:float ... ... @@ -1667,87 +1667,14 @@ 1667 1667 1668 1668 Failed: multi 1669 1669 1670 -== **crc.init(table prarm)** == 1671 - 1672 -**Function:** Initialize the CRC 1673 - 1674 -**Parameters:** 1675 - 1676 -prarm is a Lua table and needs to contain the following fields. 1677 - 1678 -* 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. 1679 -* number prarm.width: the width, i.e. the number of CRC bits. 1680 -* 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. 1681 -* number [prarm.init]: the initialization preset value of the register (crc) at the beginning of the algorithm in hexadecimal. 1682 -* number [prarm.xorout]: the final CRC value obtained after heterodyning the calculation result with this parameter. 1683 -* number [prarm.refin]: whether each byte of the data to be measured is inverted by bit, true or false. 1684 -* number [prarm.refout]: after the calculation or before the heterodyning output, whether the whole data is inverted by bit, true or false. 1685 - 1686 -Return: 1687 - 1688 -Success: crc object 1689 - 1690 -Failure: multi, error code 1691 - 1692 -|=Parameter model name|=poly|=init|=xorout|=refin|=refout 1693 -|crc8|0x07|0x00|0x00|false|false 1694 -| | | |0x00| | 1695 -| | | |0x00| | 1696 -| | | |0x00| | 1697 -| | | |0x00| | 1698 -| | | |0x00| | 1699 -| | | |0X55| | 1700 -| | | |0x00| | 1701 -| | | |0x00| | 1702 -| | | |0x00| | 1703 -| | | |0xFF| | 1704 -| | | |0x00| | 1705 -| | |0x3791|0x0000| | 1706 -| | |0x6363|0x0000| | 1707 -| | |0x554D|0x0000| | 1708 -| | |0xFFFF|0x0000| | 1709 -| | |0x0000|0x0000| | 1710 -| | |0X1D0F|0x0000| | 1711 -| | | |0x0000| | 1712 -| | |0xFFFF|0x0000| | 1713 -| | |0x800D|0x0000| | 1714 -| | |0x0000|0x0001| | 1715 -| | |0x0000|0x0000| | 1716 -| | |0x0000|0xFFFF| | 1717 -| | |0x0000|0xFFFF| | 1718 -| | |0xFFFF|0xFFFF| | 1719 -| | |0x0000|0xFFFF| | 1720 -| | |0xFFFF|0x0000| | 1721 -| | |0x0000|0x0000| | 1722 -| | |0x0000|0x0000| | 1723 -| | |0xFFFF|0xFFFF| | 1724 -| | |0x0000|0x0000| | 1725 -| | |0xFFFF|0x0000| | 1726 -| | |0xFFFF|0xFFFF| | 1727 -| | |0x0000|0x0000| | 1728 -| | |0xFFFFFFFF|0xFFFFFFFF| | 1729 -| | |0xFFFFFFFF|0xFFFFFFFF| | 1730 -| | |0xFFFFFFFF|0xFFFFFFFF| | 1731 -| | |0xFFFFFFFF|0xFFFFFFFF| | 1732 -| | |0xFFFFFFFF|0x00000000| | 1733 -| | |0x00000000|0xFFFFFFFF| | 1734 -| | |0x00000000|0x00000000| | 1735 -| | |0xFFFFFFFF|0x00000000| | 1736 -| | |0x00000000|0x00000000| | 1737 -| | |0x0000000000000000|0x0000000000000000| | 1738 -| | |0xFFFFFFFFFFFFFFFF|0xFFFFFFFFFFFFFFFF| | 1739 -| | |0xFFFFFFFFFFFFFFFF|0xFFFFFFFFFFFFFFFF| | 1740 -| | |0xFFFFFFFFFFFFFFFF|0xFFFFFFFFFFFFFFFF| | 1741 -| | | | | | 1742 -| | | | | | 1743 -| | | | | | 1744 - 1745 1745 ((( 1746 -== **set_network(table config)** == 1791 +== **9.6 set_network(table config)** == 1747 1747 ))) 1748 1748 1749 -**Function:** Set V-BOX network, take effect after restart1794 +**Function:** 1750 1750 1796 +Set V-BOX network, take effect after restart 1797 + 1751 1751 **parameter:** 1752 1752 1753 1753 //config~:// incoming network configuration table