RFXCOM RFXtrx Library for Python 3.3+
A Python library for working with your RFXTrx for automation projects.
This library is designed to work with Python 3.3+  and asyncio (but other transports can be implemented). Currently it is primarily used by the home project, a dashboard for managing and visualising your home automation devices.
This library is relatively new and thus the number of devices are limited to those that @d0ugal owns. This means, that the current list of fully supported protocols are:
- Status Packets from the RFXTrx itself.
- Energy usage sensors (such as the Owl CM119/160 and Owl CM180)
- Temperature and humidity sensors (such as the Oregon THGN132)
- Lighting and power control devices from LightwaveRF
If you want to use a device and you don’t think its supported or you are unsure then please open an issue.
It is recommended that you get the latest version from PyPI with pip:
pip install rfxcom
However, if you want to grab the latest development version you can download the repository directly from github and run python setup.py install in the root of the repository.
The following example shows some basic usage of this library, it sets up the asyncio event loop, points the library to the serial device path and attaches a simple handler function which prints out information about all the packets it receives. For example, see what it will output for energy usage sensors.:
from asyncio import get_event_loop from rfxcom.transport import AsyncioTransport dev_name = '/dev/serial/by-id/usb-RFXCOM_RFXtrx433_A1WYT9NA-if00-port0' loop = get_event_loop() def handler(packet): # Print out the packet - the string representation will show us the type. print(packet) # Each packet will have a dictionary which contains parsed data. print(packet.data) # You can access the raw bytes from the packet too. print(packet.raw) try: rfxcom = AsyncioTransport(dev_name, loop, callback=handler) loop.run_forever() finally: loop.close()
You can also use a coroutine as callback for AsyncioTransport:
from asyncio import get_event_loop, coroutine from rfxcom.transport import AsyncioTransport dev_name = '/dev/serial/by-id/usb-RFXCOM_RFXtrx433_A1WYT9NA-if00-port0' loop = get_event_loop() @coroutine def handler(packet): print(packet) yield from some_io(packet) try: rfxcom = AsyncioTransport(dev_name, loop, callback=handler) loop.run_forever() finally: loop.close()
If you would like to contribute to python-rfxcom, you will need to use tox to run the tests. This will test against Python 3.3, Python 3.4, pyflakes for code linting and build the documentation. To do this, you simply need to install tox and then call tox from the root of the python-rfxcom git repository.
pip install tox tox
Don’t worry if you can’t test against Python 3.3 and Python 3.4 locally, many people will only have one installed. We use the brilliant Travis CI to verify all pull requests.
|||However, given enough interest previous versions can be supported: https://github.com/d0ugal/python-rfxcom/pull/1|
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, Size & Hash SHA256 Hash Help||File Type||Python Version||Upload Date|
(18.0 kB) Copy SHA256 Hash SHA256
|Wheel||py2.py3||Aug 11, 2015|
(14.5 kB) Copy SHA256 Hash SHA256
|Source||None||Aug 11, 2015|