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
-
... ... @@ -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)** == 630 +== **3.1 serial.open(table setup)** == 631 631 ))) 632 632 633 -**Function:** Enable one serial port633 +**Function:** 634 634 635 +Enable one serial port 636 + 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)** == 670 +== **3.2 serial.close(serial obj)** == 669 669 ))) 670 670 671 -**Function:** Disable the serial port673 +**Function:** 672 672 673 - **Parameters: **//Obj //isthe objectreturnedbyserial.open675 +Disable the serial port 674 674 677 +**Parameters:** 678 + 679 +//Obj //is the object returned by serial.open 680 + 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])** == 688 +== **3.3 serial:read(number bytes[, number timeout])** == 683 683 ))) 684 684 685 -**Function:** Read the specified byte length serial port data691 +**Function:** 686 686 693 +Read the specified byte length serial port data 694 + 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)** == 708 +== **3.4 serial:write(string data)** == 701 701 ))) 702 702 703 -**Function:** Write the specified byte length to serial port data711 +**Function:** 704 704 705 - **Parameters:**713 +Write the specified byte length to serial port data 706 706 715 +**Parameters:** 716 + 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])** == 726 +== **3.5 serial:flush([number flag])** == 717 717 ))) 718 718 719 -**Function:** Clear the serial port buffer729 +**Function:** 720 720 731 +Clear the serial port buffer 732 + 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()** == 744 +== **3.6 serial:close()** == 733 733 ))) 734 734 735 -**Function:** Close the serial port object747 +**Function:** 736 736 737 - **Parameters:** None749 +Close the serial port object 738 738 751 +**Parameters:** 752 + 753 +None 754 + 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. 771 +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 773 +1: The message is delivered at least once, but the message may be delivered repeatedly. 774 + 775 +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. 776 + 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)** == 784 +== **4.1 mqtt.create(string serverurl, string clientid)** == 767 767 ))) 768 768 769 -**Function:** Create an MQTT object787 +**Function:** 770 770 789 +Create an MQTT object 790 + 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)** == 812 +== **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)815 +**Function:** 796 796 797 - **Parameters:**//Obj//isthebjecedturnedby mqtt.create817 +Close the specified MQTT object (if the connected server will be disconnected automatically) 798 798 819 +**Parameters:** 820 + 821 +//Obj //is the objeced returned by mqtt.create 822 + 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])** == 830 +== **4.3 mqtt:connect(table conn[, table lwt, table cart])** == 807 807 ))) 808 808 809 -**Function:** Establish a connection to the server833 +**Function:** 810 810 835 +Establish a connection to the server 836 + 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: 841 +//string conn.username//, user name 824 824 843 +//string conn.password//, password 844 + 845 +//number [conn.netway=0]//, networking method, if set error number will use Ethernet method 846 + 847 +* 0: Ethernet 848 +* 1: WIFI 849 +* 2: 4G 850 +* 3: 2G 851 + 852 +//number [conn.keepalive=60]//, keep connected heartbeat interval, in seconds 853 + 854 +//number [conn.cleansession=1]//, empty the session as described below: 855 + 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 863 +//string lwt.topic//, topic 836 836 865 +//string lwt.message//, message 866 + 867 +//number [lwt.qos=0]//, qos value 868 + 869 +//number [lwt.retain=0]//, retain flag 870 + 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])** == 878 +== **4.4 mqtt:disconnect([number timeout])** == 845 845 ))) 846 846 847 -**Function:** Disconnect from the MQTT server881 +**Function:** 848 848 849 - **Parameters: **//[timeout=10000] //Disconnectwaitingtimeout,inmilliseconds883 +Disconnect from the MQTT server 850 850 885 +**Parameters:** 886 + 887 +//[timeout=10000] //Disconnect waiting timeout, in milliseconds 888 + 851 851 **Return:** 852 852 853 853 Succeed: true ... ... @@ -855,13 +855,17 @@ 855 855 Failed: multi 856 856 857 857 ((( 858 -== **mqtt:isconnected()** == 896 +== **4.5 mqtt:isconnected()** == 859 859 ))) 860 860 861 -**Function:** Test whether or not a client is currently connected to the MQTT server899 +**Function:** 862 862 863 - **Parameters:** None901 +Test whether or not a client is currently connected to the MQTT server 864 864 903 +**Parameters:** 904 + 905 +None 906 + 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)** == 914 +== **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)917 +**Function:** 876 876 919 +Subscribe to the topic (before the subscription, the user must first call the connect method to connect to the server) 920 + 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)** == 934 +== **4.7 mqtt:unsubscribe(string topic)** == 891 891 ))) 892 892 893 -**Function:** Unsubscribe topic937 +**Function:** 894 894 939 +Unsubscribe topic 940 + 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])** == 952 +== **4.8 mqtt:publish(string topic, string message, number qos, number retain[, number timeout])** == 907 907 ))) 908 908 909 -**Function:** Publish message955 +**Function:** 910 910 957 +Publish message 958 + 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()** == 978 +== **4.9 mqtt:close()** == 931 931 ))) 932 932 933 -**Function:** Close the mqtt object (the connection to the server will be automatically disconnected)981 +**Function:** 934 934 935 - **Parameters:** None983 +Close the mqtt object (the connection to the server will be automatically disconnected) 936 936 985 +**Parameters:** 986 + 987 +None 988 + 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)** == 996 +== **4.10 mqtt:on(string method, function callback)** == 945 945 ))) 946 946 947 -**Function:** Register event callback function999 +**Function:** 948 948 1001 +Register event callback function 1002 + 949 949 **Parameters:** 950 950 951 951 //method//, It can be message/arrived/offline, these 3 types of events