Metadata-Version: 2.1
Name: whillpy
Version: 0.2
Summary: Unofficial python package for WHILL Model CK control
Home-page: http://github.com/ShibataLab/whillpy
Author: Ravi Prakash Joshi
Author-email: joshi.ravi-prakash869@mail.kyutech.jp
License: MIT
Description: # whillpy
        Unofficial python package for WHILL Model CK control
        
        ![WHILL](docs/whill.png)
        
        ## Dependencies
        1. Python 2 or 3
        1. [pyserial](https://pythonhosted.org/pyserial)
            * ~It can easily be installed using pip i.e., `pip install pyserial`~ *(it will be installed automatically)*
        
        ## Installation Steps
        Install from source
        1. Clone or download the repository
        1. Use the following command `python setup.py install`
              * Alternatively the package can be installed to a user directory using the following command
        ```
        python setup.py install --user
        ```
        
        ## Connection Diagram
        In order to control WHILL Model CK, we propose to use Raspberry Pi 3 module. This module can easily be powered up by the provided USB socket in WHILL. Below are the connection diagrams -
        
        **Power**
        
        ![power](docs/power.jpg)
        
        **Connections**
        
        ![connections](docs/connections.jpg)
        
        ## Usage
        Below is an example-
        
        ```
        import whillpy
        
        # initialize Whill by providing the name of the serial port
        whill = whillpy.connect(port='/dev/ttyUSB0')
        
        # control the power
        whill.set_power(whillpy.power.on)
        
        # move straight while turning left
        whill.move(straight=10, turn=-50)
        ```
        Examples can be found in [examples](examples) directory of this package.
        
        ## Issues
        Please check [here](https://github.com/ShibataLab/whillpy/issues) and create issues.
        
        ## Author
        [Ravi Prakash Joshi](https://ravijo.github.io/)
        
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
