plantineers / edge Goto Github PK

View Code? Open in Web Editor NEW

11.0 0.0 1.0 98 KB

The microcontroller firmware of plantbuddy

License: GNU General Public License v3.0

Rust 80.48% Dockerfile 13.81% Shell 5.71%

esp32 rust embedded-rust esp-now esp32-c3 plantmonitor

edge's Introduction

Plantbuddy-edge

Introduction

Plantbuddy is a solution for monitoring your plants. This is the repository containing the aggregator Firmware for the ESP32C3. Is is responsible for collecting data from the sensors and sending it to the esp-gateway via ESP-Now to ensure long range communication. It is written in bare-metal Rust running via esp-hal and embassy.

Getting Started

Prerequisites

Rust

Installation

Clone the repository

git clone https://github.com/plantineers/edge.git

Install Rust nightly and the required target

rustup toolchain install nightly
rustup target add riscv32imc-unknown-none-elf
rustup component add rust-src

Install cargo-espflash

cargo install espflash --git https://github.com/esp-rs/espflash/

After plugging in the ESP32C3, allow access to the serial port and flash the firmware

sudo chmod a+rw /dev/<serial-port> # To permanently allow access, add your user to the dialout or uucp group depending on the distro
cargo run --release --features "<features, comma, seperated>" # See below for available features

Features

For every sensor there is a feature that can be enabled to include it in the build. The following features are available:

Feature	Description	Output
`tsl2591`	Enable the TSL2591 light sensor	`{"light": <lux>}`
`hw390`	Enable the HW390 soil moisture sensor	`{"soil-moisture": <percentage>}`
`dht11`	Enable the DHT11 temperature and humidity sensor	`{"temperature": <celsius>, "humidity": <percentage>}`
`dht22`	Enable the DHT22 temperature and humidity sensor	`{"temperature": <celsius>, "humidity": <percentage>}`

The dht11 and dht22 features are mutually exclusive. Only one of them can be enabled at a time.

edge's People

Contributors

Stargazers

Forkers

elasticdotventures

edge's Issues

Sleep modes?

Saving power when the device is not in use for multiple minutes is very worthwhile. We could use the built-in sleep modes of the esp to wake it up after a time interval saving massive amounts of power. Also we could use rtc memory to store data that is persistent during even deep sleep.

Unfortunately light/deep sleep doesn't seem supported in esp-hal yet. We could also use esp-idf, which would no longer use the pure rust bindings.

Program the Gateway

Make a simple Gateway to forward the ESP-Now Requests to HTTP for the server

Generate UUIDS

I guess we're gonna have to use the rng peripheral much for this one to generate the UUIDs at first start.
This shows how to use the onboard rng:
https://github.com/esp-rs/esp-hal/blob/main/esp32c3-hal/examples/rng.rs

DHT22 Support

Normalisation of Sensor Data

FreeRTOS/Tockos?

The most common RTOS to develop applications with on the esp32c3 is FreeRTOS. This has Rust bindings and would probably support deep/light sleep and give us higher level abstractions, however the project would no longer be bare-metal.

ESP-Now or WIFI?

Timing fixes

Currently we have the problem that esp-now is screwing up timings. While this is fine for I2C and the tsl2591 it screws up the timings on pretty much all sensors needing a delay. Since the esp32c3 doesn't have a second core we cannot just switch to another core.

We have two ways really here and both seem hard and time-intensive:

Rewrite the project for an ESP with multiple cores(the original ESP32 comes to mind but i haven't had luck with spawning something on the other CPU core while wifi is running so a quick PoC would be necessary in order to justify the attempt)(takes less time)(useful link)
Get some way to have more accuracy despite having wifi started on the same CPU(I doubt this is possible and do not know how to even attempt this...)
Turn wifi on and off(have to look into if that is even possible but would be the easiest way)