Changes for page 01 Lua Functions

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 port
	633	+**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 port
	673	+**Function:**
672	672
673		-**Parameters: **//Obj //is the object returned by serial.open
	675	+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 data
	691	+**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 data
	711	+**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 buffer
	729	+**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 object
	747	+**Function:**
736	736
737		-**Parameters:** None
	749	+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 object
	787	+**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 //is the objeced returned by mqtt.create
	817	+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 server
	833	+**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 server
	881	+**Function:**
848	848
849		-**Parameters: **//[timeout=10000] //Disconnect waiting timeout, in milliseconds
	883	+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 server
	899	+**Function:**
862	862
863		-**Parameters:** None
	901	+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 topic
	937	+**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 message
	955	+**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:** None
	983	+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 function
	999	+**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
...	...	@@ -958,17 +958,20 @@
958	958
959	959	Parameter:
960	960
961		-* //Topic//, topic name
962		-* //Message//, content
	1015	+//Topic//, topic name
963	963
964		-**2."arrived" is published by publish, this function will be called after the publication arrives**
	1017	+//Message//, content
965	965
	1019	+**2.**"arrived" is published by publish, this function will be called after the publication arrives
	1020	+
966	966	//Callback// prototype~:// function ()//
967	967
968		-Parameter: None
	1023	+Parameter:
969	969
970		-**3.This function will be called after the "offline" connection is lost**
	1025	+None
971	971
	1027	+**3.**This function will be called after the "offline" connection is lost
	1028	+
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()** ==
	1042	+== **4.11 mqtt:setup_cfg()** ==
986	986	)))
987	987
988		-**Function:** Cloud mode interface, to obtain MQTT information configured by the cloud platform
	1045	+**Function:**
989	989
990		-**Parameters:** None
	1047	+Cloud mode interface, to obtain MQTT information configured by the cloud platform
991	991
	1049	+**Parameters:**
	1050	+
	1051	+None
	1052	+
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 )** ==
	1070	+== **5.1 json.encode( lua_object )** ==
1010	1010	)))
1011	1011
1012		-**Function: **Convert lua data type to json string
	1073	+**Function:**
1013	1013
1014		-**Parameters: **Lua data type (including boolean, number, string, table)
	1075	+Convert lua data type to json string
1015	1015
1016		-**Return：** Json format string
	1077	+**Parameters:**
1017	1017
	1079	+Lua data type (including boolean, number, string, table)
	1080	+
	1081	+**Return：**
	1082	+
	1083	+Json format string
	1084	+
1018	1018	(((
1019		-== **json.decode(string json_string)** ==
	1086	+== **5.2 json.decode(string json_string)** ==
1020	1020	)))
1021	1021
1022		-**Function:** Convert json string to lua data type
	1089	+**Function:**
1023	1023
1024		-**Parameters: **//json_string//, string of json data structure
	1091	+Convert json string to lua data type
1025	1025
1026		-**Return: **Lua data type
	1093	+**Parameters:**
1027	1027
	1095	+//json_string//, string of json data structure
	1096	+
	1097	+**Return：**
	1098	+
	1099	+Lua data type
	1100	+
1028	1028	(((
1029		-== **json.null** ==
	1102	+== **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:** None
	1109	+**Parameters:**
1037	1037
1038		-**Return: **None
	1111	+None
1039	1039
	1113	+**Return：**
	1114	+
	1115	+None
	1116	+
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()** ==
	1122	+== **6.1 bns_get_alldata()** ==
1046	1046	)))
1047	1047
1048		-**Function:** Obtain all monitoring points (point table) data configured by the end user
	1125	+**Function:**
1049	1049
1050		-**✎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
	1127	+Obtain all monitoring points (point table) data configured by the end user
1051	1051
1052		-**Parameters:** None
	1129	+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
	1131	+**Parameters:**
	1132	+
	1133	+None
	1134	+
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)** ==
	1164	+== **6.2 bns_get_config(string from)** ==
1084	1084	)))
1085	1085
1086		-**Function:** Obtain custom configuration parameters with the specified from type
	1167	+**Function:**
