helyOS Agent SDK
Methods and data strrctures to connect autonomous vehicles to helyOS.
Explore the docs »
Demo
·
Report Bug
·
Request Feature
About The Project
The helyos-agent-sdk python package encloses methods and data structures definitions that facilitate the connection to helyOS core via RabbitMQ.
List of features
- RabbitMQ client for communication with helyOS core.
- Support for both AMQP and MQTT protocols.
- Definition of agent and assignment status.
- Easy access to helyOS assignments and instant actions through callbacks.
- SSL support and application-level security with RSA signature.
- Automatic reconnection to handle connection disruptions.
Install
pip install helyos_agent_sdk
Usage
from helyos_agent_sdk import HelyOSClient, AgentConnector
# Connect via AMQP
helyOS_client = HelyOSClient(rabbitmq_host, rabbitmq_port, uuid=AGENT_UID)
# Or connect via MQTT
# helyOS_client = HelyOSMQTTClient(rabbitmq_host, rabbitmq_port, uuid=AGENT_UID)
helyOS_client.connnect(username, password)
# Check in yard
initial_agent_data = {'name': "vehicle name", 'pose': {'x':-30167, 'y':-5415, 'orientations':[0, 0]}, 'geometry':{"my_custom_format": {}}}
helyOS_client.perform_checkin(yard_uid='1', agent_data=initial_agent_data, status="free")
helyOS_client.get_checkin_result() # yard data
# Communication
agent_connector = AgentConnector(helyOS_client)
agent_connector.publish_sensors(x=-30167, y=3000, z=0, orientations=[1500, 0], sensor= {"my_custom_format": {}})
# ... #
agent_connector.publish_state(status, resources, assignment_status)
# ... #
agent_connector.consume_instant_action_messages(my_reserve_callback, my_release_callback, my_cancel_assignm_callback, any_other_callback)
agent_connector.consume_assignment_messages(my_assignment_callback)
agent_connector.start_listening()
Contributing
Keep it simple. Keep it minimal.
License
This project is licensed under the MIT License
2 maintainers
Metadata
2 maintainers
Release files for helyos_agent_sdk 0.8.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| helyos_agent_sdk-0.8.1.tar.gz | 21.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| helyos_agent_sdk-0.8.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 45.8 kB
Release files / helyos_agent_sdk-0.8.1.tar.gz
| Download URL | helyos_agent_sdk-0.8.1.tar.gz |
|---|---|
| Size | 21.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f911b50b6395f1654ebc665da57a16dd83b3cde4c7f25572b0f614d332eb1325
|
|
BLAKE2b-256 checksum How to use checksums |
7469ea14e53d87cb22f4f412c1a3890b982b353f807dae57cc8920c2a3a1b672
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.8.5 CPython/3.8.10 Linux/5.15.167.4-microsoft-standard-WSL2
|
Release files / helyos_agent_sdk-0.8.1-py3-none-any.whl
| Download URL | helyos_agent_sdk-0.8.1-py3-none-any.whl |
|---|---|
| Size | 24.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
3382f2610c1c5b1590143168f48d99fac5d97fafcc6228d017f5fe3a19c264e9
|
|
BLAKE2b-256 checksum How to use checksums |
ee58688a65efe7a3c29a3ce82a400a78bf1a943bf83e7b193d532a26e171ea68
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.8.5 CPython/3.8.10 Linux/5.15.167.4-microsoft-standard-WSL2
|
