Metadata-Version: 2.1
Name: penguinpi
Version: 1.0.0
Summary: Library for communicating with and controlling the PenguinPi robot platform.
Home-page: https://github.com/cirrus-robotics/penguinpi
Author: Cirrus Robotics Pty Ltd
License: MIT
Project-URL: Issue tracker, https://github.com/cirrus-robotics/penguinpi/issues
Project-URL: Documentation, https://github.com/cirrus-robotics/penguinpi/README.md
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Internet
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Requires-Python: >=2.7
Description-Content-Type: text/markdown
Requires-Dist: requests
Requires-Dist: opencv-python
Requires-Dist: numpy

# Penguinpi

Library for communicating with and controlling the [PenguinPi](https://cirrusrobotics.com/products/penguinpi/) robot platform.

**Key features:**

- Motor control and encoder querying
- Access to camera
- Access to HAT and LED screen

## Installing

```sh
# Python2.7
pip install penguinpi

# Python3
pip3 install penguinpi
```

## Basic usage

```py
import penguinpi
import time
import cv2

address = 'xxx.xxx.xxx.xxx'
port = 8080

bot = penguinpi.PiBot(address, port)

bot.setVelocity(50, 50)
time.sleep(2)
bot.stop()

img = bot.getImage()
cv2.imshow('image', img)
cv2.waitKey(0)
```


