Skip to main content

Python library to interface with Airios RF bridges

Project description

pyAirios

License PyPI version PyPI - Python Version

A Python library to interface with Airios RF bridges.

Description

Airios develop and produce several components for residential ventilation systems that final manufacturers use to build their products upon, from controller boards to remote controls or sensors.

All of these components communicate over a proprietary RF protocol from Honeywell called Ramses II in the 868Mhz band. The RF bridge allows third party applications to access the nodes in the RF network over standard Modbus protocol.

There are two bridge models with different interfaces. The BRDG-02R13 has a RS485 serial interface (Modbus-RTU) and the BRDG-02EM23 is an Ethernet device (Modbus-TCP).

This library only supports the RS485 model.

Working principle

Each device in the RF network is called a node and nodes must be bound together to be able to communicate. There are two classes of nodes:

  • Controllers (typically ventilation units). Binding mode is enabled for a fixed period after power cycle.
  • Accessories (remote controls or sensors). They bind to a controller in a device-specific way, e.g., pressing a combination of buttons.

The bridge is an accessory with special features. It can bind to multiple controllers and at the same time it can "intercept" the accessories binding procedure so they are bound to the controller and the bridge at the same time. Each bound device to the bridge creates a new virtual Modbus server with its own address and register set. The register set depends on the bounded product.

NOTE: Binding is only possible when products have the same OEM code. The RF bridge has a registry to change it if necessary.

Supported devices

This library has been tested with the following devices:

Installation

python -m pip install pyairios

How to use

The library offers a high level and easy to use API:

transport = AiriosModbusRTUTransport(device="/dev/ttyACM0")
api = Airios(transport)
vmd = api.node(<Modbus device id>)

A command line interface is also included in the library for testing purposes. Use the help or ? command to get the list of available commands in each context.

CLI

Acknowledgements

  • Siber for providing the documentation and an outstanding support.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyairios-1.1.0.tar.gz (38.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyairios-1.1.0-py3-none-any.whl (43.3 kB view details)

Uploaded Python 3

File details

Details for the file pyairios-1.1.0.tar.gz.

File metadata

  • Download URL: pyairios-1.1.0.tar.gz
  • Upload date:
  • Size: 38.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pyairios-1.1.0.tar.gz
Algorithm Hash digest
SHA256 f0ef4842f8f4c21a0b25ade4e80cda3a9d0d0888b89f3620707a586dd6e7cd89
MD5 8ec3af955ead05010133254f5e589222
BLAKE2b-256 2f54cbc737e156b1a6a34610bc5a36544c978e00b9bc3c0b1dda54edd94dacc8

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyairios-1.1.0.tar.gz:

Publisher: pypi-publish.yml on scabrero/pyairios

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pyairios-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: pyairios-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 43.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pyairios-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 623bb11ed8a69c3d2f844eba759bac7c9ea425d5b6d262385a99e6aa1f1de7a0
MD5 2132cd08f46e2bee0abc4c7166ac9448
BLAKE2b-256 5fdc4baf8a8a7e81bb748ed07a9c8674ceb89bc8c52f69821a86daf51b15fa11

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyairios-1.1.0-py3-none-any.whl:

Publisher: pypi-publish.yml on scabrero/pyairios

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page