Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/marcoradocchia/bombuscv-display

I2C (SSD1306) display integration for `bombuscv-rs`.
https://github.com/marcoradocchia/bombuscv-display

display i2c-display oled-display oled-display-ssd1306 oled-ssd1306 raspberry-pi ssd1306 ssd1306-oled

Last synced: about 1 month ago
JSON representation

I2C (SSD1306) display integration for `bombuscv-rs`.

Awesome Lists containing this project

README

        


BombusCV Display

![GitHub releases](https://img.shields.io/github/downloads/marcoradocchia/bombuscv-display/total?color=%23a9b665&logo=github)
![GitHub source size](https://img.shields.io/github/languages/code-size/marcoradocchia/bombuscv-display?color=ea6962&logo=github)
![GitHub open issues](https://img.shields.io/github/issues-raw/marcoradocchia/bombuscv-display?color=%23d8a657&logo=github)
![GitHub open pull requests](https://img.shields.io/github/issues-pr-raw/marcoradocchia/bombuscv-display?color=%2389b482&logo=github)
![GitHub sponsors](https://img.shields.io/github/sponsors/marcoradocchia?color=%23d3869b&logo=github)
![GitHub license](https://img.shields.io/github/license/marcoradocchia/bombuscv-display?color=%23e78a4e)


I2C (SSD1306) display integration for
[`bobmuscv-rs`](https://github.com/marcoradocchia/bombuscv-rs).

## Index

- [Use case](#use-case)
- [Examples](#examples)
- [Install](#install)
- [Cargo](#cargo)
- [Master branch](#master-branch)
- [Usage](#usage)
- [Changelog](#changelog)
- [License](#license)

## Use case

This software is intended to **extend & enhance**
[`bobmuscv-rs`](https://github.com/marcoradocchia/bombuscv-rs) functionality.

`bombuscv-display` is built to display and immediatly visualize `bombuscv-rs`
status, system and humidity/temperature sensor (i.e. DHT22) information on a
**SSD1306** oled display[^1] powered by *Raspberry Pi GPIO*.

[^1]: 0.96", 128x64 pixels, I2C display

## Examples

## Install

### Cargo

In order to install using Rust

#### Master branch

To build and install from master branch run:
```sh
cargo install --git https://github.com/marcoradocchia/bombuscv-display --branch master
```

## Usage

`bombuscv-display` reads *humidity* and *temperature* data from standard input
(i.e. a _unix pipeline_), so it's strongly recommended to use it in combination
with [`datalogger`](https://github.com/marcoradocchia/datalogger) or any other
software which is able to print to standard output such data in the following
*csv like* format: `,`.

## Changelog

Complete [CHANGELOG](CHANGELOG.md).

## License

[GPLv3](LICENSE)