1087	1087
	1169	+Obtain custom configuration parameters with the specified from type
	1170	+
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)** ==
	1188	+== **6.3 bns_get_data(string name, string data)** ==
1106	1106	)))
1107	1107
1108		-**Function:**write data to the name of the monitoring point
	1191	+**Function:**
1109	1109
	1193	+write data to the name of the monitoring point
	1194	+
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)** ==
	1208	+== **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()** ==
	1226	+== **6.5 bns_get_datadesc()** ==
1142	1142	)))
1143	1143
1144		-**Function: **Obtain all configured communication ports and monitoring point information
	1229	+**Function:**
1145	1145
1146		-**Parameters:** None
	1231	+Obtain all configured communication ports and monitoring point information
1147	1147
	1233	+**Parameters:**
	1234	+
	1235	+None
	1236	+
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()** ==
	1289	+== **6.6 bns_get_machineinfo()** ==
1201	1201	)))
1202	1202
1203		-**Function:** get machine information
	1292	+**Function:**
1204	1204
1205		-**Parameters:** None
	1294	+get machine information
1206	1206
	1296	+**Parameters:**
	1297	+
	1298	+None
	1299	+
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)** ==
	1307	+== **6.7 bns_get_groupdata(string name)** ==
1215	1215	)))
1216	1216
1217		-**Function:** Get all monitoring point data under the specified group name
	1310	+**Function:**
1218	1218
	1312	+Get all monitoring point data under the specified group name
	1313	+
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()** ==
	1325	+== **6.8 bns_get_groupdesc()** ==
1231	1231	)))
1232	1232
1233		-**Function:** Get all group information
	1328	+**Function:**
1234	1234
1235		-**Parameters:** None
	1330	+Get all group information
1236	1236
	1332	+**Parameters:**
	1333	+
	1334	+None
	1335	+
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)** ==
	1349	+== **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.
	1352	+**Function:**
1254	1254
1255		-**Parameters: **//msg// String
	1354	+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
	1356	+**Parameters:**
	1357	+
	1358	+//msg// String
	1359	+
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()** ==
	1367	+== **6.10 bns_get_allcache()** ==
1265	1265	)))
1266	1266
1267		-**Function:** Get all the cached content (once the internal cache file will be emptied)
	1370	+**Function:**
1268	1268
1269		-**Parameters:** None
	1372	+Get all the cached content (once the internal cache file will be emptied)
1270	1270
	1374	+**Parameters:**
	1375	+
	1376	+None
	1377	+
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** ==
	1405	+== **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** ==
	1410	+(((
	1411	+= **8 Internal register** =
	1412	+)))
1304	1304
1305		-Example：
	1414	+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")
	1416	+**~1. **Access by word, prefix @W_HDW,
1309	1309
1310		-local https = require("https")
	1418	+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		-functions https_demo.main()
	1420	+**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		-local url = "https://XXXXXXXXXXXXXXXXXXXXXXXXXX"
	1422	+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		-local body = {}
	1424	+**✎Note: **
1317	1317
1318		-body["XXXXXX"] = "XXXXX"
	1426	+**~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"
	1428	+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		-local bodyJson = json.encode(body)
	1430	+**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 = {}
	1432	+(((
	1433	+== **8.1 Data storage area（HDW/HDX）** ==
	1434	+)))
1325	1325
1326		-header["content-type"] = "application/json"
	1436	+The system storage area (HDW) of the V-BOX is used to store temporary data:
1327	1327
1328		-local result_table, code, headers, status = https.request(url,
	1438	+~1. Access by word, the number range is: "@W_HDW0"-"@W_HDW299999".
1329	1329
1330		-bodyJson)
	1440	+2. Access in bit mode, the number range is: "@B_HDX0.0"-"@B_HDX299999.15".
1331	1331
1332		-if code == 200 then
	1442	+(((
	1443	+== **8.2 Special data area (HSW/HSX)** ==
	1444	+)))
1333	1333
1334		-print("https suc")
	1446	+**✎Note: **
