aiomysensors

Python asyncio package to connect to MySensors gateways.

MySensors version support

The following versions are supported:

• 1.4
• 1.5

Example

"""Show a minimal example using aiomysensors."""
import asyncio

from aiomysensors import AIOMySensorsError, Gateway, SerialTransport


async def run_gateway() -> None:
    """Run a serial gateway."""
    port = "/dev/ttyACM0"
    baud = 115200
    transport = SerialTransport(port, baud)
    gateway = Gateway(transport)

    try:
        async with gateway.transport:
            async for message in gateway.listen():
                print("Message received:", message)
    except AIOMySensorsError as err:
        print("Error:", err)


if __name__ == "__main__":
    try:
        asyncio.run(run_gateway())
    except KeyboardInterrupt:
        pass

Command Line Interface

There's a CLI for testing purposes.

aiomysensors --debug serial-gateway -p /dev/ttyACM0

Development

• Install and set up development environment.

  pip install -r requirements_dev.txt
  

  This will install all requirements. It will also install this package in development mode, so that code changes are applied immediately without reinstall necessary.

• Here's a list of development tools we use.

  • black
  • flake8
  • mypy
  • pydocstyle
  • pylint
  • pytest
  • tox

• It's recommended to use the corresponding code formatter and linters also in your code editor to get instant feedback. A popular editor that can do this is vscode.

• Run all tests, check formatting and linting.

  tox
  

• Run a single tox environment.

  tox -e lint
  

• Reinstall all tox environments.

  tox -r
  

• Run pytest and all tests.

  pytest
  

• Run pytest and calculate coverage for the package.

  pytest --cov-report term-missing --cov=aiomysensors