pragmatically-dev/png2rm-system

This repository implements a gRPC service for converting PNG files to Remarkable tablet documents. Clients can stream PNG images, which are processed and converted to .rmdoc format. The service, written in Go, receives PNG files in chunks, saves them, converts them with the drawj2d tool, and streams the resulting document back to the client

PNG2RM CONVERSION SYSTEM

Overview

The System is implemented using Go and leverages gRPC for communication. It provides a server that can receive PNG files in chunks, save them, convert them using an external tool (drawj2d) the PoC-drawj2d-port-go, and stream the resulting Remarkable document back to the client.

Special Acknowledgment to:

This wouldn't have been possible without your help and incredible developments.

---

How it works (Now the server is in charge of the conversion using the PoC):

Preview

https://youtube.com/shorts/NGzp8g97Z1Y?si=tWxixrLJTe--_qKd

Requirements:

• Protoc: https://grpc.io/docs/protoc-installation/

Server side:

• Golang: https://go.dev/dl

Client side (tablet):

• rm-hacks (enables screenshot feature): https://github.com/mb1986/rm-hacks

• webinterface-onboot: https://github.com/rM-self-serve/webinterface-onboot

How to setup (locally):

Server:

1. Install Go and necessary dependencies:

   • Ensure you have Go installed on your system. You can download and install it from golang.org.
   • Set up your development environment to work with Go. Configure $GOPATH and add $GOPATH/bin to your $PATH.

2. Create the server-config.yaml file:

   • This file should contain the necessary configuration for the server. Create a file named server-config.yaml in the same directory as the main.go file with the following content:

     image_folder: "/path/to/image/folder"
     run_path: "/path/to/run/path"
     server_address: "localhost:4040"

   • Adjust the values of image_folder, run_path, and server_address according to your needs.

---

Client (tablet):

⚠️ Please be sure to have rm-hacks and webinterface-onboot Installed⚠️

1. Transfrer the client installer tar to the remarkable:

   then:

   $remarkable: ~/ tar -xvf png2rm_arm.tar
   $remarkable: ~/ cd png2rm_arm-installer
   $remarkable: ~/ ./install.sh
   

---

Now you should be able to convert your screenshots to rmlines in 3 sec

---

Knowloadge base:

• https://www.youtube.com/playlist?list=PLy_6D98if3UJd5hxWNfAqKMr15HZqFnqf

• https://blog.stackademic.com/go-concurrency-visually-explained-select-statement-b546596c8e6b

• https://blog.stackademic.com/go-concurrency-visually-explained-channel-c6f88070aafa

• https://blog.stackademic.com/go-concurrency-visually-explained-select-statement-b546596c8e6bs

png2rm-system's Issues

Running server

Do I understand correctly that for the transfer to work, the PC where the server will run must be turned on?
You can use raspberryPi or others but without the server running it is not possible to do the conversion?

Thank you for the information.

Refactor the code to make it maintainable

Also implement context library and make every hardcodes parameter configurable via Yaml file

Create a PoC using QUIC Protocol

https://github.com/sssgun/grpc-quic/
https://github.com/sssgun/grpc-quic/blob/main/examples/helloworld/server/grpc_over_quic_server.go