Skip to main content

A simple Python coroutine based driver for communicating with malos-vision.

License

This application follows the GNU General Public License, as described in the LICENSE file.

Installing

The package is available on PyPI, so you can easily install via pip:

$ pip install matrix-io-malos

Running the CLI client

The library includes a simple command line client to start reading data from your MALOS service right away.

# Get the malosclient help screen
$ malosclient --help

# Get IMU data to STDOUT from a locally running MALOS service
$ malosclient IMU

# Get HUMIDITY data to STDOUT from a remotely running MALOS service
$ malosclient -h 192.168.0.100 HUMIDITY

# Get FACE detection data using a serialized driver config file
$ malosclient --driver-config-file ~/driver_config.proto VISION

Using the MalosDriver

To use the MALOS driver works as an async generator so in your code you can do the following:

import asyncio
import sys

from matrix_io.malos.driver import IMU_PORT, UV_PORT
from matrix_io.proto.malos.v1 import driver_pb2
from matrix_io.proto.malos.v1 import sense_pb2

from matrix_io.malos.driver import MalosDriver


async def imu_data(imu_driver):
    async for msg in imu_driver.get_data():
        print(sense_pb2.Imu().FromString(msg))
        await asyncio.sleep(1.0)


async def uv_data(uv_driver):
    async for msg in uv_driver.get_data():
        print(sense_pb2.UV().FromString(msg))
        await asyncio.sleep(1.0)


async def status_handler(driver):

    type_mapping = {
        driver_pb2.Status.MESSAGE_TYPE_NOT_DEFINED: "Not Defined",
        driver_pb2.Status.STARTED: "Started",
        driver_pb2.Status.STOPPED: "Stopped",
        driver_pb2.Status.CONFIG_RECEIVED: "Config Received",
        driver_pb2.Status.COMMAND_EXECUTED: "Command Executed",
        driver_pb2.Status.STATUS_CRITICAL: "Critical",
        driver_pb2.Status.STATUS_ERROR: "Error",
        driver_pb2.Status.STATUS_WARNING: "Warning",
        driver_pb2.Status.STATUS_INFO: "Info",
        driver_pb2.Status.STATUS_DEBUG: "Debug"
    }

    async for msg in driver.get_status():
        print(type_mapping[msg.type])

        if msg.uuid:
            print("UUID: {}".format(msg.uuid))
        if msg.message:
            print("MESSAGE: {}".format(msg.message))

        await asyncio.sleep(1.0)


# Driver configuration
driver_config = driver_pb2.DriverConfig()

# Create the drivers
imu_driver = MalosDriver('localhost', IMU_PORT)
uv_driver = MalosDriver('localhost', UV_PORT)

# Create loop and initialize keep-alive
loop = asyncio.get_event_loop()
loop.run_until_complete(imu_driver.configure(driver_config))
loop.run_until_complete(uv_driver.configure(driver_config))
loop.create_task(imu_driver.start_keep_alive())
loop.create_task(uv_driver.start_keep_alive())

# Initialize data and error handlers
loop.create_task(imu_data(imu_driver))
loop.create_task(uv_data(uv_driver))
loop.create_task(status_handler(imu_driver))
loop.create_task(status_handler(uv_driver))

try:
    loop.run_forever()
except KeyboardInterrupt:
    print('Shutting down. Bye, bye !', file=sys.stderr)
finally:
    loop.stop()
    asyncio.gather(*asyncio.Task.all_tasks()).cancel()

    loop.run_until_complete(loop.shutdown_asyncgens())
    loop.close()

Who can answer questions about this library?

More Documentation

…

Metadata

Release files for admobilize-malos 0.0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for admobilize-malos 0.0.2
File Size Uploaded Provenance Actions
admobilize-malos-0.0.2.tar.gz 7.6 kB Without provenance Details for admobilize-malos-0.0.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for admobilize-malos 0.0.2
File Interpreter ABI Platform Actions
admobilize_malos-0.0.2-py3-none-any.whl Python 3 none any Details for admobilize_malos-0.0.2-py3-none-any.whl

Total release size: 29.1 kB

Release files / admobilize-malos-0.0.2.tar.gz

Download URL admobilize-malos-0.0.2.tar.gz
Size 7.6 kB
Tags Source
SHA-256 checksum
How to use checksums
f26667006027e92c47a8c3bd4665548e3962c6756865324c5d61e59a1fb619fc
BLAKE2b-256 checksum
How to use checksums
d35fac402f31cba37b16833427b7653c70e8ab51fbc82f0cc10516568f901895
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/46.4.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.6.10

Release files / admobilize_malos-0.0.2-py3-none-any.whl

Download URL admobilize_malos-0.0.2-py3-none-any.whl
Size 21.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
288c0e56f09da20efec12099f018b218b6a15eab5e69e52c584a504910800a7b
BLAKE2b-256 checksum
How to use checksums
9d6d6bafb8ceaa6afe0d9e7209b3b7504cf359eb1f9f9ec7e3df07716afcfd26
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/46.4.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.6.10

Security for admobilize-malos 0.0.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.0.2 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page