Skip to content

Commit

Permalink
update encoder docs
Browse files Browse the repository at this point in the history
  • Loading branch information
PonomarevDA committed Oct 27, 2023
1 parent e3f4386 commit 9eef4e0
Showing 1 changed file with 21 additions and 3 deletions.
24 changes: 21 additions & 3 deletions sensors/encoder/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,26 @@
# AS5600
# AS5600 Magnetic Angle Sensor Encoder Module

> Docs in process...
12-Bit Programmable Contactless Potentiometer

| | |
| - | - |
| Reference | [Datasheet](https://ams.com/documents/20143/36005/AS5600_DS000365_5-00.pdf/649ee61c-8f9a-20df-9e10-43173a3eb323) |
| Requred periphery | I2C |
| Unit tests | not yet |


## Usage

Installation:
1. Include the header file `as5600.h` and source file `as5600.c` in your C/C++ code.
2. Ensure that the required dependencies are installed, such as the STM32 HAL library or any other libraries specific to your STM32 development environment.

Usage:
1. During the boot of your application initialize I2C driver and then call `as5600Init()`
2. Periodically (with rate 10 Hz) call `as5600CollectData()`. If it returns `LIBPERIPH_OK`, then call `as5600ParseCollectedData()`.

## Additional info

Reference:
- https://ams.com/documents/20143/36005/AS5600_DS000365_5-00.pdf
- https://github.com/nicholasmorrow/AS5600
- https://github.com/Seeed-Studio/Seeed_Arduino_AS5600

0 comments on commit 9eef4e0

Please sign in to comment.