SNMP

许多Wi-Fi接入点和Wi-Fi路由器支持简单网络管理协议（SNMP）。这是监控/管理网络连接设备的标准化方法。SNMP使用树状层级结构，其中每个节点都是一个对象。这些对象中的许多包含（实时）实例和指标的列表，例如网络接口、磁盘和Wi-Fi注册。

目前Home Assistant支持以下设备类型：

• 存在检测
• 传感器
  • 查找OID
  • 示例
    • 打印机正常运行时间（分钟）
• 开关

存在检测

以下OID示例从路由器提取当前MAC地址表。这反映了最近在网络上看到的所有设备。然而，由于设备在超时之前不会被移除，因此对于设备跟踪器集成页面来说，这种方法的效果不如预期。建议使用Ping或Nmap。

要在您的安装中使用SNMP版本1或2c平台，请将以下内容添加到您的configuration.yaml文件中：

# SNMP版本1或2c的configuration.yaml示例条目
device_tracker:
  - platform: snmp
    host: 192.168.1.1
    community: public
    baseoid: 1.3.6.1.4.1.14988.1.1.1.2.1.1

如果您想使用加密，则必须通过添加auth_key和priv_key变量并在路由器上启用SNMP版本3来启用它。目前仅支持SHA1用于身份验证和AES用于加密。SNMPv3配置示例：

# SNMP版本3的configuration.yaml示例条目
device_tracker:
  - platform: snmp
    host: 192.168.1.1
    community: USERNAME
    auth_key: AUTHPASS
    priv_key: PRIVPASS
    baseoid: 1.3.6.1.4.1.14988.1.1.1.2.1.1

请参阅设备跟踪器集成页面以获取如何配置需要被跟踪的人的说明。

使用模板

对于传入数据，值模板将传入的 JSON 或原始数据转换为有效的有效负载。 传入的有效负载使用可能的 JSON 值进行渲染，因此在渲染时，可以使用 value_json 访问基于 JSON 的有效负载中的属性，否则可以使用 value 变量来处理非 JSON 基础的数据。

此外，this 可以作为模板中的变量使用。this 属性指的是实体的当前 实体状态。 关于 this 变量的更多信息可以在 模板文档 中找到。

{ "state": "ON", "temperature": 21.902 }

传感器

snmp传感器平台显示通过简单网络管理协议（SNMP）获得的信息。SNMP使用树状层级结构，其中每个节点是一个对象，主要支持网络设备，例如路由器、调制解调器和打印机。

要在您的安装中启用此传感器，请将以下内容添加到您的configuration.yaml文件中：

# configuration.yaml条目的示例
sensor:
  - platform: snmp
    host: 192.168.1.32
    baseoid: 1.3.6.1.4.1.2021.10.1.3.1

auth_protocol的有效值：

• none
• hmac-md5
• hmac-sha
• hmac128-sha224
• hmac192-sha256
• hmac256-sha384
• hmac384-sha512

priv_protocol的有效值：

• none
• des
• 3des-ede
• aes-cfb-128
• aes-cfb-192
• aes-cfb-256

查找OID

OID可能在不同系统上有所不同，因为它们是供应商特定的。除了设备手册，OID仓库是查找OID的好地方。例如，以下OID用于Linux系统的负载。

• 1分钟负载: 1.3.6.1.4.1.2021.10.1.3.1
• 5分钟负载: 1.3.6.1.4.1.2021.10.1.3.2
• 15分钟负载: 1.3.6.1.4.1.2021.10.1.3.3

有许多用于SNMP的工具可供使用。snmpwalk让您轻松检索OID的值。

$ snmpwalk -Os -c public -v 2c 192.168.1.32 1.3.6.1.4.1.2021.10.1.3.1
laLoad.1 = STRING: 0.19

示例

打印机正常运行时间（分钟）

根据最常见的SNMP标准，设备的正常运行时间可以在OID 1.3.6.1.2.1.1.3.0下访问。值以称为TimeTicks的格式表示，以百分之一秒为单位。

要创建一个传感器，用于以分钟为单位显示打印机的正常运行时间，您可以使用以下配置：

# configuration.yaml条目的示例
sensor:
  - platform: snmp
    name: "打印机正常运行时间"
    host: 192.168.2.21
    baseoid: 1.3.6.1.2.1.1.3.0
    accept_errors: true
    unit_of_measurement: "分钟"
    value_template: "{{((value | int) / 6000) | int}}"

accept_errors选项将允许传感器在Home Assistant首次启动时即使打印机未开启也能正常工作：传感器将仅显示-而不是分钟数。

value_template选项将原始值转换为分钟。

开关

snmp开关平台允许您控制支持SNMP的设备。

目前，仅支持接受整数值的SNMP OID。支持SNMP v1、v2c和v3。

要在您的安装中使用SNMP开关：

# configuration.yaml条目的示例：
switch:
  - platform: snmp
    host: 192.168.0.2
    baseoid: 1.3.6.1.4.1.19865.1.2.1.4.0

您应该与设备的供应商联系，以了解正确的BaseOID以及开关的开启和关闭值。

auth_protocol的有效值：

• none
• hmac-md5
• hmac-sha
• hmac128-sha224
• hmac192-sha256
• hmac256-sha384
• hmac384-sha512

priv_protocol的有效值：

• none
• des
• 3des-ede
• aes-cfb-128
• aes-cfb-192
• aes-cfb-256

vartype的有效值：

• Counter32
• Counter64
• Gauge32
• Integer32
• Integer
• IpAddress
• ObjectIdentifier
• OctetString
• Opaque
• TimeTicks
• Unsigned32

完整示例：

switch:
  - platform: snmp
    name: SNMP v1开关
    host: 192.168.0.2
    community: private
    baseoid: 1.3.6.1.4.1.19865.1.2.1.4.0
    payload_on: 1
    payload_off: 0

  - platform: snmp
    name: SNMP v3开关
    host: 192.168.0.3
    version: "3"
    username: "myusername"
    auth_key: "myauthkey"
    auth_protocol: "hmac-sha"
    priv_key: "myprivkey"
    priv_protocol: "aes-cfb-128"
    baseoid: 1.3.6.1.4.1.19865.1.2.1.4.0
    payload_on: 1
    payload_off: 0

  - platform: snmp
    name: 使用SNMP v3启用Netgear交换机端口2的PoE
    host: 192.168.0.4
    version: "3"
    username: "myusername"
    auth_key: "myauthkey"
    auth_protocol: "hmac-sha"
    priv_key: "myprivkey"
    priv_protocol: "des"
    baseoid: 1.3.6.1.4.1.4526.11.15.1.1.1.1.1.2
    payload_on: 15400
    payload_off: 3000
    vartype: Gauge32