Skip to content

Commit

Permalink
initial testing instructions
Browse files Browse the repository at this point in the history
Add initial testing instructions. More details instructions to follow.
  • Loading branch information
gary-kim committed Apr 4, 2024
1 parent 3673d3d commit 0820862
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,35 @@

This repo contains end of line testing scripts and firmware for the Cooper
Common Microcontroller Node.

### Supported Operating Systems

* Full Support: Linux
* Partial Support MacOS/Darwin

### Testing Instructions

#### Requirements

* [SCons](https://scons.org) `pip install --user scons`
* [Rust](https://rust-lang.org) Your package manager or `curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh`

Depending on your distro, you may also need to install `libudev` (for Fedora,
this is `sudo dnf install libudev-devel`).

#### TL;DR

```bash
# Set up and compile
scons

# Compile eoltest
(cd "eoltest" && cargo build)

# Flash board with tester firmware
scons fw --pioflags="run -e tester -t upload"

# Connect all required connections then run tester
(cd "eoltest" && cargo run -- --tester-port /dev/ttyACM0 --serial-number 9)
```

0 comments on commit 0820862

Please sign in to comment.