nixo
/
tuhi
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Updated Using Tuhi (markdown)

Peter Hutterer 2019-08-09 15:53:42 +10:00
parent 7e7ae5d9e9
commit ad24068c8b
1 changed files with 21 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

80
Using-Tuhi.md

@ -1,69 +1,31 @@
This is a quickstart to get you up and running with Tuhi. For details, see the [[Terminology]] page.
A few notes on the Tuhi GUI.
# Tuhi
## Tuhi defaults to the first device
Tuhi is a DBus session daemon. From the git repository, simply start with:
```
$ ./tuhi.py
```
Tuhi GUI only supports a single device. Where multiple devices are present, it will simply pick the first one it finds. Unless you have more than one device, this is not an issue.
If you have [installed](Installation) Tuhi, start it with `tuhi` from your favorite shell.
## Registering a device
# Tuhi Kete
When Tuhi first opens with no device [[registered|Terminology]], it will start the registration process. Follow the instructions which basically consist of: press and hold the button for 6 seconds until the blue light flashes. Then press the button again when prompted.
`kete` is the commandline tool to interact with Tuhi featuring an interactive shell. `kete` is currently on available in the git repository and does not get installed. A graphical UI to Tuhi is in the works.
## Downloading drawings
## Registering a device with Tuhi Kete
The above process of registering a device is as follows:
```
$ ./tools/kete.py
Tuhi shell control
INFO: Connected to the Tuhi daemon
tuhi> search
INFO: Search started
tuhi>
```
Now hold the device button until the blue light starts flashing and you'll see:
```
INFO: Unregistered device: DC:2C:26:A0:C9:A8 - LE Paper
tuhi>
```
Register the device with the Bluetooth address (tab-completion is available)
```
INFO: Unregistered device: DC:2C:26:A0:C9:A8 - LE Paper
tuhi> register DC:2C:26:A0:C9:A8
INFO: DC:2C:26:A0:C9:A8 - LE Paper: Press button on device now
```
Press the device button when prompted.
```
INFO: DC:2C:26:A0:C9:A8 - LE Paper: Press button on device now
INFO: DC:2C:26:A0:C9:A8 - LE Paper: Registration successful
```
And done. The device is now available in Tuhi.
Tuhi will automatically download any drawings from the device when connected. To initialize a connection, press the button on the device while Tuhi is running.
## Downloading drawings with Tuhi Kete
**WARNING: Drawings get deleted from the device after downloading.** This appears to be an inherent functionality of the device firmware.
The `info` command shows some basic data of the device, including which drawings are available. The `listen` command starts to listen for new data on the device. To get the device to connect, press its button. This is usually only needed once, the device stays connected while Tuhi is running and listening and Tuhi will keep downloading data as it is made available by the device.
## Manipulating drawings
```
tuhi> info DC:2C:26:A0:C9:A8
DC:2C:26:A0:C9:A8 - LE Paper
Battery level: 78%, discharging
Available drawings:
* 1518566232: drawn on the 2018-02-14 at 09:57
* 1518570062: drawn on the 2018-02-14 at 11:01
tuhi> listen DC:2C:26:A0:C9:A8
[...]
tuhi> listen DC:2C:26:A0:C9:A8 off
```
To download a drawing, use the `fetch` command, either with the drawing's identifier or the `all` keyword:
```
tuhi> fetch DC:2C:26:A0:C9:A8 1518566232
INFO: LE Paper: saved file "LE Paper-2018-02-14-09-57.svg"
tuhi> fetch DC:2C:26:A0:C9:A8 all
INFO: LE Paper: saved file "LE Paper-2019-07-15-16-44.svg"
INFO: LE Paper: saved file "LE Paper-2019-07-15-16-45.svg"
...
```
And the SVG file will be available in your `$PWD`.
Drawings can only be rotated. Use the buttons above the drawings to rotate left or right, or the hamburger menu to change the orientation of the tablet permanently.
## Saving drawings
Use the "save as" button above each drawing to save it to the file system.
## Deleting drawings
Use the delete button above each drawing to delete it. Unless deleted, the drawing will stay around forever but you **really** don't want to rely on Tuhi as a backup system for your precious drawings.
## Zooming
There is a zoom slider inside the window bar, use that to enlarge the thumbnails where needed. This has no effect on the actual drawings which are always in device units.