Changes for page 01 Lua Functions

Last modified by Theodore Xu on 2023/10/26 10:51

From version 5.16
edited by Stone Wu
on 2022/07/12 09:53
Change comment: There is no comment for this version
To version 21.1
edited by Theodore Xu
on 2023/10/26 10:51
Change comment: There is no comment for this version

Summary

Details

Page properties
Parent
... ... @@ -1,1 +1,1 @@
1 -V-BOX.V-Net.1\.User Manual.04 Lua Script.WebHome
1 +V-BOX.V-Net.Manual.04 Lua Script.WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.Stone
1 +XWiki.AiXia
Content
... ... @@ -140,7 +140,7 @@
140 140  
141 141   Table 2-1
142 142  
143 -(% class="box errormessage" %)
143 +(% class="box infomessage" %)
144 144  (((
145 145  **✎Note: **If HLword enters any other value, it will be treated as invalid.
146 146  )))
... ... @@ -608,11 +608,12 @@
608 608  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 +{{code language="LUA"}}
611 611  local setup = {
612 612  
613 613  name = "COM2",
614 614  
615 -mode = 422, ~-~- COM2 does not support RS422
616 +mode = 422, -- COM2 does not support RS422
616 616  
617 617  ...
618 618  
... ... @@ -619,6 +619,7 @@
619 619  }
620 620  
621 621  serial.open(setup)
623 +{{/code}}
622 622  )))
623 623  
624 624  **Data bit:**
... ... @@ -1063,8 +1063,9 @@
1063 1063  
1064 1064  If there is no custom configuration, return an empty table, otherwise, return with "field name/field content"
1065 1065  
1066 -E.g:
1068 +**For example:**
1067 1067  
1070 +{{code language="LUA"}}
1068 1068  {
1069 1069  
1070 1070  [1]= {[1]=1234, [2]=1, [3]='temp', [4]='23.5', [5]={"fruit"="apple"}},
... ... @@ -1077,7 +1077,8 @@
1077 1077  
1078 1078  }
1079 1079  
1080 -Failed: //table// empty table
1083 +Failed: table empty table
1084 +{{/code}}
1081 1081  
1082 1082  (((
1083 1083  == **bns_get_config(string from)** ==
... ... @@ -1157,13 +1157,15 @@
1157 1157  
1158 1158  Type (1: switch, 2: number, 3: string)
1159 1159  
1160 -E.g:
1161 - {
1164 +**For example:**
1162 1162  
1163 -[1]={~-~-The first communication port
1166 +{{code language="LUA"}}
1167 +{
1164 1164  
1165 -[1]={~-~-monitoring point array of the first communication port
1169 +[1]={--The first communication port
1166 1166  
1171 +[1]={--monitoring point array of the first communication port
1172 +
1167 1167  [1]={[1]=11,[2]='data1',[3]=3,[4]=2},
1168 1168  
1169 1169  [2]={[1]=12,[2]='data2',[3]=3,[4]=2},
... ... @@ -1170,23 +1170,23 @@
1170 1170  
1171 1171  ...
1172 1172  
1173 -[n]={[1]=xx,[2]='datan',[3]=x,[4]=x},~-~-n monitoring points
1179 +[n]={[1]=xx,[2]='datan',[3]=x,[4]=x},--n monitoring points
1174 1174  
1175 1175  },
1176 1176  
1177 -[2]=14, ~-~-ID
1183 +[2]=14, --ID
1178 1178  
1179 -[3]='Modbus TCP' ~-~-n monitoring points
1185 +[3]='Modbus TCP' --n monitoring points
1180 1180  
1181 1181  },
1182 1182  
1183 -[2]={~-~-The second communication port
1189 +[2]={--The second communication port
1184 1184  
1185 -[1]={},~-~-The monitoring point of the second communication port is not configured and is empty
1191 +[1]={},--The monitoring point of the second communication port is not configured and is empty
1186 1186  
1187 -[2]=15, ~-~-ID
1193 +[2]=15, --ID
1188 1188  
1189 -[3]='WECON' ~-~-communication protocol name
1195 +[3]='WECON' --communication protocol name
1190 1190  
1191 1191  },
1192 1192  
... ... @@ -1193,6 +1193,7 @@
1193 1193  ...n communication ports and so on
1194 1194  
1195 1195  }
1202 +{{/code}}
1196 1196  
1197 1197  Failed~:// table// empty table
1198 1198  
... ... @@ -1272,8 +1272,9 @@
1272 1272  
1273 1273  Succeed: //table// one-dimensional array
1274 1274  
1275 -E.g:
1282 +**For example:**
1276 1276  
1284 +{{code language="LUA"}}
1277 1277  {
1278 1278  
1279 1279  [1]="This is the oldest message", - the first is the oldest message
... ... @@ -1285,6 +1285,7 @@
1285 1285  [n]="This is the latest message", - the last is the latest message
1286 1286  
1287 1287  }
1296 +{{/code}}
1288 1288  
1289 1289  Failede: nil
1290 1290  
... ... @@ -1302,7 +1302,7 @@
1302 1302  
1303 1303  == **https request** ==
1304 1304  
1305 -Example
1314 +**For example:**
1306 1306  
1307 1307  {{code language="LUA"}}
1308 1308  local json = require("json")
... ... @@ -1347,184 +1347,19 @@
1347 1347  {{/code}}
1348 1348  
1349 1349  (((
1350 -= **8 Internal register** =
1359 +
1351 1351  )))
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):
1354 -
1355 -**Access by word, prefix @W_HDW.**
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.
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.**
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.
1362 -
1363 -(% class="box infomessage" %)
1364 1364  (((
1365 -**✎Note: **
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.
1363 += **8 General Functions** =
1370 1370  )))
1371 1371  
1372 -
1373 -
1374 1374  (((
1375 -== **Data storage area(HDW/HDX)** ==
1367 +== **send_sms_ira(string number, string message)** ==
1376 1376  )))
1377 1377  
1378 -The system storage area (HDW) of the V-BOX is used to store temporary data:
1370 +**Function:** Use IRA character set to send English text messages
1379 1379  
1380 -1. Access by word, the number range is: "@W_HDW0"-"@W_HDW299999".
1381 -1. Access in bit mode, the number range is: "@B_HDX0.0"-"@B_HDX299999.15".
1382 -
1383 -(((
1384 -== **8.2 Special data area (HSW/HSX)** ==
1385 -
1386 -(% class="box infomessage" %)
1387 -(((
1388 -**✎Note: **
1389 -
1390 -* //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).
1391 -* //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.
1392 -)))
1393 -)))
1394 -
1395 -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:
1396 -
1397 -(% class="table-bordered" %)
1398 -|=(% style="width: 151px;" %)address|=(% style="width: 169px;" %)function|=(% style="width: 456px;" %)Read and write status: read only, write only, read and write
1399 -|(% style="width:151px" %)@W_HSW0|(% style="width:169px" %)restart|(% style="width:456px" %)read and write
1400 -|(% style="width:151px" %)@W_HSW1|(% style="width:169px" %)Box time: year|(% style="width:456px" %)read and write
1401 -|(% style="width:151px" %)@W_HSW2|(% style="width:169px" %)Box time: month|(% style="width:456px" %)read and write
1402 -|(% style="width:151px" %)@W_HSW3|(% style="width:169px" %)Box time: day|(% style="width:456px" %)read and write
1403 -|(% style="width:151px" %)@W_HSW4|(% style="width:169px" %)Box time: hour|(% style="width:456px" %)read and write
1404 -|(% style="width:151px" %)@W_HSW5|(% style="width:169px" %)Box time: minute|(% style="width:456px" %)read and write
1405 -|(% style="width:151px" %)@W_HSW6|(% style="width:169px" %)Box time: second|(% style="width:456px" %)read and write
1406 -|(% style="width:151px" %)@W_HSW7|(% style="width:169px" %)Box time: week|(% style="width:456px" %)read and write
1407 -|(% style="width:151px" %)@W_HSW8|(% style="width:169px" %)Ethernet IP1|(% style="width:456px" %)read only
1408 -|(% style="width:151px" %)@W_HSW9|(% style="width:169px" %)Ethernet IP2|(% style="width:456px" %)read only
1409 -|(% style="width:151px" %)@W_HSW10|(% style="width:169px" %)Ethernet IP3|(% style="width:456px" %)read only
1410 -|(% style="width:151px" %)@W_HSW11|(% style="width:169px" %)Ethernet IP4|(% style="width:456px" %)read only
1411 -|(% style="width:151px" %)@W_HSW12|(% style="width:169px" %)Ethernet Mask 1|(% style="width:456px" %)read only
1412 -|(% style="width:151px" %)@W_HSW13|(% style="width:169px" %)Ethernet Mask 2|(% style="width:456px" %)read only
1413 -|(% style="width:151px" %)@W_HSW14|(% style="width:169px" %)Ethernet Mask 3|(% style="width:456px" %)read only
1414 -|(% style="width:151px" %)@W_HSW15|(% style="width:169px" %)Ethernet Mask 4|(% style="width:456px" %)read only
1415 -|(% style="width:151px" %)@W_HSW16|(% style="width:169px" %)Ethernet Gateway 1|(% style="width:456px" %)read only
1416 -|(% style="width:151px" %)@W_HSW17|(% style="width:169px" %)Ethernet Gateway 2|(% style="width:456px" %)read only
1417 -|(% style="width:151px" %)@W_HSW18|(% style="width:169px" %)Ethernet Gateway 3|(% style="width:456px" %)read only
1418 -|(% style="width:151px" %)@W_HSW19|(% style="width:169px" %)Ethernet Gateway 4|(% style="width:456px" %)read only
1419 -|(% style="width:151px" %)@W_HSW21|(% style="width:169px" %)Ethernet MAC1|(% style="width:456px" %)read only
1420 -|(% style="width:151px" %)@W_HSW22|(% style="width:169px" %)Ethernet MAC2|(% style="width:456px" %)read only
1421 -|(% style="width:151px" %)@W_HSW23|(% style="width:169px" %)Ethernet MAC3|(% style="width:456px" %)read only
1422 -|(% style="width:151px" %)@W_HSW24|(% style="width:169px" %)Ethernet MAC4|(% style="width:456px" %)read only
1423 -|(% style="width:151px" %)@W_HSW25|(% style="width:169px" %)Ethernet MAC3|(% style="width:456px" %)read only
1424 -|(% style="width:151px" %)@W_HSW26|(% style="width:169px" %)Ethernet MAC4|(% style="width:456px" %)read only
1425 -|(% style="width:151px" %)@W_HSW128|(% style="width:169px" %)WIFI IP1|(% style="width:456px" %)read only
1426 -|(% style="width:151px" %)@W_HSW129|(% style="width:169px" %)WIFI IP2|(% style="width:456px" %)read only
1427 -|(% style="width:151px" %)@W_HSW130|(% style="width:169px" %)WIFI IP3|(% style="width:456px" %)read only
1428 -|(% style="width:151px" %)@W_HSW131|(% style="width:169px" %)WIFI IP4|(% style="width:456px" %)read only
1429 -|(% style="width:151px" %)@W_HSW132|(% style="width:169px" %)WIFI Mask 1|(% style="width:456px" %)read only
1430 -|(% style="width:151px" %)@W_HSW133|(% style="width:169px" %)WIFI Mask 2|(% style="width:456px" %)read only
1431 -|(% style="width:151px" %)@W_HSW134|(% style="width:169px" %)WIFI Mask 3|(% style="width:456px" %)read only
1432 -|(% style="width:151px" %)@W_HSW135|(% style="width:169px" %)WIFI Mask 4|(% style="width:456px" %)read only
1433 -|(% style="width:151px" %)@W_HSW136|(% style="width:169px" %)WIFI Gateway 1|(% style="width:456px" %)read only
1434 -|(% style="width:151px" %)@W_HSW137|(% style="width:169px" %)WIFI Gateway 2|(% style="width:456px" %)read only
1435 -|(% style="width:151px" %)@W_HSW138|(% style="width:169px" %)WIFI Gateway 3|(% style="width:456px" %)read only
1436 -|(% style="width:151px" %)@W_HSW139|(% style="width:169px" %)WIFI Gateway 4|(% style="width:456px" %)read only
1437 -|(% style="width:151px" %)@W_HSW140|(% style="width:169px" %)WIFI MAC1|(% style="width:456px" %)read only
1438 -|(% style="width:151px" %)@W_HSW141|(% style="width:169px" %)WIFI MAC2|(% style="width:456px" %)read only
1439 -|(% style="width:151px" %)@W_HSW142|(% style="width:169px" %)WIFI MAC3|(% style="width:456px" %)read only
1440 -|(% style="width:151px" %)@W_HSW143|(% style="width:169px" %)WIFI MAC4|(% style="width:456px" %)read only
1441 -|(% style="width:151px" %)@W_HSW144|(% style="width:169px" %)WIFI MAC5|(% style="width:456px" %)read only
1442 -|(% style="width:151px" %)@W_HSW145|(% style="width:169px" %)WIFI MAC6|(% style="width:456px" %)read only
1443 -|(% style="width:151px" %)@W_HSW146|(% style="width:169px" %)WIFI Signal value|(% style="width:456px" %)read only
1444 -|(% style="width:151px" %)@W_HSW148|(% style="width:169px" %)4G IP1|(% style="width:456px" %)read only
1445 -|(% style="width:151px" %)@W_HSW149|(% style="width:169px" %)4G IP2|(% style="width:456px" %)read only
1446 -|(% style="width:151px" %)@W_HSW150|(% style="width:169px" %)4G IP3|(% style="width:456px" %)read only
1447 -|(% style="width:151px" %)@W_HSW151|(% style="width:169px" %)4G IP4|(% style="width:456px" %)read only
1448 -|(% style="width:151px" %)@W_HSW152|(% style="width:169px" %)4G Mask 1|(% style="width:456px" %)read only
1449 -|(% style="width:151px" %)@W_HSW153|(% style="width:169px" %)4G Mask 2|(% style="width:456px" %)read only
1450 -|(% style="width:151px" %)@W_HSW154|(% style="width:169px" %)4G Mask 3|(% style="width:456px" %)read only
1451 -|(% style="width:151px" %)@W_HSW155|(% style="width:169px" %)4G Mask 4|(% style="width:456px" %)read only
1452 -|(% style="width:151px" %)@W_HSW156|(% style="width:169px" %)4G Gateway 1|(% style="width:456px" %)read only
1453 -|(% style="width:151px" %)@W_HSW157|(% style="width:169px" %)4G Gateway 2|(% style="width:456px" %)read only
1454 -|(% style="width:151px" %)@W_HSW158|(% style="width:169px" %)4G Gateway 3|(% style="width:456px" %)read only
1455 -|(% style="width:151px" %)@W_HSW159|(% style="width:169px" %)4G Gateway 4|(% style="width:456px" %)read only
1456 -|(% style="width:151px" %)@W_HSW160|(% style="width:169px" %)4G MAC1|(% style="width:456px" %)read only
1457 -|(% style="width:151px" %)@W_HSW161|(% style="width:169px" %)4G MAC2|(% style="width:456px" %)read only
1458 -|(% style="width:151px" %)@W_HSW162|(% style="width:169px" %)4G MAC3|(% style="width:456px" %)read only
1459 -|(% style="width:151px" %)@W_HSW163|(% style="width:169px" %)4G MAC4|(% style="width:456px" %)read only
1460 -|(% style="width:151px" %)@W_HSW164|(% style="width:169px" %)4G MAC5|(% style="width:456px" %)read only
1461 -|(% style="width:151px" %)@W_HSW165|(% style="width:169px" %)4G MAC6|(% style="width:456px" %)read only
1462 -|(% style="width:151px" %)@W_HSW166|(% style="width:169px" %)4G Signal value|(% style="width:456px" %)read only
1463 -
1464 -**Others**
1465 -
1466 -* Access password: addr_getstring("@W_HSW27", 16)
1467 -* Machine code: addr_getstring("@W_HSW60", 64)
1468 -* Positioning method (@W_HSW167): (read only)
1469 -** Latitude and longitude
1470 -*** Longitude: addr_getdouble("@W_HSW168") (read only)
1471 -*** Latitude: addr_getdouble("@W_HSW172") (read only)
1472 -** Base station positioning
1473 -*** LAC: addr_getdword("@W_HSW168") (read only)
1474 -*** CI: addr_getdword("@W_HSW172") (read only)
1475 -* Convert base station to latitude and longitude via API
1476 -** Longitude: addr_getdouble("@W_HSW187") (read only)
1477 -** Latitude: addr_getdouble("@W_HSW183") (read only)
1478 -* Operator information: addr_getdword("@W_HSW181") (read only)
1479 -* Networking mode: addr_getword("@W_HSW177") (read only)
1480 -** 0: Ethernet
1481 -** 1: WIFI
1482 -** 2: 4G
1483 -** 3: 2G
1484 -* Map fence flag: addr_getword("@W_HSW178") (read only)
1485 -** 0: No map fence is drawn
1486 -** 1: Draw a map fence and the box is in the fence
1487 -** 2: Draw a map fence and the box is not in the fence
1488 -* SIM card status addr_getword("@W_HSW179") (read only)
1489 -** 1: No card detected
1490 -** 2: Card insertion detected
1491 -** 3: The card status is abnormal
1492 -* MQTT status addr_getword("@W_HSW180") (read only)
1493 -** 1: online, 2: offline
1494 -* IO interface, X is read only, Y is read and write (H series)
1495 -** addr_getbit(addr1), addr_setbit(addr2)
1496 -** addr1:"@B_Y0" "@B_Y1" "@B_X0" "@B_X1"
1497 -** addr2:"@B_Y0" "@B_Y1"
1498 -* Obtaining IMEI (read only)
1499 -** addr_getstring("@W_HSW191",17)
1500 -* Obtaining ICCID (read only)
1501 -** addr_getstring("@W_HSW225",15)
1502 -
1503 -(((
1504 -(% class="wikigeneratedid" %)
1505 -== **Power-down storage area (HAW/HAX)** ==
1506 -
1507 -The system storage area (HAW) is used for the system power-down hold registers:
1508 -
1509 -1. Accessed as a word, numbered in the range: "@W_HAW0"-"@W_HAW199999".
1510 -1. Accessed by bit, the numbering range is: "@B_HAX0.0"-"@B_HAX199999.15".
1511 -
1512 -(% class="box infomessage" %)
1513 -(((
1514 -**✎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
1515 -)))
1516 -
1517 -= **9 General Functions** =
1518 -)))
1519 -
1520 -(((
1521 -== **9.1 send_sms_ira(string number, string message)** ==
1522 -)))
1523 -
1524 -**Function:**
1525 -
1526 -Use IRA character set to send English text messages
1527 -
1528 1528  **Parameters:**
1529 1529  
1530 1530  //number: //number (up to 32 characters, the excess will be discarded)
... ... @@ -1538,7 +1538,7 @@
1538 1538  Failed: multi
1539 1539  
1540 1540  (((
1541 -== **9.2 send_sms_ucs2(string number, string message)** ==
1385 +== **send_sms_ucs2(string number, string message)** ==
1542 1542  )))
1543 1543  
1544 1544  **Function:**
... ... @@ -1558,13 +1558,11 @@
1558 1558  Failed: multi
1559 1559  
1560 1560  (((
1561 -== **9.3 sms_get_state(number id)** ==
1405 +== **sms_get_state(number id)** ==
1562 1562  )))
1563 1563  
1564 -**Function:**
1408 +**Function:** Get the status of the SMS
1565 1565  
1566 -Get the status of the SMS
1567 -
1568 1568  **parameter:**
1569 1569  
1570 1570  //id~:// SMS corresponding id
... ... @@ -1576,13 +1576,11 @@
1576 1576  Failed: multi
1577 1577  
1578 1578  (((
1579 -== **9.4 jwt_encode(table head, table payload, string aud, number iat, number exp, string key, int jwttype)** ==
1421 +== **jwt_encode(table head, table payload, string aud, number iat, number exp, string key, int jwttype)** ==
1580 1580  )))
1581 1581  
1582 -**Function:**
1424 +**Function:** Convert data to JWT format
1583 1583  
1584 -Convert data to JWT format
1585 -
1586 1586  **parameter:**
1587 1587  
1588 1588  //aud: //project name
... ... @@ -1627,19 +1627,20 @@
1627 1627  
1628 1628  //key~:// the private key required for encryption
1629 1629  
1630 -For example:
1470 +**For example:**
1631 1631  
1472 +{{code language="LUA"}}
1632 1632  function jwt.main()
1633 1633  
1634 -local PRIVATE_KEY = ~[~[~-~- Please enter the secret key~-~-]]
1475 +local PRIVATE_KEY = [[-- Please enter the secret key--]]
1635 1635  
1636 1636  local JWTType=0
1637 1637  
1638 -local payload = ~{~{key="test1",value="test1",type="0"},
1479 +local payload = {{key="test1",value="test1",type="0"},
1639 1639  
1640 1640  {key="test",value="123122131",type="1"}}
1641 1641  
1642 -local head = ~{~{ key="name",value="data",type="0"},
1483 +local head = {{ key="name",value="data",type="0"},
1643 1643  
1644 1644  {key="test2",value="test2",type="0"}}
1645 1645  
... ... @@ -1654,15 +1654,14 @@
1654 1654  print(en)
1655 1655  
1656 1656  End
1498 +{{/code}}
1657 1657  
1658 1658  (((
1659 -== **9.5 convertohex(number type, number value)** ==
1501 +== **convertohex(number type, number value)** ==
1660 1660  )))
1661 1661  
1662 -**Function:**
1504 +**Function:** Convert data into hexadecimal data
1663 1663  
1664 -Convert data into hexadecimal data
1665 -
1666 1666  **parameter:**
1667 1667  
1668 1668  //type~:// incoming data type 0:word 1:dword 2:float
... ... @@ -1675,106 +1675,267 @@
1675 1675  
1676 1676  Failed: multi
1677 1677  
1518 +== **crc.init(table prarm)** ==
1519 +
1520 +**Function:** Initialize the CRC
1521 +
1522 +**Parameters:**
1523 +
1524 +prarm is a Lua table and needs to contain the following fields.
1525 +
1526 +* 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.
1527 +* number prarm.width: the width, i.e. the number of CRC bits.
1528 +* 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.
1529 +* number [prarm.init]: the initialization preset value of the register (crc) at the beginning of the algorithm in hexadecimal.
1530 +* number [prarm.xorout]: the final CRC value obtained after heterodyning the calculation result with this parameter.
1531 +* number [prarm.refin]: whether each byte of the data to be measured is inverted by bit, true or false.
1532 +* number [prarm.refout]: after the calculation or before the heterodyning output, whether the whole data is inverted by bit, true or false.
1533 +
1534 +**Return:**
1535 +
1536 +Success: crc object
1537 +
1538 +Failure: multi, error code
1539 +
1678 1678  (((
1679 -== **9.6 set_network(table config)** ==
1541 +|=Parameter model name|=poly|=init|=xorout|=refin|=refout
1542 +|crc8|0x07|0x00|0x00|false|false
1543 +|crc8_cdma2000|0x9B|0xFF|0x00|false|false
1544 +|crc8_darc|0x39|0x00|0x00|true|true
1545 +|crc8_dvb_s2|0xD5|0x00|0x00|false|false
1546 +|crc8_ebu|0x1D|0xFF|0x00|true|true
1547 +|crc8_i_code|0x1D|0xFD|0x00|false|false
1548 +|crc8_itu|0x07|0x00|0x55|false|false
1549 +|crc8_maxim|0x31|0x00|0x00|true|true
1550 +|crc8_rohc|0x07|0xFF|0x00|true|true
1551 +|crc8_wcdma|0x9B|0x00|0x00|true|true
1552 +|crc8_sae_j1850|0x1D|0xFF|0xFF|false|false
1553 +|crc8_opensafety|0x2F|0x00|0x00|false|false
1554 +|crc16_tms37157|0x1021|0x3791|0x0000|true|true
1555 +|crc16_a|0x1021|0x6363|0x0000|true|true
1556 +|crc16_riello|0x1021|0x554D|0x0000|true|true
1557 +|crc16_ccitt_false|0x1021|0xFFFF|0x0000|false|false
1558 +|crc16_arc|0x8005|0x0000|0x0000|true|true
1559 +|crc16_arc_ccitt|0x1021|0x1D0F|0x0000|false|false
1560 +|crc16_buypass|0x8005|0x0000|0x0000|false|false
1561 +|crc16_cdma2000|0xC867|0xFFFF|0x0000|false|false
1562 +|crc16_dds110|0x8005|0x800D|0x0000|false|false
1563 +|crc16_dect_r|0x0589|0x0000|0x0001|false|false
1564 +|crc16_dect_x|0x0589|0x0000|0x0000|false|false
1565 +|crc16_dnp|0x3D65|0x0000|0xFFFF|true|true
1566 +|crc16_en_13757|0x3D65|0x0000|0xFFFF|false|false
1567 +|crc16_genibus|0x1021|0xFFFF|0xFFFF|false|false
1568 +|crc16_maxim|0x8005|0x0000|0xFFFF|true|true
1569 +|crc16_mcrf4xx|0x1021|0xFFFF|0x0000|true|true
1570 +|crc16_t10_dif|0x8BB7|0x0000|0x0000|false|false
1571 +|crc16_teledisk|0xA097|0x0000|0x0000|false|false
1572 +|crc16_usb|0x8005|0xFFFF|0xFFFF|true|true
1573 +|crc16_kermit|0x1021|0x0000|0x0000|true|true
1574 +
1575 +(% class="wikigeneratedid" %)
1576 +Table 9-1
1577 +
1578 +== **crc:calc(string crcValue)** ==
1579 +
1580 +**Function:** Calculate CRC result
1581 +
1582 +**Parameter:**
1583 +
1584 +crcValue: the value to be calculated
1585 +
1586 +**Return:**
1587 +
1588 +Succeed: calculated result
1589 +
1590 +Failed: multi, error code
1680 1680  )))
1681 1681  
1682 -**Function:**
1593 +**For example:**
1683 1683  
1684 -Set V-BOX network, take effect after restart
1595 +{{code language="LUA"}}
1596 +function crcTest.main()
1685 1685  
1686 -**parameter:**
1598 +local param = {
1687 1687  
1688 -//config~:// incoming network configuration table
1600 +name = '',
1689 1689  
1690 -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.
1691 -1. ethernetEnable: Whether to enable Ethernet, 1: enable, 0: disable, and it is not allowed to be empty.
1692 -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.
1693 -1. ethernetIpMode: Whether to enable Ethernet static IP, 1: Enable static IP, 0: DHCP, not allowed to be empty.
1694 -1. ethernetIp: The IP address needs to be configured when the Ethernet static IP is used, and it is not allowed to be empty.
1695 -1. ethernetNetmask: The subnet mask needs to be configured when Ethernet static IP is used, and it is not allowed to be empty.
1696 -1. ethernetGateway: The gateway can be configured when Ethernet static IP is used.
1602 +width = 64,
1697 1697  
1698 -1. When using the Ethernet network, if the Gateway is empty, V-BOX will not connect to the server.
1699 -1. If you only use Ethernet to directly connect to the PLC for communication, you do not need to configure a gateway.
1604 +poly = 0x42F0E1EBA9EA3693,
1700 1700  
1701 -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.
1702 -1. ethernetSpareDns: Alternate DNS server can be configured when the Ethernet static IP is used, and it is allowed to be empty.
1703 -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.
1704 -1. wifiName: WIFI name, if WIFI is enabled, it is not allowed to be empty.
1705 -1. wifiPassword: WIFI password, it is allowed to be empty.
1706 -1. wifiIpMode: Whether to enable WIFI static IP, 1: Enable static IP, 0: DHCP, not allowed to be empty.
1707 -1. wifiIp: IP address needs to be configured when WIFI static IP is used, it is not allowed to be empty.
1708 -1. wifiNetmask: The subnet mask needs to be configured when WIFI static IP is used, and it is not allowed to be empty.
1709 -1. wifiGateway: The gateway can be configured when WIFI static IP is used, and it is not allowed to be empty.
1710 -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.
1711 -1. wifiSpareDns: Alternate DNS server can be configured when the WIFI static IP is used, and it is allowed to be empty.
1712 -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.
1713 -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.
1714 -1. apnName: APN name, if you choose to manually configure APN, it is not allowed to be empty.
1715 -1. apnPassword: APN username, it is allowed to be empty.
1716 -1. apnUserName: APN number, it is allowed to be empty.
1717 -1. apnNumber: APN number, it is allowed to be empty.
1606 +init = 0xFFFFFFFFFFFFFFFF,
1718 1718  
1608 +xorout = 0xFFFFFFFFFFFFFFFF,
1609 +
1610 +refin = 1,
1611 +
1612 +refout = 1
1613 +
1614 +}
1615 +
1616 +crc64,err = crc.init(param)
1617 +
1618 +if not crc64 then
1619 +
1620 +print("Crc init failed:", err)
1621 +else
1622 +
1623 +crcvalue = crc64:calc("123456789")
1624 +
1625 +print(string.format("crc64 calc :0X%16X", crcvalue))
1626 +
1627 +end
1628 +
1629 +end
1630 +{{/code}}
1631 +
1632 += **9 Special function for V-NET** =
1633 +
1634 +== **normal_get_alldata()** ==
1635 +
1636 +**Function: **Obtain the data of all the monitoring points
1637 +
1638 +**Parameter: None**
1639 +
1719 1719  **Return:**
1720 1720  
1721 -Succeed: true
1642 +Succeed: table two-dimensional arrays, as follows:
1722 1722  
1723 -Faied: multi
1644 +* Each item is a monitoring point and contains 4 attributes:
1645 +** 1: ID
1646 +** 2: status
1647 +** 3: tag name
1648 +** 4: value
1649 +* Status contains 3 enumerated values
1650 +** 0: offline
1651 +** 1: online
1652 +** 2: timeout
1653 +* Customization returns an empty table if there is no configuration, otherwise returns "field name/field content"
1724 1724  
1725 -(((
1726 -== **9.7 remote_com_start(string config)** ==
1727 -)))
1655 +**For example:**
1728 1728  
1729 -**Function:**
1657 +{{code language="LUA"}}
1658 +{
1730 1730  
1731 -start serial port pass-through
1660 +[1]= {[1]=1234, [2]=1, [3]='temp', [4]='23.5'},
1732 1732  
1662 +[2]= {[1]=1235, [2]=1, [3]='humi', [4]='67'},
1663 +
1664 +...
1665 +
1666 +[n]= {[1]=xxxx, [2]=x, [3]='xxxx', [4]='xx.x'},
1667 +
1668 +}
1669 +
1670 +Failed: table, empty table
1671 +{{/code}}
1672 +
1673 +== **normal_setdata_byname(string name, string data)** ==
1674 +
1675 +**Function:** Write data to the monitoring point name
1676 +
1733 1733  **Parameter:**
1734 1734  
1735 -//config: //incoming serial port parameter configuration, JSON format
1679 +name: the name of monitoring point
1736 1736  
1737 -1. type:0, serial port pass-through
1738 -1. port: serial port number marked on the V-BOX
1739 -1. comtype:0-RS232, 1-RS485, 2-RS422
1740 -1. baudrate: Baud Rate
1741 -1. data_length: Data Bits
1742 -1. stop_bit: Stop Bit
1743 -1. check_bit: Check Bit
1681 +data: the data to be written
1744 1744  
1745 1745  **Return:**
1746 1746  
1747 -Succeed: true
1685 +Succeed: string: The value of the monitor point before it is written
1748 1748  
1749 -Failed: multi
1687 +Failed: nil
1750 1750  
1751 -(((
1752 -== **9.8 remote_com_stop()** ==
1753 -)))
1689 +== **normal_getdata_byname(string name)** ==
1754 1754  
1755 -**Function:**
1691 +**Function:** Read the data of the monitoring point name
1756 1756  
1757 -close serial port pass-through
1693 +**Parameter:**
1758 1758  
1695 +name: the name of monitoring point
1696 +
1759 1759  **Return:**
1760 1760  
1761 -Succeed: true
1699 +Succeed: string
1762 1762  
1763 -Failed: multi
1701 +Failed: nil
1764 1764  
1765 -(((
1766 -== **9.9 remote_com_state()** ==
1767 -)))
1703 += **10 Message summary algorithm** =
1768 1768  
1769 -**Function:**
1705 +== **hmac(string hash_func, string key, string message)** ==
1770 1770  
1771 -query the serial port pass-through status and pass-through server domain name and port
1707 +**Function:** HMAC calculate
1772 1772  
1709 +**Function name**
1710 +
1711 +hash_func:
1712 +
1713 +* [md5, sha1, sha224, sha256, sha384, sha512]
1714 +* [sha512_224, sha512_256, sha3_224, sha3_256]
1715 +* [sha3_384, sha3_512]
1716 +
1717 +**Parameter:**
1718 +
1719 +key: the key
1720 +
1721 +message: message content
1722 +
1773 1773  **Return:**
1774 1774  
1775 -Succeed:
1725 +Succeed: string, calculation result
1776 1776  
1777 -1. number, current pass-through status: 0-none 1,2-starting pass-through 3-penetrating 4,5-finishing pass-through 6-pass-through error
1778 -1. string, pass-through server domain name and port number, xxxx (domain name): xxx (port number)
1727 +Failed: nil
1779 1779  
1780 -Failed: multi
1729 +**For example:**
1730 +
1731 +{{code language="LUA"}}
1732 +local sha = require"sha2"
1733 +
1734 +function hmac_test.main()
1735 +
1736 +local hmac = sha.hmac
1737 +
1738 +print(hmac(sha.sha1,
1739 +
1740 +"your key", "your message"))
1741 +
1742 +end
1743 +{{/code}}
1744 +
1745 +== **sha(string message** ==
1746 +
1747 +**Function:** SHA calculate
1748 +
1749 +**Function name:**
1750 +
1751 +sha:
1752 +
1753 +* sha1, sha224, sha256, sha384, sha512]
1754 +* [sha512_224, sha512_256, sha3_224, sha3_256]
1755 +* [sha3_384, sha3_512]
1756 +
1757 +**Parameter:**
1758 +
1759 +key: the key
1760 +
1761 +message: message content
1762 +
1763 +**Return:**
1764 +
1765 +Succeed: string, calculation result
1766 +
1767 +Failed: nil
1768 +
1769 +For example:
1770 +
1771 +{{code language="LUA"}}
1772 +local sha = require"sha2"
1773 +
1774 +function sha_test.main()
1775 +
1776 +local sha256 = sha.sha256
1777 +
1778 +print(sha256("your message"))
1779 +
1780 +end
1781 +{{/code}}