Metadata-Version: 2.1
Name: dynamixel-helper
Version: 0.0.0
Summary: You can use this helper instead of the Dynamixel-SDK to speed up your work.
Home-page: https://github.com/ryul1206/easy-dynamixel-helper
Author: Hong-ryul Jung
Author-email: jung.hr.1206@gmail.com
License: MIT
Description: # Easy Dynamixel Helper
        
        ![PyPI](https://img.shields.io/pypi/v/dynamixel-helper.svg)
        ![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/ryul1206/easy-dynamixel-helper.svg)
        ![CodeFactor](https://www.codefactor.io/repository/github/ryul1206/easy-dynamixel-helper/badge/master)
        ![GitHub](https://img.shields.io/github/license/ryul1206/easy-dynamixel-helper.svg)
        
        🌏 [English](README.md), [한국어](README.kr.md)
        
        This helper is a wrapper for the Dynamixel-SDK. With this, configure and drive your motor more quickly. You do not need to know how the SDK works.
        
        **Table of Contents**
        
        1. [ Getting Started](#-Getting-Started)
            1. [Prerequisites](#Prerequisites)
            1. [Installation](#Installation)
        1. [ Simple Example](#-Simple-Example)
        1. [ Features](#-Features)
        1. [ Tutorials](#-Tutorials)
        1. [ Release Notes](#-Release-Notes)
        1. [ Contributing](#-Contributing)
            1. [Style Guide](#Style-Guide)
        1. [ Maintainers](#-Maintainers)
        1. [ Licenses](#-Licenses)
        
        ## 🚀 Getting Started
        
        ### Prerequisites
        
        You need to install the official [Dynamixel SDK](https://github.com/ROBOTIS-GIT/DynamixelSDK) before using this helper.
        
        <details><summary>Click here: Dynamixel SDK Installation</summary>
        <p>
        
        1. Clone the official SDK repository into your custom folder, for example, I created `~/lib`.
        
            ```bash
            git clone https://github.com/ROBOTIS-GIT/DynamixelSDK.git
            ```
        2. Go into the folder `/DynamixelSDK/python` of your cloned SDK.
        
            ```bash
            cd ${your_download_path}/DynamixelSDK/python
            ```
        
        3. Run `setup.py` as administrator to install the library.
        
            ```bash
            sudo python setup.py install
            ```
        
        </p>
        </details>
        
        ### Installation
        
        Simply type `pip` command below to install this helper.
        
        ```bash
        pip install dynamixel_helper --user
        ```
        
        ## 🐣 Simple Example
        
        The following code is an example of turning on the motor torque.
        
        ```python
        from dynamixel_helper import DxlHelper
        
        helper = DxlHelper("preset/{your_robot}.json")
        motor = helper.get_motor(0)  # id: 0
        motor.set_torque(True)
        ```
        
        ## 💎 Features
        
        - Motor configurations in JSON format
        - Support for Python 3 and 2
        - Easy multiple USB connections
        
        ## 🌱 Tutorials
        
        [Go to tutorials](/tutorial/TUTORIAL.en.md)
        
        ## 🚩 Release Notes
        
        
        [Go to release notes](/CHANGELOG.md#Release-Notes)
        
        ## 💌 Contributing
        
        - We will welcome whatever your contribution is!
        - If you are planning to send a new `Pull request`, please send them into the `develop` Branch.😍
        ### Style Guide
        
        > This style guide is only a recommendation, never more important than your interest and contributions.
        
        - Our default Python style is [PEP 8](https://www.python.org/dev/peps/pep-0008/).
        - If you use [VSCode](https://code.visualstudio.com/) as your code editor, please refer to the following settings. This setting is a part of our `setting.json`.
        
            ```json
            {
                "editor.tabSize": 4,
                "[json]": {
                    "editor.tabSize": 2
                },
                "python.linting.pylintEnabled": false,
                "python.linting.pep8Enabled": true,
                "python.linting.enabled": true
            }
            ```
        
        ## 🔧 Maintainers
        
        - **Hong-ryul Jung** _Initial work_ [ryul1206](https://github.com/ryul1206)
        - **Il-ho Oh** _Initial work_ [ohilho](https://github.com/ohilho)
        
        ## 📜 Licenses
        
        The contents of this repository are subject to the [MIT License](/LICENSE) by default, except as noted below.
        
        - Dynamixel SDK is under the [Apache-2.0](https://github.com/ROBOTIS-GIT/DynamixelSDK/blob/master/LICENSE)
        
Keywords: dynamixel
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 2
Requires-Python: >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, <4
Description-Content-Type: text/markdown
