# 9.6 Lua Script Interfaces **1.Data format** void //void double //floating number int //signed integer uint //unsinged integer string //string table //table bool //false or true multi // Multiple return values (see the description of "Return" for details) **2.Lua built-in function library** The built-in functions mentioned below could be used, the rest cannot be used All available: Mathematics, string, table, file io, UTF8, etc. Partially available: System type os (only includes clock, date, difftime, remove, rename, time) **3.File IO** As long as the file is not closed during the use of the write function, what is written is temporarily stored in the RAM space. If the cumulative number of written bytes is about 60% of the RAM size, the program will be crashed. For example, the HMI memory size is 128M, and written byte is about 70M. The operating memory space required by the system itself, then a total of 90% of the total memory is occupied, the program will be killed (that is, the screen will freeze). The space of the internal Flash is limited. Once the internal space is full, files cannot be written. If you need to operate large files, they must be handled separately, you can read and write files through an external U disk. **4.Table** Lua tables can implement various data structures, such as stacks, queues, and trees. The size of the table needs to be controlled during use, because the RAM size of the HMI is limited. Using a loop to create a table array with nearly endless elements results in excessive memory usage, thus the program wil be killed (that is, the screen freezes) . Below is an example. local t = {} for i=1, math.maxinteger do table.insert(t, math.random(100000, 9999999)) end **5.Lua supports bit operation** **&**: Bitwise and **|**: Bitwise or **\~**: Bitwise XOR **>>**: right shift **<<**: left shift **\~**: bitwise not ## Chapter 1 Public function A large number of operations to read and write external addresses will slow down the running speed of the script, such as calling we\_bas\_setword("xx", 1) 100 times, it may take a few seconds to run. ### we\_atu8 string we\_atu8**(**string str**)** /\* \*Function：Convert ANSI character set string to utf8 character set string \*Parameter： \* str String of ANSI character set \*Return：String of Utf-8 character set \*/ ### we\_u8ta string we\_u8ta**(**string str**)** /\* \*Function：Convert utf8 character set string to ANSI character set string， \*Parameter： \* str String of Utf-8 character set \*Return：String of ANSI character set \*/ ### we\_bas\_getshort multi we\_bas\_getshort(string address, int type) /\* \*Function：Read single word signed decimal address \*Parameter： \* address address \* type type(no need to set，type = 1 means read thorough) \*Return：single word signed decimal value Read correctly \* multi Return values（nil and error message） read error \*/ ### we\_bas\_setshort multi we\_bas\_setshort(string address, int value, int type) /\* \*Function：Write value to a single word signed decimal address \*Parameter： \* address address \* value value \* type type(no need to set，type = 1 means read thorough) \*Return：TRUE set correctly \* multi Return values（nil and error message） set error \*/ ### we\_bas\_getword multi we\_bas\_getword(string address, int type) /\* \*Function：Read single word unsigned decimal address \*Parameter： \* address address \* type type(no need to set，type = means read thorough) \*Return：Word unsigned decimal value read correctly \* multi return values（nil and error message） read error \*/ ### we\_bas\_setword multi we\_bas\_setword(string address, uint value, int type) /\* \*Function：Write a single word unsigned decimal address \*Parameter： \* address address \* value value \* type type(no need to set，type = means read thorough) \*Return：TRUE set correctly \* multi return values（nil and error message） set error \*/ ### we\_bas\_getint multi we\_bas\_getint(string address, int type) /\* \*Function：Read double word signed decimal address \*Parameter： \* address address \* type type(no need to set，type = means read thorough) \*Return：Double word signed decimal value read correctly \* multi return values（nil and error message） read error \*/ ### we\_bas\_setint multi we\_bas\_setint(string address, int value, int type) /\* \*Function：Write double-word signed decimal address \*Parameter： \* address address \* value value \* type type(no need to set，type = means read thorough) \*Return：TRUE set correctly \* multi return values（nil and error message） set error \*/ ### we\_bas\_getdword multi we\_bas\_getdword(string address, int type) /\* \*Function：Read double word unsigned decimal address \*Parameter： \* address address \* type type(no need to set，type = means read thorough) \*Return：Double word unsigned decimal value read correctly \* multi return values（nil and error message） read error \*/ ### we\_bas\_setdword multi we\_bas\_setdword(string address, uint value, int type) /\* \*Function：Write double word unsigned decimal address \*Parameter： \* address address \* value value \* type type(no need to set，type = means read thorough) \*Return：TRUE set correctly \* multi return values（nil and error message） set error \*/ ### we\_bas\_getbit multi we\_bas\_getbit(string address, int type) /\* \*Function：Read a bit of the register address \*Parameter： \* address internal bit address \* type type(no need to set，type = means read thorough) \*Return：bit address value read correctly \* multi return values（nil and error message） read error \*/ ### we\_bas\_setbit multi we\_bas\_setbit(string address, uint value, int type) /\* \*Function：Write a bit of the register address \*Parameter： \* address internal bit address \* value value \* type type(no need to set，type = means read thorough) \*Return：TRUE set correctly \* multi return values（nil and error message） set error \*/ ### we\_bas\_getfloat multi we\_bas\_getfloat(string address, int type) /\* \*Function：Read 32-bit floating point address \*Parameter： \* address address \* type type(no need to set，type = means read thorough) \*Return：32-bit floating point value read correctly \* multi return values（nil and error message） read error \*/ ### we\_bas\_setfloat multi we\_bas\_setfloat(string address, double value, int type) /\* \*Function：Write 32-bit floating point address \*Parameter： \* address address \* value value \* type type(no need to set，type = means read thorough) \*Return：TRUE set correctly \* multi return values（nil and error message） set error \*/ ### we\_bas\_getdouble multi we\_bas\_getdouble(string address, int type) /\* \*Function：Read 64-bit floating point address \*Parameter： \* address address \* type type(no need to set，type = means read thorough) \*Return：64-bit floating point value read correctly \* multi return values（nil and error message） read error \*/ ### we\_bas\_setdouble multi we\_bas\_setdouble(string address, double value, int type) /\* \*Function：Write 64-bit floating point address \*Parameter： \* address address \* value value \* type type(no need to set，type = means read thorough) \*Return：TRUE set correctly \* multi return values（nil and error message） set error \*/ ### we\_bas\_getstring multi we\_bas\_getstring(string address, uint len) /\* \*Function：Read the specified length string \*Parameter： \* address address \* len length（unit：byte） \*Return：Specify length string read correctly \* multi return values（nil and error message） read error \*/ ### we\_bas\_setstring multi we\_bas\_setstring(string address, string str, uint len) /\* \*Function：write string \*Parameter： \* address address \* str string \* len length(no need to set，the default setting is the number of bytes in the string) \*Return：TRUE set correctly \* multi return values（nil and error message） set error \*/ ### we\_bas\_gettickcount uint we\_bas\_gettickcount() /\* \*Function：Get the time(millisecond) it takes to start the OS \*Parameter： \* none \*Return：Return the time it takes to start the OS \*/ ### we\_bas\_sleep void we\_bas\_sleep(uint millisecond) /\* \*Function：sleep \*Parameter： \* millisecond Sleep milliseconds \*Return：none \*/ ### we\_bas\_bmov multi we\_bas\_bmov(string desAddress, string srcAddress, uint len) /\* \*Function：Copy data with specified length from source address to destination address \*Parameter： \* desAddress target address \* srcAddress source address \* len Specified length (unit: word) \*Return：TRUE copy successfully \* multi return values（nil and error message） copy error \*/ ### print void print(constchar \*format, \[argument]) /\* \*Function：Print debugging information in the debugging window \*Parameter： \* format，\[argument] print Parameter format \*Return：none \*/ ### we\_bas\_fill multi we\_bas\_fill(string address, int value, uint len) /\* \*Function：Assign the same value to consecutive addresses \*Parameter： \* address address \* value value \* len Continuous length (unit: words) \*Return：TRUE set correctly \* multi return values（nil and error message） set error \*/ ### we\_bas\_beep void we\_bas\_beep() /\* \*Function：beep \*Parameter： \* none \*Return：none \*/ ### we\_bas\_newnoaddr multi we\_bas\_newnoaddr(string address, uint len) /\* \*Function：offset address \*Parameter： \* address address \* len length \*Return：the address after offset set correctly \* multi return values（nil and error message） set error \*/ ### we\_bas\_newstataddr multi we\_bas\_newstataddr(string address， uint len) /\* \*Function：offset station number \*Parameter： \* address address \* len length \*Return：the address after offset set correctly \* multi return values（nil and error message） set error \*/ ### we\_bas\_getscriptpath multi we\_bas\_getscriptpath() /\* \*Function：get script path \*Parameter： none \*Return：script path get successfully \* multi return values（nil and error message） get error \*/ ### we\_bas\_getcustompath string we\_bas\_getcustompath() /\* \*Function：Get user-defined folder path \*Parameter： none \*Return：data path \*/ ### we\_bas\_getusbpath multi we\_bas\_getusbpath() /\* \*Function：get u disk path \*Parameter： none \*Return：U disk path get successfully \* multi return values（nil and error message） get error \*/ ### we\_bas\_getsdpath multi we\_bas\_getsdpath() /\* \*Function：get SD card path \*Parameter： none \*Return：SD card path get successfully \* multi return values（nil and error message） get error \*/ ### we\_bas\_file\_exist bool we\_bas\_file\_exist(string path) /\* \*Function: judge whether there is a file \*Parameter： path file path \*Return：true exist \* false not exist \*/ ### we\_bas\_path\_exist bool we\_bas\_path\_exist(string path) /\* \*Function：judge whether there is a folder \*Parameter： path folder path \*Return：true exist \* false not exist \*/ ### we\_bas\_jumpscreen bool we\_bas\_jumpscreen(uint id) /\* \*Function：main screen jump \*Parameter：id screen id \*Return：true jump successfully \* false jump error \*/ ### we\_bas\_popscreen bool we\_bas\_popscreen **(**int scrno**,**int x**,** int y**)** /\* \*Function：Sub-screen pops up, if the built-in screen like keyboard pops up, the screen cannot be used \*Parameter： \* scrno Screen number of the sub screen \* x The x coordinate \* y The y coordinate \*Return： \* true success \* false failure \*Note： \*/ ### we\_bas\_closescreen bool we\_bas\_closescreen **(**int scrno**)** /\* \*Function：close subscreen \*Parameter： \* scrno Screen number of the sub screen \*Return： \* true success \* false failure \*Note： \*/ \* ## Chapter 2 Object operation function ### 2.1 we\_part\_setstate bool we\_part\_setstate**(**string partName**,** string value**)** /\* \*Function：Set the state of the object according to the object name (for bit lamp, bit switch, word switch, LUA script object) \*Parameter： \* partName object name \* value the set value \*Return： \* true success \* false failure \*Note：If object has an address, then the operation address is the monitoring address; \* If object doesn’t have an address, then the operation address is the internal address; \* The “parameter value” should be the original data \*/ ### 2.2 we\_part\_getstate string we\_part\_getstate**(**string partName**)** /\* \*Function：get the value of object（for bit lamp, bit switch, word switch, lua script object） \*Parameter： \* partName object name \*Return： \* objet value success \* nill failure \*Note：If object has an address, then the operation address is the monitoring address; \* If object doesn’t have an address, then the operation address is the internal address; \* The “parameter value” must be the original data \*/ ### 2.3 we\_part\_settchenable bool we\_part\_settchenable**(**string partName**)** /\* \*Function：Set to allow parts to be clicked (for all parts with this attribute) \*Parameter： \* partName object name \*Return： \* true success \* false failure \*Note： \*/ ### 2.4 we\_part\_settchunable bool we\_part\_settchunable**(**string partName**)** /\* \*Function：Set to not allow parts to be clicked (for all parts with this attribute) \*Parameter： \* partName object name \*Return： \* true success \* false failure \*Note： \*/ ### 2.5 we\_part\_gettchstate bool we\_part\_gettchstate**(**string partName**)** /\* \*Function：Get whether the part is allowed to be clicked (for all parts with this attribute) \*Parameter： \* partName object name \*Return： \* true allowed \* false not allowed \* nill failure \*Note： \*/ ### 2.6 we\_part\_sethidestate bool we\_part\_sethidestate**(**string partName**,** int value**)** /\* \*Function：Set part hidden attribute (for all parts with this attribute) \*Parameter： \* partName object name \* value the set value \* 0：Dispaly or hide according to part control address \* 1：Just display and not affected by the control address \* 2：Just hide and affected by the control address \*Return： \* true success \* false failure \*Note： \*/ ### 2.7 we\_part\_gethidestate bool we\_part\_gethidestate**(**string partName**)** /\* \*Function：Get hidden attributes of parts (for all parts with this attribute) \*Parameter： \* partName object name \*Return： \* true hidden \* false display \* nill failure \*Note： \*/ ### 2.8 we\_part\_clickdown bool we\_part\_clickdown**(**string partName**)** /\* \*Function：Send click-down command messages to specified parts (for all parts with this attribute) \*Parameter： \* partName object name \*Return： \* true success \* false failure \*Note： \*/ ### 2.9 we\_part\_clickup bool we\_part\_clickup**(**string partName**)** /\* \*Function：Send click-up command messages to specified parts (for all parts with this attribute) \*Parameter： \* partName object name \*Return： \* true success \* false failure \*Note： \*/ ### 2.10 we\_part\_setcurrc bool we\_part\_setcurrc**(**string partName**,** int Left**,** int Top**,** int Right**,** int Bottom**)** /\* \*Function：Set the contour information of the part (for all parts with this attribute) \*Parameter： \* partName object name \* Left coordinate of the left side of the part \* Top coordinate of the top side of the part \* Right Coordinates of the right side of the part \* Bottom coordinate of the bottom side of the part \*Return： \* true success \* false failure \*Note： \*/ ### 2.11 we\_part\_getcurrc multi we\_part\_getcurrc**(**string partName**)** /\* \*Function：Get the outline information of the part (for all parts have this attribute) \*Parameter： \* partName object name \*Return： \* Left nill: Execution error \* not nill(int):coordinate of the left side of the part \* Top nill: Execution error \* not nill(int):coordinate of the top side of the part \* Right nill: Execution error \* not nill(int):Coordinates of the right side of the part \* Bottom nill: Execution error \* not nill(int):coordinate of the bottom side of the part \*Note： \*/ ### 2.12 we\_part\_getoriginalrc multi we\_part\_getoriginalrc**(**string partName**)** /\* \*Function：Get contour information of the part (for all parts with this attribute) \*Parameter： \* partName object name \*Return： \* Left nill: Execution error \* not nill(int):Coordinates of the left side of the part \* Top nill: Execution error \* not nill(int):coordinate of the top side of the part \* Right nill: Execution error \* not nill(int):coordinate of the right side of the part \* Bottom nill: Execution error \* not nill(int):coordinate of the bottom side of the part \*Note： \*/ ## Chapter 3 lfs operation library functions **Declare**: The following lists only some of the functions of the lfs library, and others that are not mentioned in the document are unavailable. For details, see . ### 3.1 lfs.attributes table lfs.attributes(string filePath \[, aname]) /\* \*Function：Get a table with file attributes corresponding to the file path, if the second parameter is given, only the value of the named attribute is returned \*Parameter： \* filePath given path \* aname attribute（optional） \*Return：Return a table get successfully \* nil get error \*/ ### 3.2 lfs.currentdir string lfs.currentdir() /\* \*Function：Get current working directory \*Parameter： \* none \*Return：Return path get successfully \* nil get error \*/ ### 3.3 lfs.dir string lfs.dir(string path) /\* \*Function：go through current directory to get file name \*Parameter： \* path Current directory path \*Return：Return file name get successfully \* nil get error \*/ ### 3.4 lfs.mkdir bool lfs.mkdir(string dirName) /\* \*Function：Create Folder \*Parameter： \* dirName Folder name \*Return： TRUE Operation correct \* nil Operation error \*/ ### 3.5 lfs.rmdir bool lfs.rmdir(string dirName) /\* \*Function：remove folder \*Parameter： \* dirName folder name \*Return： TRUE operation correct \* nil operation error \*/ --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://wecon.gitbook.io/pistudio-manual/9.-scripts/lua-script/lua-script-interfaces.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.