1335	1335
1336		-return true
	1448	+//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
	1450	+//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		-print("https fail")
	1452	+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
	1454	+(% class="table-bordered" %)
	1455	+|address|function|Read and write status: read only, write only, read and write
	1456	+|@W_HSW0|restart|read and write
	1457	+|@W_HSW1|Box time: year|read and write
	1458	+|@W_HSW2|Box time: month|read and write
	1459	+|@W_HSW3|Box time: day|read and write
	1460	+|@W_HSW4|Box time: hour|read and write
	1461	+|@W_HSW5|Box time: minute|read and write
	1462	+|@W_HSW6|Box time: second|read and write
	1463	+|@W_HSW7|Box time: week|read and write
	1464	+|@W_HSW8|Ethernet IP1|read only
	1465	+|@W_HSW9|Ethernet IP2|read only
	1466	+|@W_HSW10|Ethernet IP3|read only
	1467	+|@W_HSW11|Ethernet IP4|read only
	1468	+|@W_HSW12|Ethernet Mask 1|read only
	1469	+|@W_HSW13|Ethernet Mask 2|read only
	1470	+|@W_HSW14|Ethernet Mask 3|read only
	1471	+|@W_HSW15|Ethernet Mask 4|read only
	1472	+|@W_HSW16|Ethernet Gateway 1|read only
	1473	+|@W_HSW17|Ethernet Gateway 2|read only
	1474	+|@W_HSW18|Ethernet Gateway 3|read only
	1475	+|@W_HSW19|Ethernet Gateway 4|read only
	1476	+|@W_HSW21|Ethernet MAC1|read only
	1477	+|@W_HSW22|Ethernet MAC2|read only
	1478	+|@W_HSW23|Ethernet MAC3|read only
	1479	+|@W_HSW24|Ethernet MAC4|read only
	1480	+|@W_HSW25|Ethernet MAC3|read only
	1481	+|@W_HSW26|Ethernet MAC4|read only
	1482	+|@W_HSW128|WIFI IP1|read only
	1483	+|@W_HSW129|WIFI IP2|read only
	1484	+|@W_HSW130|WIFI IP3|read only
	1485	+|@W_HSW131|WIFI IP4|read only
	1486	+|@W_HSW132|WIFI Mask 1|read only
	1487	+|@W_HSW133|WIFI Mask 2|read only
	1488	+|@W_HSW134|WIFI Mask 3|read only
	1489	+|@W_HSW135|WIFI Mask 4|read only
	1490	+|@W_HSW136|WIFI Gateway 1|read only
	1491	+|@W_HSW137|WIFI Gateway 2|read only
	1492	+|@W_HSW138|WIFI Gateway 3|read only
	1493	+|@W_HSW139|WIFI Gateway 4|read only
	1494	+|@W_HSW140|WIFI MAC1|read only
	1495	+|@W_HSW141|WIFI MAC2|read only
	1496	+|@W_HSW142|WIFI MAC3|read only
	1497	+|@W_HSW143|WIFI MAC4|read only
	1498	+|@W_HSW144|WIFI MAC5|read only
	1499	+|@W_HSW145|WIFI MAC6|read only
	1500	+|@W_HSW146|WIFI Signal value|read only
	1501	+|@W_HSW148|4G IP1|read only
	1502	+|@W_HSW149|4G IP2|read only
	1503	+|@W_HSW150|4G IP3|read only
	1504	+|@W_HSW151|4G IP4|read only
	1505	+|@W_HSW152|4G Mask 1|read only
	1506	+|@W_HSW153|4G Mask 2|read only
	1507	+|@W_HSW154|4G Mask 3|read only
	1508	+|@W_HSW155|4G Mask 4|read only
	1509	+|@W_HSW156|4G Gateway 1|read only
	1510	+|@W_HSW157|4G Gateway 2|read only
	1511	+|@W_HSW158|4G Gateway 3|read only
	1512	+|@W_HSW159|4G Gateway 4|read only
	1513	+|@W_HSW160|4G MAC1|read only
	1514	+|@W_HSW161|4G MAC2|read only
	1515	+|@W_HSW162|4G MAC3|read only
	1516	+|@W_HSW163|4G MAC4|read only
	1517	+|@W_HSW164|4G MAC5|read only
	1518	+|@W_HSW165|4G MAC6|read only
	1519	+|@W_HSW166|4G Signal value|read only
