sensor_lib_as5600

A Rust sensor library for the AS5600 magnetic rotary encoder module.

Current State

The library is currently functional and has been tested thorugh unit testing and on actual hardware(ch32v203 micro-controller).

Sensor Pinout

Below is a basic overview of the sensor packges pinout, but make sure to checkout the data sheet for more detail.

1. VDD5V:: 5v supply pin.
2. VDD3V3:: 3.3v supply pin.
3. OUT:: PWM output
4. GND:: Ground pin.
5. PGO:: Digital Input for Programming Option
6. SDA:: I2C Data.
7. SCL:: I2C Clock.
8. DIR:: Digital Input for Direction(GND = ClockWise/VDD = CounterClockWise)

Usage

Adding to project

There are two ways to add the crate/repo to your project. You can use the github URL or you can add it via the normal crates name(TBD).

Cargo.toml

sensor_lib_as5600 = {git = 'https://github.com/jake-g00dwin/sensor_lib_as5600'}

Running Tests

To run the tests for the project after downloading or cloning the repo

cargo test

Roadmap

• Define all Bitmasks for registers.
• Add non-default i2c addressing.
• setup un-initialized and initialized versions of the sensor.
• Add example usage.
• Create an example repo for drop-in uC examples.
• Create Comperhensive Documentation using D.S. images.
• Create and link to example usage video.

Contributing

If you want to contribute to it feel free to open up a pull-request or make a new github issue.