hiro/rmview
1
0
Fork 0
mirror of https://github.com/vale981/rmview synced 2025-03-05 09:11:39 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge branch 'common' into vnc

Browse source
This commit is contained in:
Emanuele 2020-09-11 02:44:32 +02:00
commit e95d646e8c
2 changed files with 41 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

46
README.md
View file

@ -28,27 +28,33 @@ the optional `config` parameter is the filename of a json configuration file.
If the parameter is not found, the program will look for a `rmview.json` file in the current directory, or, if not found, for the path stored in the environment variable `RMVIEW_CONF`.
If none are found, or if the configuration is underspecified, the tool is going to prompt for address/password.
The supported configuration settings are:
The supported configuration settings are below.
Look in file `example.json` for an example configuration.
All the settings are optional.
| Setting key | Values | Default |
| ------------------------ | ------------------------------------------------------- | ------------- |
| `ssh` | Connection parameters (see below) | `{}` |
| `orientation` | `"landscape"`, `"portrait"`, `"auto"` | `"landscape"` |
| `pen_size` | diameter of pointer in px | `15` |
| `pen_color` | color of pointer or trail | `"red"` |
| `pen_trail` | persistence of trail in ms | `200` |
| `background_color` | color of window | `"white"` |
| `fetch_frame_delay` | delay in sec after each frame fetch to throttle refresh | `0` |
| `lz4_path_on_remarkable` | absolute path on the reMarkable | `"$HOME/lz4"` |
| `hide_pen_on_press` | bool | `true` |
Connection parameters are provided as a dictionary with the following keys (all optional):
| Parameter | Values | Comments |
| ----------- | -------------------------------------- | ------------------------------- |
| `address` | IP of remarkable | tool prompts for it if missing |
| `username` | username for ssh access on reMarkable | default: `"root"` |
| `key` | Local path to key for ssh | not needed if password provided |
| `password` | Password provide by reMarkable | not needed if key provided |
| `timeout` | connection timeout in seconds | default: 1 |
```js
{ // all settings are optional, comments not allowed
"ssh": {
"address": "10.11.99.1", // works over WiFi too!
"username": "root",
"key": "~/.ssh/id_rsa_remarkable",
// alternatively to key, "password": "****" is supported
"timeout": 1 // in seconds
},
"orientation": "portrait", // auto for auto-detect, default: landscape
"pen_size": 10, // set to 0 to disable
"pen_color": "red",
"pen_trail": 1000, // set to 0 to disable, default: 200
"background_color": "black", // default: white
"fetch_frame_delay": 0.03, // sleep 0.03s on remarkable before fetching new frame (default is no delay)
"lz4_path_on_remarkable": "/usr/opt/lz4", // default: $HOME/lz4
"hide_pen_on_press": false // hides pointer when pen touches display, default: true
}
```
Tested with Python 3.8.2, PyQt 5.14.2, MacOs 10.15.4, reMarkable firmware 2.1.1.3

15
example.json Normal file
View file

@ -0,0 +1,15 @@
{
"ssh": {
"address": "10.11.99.1",
"username": "root",
"key": "~/.ssh/id_rsa",
"timeout": 2
},
"orientation": "auto",
"pen_size": 10,
"pen_color": "red",
"pen_trail": 1000,
"background_color": "black",
"fetch_frame_delay": 0.03,
"hide_pen_on_press": false
}