1343	1343
1344		-end
	1521	+2. Other
1345	1345
1346		-end
1347		-{{/code}}
	1523	+2.1 Access password: addr_getstring("@W_HSW27", 16)
1348	1348
1349		-(((
1350		-= **8 Internal register** =
1351		-)))
	1525	+2.2 Machine code: addr_getstring("@W_HSW60", 64)
1352	1352
1353		-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):
	1527	+2.3 Positioning method (@W_HSW167): (read only)
1354	1354
1355		-**Access by word, prefix @W_HDW.**
	1529	+~1. Latitude and longitude
1356	1356
1357		-For example: @W_HDW0 represents the first word of the system data area, @W_HDW1 represents the second word of the system data area.
	1531	+Longitude: addr_getdouble("@W_HSW168") (read only)
1358	1358
1359		-**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.**
	1533	+Latitude: addr_getdouble("@W_HSW172") (read only)
1360	1360
1361		-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.
	1535	+2. Base station positioning
1362	1362
1363		-(% class="box infomessage" %)
1364		-(((
1365		-**✎Note: **
	1537	+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		-)))
	1539	+CI: addr_getdword("@W_HSW172") (read only)
1371	1371
	1541	+2.4 Convert base station to latitude and longitude via API
1372	1372
1373		-(((
1374		-== **Data storage area（HDW/HDX）** ==
1375		-)))
	1543	+Longitude: addr_getdouble("@W_HSW187") (read only)
1376	1376
1377		-The system storage area (HDW) of the V-BOX is used to store temporary data:
	1545	+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".
	1547	+2.5 Operator information: addr_getdword("@W_HSW181") (read only)
1381	1381
1382		-(((
1383		-== **8.2 Special data area (HSW/HSX)** ==
	1549	+2.6 Networking mode: addr_getword("@W_HSW177") (read only)
1384	1384
1385		-(% class="box infomessage" %)
1386		-(((
1387		-**✎Note: **
	1551	+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		-)))
	1553	+2.7 Map fence flag: addr_getword("@W_HSW178") (read only)
1393	1393
1394		-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:
	1555	+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
	1557	+1: Draw a map fence and the box is in the fence
1462	1462
1463		-**Others**
	1559	+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)
	1561	+2.8 SIM card status addr_getword("@W_HSW179") (read only)
1501	1501
1502		-(((
1503		-== **Power-down storage area (HAW/HAX)** ==
	1563	+1: No card detected
1504	1504
1505		-The system storage area (HAW) is used for the system power-down hold registers:
	1565	+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".
	1567	+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		-)))
	1569	+2.9 MQTT status addr_getword("@W_HSW180") (read only)
1514	1514
	1571	+1: online, 2: offline
	1572	+
	1573	+2.10 IO interface, X is read only, Y is read and write (H series)
	1574	+
	1575	+addr_getbit(addr1), addr_setbit(addr2)
	1576	+
	1577	+addr1:"@B_Y0" "@B_Y1" "@B_X0" "@B_X1"
	1578	+
	1579	+addr2:"@B_Y0" "@B_Y1"
	1580	+
	1581	+(((
1515	1515	= **9 General Functions** =
1516	1516	)))
1517	1517
1518	1518	(((
1519		-== **send_sms_ira(string number, string message)** ==
	1586	+== **9.1 send_sms_ira(string number, string message)** ==
1520	1520	)))
1521	1521
1522		-**Function:** Use IRA character set to send English text messages
	1589	+**Function:**
1523	1523
	1591	+Use IRA character set to send English text messages
	1592	+
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)** ==
	1626	+== **9.3 sms_get_state(number id)** ==
1558	1558	)))
1559	1559
1560		-**Function:** Get the status of the SMS
	1629	+**Function:**
1561	1561
	1631	+Get the status of the SMS
	1632	+
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)** ==
	1644	+== **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 format
	1647	+**Function:**
1577	1577
	1649	+Convert data to JWT format
	1650	+
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:**
	1695	+For example:
1623	1623
1624		-{{code language="LUA"}}
1625	1625	function jwt.main()
1626	1626
1627		-local PRIVATE_KEY = [[-- Please enter the secret key--]]
	1699	+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"},
	1703	+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"},
	1707	+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)** ==
	1724	+== **9.5 convertohex(number type, number value)** ==
