https://github.com/hellothisisflo/remarkablestreaming
Stream the Remarkable in 1 command
https://github.com/hellothisisflo/remarkablestreaming
Last synced: 2 months ago
JSON representation
Stream the Remarkable in 1 command
- Host: GitHub
- URL: https://github.com/hellothisisflo/remarkablestreaming
- Owner: HelloThisIsFlo
- Created: 2020-07-22T15:24:26.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-10-15T09:20:48.000Z (7 months ago)
- Last Synced: 2025-03-17T01:13:28.192Z (2 months ago)
- Language: Shell
- Size: 5.61 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Remarkable Streaming
## 1. Install deps
The version of rMview made to work with a VNC server can be found at the `vnc` branch of this repository.
1. Install the project
```bash
./install.sh
```
## 2. Run
1. Configure by tweaking the `rmview.json` config
```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
}
```
2. Start streaming
```bash
./start.sh
```