Metadata-Version: 2.4
Name: mir250ctrl
Version: 1.0
Summary: Python tools for controlling and interfacing with MiR250 robots
Home-page: https://github.com/Shahriar88/mir250ctrl
Author: Md Shahriar Forhad
Author-email: shahriar.forhad.eee@gmail.com
License: MIT
Project-URL: Source, https://github.com/Shahriar88/mir250ctrl
Project-URL: Issues, https://github.com/Shahriar88/mir250ctrl/issues
Keywords: mir,mir250,robot,mobile-robot,robotics,automation,point-cloud,rest-api
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Operating System :: OS Independent
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development :: Libraries
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: requests
Requires-Dist: numpy
Requires-Dist: matplotlib
Requires-Dist: Pillow
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: project-url
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# mir250ctrl

A Python toolkit for controlling, monitoring, and interfacing with MiR250 mobile robots.

`mir250ctrl` provides a reusable interface for MiR REST API communication, robot mission control, map access, live point-cloud capture, TCP communication, and map/robot/obstacle visualization.

## Features

- MiR REST API communication
- Robot status monitoring
- Mission queue management
- Absolute and relative robot motion helpers
- Charging mission support
- Register read and write operations
- Map retrieval and PNG export
- Protective scan retrieval
- MiR map and robot pose integration
- Live laser point-cloud capture
- ROS `PointCloud2` decoding
- TCP point-cloud server and client
- Point-cloud transformation into map coordinates
- MiR map, robot pose, orientation, and live obstacle visualization
- Optional `PyShark` support for live packet capture
- Importing the package does not automatically connect to or move the robot

## Installation

```bash
pip install mir250ctrl
```

## Documentation

For complete usage examples, configuration, API details, point-cloud setup, map visualization, and troubleshooting, see the GitHub repository:

**https://github.com/Shahriar88/mir250ctrl**

## License

MIT License

Copyright (c) 2026 Md Shahriar Forhad
