4f440d286d
Add the PWM Servo example to the readme. Fix typo in rainbow animation. Add images to boath examples showing working examples. |
||
|---|---|---|
| .. | ||
| examples | ||
| src | ||
| .gitignore | ||
| build.rs | ||
| Cargo.toml | ||
| CHANGELOG.md | ||
| README.md | ||
pimoroni-servo2040 - Board Support for the Pimoroni Servo2040
You should include this crate if you are writing code that you want to run on a Pimoroni Servo2040 - a standalone servo motor controller for up to 18 servos and 6 sensors.
This crate includes the rp2040-hal, but also configures each pin of the RP2040 chip according to how it is connected up on the Servo2040.
Using
To use this crate, your Cargo.toml file should contain:
pimoroni-servo2040 = "0.1.0"
In your program, you will need to call pimoroni_servo2040::Pins::new to create
a new Pins structure. This will set up all the GPIOs for any on-board
devices. See the examples folder for more details.
Examples
General Instructions
To compile an example, clone the rp-hal repository and run:
rp-hal/boards/pimoroni-servo2040 $ cargo build --release --example <name>
You will get an ELF file called
./target/thumbv6m-none-eabi/release/examples/<name>, where the target
folder is located at the top of the rp-hal repository checkout. Normally
you would also need to specify --target=thumbv6m-none-eabi but when
building examples from this git repository, that is set as the default.
If you want to convert the ELF file to a UF2 and automatically copy it to the USB drive exported by the RP2040 bootloader, simply boot your board into bootloader mode and run:
rp-hal/boards/pimoroni-servo2040 $ cargo run --release --example <name>
If you get an error about not being able to find elf2uf2-rs, try:
$ cargo install elf2uf2-rs
then try repeating the cargo run command above.
pimoroni_servo2040_rainbow
Animates a rainbow wheel on the Servo2040's six on-board LEDs in sequence.
pimoroni_servo2040_pwm_servo
Moves a micro servo connected to pin Servo 1 on a Servo2040 board using the PWM peripheral.
Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
The steps are:
- Fork the Project by clicking the 'Fork' button at the top of the page.
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Make some changes to the code or documentation.
- Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Feature Branch (
git push origin feature/AmazingFeature) - Create a New Pull Request
- An admin will review the Pull Request and discuss any changes that may be required.
- Once everyone is happy, the Pull Request can be merged by an admin, and your work is part of our project!
Code of Conduct
Contribution to this crate is organized under the terms of the Rust Code of Conduct, and the maintainer of this crate, the rp-rs team, promises to intervene to uphold that code of conduct.
License
The contents of this repository are dual-licensed under the MIT OR Apache
2.0 License. That means you can choose either the MIT license or the
Apache-2.0 license when you re-use this code. See MIT or APACHE2.0 for more
information on each specific license.
Any submissions to this project (e.g. as Pull Requests) must be made available under these terms.