Metadata-Version: 2.4
Name: earth_rover_mini_sdk
Version: 1.0.0
Summary: API for EarthRover Mini. Allows interfacing and control over device through a simple interface.
Project-URL: Homepage, https://github.com/SIGRobotics-UIUC/earth_rover_mini_sdk
Project-URL: Issues, https://github.com/SIGRobotics-UIUC/earth_rover_mini_sdk/issues
Author-email: Saketh Kantipudi <saketh3@illinois.edu>, Hasan Al Saeedi <halsae2@illinois.edu>, Aarsh Mittal <aarshm2@illinois.edu>, Somrishi Banerjee <sb91@illinois.edu>, Sairaj Shetye <sshetye2@illinois.edu>
License-Expression: MIT
License-File: LICENSE
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.9
Description-Content-Type: text/markdown

# earth_rover_mini_sdk

API for the Earth Rover Mini. Uploaded to PyPi, installable using pip.

## Installation

Windows:
```bash
py -m pip install earth_rover_mini_sdk
```

Unix/MacOS:
```bash
python3 -m pip install earth_rover_mini_sdk
```

## Example Usage

Below is an example of how to use the code.

```python
from earth_rover_mini_sdk import EarthRoverMini_API

def main():
    rover = EarthRoverMini_API("192.168.11.1", 8888)

    rover.connect()

    print("\n[TEST] Ping test:")

    rover.safe_ping()

    print("\n[TEST] Move test (3s at speed=60, angular=360):")

    rover.move(1, 60, 0)

    rover.disconnect()
```
