xs1-api-client 3.0.1

创建API对象

创建API对象的基本方法是直接在创建时提供连接信息。

from xs1_api_client import api as xs1api
from xs1_api_client import api_constants

# Create an api object with private configuration
api = xs1api.XS1(host='192.168.2.20', user="Username", password="Password")

这将自动尝试使用给定的凭据连接到网关，并检索基本网关信息，您可以像这样输出：

print("Gateway Hostname: " + api.get_gateway_name())
print("Gateway MAC: " + api.get_gateway_mac())
print("Gateway Hardware Version: " + api.get_gateway_hardware_version())
print("Gateway Bootloader Version: " + api.get_gateway_bootloader_version())
print("Gateway Firmware Version: " + api.get_gateway_firmware_version())
print("Gateway uptime: " + str(api.get_gateway_uptime()) + " seconds")

您还可以指定自定义端口并启用SSL。

api = xs1api.XS1(host='192.168.2.20', port=1234, ssl=True, user="Username", password="Password")

现在您已经连接到您的网关，我们可以检索其配置，设置或检索配置的执行器和传感器的值，甚至修改它们的配置。

设备

您在XS1中配置的所有设备都使用XS1Device基类实现，该类位于/device/__init__.py。此类为每个设备提供基本功能，例如获取id、name、type和其他值。

检索执行器

要检索所有64个执行器的列表，请使用以下调用

actuators = api.get_all_actuators()

这将返回一个包含XS1Actuator对象的列表，这是所有执行器的另一个基类。您可以使用类似以下的方式打印所有您的执行器

for actuator in actuators:
    print("Actuator " + str(actuator.id()) + ": " + actuator.name() + " (" + str(actuator.type()) + ")")

还有一个内置的__str__方法来打印出大多数有用的属性，就像这样

for actuator in actuators:
    print(actuator)

您也可以通过使用以下方式根据enabled和disabled状态筛选元素

enabled_actuators = api.get_all_actuators(True)

通过简单地使用以下方式检索单个执行器

actuator_1 = api.get_actuator(1)

检索执行器值

要检索执行器的当前值，只需调用

current_value = actuator.value()

设置新的执行器值

要设置此执行器的新值，请使用

actuator.set_value(100)

这将向XS1发送所需请求并设置new_value属性为您提供的值。通常，此值会立即设置，与value属性同步。但是，如果此值与标准value不同，XS1网关仍在尝试更新远程设备上的值。对于某些设备，这可能需要几分钟（例如FHT 80B加热）。

更新执行器信息

当前在值最终更新时没有回调，因此如果您想获取其当前状态更新，您必须手动更新设备信息。

actuator.update()

之后，通常的方法如actuator.value()将响应更新的状态。

执行执行器功能

如果您为设备定义了功能预设，您可以使用以下方式获取所有功能的列表

functions = actuator.get_functions()

并按如下方式打印它们

for function in functions:
    print(function)

要执行其中一个功能，请输入

function.execute()

这将立即更新设备状态，与网关的响应同步。但是请记住，向实际远程设备发送此值可能会有延迟，如上所述。

检索传感器列表

要检索所有64个传感器的列表，请使用以下调用

sensors = api.get_all_sensors()

就像执行器一样，您可以使用以下方式根据enabled和disabled状态筛选元素

enabled_sensors = api.get_all_sensors(True)

for sensor in sensors:
    print("Sensor " + str(sensor.id()) + ": " + sensor.name() + " (" + str(sensor.value()) + ")")

就像上面提到的，您也可以使用以下方式检索特定传感器：

for sensor in sensors:
    print(sensor)

或

sensor_1 = api.get_sensor(1)

来检索特定的传感器。

更新传感器信息

与执行器一样，传感器也没有自动更新。要从XS1网关获取传感器对象的州更新，请调用

sensor.update()

之后，此传感器的完整状态将更新。

禁用设备

XS1支持最多64个执行器和64个传感器配置。这128个设备配置可以通过HTTP API在任何时间访问 - 即使对于特定的设备ID/编号没有配置也是如此。

要检查设备是否已在XS1网页界面中配置（并启用），请调用

device.enabled()

适用于执行器和传感器的统一接口。

获取设备配置

自2.0版本以来，可以使用此库获取和设置XS1上的设备配置。

请查看< span class="docutils literal">example_config.py文件，了解如何检索设备配置。

修改设备配置

在您继续之前

每次配置更改都会写入XS1的内部闪存。请注意，频繁写入闪存可能会降低其性能。

复制设备配置

在此项目中有一个非常详细的示例，名为< span class="docutils literal">example_config_copy_actuator.py，将向您展示如何复制设备配置，并解释您将需要设置自定义配置的大部分重要配置参数。请记住，配置参数可能因设备类型和系统而异。