The goMarkableStream is a lightweight and user-friendly application designed specifically for the reMarkable tablet. Its primary goal is to enable users to stream their reMarkable tablet screen to a web browser without the need for any hacks or modifications that could void the warranty.
- reMarkable with firmware < 3.4 may use goMarkableStream version < 0.8.6
- reMarkable with firmware >= 3.4 and < 3.6 may use version >= 0.8.6 and < 0.11.0
- reMarkable with firmware >= 3.6 may use version >= 0.11.0
- No hacks or warranty voiding: The tool operates within the boundaries of the reMarkable tablet's intended functionality and does not require any unauthorized modifications.
- No subscription required: Unlike other screen streaming solutions, this tool does not impose any subscription fees or recurring charges. It is completely free to use.
- No client-side installation: Users can access the screen streaming feature directly through their web browser without the need to install any additional software or plugins.
- Color support
localhost> ssh root@remarkableFor version >= 3.6
export GORKVERSION=$(wget -q -O - https://api.github.com/repos/owulveryck/goMarkableStream/releases/latest | grep tag_name | awk -F\" '{print $4}')
wget -q -O - https://github.com/owulveryck/goMarkableStream/releases/download/$GORKVERSION/goMarkableStream_${GORKVERSION//v}_linux_arm.tar.gz | tar xzvf - -O goMarkableStream_${GORKVERSION//v}_linux_arm/goMarkableStream > goMarkableStream
chmod +x goMarkableStream
./goMarkableStreamfor version < 3.6
export GORKVERSION=$(curl -s https://api.github.com/repos/owulveryck/goMarkableStream/releases/latest | grep tag_name | awk -F\" '{print $4}')
curl -L -s https://github.com/owulveryck/goMarkableStream/releases/download/$GORKVERSION/goMarkableStream_${GORKVERSION//v}_linux_arm.tar.gz | tar xzvf - -O goMarkableStream_${GORKVERSION//v}_linux_arm/goMarkableStream > goMarkableStream
~/chmod +x goMarkableStream
./goMarkableStreamthen go to https://remarkable.local.:2001 and login with admin/password (can be changed through environment variables or disable authentication with -unsafe)
note: remarkable.local. may work from apple devices (mDNS resolution). Please note the . at the end. If it does not work, you may need to replace remarkable.local. by the IP address of the tablet.
note 2: you can use this to update to a new version (ensure that you killed the previous version before with kill $(pidof goMarkableStream))
If your reMarkable is on a different network than the displaying device, you can use the ngrok builtin feature for automatic tunneling.
To utilize this tunneling, you need to sign up for an ngrok account and obtain a token from the dashboard.
Once you have the token, launch reMarkable using the following command:
NGROK_AUTHTOKEN=YOURTOKEN RK_SERVER_BIND_ADDR=ngrok ./goMarkableStream
The app will start, displaying a message similar to:
2023/09/29 16:49:20 listening on 72e5-22-159-32-48.ngrok-free.app
Then, connect to https://72e5-22-159-32-48.ngrok-free.app to view the result.
There is a new exxperimental feature to record the stream in webm format. This is available on the side menu.
goMarkableStream introduces an innovative experimental feature that allows users to set a presentation or video in the background, enabling live annotations using a reMarkable tablet. This feature is ideal for enhancing presentations or educational content by allowing dynamic, real-time interaction.
- To use this feature, append
?present=https://url-of-the-embedded-fileto your streaming URL. - This action will embed your chosen presentation or video in the stream's background.
- You can then annotate or draw on the reMarkable tablet, with your input appearing over the embedded content in the stream.
- Live Presentation Enhancement: For instance, using Google Slides, you can leave spaces in your slides or use a blank slide to write additional content live. This feature is perfect for educators, presenters, and anyone looking to make their presentations more interactive and engaging.
- The feature works with any content that can be embedded in an iframe. This includes a variety of presentation and video platforms.
- Ensure that the content you wish to embed allows iframe integration.
- Screen Size: Currently, the drawing screen size on the tablet is smaller than the presentations, which may affect how content is displayed.
- Control: There is no way to control the underlying presentation directly from the tablet. Users must use the side menu for navigation and control.
- This feature operates seamlessly, with no additional load on the reMarkable tablet, as all rendering is done in the client's browser.
- As this is an experimental feature, your feedback is crucial for its development. Please share your experiences, suggestions, and any issues encountered using the GitHub issues section of this repository.
This is a standalone application that runs directly on a Remarkable tablet. It does not have any dependencies on third-party libraries, making it a completely self-sufficient solution. This application exposes an HTTP server with two endpoints:
/: This endpoint serves an embedded HTML and JavaScript file containing the necessary logic to display an image from the Remarkable tablet on a client's web browser./stream: This endpoint streams the image data from the Remarkable tablet to the client continuously.
The image data is read directly from the main process's memory as a byte array. A simple Run-Length Encoding (RLE) compression algorithm is applied on the tablet to reduce the amount of data transferred between the tablet and the browser. The CPU footprint is relatively low, using about 10% of the CPU for a frame every 200 ms. You can increase the frame rate, but it will consume slightly more CPU.
On the client side, the streamed byte data is decoded and displayed on an invisible canvas that matches the size of the Remarkable tablet's display. This canvas is then copied to another responsive canvas for viewing.
Additionally, the application features a side menu which allows users to rotate the displayed image. All image transformations utilize native browser implementations, providing optimized performance.
Despite the continuous streaming and processing of images, this application maintains a minimal impact on the CPU, using only about 10% of its capacity. However, increasing the frame rate will proportionally increase CPU usage. On idle (if not browser is opened), the programs goes to idel and therefore does not drain the battery.
All operations, including image rendering and transformations, are performed using the client's native browser capabilities. This ensures the best performance and compatibility across a range of devices.
The application includes features for rotating the displayed image. This is achieved using the browser's native capabilities, ensuring an optimal performance during transformations.
To use the reMarkable Screen Streaming Tool, follow these steps:
- Ensure that you have a reMarkable tablet and a computer or device with an ssh client.
- Get a compiled version from the release or compile it yourself
- copy the utility on the tablet
- launch the utility by conencting via ssh and launch
./goMarkableStream & - go to https://IP-OF-REMARKABLE:2001 (you need to accept the self-signed certificate)
The application is configured via environment variables:
KEY TYPE DEFAULT REQUIRED DESCRIPTION
RK_SERVER_BIND_ADDR String :2001 true
RK_SERVER_USERNAME String admin
RK_SERVER_PASSWORD String password
RK_HTTPS True or False true
GOOS=linux GOARCH=arm GOARM=7 CGO_ENABLED=0 go build .
I welcome contributions from the community to improve and enhance the reMarkable Screen Streaming Tool. If you have any ideas, bug reports, or feature requests, please submit them through the GitHub repository's issue tracker.
The reMarkable Screen Streaming Tool is released under the MIT License . Feel free to modify, distribute, and use the tool in accordance with the terms of the license.
If you plan to buy a reMarkable 2, you can use my referal program link. It will provide a discount for you and also for me.