Changes for page 01 Lua Functions

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

From version 5.31
edited by Stone Wu
on 2022/07/12 10:45
Change comment: (Autosaved)
To version 5.17
edited by Stone Wu
on 2022/07/12 09:55
Change comment: (Autosaved)

Summary

Details

Page properties
Content
... ... @@ -1370,6 +1370,7 @@
1370 1370  )))
1371 1371  
1372 1372  
1373 +
1373 1373  (((
1374 1374  == **Data storage area(HDW/HDX)** ==
1375 1375  )))
... ... @@ -1500,6 +1500,7 @@
1500 1500  ** addr_getstring("@W_HSW225",15)
1501 1501  
1502 1502  (((
1504 +(% class="wikigeneratedid" %)
1503 1503  == **Power-down storage area (HAW/HAX)** ==
1504 1504  
1505 1505  The system storage area (HAW) is used for the system power-down hold registers:
... ... @@ -1573,7 +1573,7 @@
1573 1573  == **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
1578 +**Function:** Convert data to JWT format
1577 1577  
1578 1578  **parameter:**
1579 1579  
... ... @@ -1619,20 +1619,19 @@
1619 1619  
1620 1620  //key~:// the private key required for encryption
1621 1621  
1622 -**For example:**
1624 +For example:
1623 1623  
1624 -{{code language="LUA"}}
1625 1625  function jwt.main()
1626 1626  
1627 -local PRIVATE_KEY = [[-- Please enter the secret key--]]
1628 +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"},
1632 +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"},
1636 +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)** ==
1653 +== **9.5 convertohex(number type, number value)** ==
1654 1654  )))
1655 1655  
1656 -**Function:** Convert data into hexadecimal data
1656 +**Function:**
1657 1657  
1658 +Convert data into hexadecimal data
1659 +
1658 1658  **parameter:**
1659 1659  
1660 1660  //type~:// incoming data type 0:word 1:dword 2:float
... ... @@ -1667,169 +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
1673 +== **9.6 set_network(table config)** ==
1743 1743  )))
1744 1744  
1745 -Example:
1676 +**Function:**
1746 1746  
1747 -{{code language="LUA"}}
1748 -function crcTest.main()
1678 +Set V-BOX network, take effect after restart
1749 1749  
1750 -local param = {
1680 +**parameter:**
1751 1751  
1752 -name = '',
1682 +//config~:// incoming network configuration table
1753 1753  
1754 -width = 64,
1684 +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.
1685 +1. ethernetEnable: Whether to enable Ethernet, 1: enable, 0: disable, and it is not allowed to be empty.
1686 +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.
1687 +1. ethernetIpMode: Whether to enable Ethernet static IP, 1: Enable static IP, 0: DHCP, not allowed to be empty.
1688 +1. ethernetIp: The IP address needs to be configured when the Ethernet static IP is used, and it is not allowed to be empty.
1689 +1. ethernetNetmask: The subnet mask needs to be configured when Ethernet static IP is used, and it is not allowed to be empty.
1690 +1. ethernetGateway: The gateway can be configured when Ethernet static IP is used.
1755 1755  
1756 -poly = 0x42F0E1EBA9EA3693,
1692 +1. When using the Ethernet network, if the Gateway is empty, V-BOX will not connect to the server.
1693 +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,
1695 +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.
1696 +1. ethernetSpareDns: Alternate DNS server can be configured when the Ethernet static IP is used, and it is allowed to be empty.
1697 +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.
1698 +1. wifiName: WIFI name, if WIFI is enabled, it is not allowed to be empty.
1699 +1. wifiPassword: WIFI password, it is allowed to be empty.
1700 +1. wifiIpMode: Whether to enable WIFI static IP, 1: Enable static IP, 0: DHCP, not allowed to be empty.
1701 +1. wifiIp: IP address needs to be configured when WIFI static IP is used, it is not allowed to be empty.
1702 +1. wifiNetmask: The subnet mask needs to be configured when WIFI static IP is used, and it is not allowed to be empty.
1703 +1. wifiGateway: The gateway can be configured when WIFI static IP is used, and it is not allowed to be empty.
1704 +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.
1705 +1. wifiSpareDns: Alternate DNS server can be configured when the WIFI static IP is used, and it is allowed to be empty.
1706 +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.
1707 +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.
1708 +1. apnName: APN name, if you choose to manually configure APN, it is not allowed to be empty.
1709 +1. apnPassword: APN username, it is allowed to be empty.
1710 +1. apnUserName: APN number, it is allowed to be empty.
1711 +1. apnNumber: APN number, it is allowed to be empty.
1759 1759  
1760 -xorout = 0xFFFFFFFFFFFFFFFF,
1713 +**Return:**
1761 1761  
1762 -refin = 1,
1715 +Succeed: true
1763 1763  
1764 -refout = 1
1717 +Faied: multi
1765 1765  
1766 -}
1719 +(((
1720 +== **9.7 remote_com_start(string config)** ==
1721 +)))
1767 1767  
1768 -crc64,err = crc.init(param)
1723 +**Function:**
1769 1769  
1770 -if not crc64 then
1725 +start serial port pass-through
1771 1771  
1772 -print("Crc init failed:", err)
1773 -else
1727 +**Parameter:**
1774 1774  
1775 -crcvalue = crc64:calc("123456789")
1729 +//config: //incoming serial port parameter configuration, JSON format
1776 1776  
1777 -print(string.format("crc64 calc :0X%16X", crcvalue))
1731 +1. type:0, serial port pass-through
1732 +1. port: serial port number marked on the V-BOX
1733 +1. comtype:0-RS232, 1-RS485, 2-RS422
1734 +1. baudrate: Baud Rate
1735 +1. data_length: Data Bits
1736 +1. stop_bit: Stop Bit
1737 +1. check_bit: Check Bit
1778 1778  
1779 -end
1739 +**Return:**
1780 1780  
1781 -end
1782 -{{/code}}
1741 +Succeed: true
1783 1783  
1784 -= **11 Special function for V-NET** =
1743 +Failed: multi
1785 1785  
1786 -== **normal_get_alldata()** ==
1745 +(((
1746 +== **9.8 remote_com_stop()** ==
1747 +)))
1787 1787  
1788 -**Function: **Obtain the data of all the monitoring points
1749 +**Function:**
1789 1789  
1790 -**Parameter: None**
1751 +close serial port pass-through
1791 1791  
1792 1792  **Return:**
1793 1793  
1794 -Succeed: table two-dimensional arrays, as follows:
1755 +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"
1757 +Failed: multi
1806 1806  
1807 -For example:
1759 +(((
1760 +== **9.9 remote_com_state()** ==
1761 +)))
1808 1808  
1809 -{
1763 +**Function:**
1810 1810  
1811 -[1]= {[1]=1234, [2]=1, [3]='temp', [4]='23.5'},
1765 +query the serial port pass-through status and pass-through server domain name and port
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 -**Parameter:**
1828 -
1829 -name: the name of mo
1830 -
1831 1831  **Return:**
1832 1832  
1833 -Succeed: calculated result
1769 +Succeed:
1834 1834  
1835 -Failed: multi, error code
1771 +1. number, current pass-through status: 0-none 1,2-starting pass-through 3-penetrating 4,5-finishing pass-through 6-pass-through error
1772 +1. string, pass-through server domain name and port number, xxxx (domain name): xxx (port number)
1773 +
1774 +Failed: multi