Metadata-Version: 2.1
Name: raspberry-i2c-tb6612fng
Version: 0.1.2
Summary: A port of Grove Motor Driver TB6612FNG library for python and RaspberryPI. This library also includes easing functions to control your motors with smooth transitions.Easing functions are available for dc motors only.
Home-page: https://github.com/MarkusBansky/raspberry-i2c-tb6612fng
Author: Markiian Benovskyi
Author-email: admin@markiian-benovskyi.com
License: GNU General Public License
Description: # RaspberryPi Grove TB6612FNG Motor Shield Library
        
        [![PyPI pyversions](https://img.shields.io/pypi/pyversions/raspberry-i2c-tb6612fng.svg)](https://pypi.python.org/pypi/raspberry-i2c-tb6612fng/)
        [![PyPI version shields.io](https://img.shields.io/pypi/v/raspberry-i2c-tb6612fng.svg)](https://pypi.python.org/pypi/raspberry-i2c-tb6612fng/)
        [![PyPI license](https://img.shields.io/pypi/l/raspberry-i2c-tb6612fng.svg)](https://pypi.python.org/pypi/raspberry-i2c-tb6612fng/)
        [![Codacy Badge](https://api.codacy.com/project/badge/Grade/5bbc671589af4d7badab5a8e13910123)](https://app.codacy.com/manual/benovskym/raspberry-i2c-tb6612fng?utm_source=github.com&utm_medium=referral&utm_content=MarkusBansky/raspberry-i2c-tb6612fng&utm_campaign=Badge_Grade_Dashboard)
        
        This is an open source port of the official Grove Motor Shield TB6612FNG library for Arduino to Python3 on RaspberryPI.
        
        This is a port of [Grove Arduino LIbrary](https://github.com/Seeed-Studio/Grove_Motor_Driver_TB6612FNG) for [Grove I2C Motor Driver on TB6612FNG](https://wiki.seeedstudio.com/Grove-I2C_Motor_Driver-TB6612FNG/).
        
        ## Features
          - Library is identical to the official Grove
          - It depends only on built in libraries**
        
        ***library requires I2C to be activated on the RaspberryPI board running Linux build*
        
        ## Requirements
          - RaspberryPi linux image
          - Python 3.6+
          - **smbus** library
          - **time** library
          - **math** library
        
        This library also includes a experimental python easing functions:
          - Contains 6 easing functions for smooth start of motors
          - Easing functions currently can only be used on a single motor at once
          - Containing IN and OUT functions
        
        
        This text you see here is *actually* written in Markdown! To get a feel for Markdown's syntax, type some text into the left window and watch the results in the right.
        
        # How to use
        Basic usage of this library is very simple. First of all make sure you are running the latest released version of **pip**.
        
        This library requires you to add an additional `index-url` to **pip.conf** in order to install it. You can do this by editing your config file with `sudo nano /etc/pip.conf` and inserting this line just after the `[global]` section:
        
        ```config
        index-url=https://pypi.python.org/
        ```
        
        Now you can install the package as usual, for python3 use something for example:
        `python3 -m pip install raspberry-i2c-tb6612fng`
        
        Next, after successfull instalation you can import this library and start using it in your project like this:
        
        ```python
        # import default libraries that are used in this example
        import time
        
        # import the library
        from raspberry_i2c_tb6612fng import MotorDriverTB6612FNG, TB6612FNGMotors
        
        # create an instance of the driver, connected to i2c
        driver = MotorDriverTB6612FNG()
        
        # drive both motors forward
        driver.dc_motor_run(TB6612FNGMotors.MOTOR_CHA, 200)
        driver.dc_motor_run(TB6612FNGMotors.MOTOR_CHB, 200)
        
        # pause for a second
        time.sleep(1)
        
        # stop the motors
        driver.dc_motor_break(TB6612FNGMotors.MOTOR_CHA)
        driver.dc_motor_break(TB6612FNGMotors.MOTOR_CHB)
        
        ```
        
        ##### Documentation
        
        If you would like to read about all functions available, please refer to this projects Wiki page on GitHub.
Keywords: raspberry i2c tb6612fng grove motor
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.6
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: POSIX :: Linux
Requires-Python: >=3.6
Description-Content-Type: text/markdown
