doc:lua_make-your-own-scripts
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
doc:lua_make-your-own-scripts [2014/08/17 12:53] – [The Communication Commands] admin | doc:lua_make-your-own-scripts [2015/12/06 11:23] – admin | ||
---|---|---|---|
Line 136: | Line 136: | ||
- | ==== The Communication | + | ==== The Communication Commands ==== |
Line 170: | Line 170: | ||
==== The IO Commands ==== | ==== The IO Commands ==== | ||
- | FIXME the whole IO section is in pure experimental state. There' | + | |
+ | FIXME the whole IO command | ||
OOBD uses its own scheme for file IO, mainly driven by the restriction of a remote user and the need of complex data buffer handling. | OOBD uses its own scheme for file IO, mainly driven by the restriction of a remote user and the need of complex data buffer handling. | ||
+ | |||
Similar to the LUA simple IO model, OOBD has always only just input and output file handle. As long as not redirected, these are stdin and stdout. | Similar to the LUA simple IO model, OOBD has always only just input and output file handle. As long as not redirected, these are stdin and stdout. | ||
- | As OOBD knows more as only one type of data sources, filenames are given as URL, not just as simple path. | ||
+ | As OOBD knows more as only one type of data sources, the parameter '' | ||
+ | . | ||
- | === ioInput(URL[, | ||
- | Set the actual input file stream to URL, where URL could be | + | === ioInput(file_name |
- | ^ | + | |
- | | '' | + | Tries to open the file accourding to the following parameter combinations: |
- | | '' | + | |
+ | |||
+ | ^ | ||
+ | |/unix-path/.. |any message |Open a file Open dialog with preselected path (and file). At success returns | ||
+ | |/ | ||
+ | |URL like '' | ||
+ | |URL like '' | ||
=== ioRead(" | === ioRead(" | ||
- | Read one line of the input file ending with either \r\n or \n as string without the EOL. In case of input EOF or read errors the function returns nil | + | |
+ | |||
+ | Read one line of the input file ending with either | ||
=== ioRead (" | === ioRead (" | ||
+ | |||
+ | |||
Read the whole file as string | Read the whole file as string | ||
- | === ioRead (count) === | + | === ioRead (" |
- | Read count number of bytes as string | + | |
- | === ioOutput(URL[, | ||
- | Try to opens '' | + | Here it's assumed that the input file consists of a JSON string containing data. This string |
- | === ioWrite (String) === | ||
- | Attaches the string content to the output file | ||
+ | === ioRead (" | ||
- | ==== Miscellaneous | ||
- | === serDisplayWrite(String) === | + | This mainly for testing purposes. It returns the sha256 checksum of that file |
- | Writes //String// to the build in output console. | + | |
+ | ==== The Buffer Commands ==== | ||
+ | |||
+ | |||
+ | FIXME this whole Buffer section is not implemented and actual just here as a reference for discussion | ||
+ | |||
+ | |||
+ | === loadbuffer === | ||
+ | len, newfilename= loadbuffer(start , filelen , file_name , file_extension , message) | ||
+ | |||
+ | Reads the file " | ||
+ | |||
+ | The data source can be defined as explained for the ioInput command. | ||
+ | |||
+ | The number of bytes read will be returned in " | ||
+ | |||
+ | The following conditions apply: | ||
+ | * The selected filename will be returned in " | ||
+ | * If filename is 0, the whole file will be read. If the length exceeds the telegram length, an error will be raised. | ||
+ | |||
+ | |||
+ | |||
+ | |||
+ | === savebuffer === | ||
+ | len, newfilename = savebuffer(start , filelen , file_name , file_extension , message) | ||
+ | |||
+ | Writes | ||
+ | |||
+ | The number of bytes written will be returned in " | ||
+ | |||
+ | The following conditions apply: | ||
+ | * The selected file name will be returned in " | ||
+ | * If len is 0, the whole telegram buffer will be written. | ||
+ | |||
+ | === setbuffer === | ||
+ | setBuffer(bufferNr , newSize ) | ||
+ | |||
+ | Changes the actual buffer used to buffer number " | ||
+ | |||
+ | If newsize is <> 0, the old buffer is deleted and new memory with size newmem is allocated | ||
+ | |||
+ | |||
+ | === copyBuffer === | ||
+ | copyBuffer(bufferNr ) | ||
+ | |||
+ | Copies the content of buffer | ||
+ | |||
+ | |||
+ | |||
+ | |||
+ | === BlitBuffer === | ||
+ | BlitBuffer(frombuffer , startpos , topos , blocklen | ||
+ | |||
+ | Copies a memory block from the buffer " | ||
+ | |||
+ | In case the buffer len needs to be bigger, the buffer len is increased accourdingly. | ||
+ | |||
+ | === SetBufferLen === | ||
+ | |||
+ | |||
+ | | ||
+ | |||
+ | All other buffer commands can increase the ' | ||
+ | |||
+ | SetBufferLen sets the ' | ||
+ | |||
+ | The success of the SetBufferLen - operation is returned as function result as follows: | ||
+ | |||
+ | ^ input value of newSize | ||
+ | | < = 0 | available size of the buffer in bytes. This can be used to read the real allocated memory size of that buffer | ||
+ | | 1.. available size | new available size (= requested size) | | ||
+ | | > available size | available size of the buffer as **negative value ** . This is a fault condition | | ||
+ | |||
+ | As seen, a negative value given back indicates a fault condition, all other returned values are positive. | ||
+ | |||
+ | |||
+ | === SendBuffer === | ||
+ | Sends the actual buffer | ||
+ | |||
+ | |||
+ | |||
+ | ==== WriteString Command Syntax ==== | ||
+ | |||
+ | As default the command | ||
+ | |||
+ | serDisplayWrite(String) | ||
+ | |||
+ | |||
+ | writes | ||
+ | |||
+ | serDisplayWrite(parameter, | ||
+ | |||
+ | The different commands have the following effects: | ||
+ | |||
+ | ^ parameter | ||
+ | | buffername | ||
+ | | - | clear | clears actual buffer content | | ||
+ | | - | clearall | ||
+ | | filename | ||
+ | | filename | ||
+ | | filename | ||
+ | | filename | ||
+ | |||
+ | |||
+ | |||
+ | |||
+ | ==== Miscellaneous | ||
=== dbLookup(db-File , searchstring) === | === dbLookup(db-File , searchstring) === | ||
- | Searches in the //db-file// for all entries with index // | + | |
+ | Searches in the //db-file// for all entries with index // | ||
dbLookup() returns a Lua table | dbLookup() returns a Lua table | ||
- | | + | |
- | myTable = dbLookup(" | + | |
+ | < | ||
+ | myTable = dbLookup(" | ||
+ | </ | ||
// | // | ||
- | * if // | ||
- | * if // | ||
- | * if // | ||
- | When something has been found, than //myTable// contains two sections, //header// and //data//. | + | |
+ | * if // | ||
+ | * if // | ||
+ | * if // | ||
+ | |||
+ | |||
+ | When something has been found, than // | ||
The header section is needed in case you don't know in which column your wanted result is stored; you can identify the column by its column header name instead: | The header section is needed in case you don't know in which column your wanted result is stored; you can identify the column by its column header name instead: | ||
- | col= myTable.header[" | ||
- | print (col) | ||
- | 2 | ||
- | |||
- | // | ||
+ | < | ||
+ | col= myTable.header[" | ||
+ | print (col) | ||
+ | 2 | ||
+ | </ | ||
+ | |||
+ | |||
+ | // | ||
+ | |||
+ | |||
+ | The // | ||
+ | |||
+ | |||
+ | < | ||
+ | result=myTable.data[row][column] | ||
+ | </ | ||
+ | |||
+ | |||
+ | **ATTENTION**: | ||
+ | |||
+ | |||
+ | < | ||
+ | column=3 | ||
+ | row=2 | ||
+ | result=myTable.data[tostring(row)][tostring(column)]) | ||
+ | </ | ||
- | The //data// section then contains the found data itself, arranged as a two dimensional array, sorted by rows and columns. | ||
- | result=myTable.data[row][column] | + | Here after all a piece of sample code |
- | + | ||
- | **ATTENTION**: | + | |
- | column=3 | ||
- | row=2 | ||
- | result=myTable.data[tostring(row)][tostring(column)]) | ||
- | | ||
- | | ||
- | Here after all a piece of sample code | ||
<code lua> | <code lua> | ||
myTable= dbLookupCall(" | myTable= dbLookupCall(" | ||
+ | |||
print (" | print (" | ||
for k,v in pairs (myTable.header) do | for k,v in pairs (myTable.header) do | ||
print (k," | print (k," | ||
end | end | ||
+ | |||
nrOfColumns = myTable.header.size | nrOfColumns = myTable.header.size | ||
nrOfRows = myTable.len | nrOfRows = myTable.len | ||
+ | |||
print ("Rows x Columns:" | print ("Rows x Columns:" | ||
- | + | ||
+ | |||
for row = 1 , nrOfRows , 1 do | for row = 1 , nrOfRows , 1 do | ||
for column = 1 , nrOfColumns, | for column = 1 , nrOfColumns, | ||
- | | + | |
print (cy, cx, myTable.data[tostring(row)][tostring(column)]) | print (cy, cx, myTable.data[tostring(row)][tostring(column)]) | ||
end | end | ||
end | end | ||
</ | </ | ||
+ | |||
=== openXCVehicleData(lua table) === | === openXCVehicleData(lua table) === | ||
- | OOBD can work as VehicleDatasource for [[http:// | + | |
+ | OOBD can work as VehicleDatasource for [[http:// | ||
To do so, a lua table is filled with the right indentifiers and correct formated values accourding to the [[https:// | To do so, a lua table is filled with the right indentifiers and correct formated values accourding to the [[https:// | ||
+ | |||
With that table openXCVehicleData() is called and the data are been transferred to the openXC backbone task for further handling. | With that table openXCVehicleData() is called and the data are been transferred to the openXC backbone task for further handling. | ||
- | | + | |
- | + | < | |
+ | openXCVehicleData({timestamp= 1332794087.675514, | ||
+ | </ | ||
+ | |||
So everything which is understood by openXC can be generated out of a OOBD lua script. | So everything which is understood by openXC can be generated out of a OOBD lua script. | ||
doc/lua_make-your-own-scripts.txt · Last modified: 2019/04/08 18:43 by admin