https://github.com/jwillikers/humble-humidity-sensor

A simple, portable humidity sensor
https://github.com/jwillikers/humble-humidity-sensor

eink embedded epaper epd feather humidity humidity-sensor no-std rp2040 rust sensor shtc3

Last synced: 8 months ago
JSON representation

A simple, portable humidity sensor

Host: GitHub
URL: https://github.com/jwillikers/humble-humidity-sensor
Owner: jwillikers
License: other
Created: 2022-05-03T03:01:50.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2022-05-31T02:36:02.000Z (over 3 years ago)
Last Synced: 2025-02-14T21:38:55.511Z (8 months ago)
Topics: eink, embedded, epaper, epd, feather, humidity, humidity-sensor, no-std, rp2040, rust, sensor, shtc3
Language: Rust
Homepage:
Size: 29.3 KB
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.adoc
- License: LICENSE-APACHE
- Code of conduct: CODE_OF_CONDUCT.adoc

Awesome Lists containing this project

README

          = Humble Humidity Sensor

Jordan Williams 

:experimental:

:icons: font

ifdef::env-github[]

:tip-caption: :bulb:

:note-caption: :information_source:

:important-caption: :heavy_exclamation_mark:

:caution-caption: :fire:

:warning-caption: :warning:

endif::[]

:Adafruit-Feather-RP2040: https://www.adafruit.com/product/4884[Adafruit Feather RP2040]

:adafruit-feather-rp2040-bsp: https://github.com/rp-rs/rp-hal/tree/main/boards/adafruit-feather-rp2040[adafruit-feather-rp2040]

:Asciidoctor-link: https://asciidoctor.org[Asciidoctor]

:elf2uf2-rs: https://github.com/JoNil/elf2uf2-rs[elf2uf2-rs]

:epd-waveshare: https://github.com/caemor/epd-waveshare[epd-waveshare]

:embedded-graphics: https://github.com/embedded-graphics/embedded-graphics[embedded-graphics]

:embedded-hal: https://github.com/rust-embedded/embedded-hal[embedded-hal]

:embedded-time: https://github.com/FluenTech/embedded-time/[embedded-time]

:fish: https://fishshell.com/[fish]

:flip-link: https://github.com/knurling-rs/flip-link[flip-link]

:Git: https://git-scm.com/[Git]

:hs-probe: https://github.com/probe-rs/hs-probe[hs-probe]

:Linux: https://www.linuxfoundation.org/[Linux]

:probe-rs: https://probe.rs/[probe-rs]

:probe-run: https://github.com/knurling-rs/probe-run[probe-run]

:Python: https://www.python.org/[Python]

:rp2040-project-template: https://github.com/rp-rs/rp2040-project-template[Project template for rp2040-hal]

:rp-hal: https://github.com/rp-rs/rp-hal[rp-hal]

:Rouge: https://rouge.jneen.net/[Rouge]

:Ruby: https://www.ruby-lang.org/en/[Ruby]

:Rust: https://www.rust-lang.org/[Rust]

:rustup: https://rustup.rs/[rustup]

:shtcx: https://github.com/dbrgn/shtcx-rs[shtcx]

:SHTC3: https://sensirion.com/products/catalog/SHTC3/[SHTC3]

:smart-leds: https://github.com/smart-leds-rs/smart-leds[smart-leds]

:UF2: https://github.com/microsoft/uf2[UF2]

:ws2812-pio: https://github.com/ithinuel/ws2812-pio-rs/[ws2812-pio]

A simple humidity sensor using the {Adafruit-Feather-RP2040}, a 2.9" Waveshare e-Paper Module monochrome, and {SHTC3} humidity sensor, written in {Rust}.

== Hardware

All the hardware components in my particular build are enumerated here.

// Use 2 Half-Size Breadboard with Mounting Holes?

.Required Components

* {Adafruit-Feather-RP2040}

* https://www.adafruit.com/product/4636[Adafruit Sensirion SHTC3 Temperature & Humidity Sensor]

* https://www.adafruit.com/product/3898[Lithium Ion Polymer Battery Ideal For Feathers - 3.7V 400mAh]

* https://www.adafruit.com/product/4399[STEMMA QT / Qwiic JST SH 4-Pin Cable - 50mm Long]

* https://www.waveshare.com/product/2.9inch-e-paper-module.htm[Waveshare 2.9inch E-Ink display module]

.Optional Components

* https://www.adafruit.com/product/400[Extra-long break-away 0.1" 16-pin strip male headers]

* https://www.adafruit.com/product/64[Half-size breadboard]

* https://www.adafruit.com/product/4048[Mini SWD 0.05" Pitch Connector - 10 Pin SMT Box Header]

Programming will require a USB-C cable and a computer.

== How it Works

The humidity sensor queries and displays the temperature and humidity every 20 minutes.

// todo Detail the pin connections used on the Feather RP2040.

== Getting Started

. Install {rustup}.

+

[,sh]

----

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

----

. Clone the repository.

+

[,sh]

----

git clone https://github.com/jwillikers/humble-humidity-sensor.git

----

. Change to the project's directory.

+

[,sh]

----