1654	1654	)))
1655	1655
1656		-**Function:** Convert data into hexadecimal data
	1727	+**Function:**
1657	1657
	1729	+Convert data into hexadecimal data
	1730	+
1658	1658	**parameter:**
1659	1659
1660	1660	//type~:// incoming data type 0:word 1:dword 2:float
...	...	@@ -1667,381 +1667,106 @@
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	1692	(((
1693		-|=Parameter model name|=poly|=init|=xorout|=refin|=refout
1694		-|crc8|0x07|0x00|0x00|false|false
1695		-|crc8_cdma2000|0x9B|0xFF|0x00|false|false
1696		-|crc8_darc|0x39|0x00|0x00|true|true
1697		-|crc8_dvb_s2|0xD5|0x00|0x00|false|false
1698		-|crc8_ebu|0x1D|0xFF|0x00|true|true
1699		-|crc8_i_code|0x1D|0xFD|0x00|false|false
1700		-|crc8_itu|0x07|0x00|0x55|false|false
1701		-|crc8_maxim|0x31|0x00|0x00|true|true
1702		-|crc8_rohc|0x07|0xFF|0x00|true|true
1703		-|crc8_wcdma|0x9B|0x00|0x00|true|true
1704		-|crc8_sae_j1850|0x1D|0xFF|0xFF|false|false
1705		-|crc8_opensafety|0x2F|0x00|0x00|false|false
1706		-|crc16_tms37157|0x1021|0x3791|0x0000|true|true
1707		-|crc16_a|0x1021|0x6363|0x0000|true|true
1708		-|crc16_riello|0x1021|0x554D|0x0000|true|true
1709		-|crc16_ccitt_false|0x1021|0xFFFF|0x0000|false|false
1710		-|crc16_arc|0x8005|0x0000|0x0000|true|true
1711		-|crc16_arc_ccitt|0x1021|0x1D0F|0x0000|false|false
1712		-|crc16_buypass|0x8005|0x0000|0x0000|false|false
1713		-|crc16_cdma2000|0xC867|0xFFFF|0x0000|false|false
1714		-|crc16_dds110|0x8005|0x800D|0x0000|false|false
1715		-|crc16_dect_r|0x0589|0x0000|0x0001|false|false
1716		-|crc16_dect_x|0x0589|0x0000|0x0000|false|false
1717		-|crc16_dnp|0x3D65|0x0000|0xFFFF|true|true
1718		-|crc16_en_13757|0x3D65|0x0000|0xFFFF|false|false
1719		-|crc16_genibus|0x1021|0xFFFF|0xFFFF|false|false
1720		-|crc16_maxim|0x8005|0x0000|0xFFFF|true|true
1721		-|crc16_mcrf4xx|0x1021|0xFFFF|0x0000|true|true
1722		-|crc16_t10_dif|0x8BB7|0x0000|0x0000|false|false
1723		-|crc16_teledisk|0xA097|0x0000|0x0000|false|false
1724		-|crc16_usb|0x8005|0xFFFF|0xFFFF|true|true
1725		-|crc16_kermit|0x1021|0x0000|0x0000|true|true
1726		-
1727		-(% class="wikigeneratedid" %)
1728		-Table 9-1
1729		-
1730		-== **crc:calc(string crcValue)** ==
1731		-
1732		-**Function:** Calculate CRC result
1733		-
1734		-**Parameter:**
1735		-
1736		-crcValue: the value to be calculated
1737		-
1738		-**Return:**
1739		-
1740		-Succeed: calculated result
1741		-
1742		-Failed: multi, error code
	1744	+== **9.6 set_network(table config)** ==
1743	1743	)))
1744	1744
1745		-Example:
	1747	+**Function:**
1746	1746
1747		-{{code language="LUA"}}
1748		-function crcTest.main()
	1749	+Set V-BOX network, take effect after restart
