Metadata-Version: 2.1
Name: rosys
Version: 0.5.15
Summary: Modular Robot System With Elegant Automation Capabilities
Home-page: https://github.com/zauberzeug/rosys
License: MIT
Keywords: robot,framework,automation,control,steer
Author: Zauberzeug GmbH
Author-email: info@zauberzeug.com
Requires-Python: >=3.9,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: aenum (>=3.1.5,<4.0.0)
Requires-Dist: aiocache (>=0.11.1,<0.12.0)
Requires-Dist: aiohttp (>=3.7.4,<4.0.0)
Requires-Dist: aioserial (>=1.3.0,<2.0.0)
Requires-Dist: asyncio (>=3.4.3,<4.0.0)
Requires-Dist: coloredlogs (>=15.0.1,<16.0.0)
Requires-Dist: humanize (>=4.0.0,<5.0.0)
Requires-Dist: more-itertools (>=8.10.0,<9.0.0)
Requires-Dist: msgpack (>=1.0.3,<2.0.0)
Requires-Dist: networkx (>=2.6.2,<3.0.0)
Requires-Dist: nicegui (==0.7.21)
Requires-Dist: numpy (>=1.20.1,<2.0.0)
Requires-Dist: objgraph (>=3.5.0,<4.0.0)
Requires-Dist: opencv-contrib-python-headless (>=4.5.4,<5.0.0)
Requires-Dist: opencv-python (>=4.5.5,<5.0.0)
Requires-Dist: psutil (>=5.9.0,<6.0.0)
Requires-Dist: pydantic (==1.9)
Requires-Dist: pyloot (>=0.0.7,<0.0.8)
Requires-Dist: pyserial (>=3.5,<4.0)
Requires-Dist: python-socketio[asyncio_client] (>=5.3.0,<6.0.0)
Requires-Dist: requests (>=2.25.1,<3.0.0)
Requires-Dist: retry (>=0.9.2,<0.10.0)
Requires-Dist: scipy (>=1.7.2,<2.0.0)
Requires-Dist: sh (>=1.14.2,<2.0.0)
Requires-Dist: simplejson (>=3.17.2,<4.0.0)
Requires-Dist: tabulate (>=0.8.9,<0.9.0)
Requires-Dist: ujson (>=5.1.0,<6.0.0)
Requires-Dist: yappi (>=1.3.3,<2.0.0)
Project-URL: Repository, https://github.com/zauberzeug/rosys
Description-Content-Type: text/markdown

# RoSys - The Robot System

RoSys provides an easy-to-use robot system.
Its purpose is similar to [ROS](https://www.ros.org/).
But RoSys is fully based on modern web technologies and focusses on mobile robotics.

See full documentation at [rosys.io](https://rosys.io/).

## Principles

**All Python**
: Business logic is wired in Python while computation-heavy tasks are encapsulated through websockets or bindings.

**Shared State**
: All code can access and manipulate a shared and typesafe state -- this does not mean it should.
Good software design is still necessary.
But it is much easier to do if you do not have to perform serialization all the time.

**No Threading**
: Thanks to [asyncio](https://docs.python.org/3/library/asyncio.html) you can write the business logic without locks and mutex mechanisms.
The running system feels like everything is happening in parallel.
But each code block is executed one after another through an event queue and yields execution as soon as it waits for I/O or heavy computation.
The latter is still executed in threads to not block the rest of the business logic.

**Web UI**
: Most machines need some kind of human interaction.
We made sure your robot can be operated fully off the grid with any web browser by incorporating [NiceGUI](https://nicegui.io/).
It is also possible to proxy the user interface through a gateway for remote operation.

**Simulation**
: Robot hardware is often slower than your own computer.
Therefore RoSys supports a simulation mode for rapid development.
To get maximum performance the current implementation does not run a full physics engine.

**Testing**
: You can use pytest to write high-level integration tests.
It is based on the above-described simulation mode and accelerates the robot's time for super fast execution.

