rfxcom 0.5.0

安装

建议您通过pip从PyPI获取最新版本

pip install rfxcom

但是，如果您想获取最新的开发版本，可以直接从github下载存储库，并在存储库的根目录中运行python setup.py install。

文档

在 Read The Docs 上查看文档.

快速示例

以下示例展示了此库的一些基本用法，它设置了 asyncio 事件循环，将库指向串行设备路径，并附加了一个简单的处理函数，该函数打印出它接收的所有数据包的信息。例如，查看它对能源使用传感器的输出。

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()

您还可以将协程用作 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()

贡献

如果您想为 python-rfxcom 贡献，您需要使用 tox 来运行测试。这将针对 Python 3.3、Python 3.4 进行测试，使用 pyflakes 进行代码检查，并构建文档。要这样做，您只需安装 tox，然后在 python-rfxcom git 仓库的根目录下调用 tox 即可。

pip install tox
tox

如果您无法在本地针对 Python 3.3 和 Python 3.4 进行测试，请不要担心，许多人可能只有一个安装。我们使用出色的 Travis CI 来验证所有拉取请求。