1749	1749
1750		-local param = {
	1751	+**parameter:**
1751	1751
1752		-name = '',
	1753	+//config~:// incoming network configuration table
1753	1753
1754		-width = 64,
	1755	+1. connectMode: the way V-BOX connects to the server, 0: Ethernet, 1: WIFI, 2: 4G, 3: 2G, it is not allowed to be empty.
	1756	+1. ethernetEnable: Whether to enable Ethernet, 1: enable, 0: disable, and it is not allowed to be empty.
	1757	+1. ethernetLanIp: Set the LAN IP address. Only V-BOX with three network ports support this configuration, and other models of V-BOX do not support setting LAN IP. This item is allowed to be empty.
	1758	+1. ethernetIpMode: Whether to enable Ethernet static IP, 1: Enable static IP, 0: DHCP, not allowed to be empty.
	1759	+1. ethernetIp: The IP address needs to be configured when the Ethernet static IP is used, and it is not allowed to be empty.
	1760	+1. ethernetNetmask: The subnet mask needs to be configured when Ethernet static IP is used, and it is not allowed to be empty.
	1761	+1. ethernetGateway: The gateway can be configured when Ethernet static IP is used.
1755	1755
1756		-poly = 0x42F0E1EBA9EA3693,
	1763	+1. When using the Ethernet network, if the Gateway is empty, V-BOX will not connect to the server.
	1764	+1. If you only use Ethernet to directly connect to the PLC for communication, you do not need to configure a gateway.
1757	1757
1758		-init = 0xFFFFFFFFFFFFFFFF,
	1766	+1. ethernetFirstDns: You can configure the preferred DNS server when the Ethernet static IP is used, and it is allowed to be empty. If you use the Ethernet network and do not fill in the DNS server, V-BOX will not be connected to the server.
	1767	+1. ethernetSpareDns: Alternate DNS server can be configured when the Ethernet static IP is used, and it is allowed to be empty.
	1768	+1. wifiEnable: Whether to enable WIFI, 1: enable, 0: disable, it is not allowed to be empty. If it is a model that does not include WIFI, directly disable it.
	1769	+1. wifiName: WIFI name, if WIFI is enabled, it is not allowed to be empty.
	1770	+1. wifiPassword: WIFI password, it is allowed to be empty.
	1771	+1. wifiIpMode: Whether to enable WIFI static IP, 1: Enable static IP, 0: DHCP, not allowed to be empty.
	1772	+1. wifiIp: IP address needs to be configured when WIFI static IP is used, it is not allowed to be empty.
	1773	+1. wifiNetmask: The subnet mask needs to be configured when WIFI static IP is used, and it is not allowed to be empty.
	1774	+1. wifiGateway: The gateway can be configured when WIFI static IP is used, and it is not allowed to be empty.
	1775	+1. wifiFirstDns: You can configure the preferred DNS server when the WIFI static IP is used, and it is allowed to be empty. If you use the WIFI network and do not fill in the DNS server, V-BOX will not be connected to the server.
	1776	+1. wifiSpareDns: Alternate DNS server can be configured when the WIFI static IP is used, and it is allowed to be empty.
	1777	+1. mobileEnable: Whether to enable the mobile network, 1: enable, 0: disable, it is not allowed to be empty, if it does not include 4G models, directly disable it.
	1778	+1. mobileApnMode: Whether to manually configure the APN, 0: Use the default APN, 1: Manually configure the APN, it is not allowed to be empty.
	1779	+1. apnName: APN name, if you choose to manually configure APN, it is not allowed to be empty.
	1780	+1. apnPassword: APN username, it is allowed to be empty.
	1781	+1. apnUserName: APN number, it is allowed to be empty.
	1782	+1. apnNumber: APN number, it is allowed to be empty.
1759	1759
1760		-xorout = 0xFFFFFFFFFFFFFFFF,
1761		-
1762		-refin = 1,
1763		-
1764		-refout = 1
1765		-
1766		-}
1767		-
1768		-crc64,err = crc.init(param)
1769		-
1770		-if not crc64 then
1771		-
1772		-print("Crc init failed:", err)
1773		-else
1774		-
1775		-crcvalue = crc64:calc("123456789")
1776		-
1777		-print(string.format("crc64 calc :0X%16X", crcvalue))
1778		-
1779		-end
1780		-
1781		-end
1782		-{{/code}}
1783		-
1784		-= **10 Special function for V-NET** =
1785		-
1786		-== **normal_get_alldata()** ==
1787		-
1788		-**Function: **Obtain the data of all the monitoring points
1789		-
1790		-**Parameter: None**
1791		-
1792	1792	**Return:**
1793	1793
1794		-Succeed: table two-dimensional arrays, as follows:
	1786	+Succeed: true
