inhumate-rti 2.0.0

Inhumate RTI Client

Inhumate RTI Client for Python

This is the Python client for the Inhumate RTI (RunTime Infrastructure), part of the Inhumate Suite.

See the Inhumate Suite documentation for more in-depth topics and an overview of the software suite.

Installing

pip install inhumate-rti

Quick Start

import inhumate_rti as RTI

rti = RTI.Client(application="Python RTI App")
rti.wait_until_connected()

def on_connect():
    print("Connected")
rti.on("connect", on_connect)

def on_hello(content): 
    print(f"Received: {content}")
rti.subscribe_text("hello", on_hello)

rti.publish_text("hello", "Hello World!")

Note that the Python client is multi-threaded by default. subscribe callbacks are called from a separate receive thread. Depending on your use case, you might want to use the single-threaded pattern and main_loop constructor argument:

import inhumate_rti as RTI

def main_loop():
    print("." if rti.connected else "x", end="", flush=True)
    if rti and rti.connected: rti.publish_text("foo", "bar")

# connect after initializing, otherwise 'rti' will be undefined in the main loop
rti = RTI.Client(application="Python RTI App", main_loop=main_loop, main_loop_idle_time=1.0)
rti.connect() # blocks further execution

For a more complete usage example, see usage_example.py and usage_example_main_loop.py.

Running tests

Clone the project from GitHub, and in the python folder:

python -m virtualenv .venv
. .venv/bin/activate
pip install -r inhumate_rti/requirements.txt 
pip install -r test/requirements.txt
pytest

Feedback & Contributing

Feedback and contributions of any kind are welcome.

• Please file bug reports and/or feature requests as GitHub issues
• Suggest code changes by creating a pull request
• For any other questions, comments or inquiries, get in touch