mirrors
/
tuhi
mirror of https://github.com/tuhiproject/tuhi.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Created Log files (markdown)

master
Peter Hutterer 2019-08-15 14:58:27 +10:00
parent 43319f5851
commit 94d6b42e04
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
Log-files.md Normal file

@ -0,0 +1,19 @@
Downloading drawings from a tablet is destructive - the drawings get deleted after a successful download. So we *really* want to make sure we don't screw things up and log as much as possible to recover the data if need be.
The default directory for all of Tuhi's data storage is `$XDG_DATA_DIR/tuhi`, usually `$HOME/.local/share/tuhi/`. Inside are the various data files Tuhi uses.
## Raw log files
Any communication between Tuhi and the device is logged as a YAML file in `$XDG_DATA_DIR/tuhi/<bluetooth address>/raw/`. The files are named after the time they were created, e.g. `log-1565844084-2019-08-15-14:41:24.yaml`, i.e. in the format `log-$UNIX_TIMESTAMP-$HUMAN_READABLE_TIME.yaml`.
These files contain *one single interaction* with the device, they are created whenever the device connects. Given that it's BLE, the device will disconnect after any check - every few seconds. Most of the files will not have any useful data in it, grep for ``PEN`` to search for files with Pen data.
The YAML format is not guaranteed to be stable, it is a backup only. The file format is not documented, it's self-descriptive.
## JSON source files
Any converted drawing is stored as JSON file in `$XDG_DATA_DIR/tuhi/<bluetooth address>/<timestamp>.json`. These are the files that the Tuhi server will make available over DBus. There is no storage guarantee for those files, they may be deleted at any time. They exist primarily to make testing easier, so we can keep a few files around to verify the server part works as expected.
## Converted SVG files
The Tuhi GUI converts JSON files into SVG files. These are stored in `$XDG_DATA_DIR/tuhi/svg/`. Note that because the GUI only handles one device, there is no bluetooth address encoded here. These SVG files are considered cached files only and any interaction with the GUI may regenerate those files.