1795	1795
1796		-* Each item is a monitoring point and contains 4 attributes:
1797		-** 1: ID
1798		-** 2: status
1799		-** 3: tag name
1800		-** 4: value
1801		-* Status contains 3 enumerated values
1802		-** 0: offline
1803		-** 1: online
1804		-** 2: timeout
1805		-* Customization returns an empty table if there is no configuration, otherwise returns "field name/field content"
	1788	+Faied: multi
1806	1806
1807		-For example:
	1790	+(((
	1791	+== **9.7 remote_com_start(string config)** ==
	1792	+)))
1808	1808
1809		-{
	1794	+**Function:**
1810	1810
1811		-[1]= {[1]=1234, [2]=1, [3]='temp', [4]='23.5'},
	1796	+start serial port pass-through
1812	1812
1813		-[2]= {[1]=1235, [2]=1, [3]='humi', [4]='67'},
1814		-
1815		-...
1816		-
1817		-[n]= {[1]=xxxx, [2]=x, [3]='xxxx', [4]='xx.x'},
1818		-
1819		-}
1820		-
1821		-Failed: table, empty table
1822		-
1823		-== **normal_setdata_byname(string name, string data)** ==
1824		-
1825		-**Function:** Write data to the monitoring point name
1826		-
1827	1827	**Parameter:**
1828	1828
1829		-name: the name of monitoring point
	1800	+//config: //incoming serial port parameter configuration, JSON format
1830	1830
1831		-data: the data to be written
	1802	+1. type:0, serial port pass-through
	1803	+1. port: serial port number marked on the V-BOX
	1804	+1. comtype:0-RS232, 1-RS485, 2-RS422
	1805	+1. baudrate: Baud Rate
	1806	+1. data_length: Data Bits
	1807	+1. stop_bit: Stop Bit
	1808	+1. check_bit: Check Bit
1832	1832
1833	1833	**Return:**
1834	1834
1835		-Succeed: string: The value of the monitor point before it is written
	1812	+Succeed: true
1836	1836
1837		-Failed: mil
	1814	+Failed: multi
1838	1838
1839		-== **normal_getdata_byname(string name)** ==
	1816	+(((
	1817	+== **9.8 remote_com_stop()** ==
	1818	+)))
1840	1840
	1820	+**Function:**
1841	1841
	1822	+close serial port pass-through
1842	1842
1843		-**Function:** Read the data of the monitoring point name
1844		-
1845		-**Parameter:**
1846		-
1847		-name: the name of monitoring point
1848		-
1849	1849	**Return:**
1850	1850
1851		-Succeed: string
	1826	+Succeed: true
1852	1852
1853		-Failed: mil
1854		-
1855		-= **11 MySQL database operation** =
1856		-
1857		-== **luaMySql.init(string sourcename, string username, string password, string host, number port, string character)** ==
1858		-
1859		-**Function:** Configure database connection parameters
1860		-
1861		-**Parameter:**
1862		-
1863		-sourcename: the name of database
1864		-
1865		-username: the username of the connection
1866		-
1867		-password: the password of the connection
1868		-
1869		-host: the host name of the connection
1870		-
1871		-port: the host port of the connection
1872		-
1873		-character: the character set of the connection
1874		-
1875		-**Return:**
1876		-
1877		-Succeed: string
1878		-
1879	1879	Failed: multi
1880	1880
1881		-== **luaMySql.exec(string statement)** ==
	1830	+(((
	1831	+== **9.9 remote_com_state()** ==
	1832	+)))
1882	1882
1883		-**Function:** Execute the given SQL statement without returning the result set (add, delete, change)
	1834	+**Function:**
1884	1884
1885		-**Parameter:**
	1836	+query the serial port pass-through status and pass-through server domain name and port
