# OpenVoiceOS Bus Client
This module is a simple interface for the OVOS messagebus and can be used to connect to OVOS, send messages and react to messages sent by the OpenVoiceOS system.
## MycroftBusClient()
The `MycroftBusClient()` object can be setup to connect to any host and port as well as any endpont on that host. this makes it quite versitile and will work on the main bus as well as on a gui bus. If no arguments are provided it will try to connect to a local instance of OVOS on the default endpoint and port.
> NOTE: we kept the original pre-fork class name for compatibility reasons
## Message()
The `Message` object is a representation of the messagebus message, this will always contain a message type but can also contain data and context. Data is usually real information while the context typically contain information on where the message originated or who the intended recipient is.
```python
Message('MESSAGE_TYPE', data={'meaning': 42}, context={'origin': 'A.Dent'})
```
## Examples
Below are some a couple of simple cases for sending a message on the bus as well
as reacting to messages on the bus
### Sending a message on the bus.
```python
from ovos_bus_client import MessageBusClient, Message
print('Setting up client to connect to a local OVOS instance')
client = MessageBusClient()
client.run_in_thread()
print('Sending speak message...')
client.emit(Message('speak', data={'utterance': 'Hello World'}))
```
### Catching a message on the messagebus
```python
from ovos_bus_client import MessageBusClient, Message
print('Setting up client to connect to a local OVOS instance')
client = MessageBusClient()
def print_utterance(message):
print('OVOS said "{}"'.format(message.data.get('utterance')))
print('Registering handler for speak message...')
client.on('speak', print_utterance)
client.run_forever()
```
Raw data
{
"_id": null,
"home_page": "https://github.com/OpenVoiceOS/ovos-bus-client",
"name": "ovos-bus-client",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "JarbasAI",
"author_email": "jarbas@openvoiceos.com",
"download_url": "https://files.pythonhosted.org/packages/c5/7e/d37525371e160d8dbf997cd2c7b9b115a6e5bef7201fbc7c2d8a8a3ee42d/ovos-bus-client-1.0.4.tar.gz",
"platform": null,
"description": "# OpenVoiceOS Bus Client\n\nThis module is a simple interface for the OVOS messagebus and can be used to connect to OVOS, send messages and react to messages sent by the OpenVoiceOS system.\n\n\n## MycroftBusClient()\n\nThe `MycroftBusClient()` object can be setup to connect to any host and port as well as any endpont on that host. this makes it quite versitile and will work on the main bus as well as on a gui bus. If no arguments are provided it will try to connect to a local instance of OVOS on the default endpoint and port.\n\n> NOTE: we kept the original pre-fork class name for compatibility reasons\n\n## Message()\n\nThe `Message` object is a representation of the messagebus message, this will always contain a message type but can also contain data and context. Data is usually real information while the context typically contain information on where the message originated or who the intended recipient is.\n\n```python\nMessage('MESSAGE_TYPE', data={'meaning': 42}, context={'origin': 'A.Dent'})\n```\n\n## Examples\n\nBelow are some a couple of simple cases for sending a message on the bus as well\nas reacting to messages on the bus\n\n### Sending a message on the bus.\n\n```python\nfrom ovos_bus_client import MessageBusClient, Message\n\nprint('Setting up client to connect to a local OVOS instance')\nclient = MessageBusClient()\nclient.run_in_thread()\n\nprint('Sending speak message...')\nclient.emit(Message('speak', data={'utterance': 'Hello World'}))\n```\n\n### Catching a message on the messagebus\n\n```python\nfrom ovos_bus_client import MessageBusClient, Message\n\nprint('Setting up client to connect to a local OVOS instance')\nclient = MessageBusClient()\n\ndef print_utterance(message):\n print('OVOS said \"{}\"'.format(message.data.get('utterance')))\n\n\nprint('Registering handler for speak message...')\nclient.on('speak', print_utterance)\n\nclient.run_forever()\n```\n\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "OVOS Messagebus Client",
"version": "1.0.4",
"project_urls": {
"Homepage": "https://github.com/OpenVoiceOS/ovos-bus-client"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6b0da25adf5164abbe2b981db5d4b6b294f49739a39a6d2072beaf9cc15ba2f3",
"md5": "075e9db139052c1a4fb2130a92944820",
"sha256": "8a2a8eb65bdcf6c2a210d7f76942547fa321b84debf72348dbbd1f45947b2448"
},
"downloads": -1,
"filename": "ovos_bus_client-1.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "075e9db139052c1a4fb2130a92944820",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 50689,
"upload_time": "2024-11-21T07:31:50",
"upload_time_iso_8601": "2024-11-21T07:31:50.771811Z",
"url": "https://files.pythonhosted.org/packages/6b/0d/a25adf5164abbe2b981db5d4b6b294f49739a39a6d2072beaf9cc15ba2f3/ovos_bus_client-1.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c57ed37525371e160d8dbf997cd2c7b9b115a6e5bef7201fbc7c2d8a8a3ee42d",
"md5": "9fca3c36863ccf2edbe37b2c661b2d1e",
"sha256": "c61f0a15d3b6a846685fd95b9de9740f41af86fc55c730b4a854f935797a34a1"
},
"downloads": -1,
"filename": "ovos-bus-client-1.0.4.tar.gz",
"has_sig": false,
"md5_digest": "9fca3c36863ccf2edbe37b2c661b2d1e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 44395,
"upload_time": "2024-11-21T07:31:52",
"upload_time_iso_8601": "2024-11-21T07:31:52.378095Z",
"url": "https://files.pythonhosted.org/packages/c5/7e/d37525371e160d8dbf997cd2c7b9b115a6e5bef7201fbc7c2d8a8a3ee42d/ovos-bus-client-1.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-21 07:31:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "OpenVoiceOS",
"github_project": "ovos-bus-client",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "ovos-config",
"specs": [
[
">=",
"0.0.12"
],
[
"<",
"1.0.0"
]
]
},
{
"name": "ovos-utils",
"specs": [
[
">=",
"0.3.5"
],
[
"<",
"1.0.0"
]
]
},
{
"name": "websocket-client",
"specs": [
[
">=",
"0.54.0"
]
]
},
{
"name": "pyee",
"specs": [
[
">=",
"8.1.0"
],
[
"<",
"13.0.0"
]
]
},
{
"name": "orjson",
"specs": []
}
],
"lcname": "ovos-bus-client"
}
JSON
