raspyrfm-client 1.2.8

导入所需模块

from raspyrfm_client import RaspyRFMClient
from raspyrfm_client.device_implementations.controlunit.actions import Action
from raspyrfm_client.device_implementations.controlunit.controlunit_constants import ControlUnitModel
from raspyrfm_client.device_implementations.gateway.manufacturer.gateway_constants import GatewayModel
from raspyrfm_client.device_implementations.manufacturer_constants import Manufacturer

创建RaspyRFMClient对象

通过调用获取客户端实例

rfm_client = RaspyRFMClient()

创建Gateway实例

您可以使用以下方式自动搜索LAN中可用的网关

gateways = rfm_client.search()

这将返回一个网关列表，稍后可以使用这些网关发送信号。

要快速查看哪些网关制造商和型号受到支持，请调用

rfm_client.list_supported_gateways()

使用指定的网关IP和端口创建网关实例

gateway = rfm_client.get_gateway(Manufacturer.SEEGEL_SYSTEME, GatewayModel.RASPYRFM, "192.168.2.10", 9876)

或

gateway = rfm_client.get_gateway(Manufacturer.SEEGEL_SYSTEME, GatewayModel.RASPYRFM, "192.168.2.10") # defaults to 49880 or the gateway implementations default

获取一个ControlUnit

ControlUnit是接收通过网关发送的rc信号并接收的设备，例如电源插座。

要快速查看哪些ControlUnit 制造商和型号受到支持，请调用

rfm_client.list_supported_controlunits()

这将提供一个类似以下的缩进列表，列出支持的制造商及其支持的型号

Elro
  RC3500-A IP44 DE
  AB440S
  AB440D 200W
  AB440D 300W
  AB440ID
  AB440IS
  AB440L
  AB440SC
  AB440WD
BAT
  RC AAA1000-A IP44 Outdoor
Brennenstuhl
  RCS 1000 N Comfort
  RCS 1044 N Comfort
Intertek
  Model 1919361
[...]

为了为设备生成代码，您首先需要获取其实例，如下所示：

brennenstuhl_rcs1000 = rfm_client.get_controlunit(manufacturer_constants.BRENNENSTUHL,
                                          manufacturer_constants.RCS_1000_N_COMFORT)

get_controlunit() 方法的参数始终需要指定类型的枚举值。您可以通过名称来获取枚举常量，如下所示：

manufacturer = Manufacturer("Intertechno")
model = ControlUnitModel("IT-1500")

ControlUnit 通道配置

在您可以使用您的新颖的网关和 ControlUnit 实现生成代码之前，您必须为您的 ControlUnit 指定一个通道配置。这些配置对于每个设备都可能会有很大差异。了解特定设备的正确通道配置方法，最好的方式是查看源代码（是的，我知道……）或通过试错（更糟糕）。一个好的 ControlUnit 实现应该在您错误指定配置时告诉您应该如何进行配置。

然而，所有配置都是一个 键控字典。因此，通常有两种传递通道配置参数的方法。一种是（内联）

device.set_channel_config(value1=1, value2=2)

另一种是（作为字典）

device.set_channel_config(**{
    'value1': 1,
    'value2': 2
})

注意，键始终需要是一个 字符串。第二种方法更推荐，因为它通常会产生更易于阅读的源代码。

对于我们的 Brennenstuhl 设备，它看起来像这样：

brennenstuhl_rcs1000.set_channel_config(**{
    '1': True,
    '2': True,
    '3': True,
    '4': True,
    '5': True,
    'CH': 'A'
})

生成动作代码

现在，您已经正确设置了 ControlUnit，您可以使用之前导入的 Action 枚举常量来生成它支持的动作的代码。

要获取 ControlUnit 支持的动作列表，请调用

brennenstuhl_rcs1000.get_supported_actions()

然后使用您的 Gateway 实例生成其中一个动作的代码

code = gateway.generate_code(brennenstuhl_rcs1000, Action.ON)

将代码发送到 RaspyRFM 模块

要发送您选择的设备的代码，您可以组合此调用中的对象

rfm_client.send(gateway, brennenstuhl_rcs1000, Action.ON)

这将生成特定于传入网关实现的代码，并在发送到其主地址后立即发送。