https://github.com/ivmarkov/ruwm

[Ru]st [W]ater [M]eter - my explorations into an embedded, async, real-world project
https://github.com/ivmarkov/ruwm

Last synced: about 2 months ago
JSON representation

[Ru]st [W]ater [M]eter - my explorations into an embedded, async, real-world project

• Host: GitHub
• URL: https://github.com/ivmarkov/ruwm
• Owner: ivmarkov
• Created: 2022-01-16T21:32:57.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2024-05-24T13:30:44.000Z (8 months ago)
• Last Synced: 2024-11-07T18:54:37.921Z (about 2 months ago)
• Language: Rust
• Homepage:
• Size: 58.7 MB
• Stars: 53
• Watchers: 5
• Forks: 6
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# ruwm

[Ru]st [W]ater [M]eter - my explorations into an embedded, async, real-world project

[![CI](https://github.com/ivmarkov/ruwm/actions/workflows/ci.yml/badge.svg)](https://github.com/ivmarkov/ruwm/actions/workflows/ci.yml)

[![Documentation](https://img.shields.io/badge/docs-esp--rs-brightgreen)](https://ivmarkov.github.io/ruwm/ruwm/index.html)

**(Work in Progress)**

# [DEMO](https://ivmarkov.github.io/ruwm/demo/) 

(Once in, hit F12 in the browser window to open the Dev Tools Console and see the demo logs.)

# How to build?

Easiest is to build the demo. 

* The demo is the actual Water Meter Rust application - together with its Web UI - deployed as a browser (WASM) application.

* The left part of the screen is [`hal-sim`](https://github.com/ivmarkov/hal-sim) - a small [`embedded-hal`](https://github.com/rust-embedded/embedded-hal) & [`embedded-graphics`](https://github.com/embedded-graphics/embedded-graphics) simulator that implements the GPIO, ADC and Display traits and allows the user to interact with these via the browser.

To build:

* Get [rustup](https://rustup.rs/).

* Add the wasm target

```sh

rustup target add wasm32-unknown-unknown

```

* Install [Trunk](https://github.com/thedodd/trunk)

```sh

cargo install trunk

```

* Clone, build and run the simulator demo app

```

git clone https://github.com/ivmarkov/ruwm

cd ruwm/ruwm-sim

trunk serve -w . -w ../ruwm -w ../ruwm-web

```

* Go to [http://localhost:8080/](http://localhost:8080/) to see the demo in action

* Hit F12 in the browser to see the app logs in the Dev Tools Console

# Faster edit-compile-deploy-test cycle

Note that the demo you are running via Trunk is - in fact - **live**. You can change from e.g. VSCode any part of the app code (its backend that would in reality run on the actual MCU, or the Web UI) and then hit save and - voila - in a few seconds Trunk will reload the app in the browser!

A bit like Frontend development workflow, but for embedded.

# How to build the actual ESP32 firmware?

TBD