Metadata-Version: 2.5
Name: argus_dynamixel
Version: 0.2.4
Summary: The dynamixel SDK wrapper for the Argus Array project
Author-email: Alan Vasquez <vasqua@unc.edu>
License: MIT License
        
        Copyright (c) 2021, Alan Vasquez
        
        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.
        
License-File: LICENSE
Requires-Python: >=3.10
Requires-Dist: dynamixel-sdk<4,>=3.7.31
Requires-Dist: python-dotenv>=1.0.1
Description-Content-Type: text/markdown

<!-- PROJECT LOGO -->
<br />
<p align="center">
  <a href="https://github.com/argus-hdps/argus_dynamixel">
    <img src="images/logo.png" alt="Logo">
  </a>

  <h3 align="center">argus_dynamixel</h3>

  <p align="center">
    A Python wrapper with the necessary methods to enable Dynamixel usage on Argus Array hardware.
    <br />
    <a href="https://github.com/argus-hdps/argus_dynamixel"><strong>Explore the docs »</strong></a>
    <br />
    <br />
    <a href="https://github.com/argus-hdps/argus_dynamixel/issues">Report Bug</a>
    ·
    <a href="https://github.com/argus-hdps/argus_dynamixel/issues">Request Feature</a>
  </p>
</p>

<!-- ABOUT THE PROJECT -->
## About The Project

`argus_dynamixel` is a Python package that provides a wrapper for the Dynamixel SDK, specifically tailored for the Argus Array project. This package simplifies the integration and control of Dynamixel motors within the Argus Array hardware setup.

### Built With

* [Python](https://www.python.org/)
* [Dynamixel SDK](https://github.com/ROBOTIS-GIT/DynamixelSDK)
* [Poetry](https://python-poetry.org/)

<!-- GETTING STARTED -->
## Getting Started

To get a local copy up and running follow these simple steps.

### Prerequisites

* [Poetry](https://python-poetry.org)
* Python 3.10 or later

### Installation

1. Clone the repo
   ```sh
   git clone https://github.com/vasqua/argus_dynamixel
   ```
2. Create the Poetry environment
   ```sh
   cd argus_dynamixel/
   poetry install
   ```
3. Activate the shell and run the package
   ```sh
   poetry shell
   poetry run ...
   ```

<!-- USAGE EXAMPLES -->
## Usage

Here are some examples of how to use the `argus_dynamixel` package:

```python
from argus_dynamixel import DXLMotorSDK

# Initialize the controller
controller = DXLMotorSDK(port='/dev/ttyUSB0', baudrate=57600)

# Enable a motor
controller.enable_motor(dxl_id=1)

# Set motor position
controller.set_position(dxl_id=1, position=512)

# Get motor position
position = controller.get_position(dxl_id=1)
print(f"Motor position: {position}")

# Disable the motor
controller.disable_motor(dxl_id=1)
```

_For more examples, please refer to the [Documentation](https://github.com/vasqua/argus_dynamixel)_

<!-- ROADMAP -->
## Roadmap

See the [open issues](https://github.com/vasqua/argus_dynamixel/issues) for a list of proposed features (and known issues).

<!-- CONTRIBUTING -->
## Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

<!-- LICENSE -->
## License

Distributed under the MIT License. See `LICENSE` for more information.

<!-- CONTACT -->
## Contact

Alan Vasquez - vasqua@unc.edu

Project Link: [https://github.com/vasqua/argus_dynamixel](https://github.com/vasqua/argus_dynamixel)

<!-- ACKNOWLEDGEMENTS -->
## Acknowledgements

* [ROBOTIS-GIT](https://github.com/ROBOTIS-GIT)
* [Python Software Foundation](https://www.python.org/psf/)
* [Poetry](https://python-poetry.org/)
