Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/libdriver/as5600
AS5600 full function driver library for general MCU and Linux.
https://github.com/libdriver/as5600
as5600 c full-function-driver iic linux magnetic-rotary-encoder mcu
Last synced: 12 days ago
JSON representation
AS5600 full function driver library for general MCU and Linux.
- Host: GitHub
- URL: https://github.com/libdriver/as5600
- Owner: libdriver
- License: mit
- Created: 2022-10-02T16:54:20.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-31T11:16:02.000Z (2 months ago)
- Last Synced: 2024-10-11T00:18:58.697Z (28 days ago)
- Topics: as5600, c, full-function-driver, iic, linux, magnetic-rotary-encoder, mcu
- Language: C
- Homepage: https://www.libdriver.com
- Size: 3.51 MB
- Stars: 92
- Watchers: 22
- Forks: 24
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
[English](/README.md) | [ 简体中文](/README_zh-Hans.md) | [繁體中文](/README_zh-Hant.md) | [日本語](/README_ja.md) | [Deutsch](/README_de.md) | [한국어](/README_ko.md)
## LibDriver AS5600
[](/misra/README.md) [](https://www.libdriver.com/docs/as5600/index.html) [](/LICENSE)
The AS5600 is an easy to program magnetic rotary position sensor with a high-resolution 12-bit analog or PWM output. This contactless system measures the absolute angle of a diametric magnetized on-axis magnet. This AS5600 is designed for contactless potentiometer applications and its robust design eliminates the influence of any homogenous external stray magnetic fields.The industry-standard I²C interface supports simple user programming of non-volatile parameters without requiring a dedicated programmer.By default the output represents a range from 0 to 360 degrees.It is also possible to define a smaller range to the output by programming a zero angle (start position) and a maximum angle (stop position).The AS5600 is also equipped with a smart low power mode feature to automatically reduce the power consumption.An input pin (DIR) selects the polarity of the output with regard to rotation direction. If DIR is connected to ground, the output value increases with clockwise rotation. If DIR is connected to VDD, the output value increases with counterclockwise rotation.
LibDriver AS5600 is the AS5600 full function driver launched by LibDriver.It provides magnetic angle reading and other functions. LibDriver is MISRA compliant.
### Table of Contents
- [Instruction](#Instruction)
- [Install](#Install)
- [Usage](#Usage)
- [example basic](#example-basic)
- [Document](#Document)
- [Contributing](#Contributing)
- [License](#License)
- [Contact Us](#Contact-Us)
### Instruction
/src includes LibDriver AS5600 source files.
/interface includes LibDriver AS5600 IIC platform independent template.
/test includes LibDriver AS5600 driver test code and this code can test the chip necessary function simply.
/example includes LibDriver AS5600 sample code.
/doc includes LibDriver AS5600 offline document.
/datasheet includes AS5600 datasheet.
/project includes the common Linux and MCU development board sample code. All projects use the shell script to debug the driver and the detail instruction can be found in each project's README.md.
/misra includes the LibDriver MISRA code scanning results.
### Install
Reference /interface IIC platform independent template and finish your platform IIC driver.
Add the /src directory, the interface driver for your platform, and your own drivers to your project, if you want to use the default example drivers, add the /example directory to your project.
### Usage
You can refer to the examples in the /example directory to complete your own driver. If you want to use the default programming examples, here's how to use them.
#### example basic
```C
#include "driver_as5600_basic.h"
uint8_t res;
uint32_t i;
uint32_t times;
/* basic init */
res = as5600_basic_init();
if (res != 0)
{
return 1;
}
...
/* get the times */
times = 10;
for (i = 0; i < times; i++)
{
float deg;
/* read data */
res = as5600_basic_read(°);
if (res != 0)
{
(void)as5600_basic_deinit();
return 1;
}
/* output */
as5600_interface_debug_print("as5600: angle is %.2f.\n", deg);
/* delay 1000ms */
as5600_interface_delay_ms(1000);
...
}
...
/* deinit */
(void)as5600_basic_deinit();
return 0;
```
### Document
Online documents: [https://www.libdriver.com/docs/as5600/index.html](https://www.libdriver.com/docs/as5600/index.html).
Offline documents: /doc/html/index.html.
### Contributing
Please refer to CONTRIBUTING.md.
### License
Copyright (c) 2015 - present LibDriver All rights reserved
The MIT License (MIT)
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
### Contact Us
Please send an e-mail to [email protected].