1886	1886
1887		-statement: the given SQL statement
1888		-
1889	1889	**Return:**
1890	1890
1891		-Succeed: status: returns the number of rows affected by SQL statement execution.
	1840	+Succeed:
1892	1892
1893		-Failed: mil, errorString
	1842	+1. number, current pass-through status: 0-none 1,2-starting pass-through 3-penetrating 4,5-finishing pass-through 6-pass-through error
	1843	+1. string, pass-through server domain name and port number, xxxx (domain name): xxx (port number)
1894	1894
1895		-== **luaMySql.execWithResult(string statement)** ==
1896		-
1897		-**Function:** Execute the given SQL statement returning the result set (check)
1898		-
1899		-**Parameter:**
1900		-
1901		-statement: the given SQL statement
1902		-
1903		-**Return:**
1904		-
1905		-Succeed: table: returns the result set
1906		-
1907		-Failed: mil, errorString
1908		-
1909		-For example:
1910		-
1911		-{{code language="LUA"}}
1912		-mysql = require"mysqlclient"
1913		-
1914		-function DataInitRight()
1915		-
1916		-local dbName = "db_lua1"
1917		-
1918		-local user = "root"
1919		-
1920		-local pwd = "123456"
1921		-
1922		-local host = "192.168.56.186"
1923		-
1924		-local port = 3306
1925		-local character = "UTF8"
1926		-
1927		-mysql.init(dbName, user, pwd, host, port, character)
1928		-
1929		-end
1930		-
1931		-function ExecFunc()
1932		-
1933		-status, errorString = mysql.exec("delete from tb_lua1 where mykey =
1934		-
1935		-10;")
1936		-
1937		-if nil == status then
1938		-
1939		-print("ExecFunc() error:", errorString)
1940		-
1941		-return -1
1942		-
1943		-else
1944		-
1945		-print("the number of rows affected by the command:", status)
1946		-
1947		-end
1948		-
1949		-return 0
1950		-
1951		-end
1952		-
1953		-function ExecWithResultFunc()
1954		-
1955		-status, errorString = mysql.execWithResult("select * from tb_lua1;")
1956		-
1957		-if nil == status then
1958		-
1959		-print("ExecWithResultFunc() error:", errorString)
1960		-
1961		-return -1
1962		-
1963		-else
1964		-
1965		-print("ExecWithResultFunc()
1966		-
1967		-success
1968		-
1969		-: status
1970		-
1971		-type
1972		-
1973		-=
1974		-
1975		-",
1976		-
1977		-type(status))
1978		-
1979		-print("ExecWithResultFunc() success : status len = ", #status)
1980		-
1981		-local num = #status
1982		-
1983		-local i = 1
1984		-
1985		-if num > 0 then
1986		-
1987		-for i = 1, num, 1 do
1988		-
1989		-local var = string.format("select result[%d] :mykey = %d,
1990		-
1991		-value = %s", i, status[i].mykey, status[i].value)
1992		-
1993		-print(var)
1994		-
1995		-end
1996		-
1997		-end
1998		-
1999		-print("---------------")
2000		-
2001		-end
2002		-
2003		-return 0
2004		-end
2005		-
2006		-function luaMysql_apiTest.main()
2007		-
2008		-print("script running ...")
2009		-
2010		-DataInitRight()
2011		-
2012		---use exec demo
2013		-
2014		-if ExecFunc() < 0 then
2015		-
2016		-return
2017		-
2018		-end
2019		-
2020		---use execWithResult demo
2021		-
2022		-if ExecWithResultFunc() < 0 then
2023		-
2024		-return
2025		-
2026		-end
2027		-
2028		-print("script running success")
2029		-
2030		-end
2031		-{{/code}}
2032		-
2033		-= **12 Message summary algorithm** =
2034		-
2035		-== **hmac(string hash_func, string key, string message)** ==
2036		-
2037		-**Function:** Execute the given SQL statement returning the result set (check)
2038		-
2039		-**Parameter:**
2040		-
2041		-statement: the given SQL statement
2042		-
2043		-**Return:**
2044		-
2045		-Succeed: table: returns the result set
2046		-
2047		-Failed: mil, errorString
	1845	+Failed: multi