Skip to content

Latest commit

 

History

History
101 lines (70 loc) · 3.1 KB

README.md

File metadata and controls

101 lines (70 loc) · 3.1 KB

Chapter 1: Setting Up

Setting up a Arduino Rust project for Arduino. The test board has one red led light.

Arduino board with one red led light

Arduino board with a red led and a button.

Arduino board with a red led and a button

Arduino board with a red led and buttons in series.

Arduino board with a red led and buttons in series

Arduino board with a red led and buttons parallel.

Arduino board with a red led and buttons parallel

Prerequisites

Install rustup to manage Rust build targets on your machine.

# Install nightly version on Rust
rustup install nightly

# Clippy helps to write clean Rust code
rustup component add clippy --toolchain nightly-2023-08-08-x86_64-apple-darwin

Brew is handy package manager for OSX.

You can use any editor of your choice for the Rust code. I have used Visual Studio Code. I would recommend installing Rust related extensions from the editor's 'Extensions' tab.

brew install vscode

Setup Development Environment

Setting up for Linux and Windows. The following instructions are for OSX.

xcode-select --install
brew tap osx-cross/avr
brew install avr-binutils avr-gcc avrdude
brew install lsusb # For finding the connected Arduino board

avr-hal is Hardware Abstraction Layer for AVR microcontrollers.

Ravedude handles everything from finding the board, flashing the board, and listening to connections. Use with the cargo run command. To install Ravedude run the following command.

cargo +stable install ravedude

Build Instructions

Connect your board to your computer with usb cable.

# Find Arduino board
# -v flag stands for Verbose output
# The flag helped to confirm that the Arduino Uno board is connected
lsusb -v
# Output:
# ...
# Product ID: 0x0043
# Vendor ID: 0x2341
# Version: 0.01
# Serial Number: 34239323339351311270
# Speed: Up to 12 Mb/s
# Manufacturer: Arduino (www.arduino.cc)
# ...

l /dev/tty.* # Arduino on OSX prints like tty.usbmodem146301
# Set ravedude envionment variable
export RAVEDUDE_PORT=/dev/tty.usbmodem146301

Create a Project

The template can be used for different Arduino boards.

cargo install cargo-generate
cargo generate --git https://github.com/Rahix/avr-hal-template.git
# Build the firmware
cargo build

# Flash the firmware to a connected board
cargo run

If ravedude fails to detect your board, check its documentation at https://crates.io/crates/ravedude. ravedude will open a console session after flashing where you can interact with the UART console of your board.