Skip to Content

Changes for page 01 Lua Functions

Last modified by Theodore Xu on 2023/10/26 10:51
From version 5.25
edited by Stone Wu
on 2022/07/12 10:25
Change comment: (Autosaved)
To version 9.1
edited by Stone Wu
on 2022/07/25 11:32
Change comment: Renamed from xwiki:V-BOX.V-Net.1\.User Manual.04 Lua Script.01 Lua Functions.WebHome

Summary

Details

Page properties
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")
... ... @@ -1358,7 +1358,7 @@
1358 1358  
1359 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 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.
1370 +**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 1362  
1363 1363  (% class="box infomessage" %)
1364 1364  (((
... ... @@ -1380,7 +1380,7 @@
1380 1380  1. Access in bit mode, the number range is: "@B_HDX0.0"-"@B_HDX299999.15".
1381 1381  
1382 1382  (((
1383 -== **8.2 Special data area (HSW/HSX)** ==
1392 +== **Special data area (HSW/HSX)** ==
1384 1384  
1385 1385  (% class="box infomessage" %)
1386 1386  (((
... ... @@ -1534,7 +1534,7 @@
1534 1534  Failed: multi
1535 1535  
1536 1536  (((
1537 -== **9.2 send_sms_ucs2(string number, string message)** ==
1546 +== **send_sms_ucs2(string number, string message)** ==
1538 1538  )))
1539 1539  
1540 1540  **Function:**
... ... @@ -1683,163 +1683,429 @@
1683 1683  * number [prarm.refin]: whether each byte of the data to be measured is inverted by bit, true or false.
1684 1684  * number [prarm.refout]: after the calculation or before the heterodyning output, whether the whole data is inverted by bit, true or false.
1685 1685  
1686 -Return:
1695 +**Return:**
1687 1687  
1688 1688  Success: crc object
1689 1689  
1690 1690  Failure: multi, error code
1691 1691  
1692 -|=Parameter model name|=poly|=init|=(% style="width: 184px;" %)xorout|=(% style="width: 69px;" %)refin|=refout
1693 -|crc8|0x07|0x00|(% style="width:184px" %)0x00|(% style="width:69px" %)false|false
1694 -|crc8_cdma2000|0c9B|0xFF|(% style="width:184px" %)0x00|(% style="width:69px" %)false|false
1695 -|crc8_darc| |0x00|(% style="width:184px" %)0x00|(% style="width:69px" %)true|true
1696 -|crc8_dvb_s2| |0x00|(% style="width:184px" %)0x00|(% style="width:69px" %)false|false
1697 -|crc8_ebu| |0xFF|(% style="width:184px" %)0x00|(% style="width:69px" %)true|true
1698 -|crc8_i_code| |0xFD|(% style="width:184px" %)0x00|(% style="width:69px" %)false|false
1699 -|crc8_itu| |0x00|(% style="width:184px" %)0X55|(% style="width:69px" %)false|false
1700 -|crc8_maxim| |0x00|(% style="width:184px" %)0x00|(% style="width:69px" %)true|true
1701 -|crc8_rohc| |0xFF|(% style="width:184px" %)0x00|(% style="width:69px" %)true|true
1702 -|crc8_wcdma| |0x00|(% style="width:184px" %)0x00|(% style="width:69px" %)true|true
1703 -|crc8_sae_j1850| |0xFF|(% style="width:184px" %)0xFF|(% style="width:69px" %)false|false
1704 -|crc8_opensafaty| |0x00|(% style="width:184px" %)0x00|(% style="width:69px" %)false|false
1705 -|crc16_tms37157| |0x3791|(% style="width:184px" %)0x0000|(% style="width:69px" %)true|true
1706 -|crc16_a| |0x6363|(% style="width:184px" %)0x0000|(% style="width:69px" %)true|true
1707 -|crc16_riello| |0x554D|(% style="width:184px" %)0x0000|(% style="width:69px" %)true|true
1708 -|crc16_ccitt_false| |0xFFFF|(% style="width:184px" %)0x0000|(% style="width:69px" %)false|false
1709 -|crc16_arc| |0x0000|(% style="width:184px" %)0x0000|(% style="width:69px" %)true|true
1710 -|crc16_arc_ccitt| |0X1D0F|(% style="width:184px" %)0x0000|(% style="width:69px" %)false|false
1711 -|crc16_cdma2000| |0x0000|(% style="width:184px" %)0x0000|(% style="width:69px" %)false|false
1712 -|crc16_dds110| |0xFFFF|(% style="width:184px" %)0x0000|(% style="width:69px" %)false|false
1713 -|crc16_dect_r| |0x800D|(% style="width:184px" %)0x0000|(% style="width:69px" %)false|false
1714 -|crc16_dect_x| |0x0000|(% style="width:184px" %)0x0001|(% style="width:69px" %)false|false
1715 -|crc16_dnp| |0x0000|(% style="width:184px" %)0x0000|(% style="width:69px" %)false|false
1716 -|crc16_en_13757| |0x0000|(% style="width:184px" %)0xFFFF|(% style="width:69px" %)true|true
1717 -|crc16_genibus| |0x0000|(% style="width:184px" %)0xFFFF|(% style="width:69px" %)false|false
1718 -|crc16_maxim| |0xFFFF|(% style="width:184px" %)0xFFFF|(% style="width:69px" %)false|false
1719 -|crc16_mcrf4xx| |0x0000|(% style="width:184px" %)0xFFFF|(% style="width:69px" %)true|true
1720 -|crc16_r10_dif| |0xFFFF|(% style="width:184px" %)0x0000|(% style="width:69px" %)true|true
1721 -|crc16_teldisk| |0x0000|(% style="width:184px" %)0x0000|(% style="width:69px" %)false|false
1722 -|crc16_usb| |0x0000|(% style="width:184px" %)0x0000|(% style="width:69px" %)false|false
1723 -|crc16_kermit| |0xFFFF|(% style="width:184px" %)0xFFFF|(% style="width:69px" %)true|true
1724 -| | |0x0000|(% style="width:184px" %)0x0000|(% style="width:69px" %)true|true
1725 -| | |0xFFFF|(% style="width:184px" %)0x0000|(% style="width:69px" %)true|true
1726 -| | |0xFFFF|(% style="width:184px" %)0xFFFF|(% style="width:69px" %)true|true
1727 -| | |0x0000|(% style="width:184px" %)0x0000|(% style="width:69px" %)false|false
1728 -| | |0xFFFFFFFF|(% style="width:184px" %)0xFFFFFFFF|(% style="width:69px" %)true|true
1729 -| | |0xFFFFFFFF|(% style="width:184px" %)0xFFFFFFFF|(% style="width:69px" %)false|false
1730 -| | |0xFFFFFFFF|(% style="width:184px" %)0xFFFFFFFF|(% style="width:69px" %)true|true
1731 -| | |0xFFFFFFFF|(% style="width:184px" %)0xFFFFFFFF|(% style="width:69px" %)true|true
1732 -| | |0xFFFFFFFF|(% style="width:184px" %)0x00000000|(% style="width:69px" %)false|false
1733 -| | |0x00000000|(% style="width:184px" %)0xFFFFFFFF|(% style="width:69px" %)false|false
1734 -| | |0x00000000|(% style="width:184px" %)0x00000000|(% style="width:69px" %)false|false
1735 -| | |0xFFFFFFFF|(% style="width:184px" %)0x00000000|(% style="width:69px" %)true|true
1736 -| | |0x00000000|(% style="width:184px" %)0x00000000|(% style="width:69px" %)false|false
1737 -| | |0x0000000000000000|(% style="width:184px" %)0x0000000000000000|(% style="width:69px" %)false|false
1738 -| | |0xFFFFFFFFFFFFFFFF|(% style="width:184px" %)0xFFFFFFFFFFFFFFFF|(% style="width:69px" %)true|true
1739 -| | |0xFFFFFFFFFFFFFFFF|(% style="width:184px" %)0xFFFFFFFFFFFFFFFF|(% style="width:69px" %)false|false
1740 -| | |0xFFFFFFFFFFFFFFFF|(% style="width:184px" %)0xFFFFFFFFFFFFFFFF|(% style="width:69px" %)true|true
1741 -| | | |(% style="width:184px" %) |(% style="width:69px" %) |
1742 -| | | |(% style="width:184px" %) |(% style="width:69px" %) |
1743 -| | | |(% style="width:184px" %) |(% style="width:69px" %) |
1744 -
1745 1745  (((
1746 -== **set_network(table config)** ==
1702 +|=Parameter model name|=poly|=init|=xorout|=refin|=refout
1703 +|crc8|0x07|0x00|0x00|false|false
1704 +|crc8_cdma2000|0x9B|0xFF|0x00|false|false
1705 +|crc8_darc|0x39|0x00|0x00|true|true
1706 +|crc8_dvb_s2|0xD5|0x00|0x00|false|false
1707 +|crc8_ebu|0x1D|0xFF|0x00|true|true
1708 +|crc8_i_code|0x1D|0xFD|0x00|false|false
1709 +|crc8_itu|0x07|0x00|0x55|false|false
1710 +|crc8_maxim|0x31|0x00|0x00|true|true
1711 +|crc8_rohc|0x07|0xFF|0x00|true|true
1712 +|crc8_wcdma|0x9B|0x00|0x00|true|true
1713 +|crc8_sae_j1850|0x1D|0xFF|0xFF|false|false
1714 +|crc8_opensafety|0x2F|0x00|0x00|false|false
1715 +|crc16_tms37157|0x1021|0x3791|0x0000|true|true
1716 +|crc16_a|0x1021|0x6363|0x0000|true|true
1717 +|crc16_riello|0x1021|0x554D|0x0000|true|true
1718 +|crc16_ccitt_false|0x1021|0xFFFF|0x0000|false|false
1719 +|crc16_arc|0x8005|0x0000|0x0000|true|true
1720 +|crc16_arc_ccitt|0x1021|0x1D0F|0x0000|false|false
1721 +|crc16_buypass|0x8005|0x0000|0x0000|false|false
1722 +|crc16_cdma2000|0xC867|0xFFFF|0x0000|false|false
1723 +|crc16_dds110|0x8005|0x800D|0x0000|false|false
1724 +|crc16_dect_r|0x0589|0x0000|0x0001|false|false
1725 +|crc16_dect_x|0x0589|0x0000|0x0000|false|false
1726 +|crc16_dnp|0x3D65|0x0000|0xFFFF|true|true
1727 +|crc16_en_13757|0x3D65|0x0000|0xFFFF|false|false
1728 +|crc16_genibus|0x1021|0xFFFF|0xFFFF|false|false
1729 +|crc16_maxim|0x8005|0x0000|0xFFFF|true|true
1730 +|crc16_mcrf4xx|0x1021|0xFFFF|0x0000|true|true
1731 +|crc16_t10_dif|0x8BB7|0x0000|0x0000|false|false
1732 +|crc16_teledisk|0xA097|0x0000|0x0000|false|false
1733 +|crc16_usb|0x8005|0xFFFF|0xFFFF|true|true
1734 +|crc16_kermit|0x1021|0x0000|0x0000|true|true
1735 +
1736 +(% class="wikigeneratedid" %)
1737 +Table 9-1
1738 +
1739 +== **crc:calc(string crcValue)** ==
1740 +
1741 +**Function:** Calculate CRC result
1742 +
1743 +**Parameter:**
1744 +
1745 +crcValue: the value to be calculated
1746 +
1747 +**Return:**
1748 +
1749 +Succeed: calculated result
1750 +
1751 +Failed: multi, error code
1747 1747  )))
1748 1748  
1749 -**Function:** Set V-BOX network, take effect after restart
1754 +**For example:**
1750 1750  
1751 -**parameter:**
1756 +{{code language="LUA"}}
1757 +function crcTest.main()
1752 1752  
1753 -//config~:// incoming network configuration table
1759 +local param = {
1754 1754  
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.
1761 +name = '',
1762 1762  
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.
1763 +width = 64,
1765 1765  
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.
1765 +poly = 0x42F0E1EBA9EA3693,
1783 1783  
1767 +init = 0xFFFFFFFFFFFFFFFF,
1768 +
1769 +xorout = 0xFFFFFFFFFFFFFFFF,
1770 +
1771 +refin = 1,
1772 +
1773 +refout = 1
1774 +
1775 +}
1776 +
1777 +crc64,err = crc.init(param)
1778 +
1779 +if not crc64 then
1780 +
1781 +print("Crc init failed:", err)
1782 +else
1783 +
1784 +crcvalue = crc64:calc("123456789")
1785 +
1786 +print(string.format("crc64 calc :0X%16X", crcvalue))
1787 +
1788 +end
1789 +
1790 +end
1791 +{{/code}}
1792 +
1793 += **10 Special function for V-NET** =
1794 +
1795 +== **normal_get_alldata()** ==
1796 +
1797 +**Function: **Obtain the data of all the monitoring points
1798 +
1799 +**Parameter: None**
1800 +
1784 1784  **Return:**
1785 1785  
1786 -Succeed: true
1803 +Succeed: table two-dimensional arrays, as follows:
1787 1787  
1788 -Faied: multi
1805 +* Each item is a monitoring point and contains 4 attributes:
1806 +** 1: ID
1807 +** 2: status
1808 +** 3: tag name
1809 +** 4: value
1810 +* Status contains 3 enumerated values
1811 +** 0: offline
1812 +** 1: online
1813 +** 2: timeout
1814 +* Customization returns an empty table if there is no configuration, otherwise returns "field name/field content"
1789 1789  
1790 -(((
1791 -== **9.7 remote_com_start(string config)** ==
1792 -)))
1816 +**For example:**
1793 1793  
1794 -**Function:**
1818 +{{code language="LUA"}}
1819 +{
1795 1795  
1796 -start serial port pass-through
1821 +[1]= {[1]=1234, [2]=1, [3]='temp', [4]='23.5'},
1797 1797  
1823 +[2]= {[1]=1235, [2]=1, [3]='humi', [4]='67'},
1824 +
1825 +...
1826 +
1827 +[n]= {[1]=xxxx, [2]=x, [3]='xxxx', [4]='xx.x'},
1828 +
1829 +}
1830 +
1831 +Failed: table, empty table
1832 +{{/code}}
1833 +
1834 +== **normal_setdata_byname(string name, string data)** ==
1835 +
1836 +**Function:** Write data to the monitoring point name
1837 +
1798 1798  **Parameter:**
1799 1799  
1800 -//config: //incoming serial port parameter configuration, JSON format
1840 +name: the name of monitoring point
1801 1801  
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
1842 +data: the data to be written
1809 1809  
1810 1810  **Return:**
1811 1811  
1812 -Succeed: true
1846 +Succeed: string: The value of the monitor point before it is written
1813 1813  
1814 -Failed: multi
1848 +Failed: nil
1815 1815  
1816 -(((
1817 -== **9.8 remote_com_stop()** ==
1818 -)))
1850 +== **normal_getdata_byname(string name)** ==
1819 1819  
1820 -**Function:**
1852 +**Function:** Read the data of the monitoring point name
1821 1821  
1822 -close serial port pass-through
1854 +**Parameter:**
1823 1823  
1856 +name: the name of monitoring point
1857 +
1824 1824  **Return:**
1825 1825  
1826 -Succeed: true
1860 +Succeed: string
1827 1827  
1862 +Failed: nil
1863 +
1864 += **11 MySQL database operation** =
1865 +
1866 +== **luaMySql.init(string sourcename, string username, string password, string host, number port, string character)** ==
1867 +
1868 +**Function:** Configure database connection parameters
1869 +
1870 +**Parameter:**
1871 +
1872 +sourcename: the name of database
1873 +
1874 +username: the username of the connection
1875 +
1876 +password: the password of the connection
1877 +
1878 +host: the host name of the connection
1879 +
1880 +port: the host port of the connection
1881 +
1882 +character: the character set of the connection
1883 +
1884 +**Return:**
1885 +
1886 +Succeed: string
1887 +
1828 1828  Failed: multi
1829 1829  
1830 -(((
1831 -== **9.9 remote_com_state()** ==
1832 -)))
1890 +== **luaMySql.exec(string statement)** ==
1833 1833  
1834 -**Function:**
1892 +**Function:** Execute the given SQL statement without returning the result set (add, delete, change)
1835 1835  
1836 -query the serial port pass-through status and pass-through server domain name and port
1894 +**Parameter:**
1837 1837  
1896 +statement: the given SQL statement
1897 +
1838 1838  **Return:**
1839 1839  
1840 -Succeed:
1900 +Succeed: status: returns the number of rows affected by SQL statement execution.
1841 1841  
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)
1902 +Failed: nil, errorString
1844 1844  
1845 -Failed: multi
1904 +== **luaMySql.execWithResult(string statement)** ==
1905 +
1906 +**Function:** Execute the given SQL statement returning the result set (check)
1907 +
1908 +**Parameter:**
1909 +
1910 +statement: the given SQL statement
1911 +
1912 +**Return:**
1913 +
1914 +Succeed: table: returns the result set
1915 +
1916 +Failed: nil, errorString
1917 +
1918 +**For example:**
1919 +
1920 +{{code language="LUA"}}
1921 +mysql = require"mysqlclient"
1922 +
1923 +function DataInitRight()
1924 +
1925 +local dbName = "db_lua1"
1926 +
1927 +local user = "root"
1928 +
1929 +local pwd = "123456"
1930 +
1931 +local host = "192.168.56.186"
1932 +
1933 +local port = 3306
1934 +local character = "UTF8"
1935 +
1936 +mysql.init(dbName, user, pwd, host, port, character)
1937 +
1938 +end
1939 +
1940 +function ExecFunc()
1941 +
1942 +status, errorString = mysql.exec("delete from tb_lua1 where mykey =
1943 +
1944 +10;")
1945 +
1946 +if nil == status then
1947 +
1948 +print("ExecFunc() error:", errorString)
1949 +
1950 +return -1
1951 +
1952 +else
1953 +
1954 +print("the number of rows affected by the command:", status)
1955 +
1956 +end
1957 +
1958 +return 0
1959 +
1960 +end
1961 +
1962 +function ExecWithResultFunc()
1963 +
1964 +status, errorString = mysql.execWithResult("select * from tb_lua1;")
1965 +
1966 +if nil == status then
1967 +
1968 +print("ExecWithResultFunc() error:", errorString)
1969 +
1970 +return -1
1971 +
1972 +else
1973 +
1974 +print("ExecWithResultFunc()
1975 +
1976 +success
1977 +
1978 +: status
1979 +
1980 +type
1981 +
1982 +=
1983 +
1984 +",
1985 +
1986 +type(status))
1987 +
1988 +print("ExecWithResultFunc() success : status len = ", #status)
1989 +
1990 +local num = #status
1991 +
1992 +local i = 1
1993 +
1994 +if num > 0 then
1995 +
1996 +for i = 1, num, 1 do
1997 +
1998 +local var = string.format("select result[%d] :mykey = %d,
1999 +
2000 +value = %s", i, status[i].mykey, status[i].value)
2001 +
2002 +print(var)
2003 +
2004 +end
2005 +
2006 +end
2007 +
2008 +print("---------------")
2009 +
2010 +end
2011 +
2012 +return 0
2013 +end
2014 +
2015 +function luaMysql_apiTest.main()
2016 +
2017 +print("script running ...")
2018 +
2019 +DataInitRight()
2020 +
2021 +--use exec demo
2022 +
2023 +if ExecFunc() < 0 then
2024 +
2025 +return
2026 +
2027 +end
2028 +
2029 +--use execWithResult demo
2030 +
2031 +if ExecWithResultFunc() < 0 then
2032 +
2033 +return
2034 +
2035 +end
2036 +
2037 +print("script running success")
2038 +
2039 +end
2040 +{{/code}}
2041 +
2042 += **12 Message summary algorithm** =
2043 +
2044 +== **hmac(string hash_func, string key, string message)** ==
2045 +
2046 +**Function:** HMAC calculate
2047 +
2048 +**Function name**
2049 +
2050 +hash_func:
2051 +
2052 +* [md5, sha1, sha224, sha256, sha384, sha512]
2053 +* [sha512_224, sha512_256, sha3_224, sha3_256]
2054 +* [sha3_384, sha3_512]
2055 +
2056 +**Parameter:**
2057 +
2058 +key: the key
2059 +
2060 +message: message content
2061 +
2062 +**Return:**
2063 +
2064 +Succeed: string, calculation result
2065 +
2066 +Failed: nil
2067 +
2068 +**For example:**
2069 +
2070 +{{code language="LUA"}}
2071 +local sha = require"sha2"
2072 +
2073 +function hmac_test.main()
2074 +
2075 +local hmac = sha.hmac
2076 +
2077 +print(hmac(sha.sha1,
2078 +
2079 +"your key", "your message"))
2080 +
2081 +end
2082 +{{/code}}
2083 +
2084 +== **sha(string message** ==
2085 +
2086 +**Function:** SHA calculate
2087 +
2088 +**Function name:**
2089 +
2090 +sha:
2091 +
2092 +* sha1, sha224, sha256, sha384, sha512]
2093 +* [sha512_224, sha512_256, sha3_224, sha3_256]
2094 +* [sha3_384, sha3_512]
2095 +
2096 +**Parameter:**
2097 +
2098 +key: the key
2099 +
2100 +message: message content
2101 +
2102 +**Return:**
2103 +
2104 +Succeed: string, calculation result
2105 +
2106 +Failed: nil
2107 +
2108 +For example:
2109 +
2110 +{{code language="LUA"}}
2111 +local sha = require"sha2"
2112 +
2113 +function sha_test.main()
2114 +
2115 +local sha256 = sha.sha256
2116 +
2117 +print(sha256("your message"))
2118 +
2119 +end
2120 +{{/code}}