https://github.com/jlarriba/jrmapi

A Java API for the reMarkable Cloud
https://github.com/jlarriba/jrmapi

java remarkable-tablet

Last synced: 3 months ago
JSON representation

A Java API for the reMarkable Cloud

• Host: GitHub
• URL: https://github.com/jlarriba/jrmapi
• Owner: jlarriba
• License: apache-2.0
• Created: 2019-04-29T06:47:42.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-09-27T13:44:03.000Z (about 2 years ago)
• Last Synced: 2024-05-21T00:02:19.009Z (6 months ago)
• Topics: java, remarkable-tablet
• Language: Java
• Homepage:
• Size: 57.6 KB
• Stars: 17
• Watchers: 6
• Forks: 7
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-reMarkable - jrmapi - A Java API for the reMarkable Cloud. (APIs / Cloud API)

README

        
# jrmapi

jrmapi is a wrapper over the REST Cloud API for the reMarkable e-paper tablet implemented in Java11. It allows the access to the reMarkable files from a Java application via an easy-to-use API.

It can be downloaded from Maven Central:

```xml

    es.jlarriba

    jrmapi

    0.6

```

# usage

It reads the auth tokens from the ~/.rmapi file stored by rmapi with the usertoken and the devicetoken.

So, to use this API, first download and install rmapi, start it for the first time, associate it to your remarkable account. It will generate the .rmapi file and from then, you can use it to traverse your remarkable cloud with jrmapi.

# build

It can be build with Maven:

```

mvn package

```

However, it uses a custom version of the zip4j library that must be in your local repository. Build zip4j from: https://github.com/jlarriba/zip4j, install it in your local repository and run `mvn package`.

# api support

- [x] authentication

- [x] list documents

- [x] download a pdf (inside a zip)

- [x] download an epub (inside a zip)

- [x] extract the document from the downloaded zip file and rename it correctly

- [x] create new directory

- [x] upload a pdf

- [x] upload an epub

- [ ] move a file

- [x] delete an entry (document or directory)

- [ ] improved error control

- [ ] add tests

- [ ] provide javadoc documentation

# thanks

Many thanks to the incredible https://github.com/juruen/rmapi project, it provides a lot of insight. The documents compiled in https://github.com/splitbrain/ReMarkableAPI are also a must for reMarkable API development.

# disclaimer

The project is provided as-is, without warranty or support. The usage of the reMarkable Cloud API is

The author(s) and contributor(s) are not associated with reMarkable AS, Norway. reMarkable is a registered trademark of reMarkable AS in some countries. Please see https://remarkable.com for their product.