https://github.com/card-io-ecg/card-io-fw

Card/IO device firmware
https://github.com/card-io-ecg/card-io-fw

Last synced: about 2 months ago
JSON representation

Card/IO device firmware

• Host: GitHub
• URL: https://github.com/card-io-ecg/card-io-fw
• Owner: card-io-ecg
• License: mit
• Created: 2023-04-27T11:47:53.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-09-16T20:01:53.000Z (3 months ago)
• Last Synced: 2024-09-17T11:14:11.436Z (3 months ago)
• Language: Rust
• Size: 1.71 MB
• Stars: 29
• Watchers: 2
• Forks: 1
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-MIT

Awesome Lists containing this project

• rust-embedded - Card/IO ECG - card-sized ECG device with Wifi connectivity (Firmware projects / WIP)
• awesome-embedded-rust - Card/IO ECG - card-sized ECG device with Wifi connectivity (Firmware projects / WIP)

README

        
Card/IO firmware

================

This repository contains the firmware source code for the Card/IO open source ECG device, built with

an ESP32-C6 or ESP32-S3 MCU.

This firmware is in its early stages of development.

Setup

-----

Tools you need to build the firmware:

- Espressif's Xtensa-enabled rust compiler - [espup](https://github.com/esp-rs/espup)

  > Make sure to run `. ~/export-esp.sh` before trying to work with the firmware

- `cargo install cargo-espflash`

- `cargo install cargo-watch`

### Enable External / USB JTAG selector solder bridge

- `pip install esptool`

- `python -m espefuse burn_efuse --port COM4 STRAP_JTAG_SEL 1`

Commands

--------

- `cargo xtask -h`: Prints information about available commands. Most of the commands have short

  aliasses, listed below.

- `cargo xbuild `: Build the firmware for a `` version board.

- `cargo xrun `: Build and run the firmware on a `` version board.

- `cargo monitor`: Connect to the Card/IO device and display serial output.

  `` can be omitted, or one of: `v4`, `v6s3`, `v6c6`. Defaults to `v6c6`.

- `cargo xcheck `: runs `cargo check`

- `cargo xclippy `: runs `cargo clippy`

- `cargo xdoc  [--open]`: runs `cargo doc` and optionally opens the generated documentation.

- `cargo xtest`: runs `cargo test`.

- `cargo example   [--watch]`: runs an example.

  Use `--watch` to enable automatic reload when a file changes.

- To run the config site on your PC, run `cargo example config-site simple --watch`

  and open `127.0.0.1:8080` in a browser.