https://github.com/ewpratten/kobo-rs

A library for interacting with Kobo devices
https://github.com/ewpratten/kobo-rs

embedded hardware-api kobo rust-hardware

Last synced: 2 months ago
JSON representation

A library for interacting with Kobo devices

• Host: GitHub
• URL: https://github.com/ewpratten/kobo-rs
• Owner: ewpratten
• License: gpl-3.0
• Created: 2022-04-12T14:50:35.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2023-04-13T17:03:32.000Z (over 1 year ago)
• Last Synced: 2024-10-10T17:19:39.078Z (2 months ago)
• Topics: embedded, hardware-api, kobo, rust-hardware
• Language: Rust
• Homepage: https://crates.io/crates/kobo
• Size: 35.2 KB
• Stars: 12
• Watchers: 4
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# kobo-rs

[![Crates.io](https://img.shields.io/crates/v/kobo)](https://crates.io/crates/kobo) 

[![Docs.rs](https://docs.rs/kobo/badge.svg)](https://docs.rs/kobo) 

[![Build](https://github.com/Ewpratten/kobo-rs/actions/workflows/build.yml/badge.svg)](https://github.com/Ewpratten/kobo-rs/actions/workflows/build.yml)

[![Clippy](https://github.com/Ewpratten/kobo-rs/actions/workflows/clippy.yml/badge.svg)](https://github.com/Ewpratten/kobo-rs/actions/workflows/clippy.yml)

`kobo-rs` is a minimal Rust library for interacting with modified Kobo e-readers. This is designed for use in applications running *on* the Kobo, not over the network.

## Building

Since we are cross-compiling (please don't try compiling software *on* a Kobo), we need a few tools.

```sh

docker pull ewpratten/kobo-cross-armhf:latest

cargo install cross

```

With that out of the way, the library can be built with:

```sh

cross build --target arm-unknown-linux-musleabihf

```

You'll need to do these same steps with your own applications.

## Running an example

To build and run the `display` example, you'll need to do the following:

```sh

cross build --target arm-unknown-linux-musleabihf --release --example display

```

Then, copy the binary to the Kobo's internal storage and execute the following command on the device:

```sh

/mnt/onboard/display

```