https://github.com/blueandi/zumohalatmega32u4
Zumo C++ hardware abstraction layer for the Pololu Zumo32u4 robot.
https://github.com/blueandi/zumohalatmega32u4
zumo zumo-robot zumo32u4
Last synced: 4 months ago
JSON representation
Zumo C++ hardware abstraction layer for the Pololu Zumo32u4 robot.
- Host: GitHub
- URL: https://github.com/blueandi/zumohalatmega32u4
- Owner: BlueAndi
- License: mit
- Created: 2024-05-17T14:53:14.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-12T09:35:46.000Z (almost 2 years ago)
- Last Synced: 2025-02-23T23:22:51.201Z (over 1 year ago)
- Topics: zumo, zumo-robot, zumo32u4
- Language: C++
- Homepage: https://blueandi.github.io/ZumoHALATmega32u4/
- Size: 265 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ZumoHALATmega32u4
[](http://choosealicense.com/licenses/mit/)
[](https://www.repostatus.org/#wip)
[](https://github.com/BlueAndi/ZumoHALATmega32u4/releases)
Hardware abstraction layer for the Pololu Zumo32U4 robot (see ).
## Table of content
- [Architecture](#architecture)
- [The Principle](#the-principle)
- [Detail](#detail)
- [How to integrate the library?](#how-to-integrate-the-library)
- [Example](#example)
- [Interface Description](#interface-description)
- [Requirements to your application](#requirements-to-your-application)
- [OLED Display Support](#oled-display-support)
- [Used Libraries](#used-libraries)
- [Issues, Ideas And Bugs](#issues-ideas-and-bugs)
- [License](#license)
- [Contribution](#contribution)
## Architecture
### The Principle

### Detail

## How to integrate the library?
1. Add it to the _platformio.ini_ in your environment to the _lib\_deps_ section:
```text
lib_deps =
BlueAndi/ZumoHALATmega32u4 @ ~1.3.0
```
### Example
See [example](/examples/example/) for more detail.
## Interface Description
See [interface description of latest version](https://blueandi.github.io/ZumoHALATmega32u4/).
## Requirements to your application
- **REQ-1** The application shall use the Arduino framework.
## OLED Display Support
Pololu provides 2 different displays for the Zumo32U4: LCD and OLED. Per default, the LCD display is used.
In order to use the OLED display instead, `CONFIG_USE_OLED_DISPLAY` must be set to 1 in the `platformio.ini` file.
```ini
build_flags =
-D CONFIG_USE_OLED_DISPLAY=1
```
## Used Libraries
| Library | Description | License |
| ----------------------------------------------------------------------- | ----------------------------------------- | ------- |
| [Zumo32U4 library](https://github.com/pololu/zumo-32u4-arduino-library) | Provides access to the Zumo32U4 hardware. | MIT |
| [ZumoHALInterfaces](https://github.com/BlueAndi/ZumoHALInterfaces) | The Zumo C++ HAL interfaces. | MIT |
## Issues, Ideas And Bugs
If you have further ideas or you found some bugs, great! Create a [issue](https://github.com/BlueAndi/ZumoHALATmega32u4/issues) or if you are able and willing to fix it by yourself, clone the repository and create a pull request.
## License
The whole source code is published under the [MIT license](http://choosealicense.com/licenses/mit/).
Consider the different licenses of the used third party libraries too!
## Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, shall be licensed as above, without any
additional terms or conditions.