cd humble-humidity-sensor

----

. Install the {Rust} toolchain for the RP2040.

+

[,sh]

----

rustup target add thumbv6m-none-eabi

----

. Install {flip-link}

+

[,sh]

----

cargo install flip-link

----

. To flash the microcontroller over USB-C, change the `.cargo/config.toml` file to use `elf2uf2-rs` as the runner.

+

..cargo/config.toml

[,toml]

----

runner = "elf2uf2-rs -d"

# runner = "probe-run --chip RP2040"

----

. Install {elf2uf2-rs}.

+

[,sh]

----

cargo install elf2uf2-rs

----

. While holding the `BOOT` button, attach the Adafruit Feather RP2040 to your computer using the USB-C port.

. Flash the board using Cargo's `run` subcommand.

+

[,sh]

----

cargo run

----

== SWD

An SWD connection is more convenient for flashing and debugging the microcontroller.

It doesn't require fiddling with the tiny buttons on the dev-board constantly.

If you've soldered an SWD debug header to the Feather RP2040, it's pretty accessible.

The {hs-probe} debugger from the {probe-rs} project works great.

. Attach the debugger to your computer.

. Attach the debugger to the Feather RP2040's SWD header.

. To flash the microcontroller over SWD, make sure that the `.cargo/config.toml` file sets the runner to `probe-run`.

+

..cargo/config.toml

[,toml]

----

# runner = "elf2uf2-rs -d"

runner = "probe-run --chip RP2040"

----

. Install {probe-run}.

+

[,sh]

----

cargo install probe-run

----

. Flash the board using Cargo's `run` subcommand.

+

[,sh]

----

cargo run

----

== Todo

* Reduce power consumption by putting XOSC into dormant mode and waking via ROSC.

* Use partial refresh to only update the necessary portion of the screen for new measurements.

* Add more pizzazz to the display.

* Profile power consumption and battery life.

* Add GitHub CI actions.

* Add pre-commit hooks?

* Include pictures in README.

== References

.Hardware

* https://learn.adafruit.com/adafruit-feather-rp2040-pico[Introducing Adafruit Feather RP2040]

* https://learn.adafruit.com/adafruit-feather-rp2040-pico/pinouts[Adafruit Feather RP2040 Pinouts]

* https://datasheets.raspberrypi.com/rp2040/rp2040-datasheet.pdf[RP2040 Datasheet]

* https://sensirion.com/media/documents/643F9C8E/6164081E/Sensirion_Humidity_Sensors_SHTC3_Datasheet.pdf[SHTC3 Datasheet]

* https://www.waveshare.com/w/upload/e/e6/2.9inch_e-Paper_Datasheet.pdf[Waveshare 2.9inch e-Paper Module Datasheet]

* https://www.waveshare.com/wiki/2.9inch_e-Paper_Module[Waveshare Wiki: 2.9inch e-Paper Module]

.Rust Docs

* https://docs.rs/adafruit-feather-rp2040/latest/adafruit_feather_rp2040/[adafruit-feather-rp2040]

* https://docs.rs/embedded-graphics/latest/embedded_graphics/[embedded-graphics]

* https://docs.rs/embedded-hal/latest/embedded_hal/[embedded-hal]

* https://docs.rs/embedded-time/latest/embedded_time/[embedded-time]

* https://docs.rs/epd-waveshare/latest/epd_waveshare/[epd-waveshare]

* https://docs.rs/rp2040-hal/latest/rp2040_hal/[rp2040-hal]

* https://docs.rs/shtcx/latest/shtcx/[shtcx]

* https://docs.rs/smart-leds/latest/smart_leds/[smart-leds]

* https://docs.rs/ws2812-pio/latest/ws2812_pio/[ws2812-pio]

== Contributing

Contributions in the form of issues, feedback, and even pull requests are welcome.

Make sure to adhere to the project's link:CODE_OF_CONDUCT.adoc[Code of Conduct].

== Open Source Software

This project is built on the hard work of countless open source contributors.

Several of these projects are enumerated below.

* {adafruit-feather-rp2040-bsp}

* {Asciidoctor-link}

* {embedded-graphics}

* {embedded-hal}

* {embedded-time}

* {elf2uf2-rs}

* {epd-waveshare}

* {fish}

* {flip-link}

* {Git}

* {hs-probe}

* {Linux}

* {probe-rs}

* {probe-run}

* {Python}

* {Rouge}

* {rp2040-project-template}

* {rp-hal}

* {Ruby}

* {Rust}

* {shtcx}

* {smart-leds}

* {ws2812-pio}

== Code of Conduct

Refer to the project's link:CODE_OF_CONDUCT.adoc[Code of Conduct] for details.

== License

Licensed under either of

* Apache License, Version 2.0 (link:LICENSE-APACHE[LICENSE-APACHE] or http://www.apache.org/licenses/LICENSE-2.0)

* MIT license (link:LICENSE-MIT[LICENSE-MIT] or http://opensource.org/licenses/MIT)

at your option.

© 2022 Jordan Williams

== Authors

mailto:{email}[{author}]

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/jwillikers/humble-humidity-sensor

Awesome Lists containing this project

README