mirror of
https://github.com/Doodle3D/doodle3d-firmware.git
synced 2024-12-22 11:03:48 +01:00
40 lines
2.2 KiB
Markdown
40 lines
2.2 KiB
Markdown
WiFi box OpenWRT firmware package
|
|
=================================
|
|
|
|
General documentation can be found on the wiki: <http://doodle3d.com/help/wiki>. Source code documentation can be generated, see below.
|
|
|
|
|
|
Documentation
|
|
-------------
|
|
|
|
The script 'doxify.sh' generates HTML documentation of the source code in the directory 'docs'.
|
|
Make sure the 'ldoc' program is installed on your machine and the LDOC variable in the script points there.
|
|
|
|
On OSX, this can be accomplished by installing it through luarocks (run `sudo luarocks install ldoc`). Luarocks can be installed using [MacPorts](http://www.macports.org/). After installing that, the command would be `sudo port install luarocks`.
|
|
|
|
Command line interface
|
|
----------------------
|
|
The Doodle3D API can be called using a terminal:
|
|
|
|
```d3dapi p=/network/scan r=GET```
|
|
|
|
Where the p parameter is the module you want to call and r is the method.
|
|
Post request can be send using the same method:
|
|
|
|
```d3dapi p=/printer/print r=POST```
|
|
|
|
Parameters: TODO
|
|
|
|
Debugging Lua
|
|
-------------
|
|
|
|
Syntax errors in Lua can lead to tricky issues since they might only surface when the faulty code is actually being run.
|
|
|
|
One countermeasure for this is to use [pcall](http://www.lua.org/pil/8.4.html) instead of regular calls in many cases. To let the error 'happen' (which in turn gives information in the form of stack traces), tell the code to use regular calls by setting 'M.DEBUG_PCALLS' to 'true' in `conf_defaults.lua`.
|
|
|
|
Additionally, when the pcall setting is not enough, a second way of debugging is to take uhttpd out of the loop and invoke the Lua code from command-line. To do this, set 'M.DEBUG_API' to 'true' in `conf_defaults.lua`. Then invoke the API using the command `d3dapi p=/mod/func r=POST` where `p=` is followed by the API path and `r=` followed by either 'GET' or 'POST'.
|
|
|
|
Note that because stack traces are sent to `stderr`, this script redirects output streams to a separate log file: `/tmp/wifibox.stdout.log`; apart from these traces, the file should not contain any data.
|
|
|
|
Finally, the `CGI` gateway of uhttpd also uses this script, so the API can also be used to obtain stack traces by calling it as `<wifibox-ip>/cgi-bin/d3dapi/<endpoint>` (note the extra `cgi-bin`).
|