feliix42/inky-ticker
1
0
Fork 0
Code Issues 3 Pull requests Projects Releases Packages Wiki Activity
A ticker to display some information on my Inky pHAT display.
12 commits 1 branch 0 tags 160 KiB
Rust 100%
Find a file
Felix Suchert b8c2dea685
Replace reqwest with ureq (#2) 
This replaces the `reqwest` crate with `ureq`, a smaller, less fat
alternative HTTP client. Using the new library helped shaving off about
50 project dependencies.
2023-03-28 17:40:56 +02:00
src Replace reqwest with ureq (#2) 2023-03-28 17:40:56 +02:00
.gitignore Implement weather API call 2022-08-07 21:29:03 +02:00
Cargo.lock Replace reqwest with ureq (#2) 2023-03-28 17:40:56 +02:00
Cargo.toml Replace reqwest with ureq (#2) 2023-03-28 17:40:56 +02:00
Cross.toml Initial commit 2022-08-02 21:50:40 +02:00
LICENSE Add License 2022-08-03 20:45:37 +02:00
rain2.bmp Rudimentary image displaying 2022-08-05 23:16:54 +02:00
README.md Implement weather API call 2022-08-07 21:29:03 +02:00

README.md

Inky Ticker

An Info display for my Inky pHAT.

Description

This repository provides an info display for an Inky pHAT, or a SSD1675 eInk display attached to a Raspberry Pi, to be more specific.

It displays (as of now) the current weather at a given location based on data provided by the OpenWeather API. I selected this particular data provider because it has a One-Call API which yields all relevant information with just one API call (hence the name, heh?). The use of the API is free so long as one stays below 1,000 requests/day (as of the time writing this). You'll need your own API key to use this project.

Copy the file src/weather/secret.rs.example to src/weather/secret.rs and replace the placeholder API key inside with yours.

Hardware Required

I developed this project for my Raspberry Pi Zero (as of me writing this there is only this one revision of the Pi Zero, though there's a version with and without WiFi) with an attached Inky pHAT.

Cross-Compiling the project

Since builds on a Pi Zero can take painfully long, I've moved to cross-compiling this project on my machine. You can do that using the cross tool by running:

cross build --target=arm-unknown-linux-gnueabi --release --bin inky --features inky

Running the Simulator

The project comes with a built-in simulator to allow for quick prototyping. To run the simulator, just execute:

cargo run --release --bin simulator --features simulator

You will need the SDL2 library for that, though. Information on how to install it can be found here.

License

This project is licensed under the MIT license. For the licensing text, refer to the LICENSE file in this repository.