Skip to content

Commit

Permalink
Add basic Platform IO instructions (#229)
Browse files Browse the repository at this point in the history
Signed-off-by: Gary Servin <[email protected]>
  • Loading branch information
garyservin authored Feb 15, 2024
1 parent 34b23af commit 664df3c
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions andino_firmware/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,25 @@ Check `encoder_driver.h` and `motor_driver.h` files to check the expected pins f

## Installation

### Arduino
Verify and Upload `andino_firmware.ino` to your arduino board.

### PlatformIO
1. Install dependencies `sudo apt-get install python3.10-venv`
2. Install platformio
```
curl -fsSL -o /tmp/get-platformio.py https://raw.githubusercontent.com/platformio/platformio-core-installer/master/get-platformio.py
python3 /tmp/get-platformio.py
```
3. Add platformio to your $PATH:
```
echo "PATH=\"\$PATH:\$HOME/.platformio/penv/bin\"" >> $HOME/.bashrc
source $HOME/.bashrc
```
4. Build and upload the firmware
- If you're using an arduino uno `pio run --target upload -e uno`
- If you're using an arduino nano `pio run --target upload -e nanoatmega328`

## Description

Via `serial` connection (57600 baud) it is possible to interact with the microcontroller. The interface is described in the [commands.h](src/commands.h) file. Here are the most used commands:
Expand Down

0 comments on commit 664df3c

Please sign in to comment.