Skip to content

CircuitPython driver library for the AMS AS5600 12-bit on-axis magnetic rotary position sensor

License

Notifications You must be signed in to change notification settings

noelanderson/CircuitPython_AS5600

Folders and files

NameName
Last commit message
Last commit date
Jan 24, 2025
Jan 24, 2025
Jan 24, 2025
Jan 24, 2025
Jan 24, 2025
Jan 24, 2025
Jan 24, 2025
Jan 24, 2025
Jan 24, 2025
Jan 24, 2025
Jan 24, 2025
Jan 24, 2025
Jan 24, 2025
Jan 24, 2025
Jan 24, 2025
Jan 24, 2025
Jan 24, 2025

Repository files navigation

Introduction

Documentation Status Discord Build Status Code Style: Ruff

CircuitPython helper library for the AMS AS5600 12-bit on-axis magnetic rotary position sensor

Dependencies

This driver depends on:

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle or individual libraries can be installed using circup.

Installing from PyPI

Note

This library is not available on PyPI yet. Install documentation is included as a standard element.

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install circuitpython-as5600

To install system-wide (this may be required in some cases):

sudo pip3 install circuitpython-as5600

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .venv
source .env/bin/activate
pip3 install circuitpython-as5600

Installing to a Connected CircuitPython Device with Circup

Make sure that you have circup installed in your Python environment. Install it with the following command if necessary:

pip3 install circup

With circup installed and your CircuitPython device connected use the following command to install:

circup install as5600

Or the following command to update an existing version:

circup update

Usage Example

import time
import board
import busio
from as5600 import AS5600

i2c = busio.I2C(board.SCL, board.SDA)
sensor = AS5600(i2c)

while True:
    print("Angle: ", sensor.angle)
    time.sleep(1)

Documentation

Class Diagram for library

Class Diagram

API documentation for this library can be found on Read the Docs.

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

About

CircuitPython driver library for the AMS AS5600 12-bit on-axis magnetic rotary position sensor

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages