jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-05-05 18:48:59 +00:00
Code Issues Packages Projects Releases Wiki Activity
home-assistant.io/source/_components/switch.snmp.markdown
Georgi Kirichkov 9f012992d1
Adds documentation for SNMP switch (#3598) 
* Adds documentation for SNMP switch

* Grammar fixes

* Update 'ha_release'
2017-10-31 20:19:56 +01:00

1.8 KiB
Raw Blame History

layout, title, description, date, sidebar, comments, sharing, footer, logo, ha_category, ha_iot_class, ha_release
layout title description date sidebar comments sharing footer logo ha_category ha_iot_class ha_release
page SNMP Switch Instructions on how to integrate SNMP switches into Home Assistant. 2017-10-12 08:00 true false true true network-snmp.png Switch Local Polling 0.57

The snmp switch platform allows you to control SNMP-enabled equipment.

Currently, only SNMP OIDs that accept integer values are supported. SNMP v1 and v2c are supported. SNMP v3 is not supported.

To use an SNMP switch in your installation:

# Example configuration.yaml entry:
switch:
  - platform: snmp
    host: 192.168.0.2
    baseoid: 1.3.6.1.4.1.19865.1.2.1.4.0

Configuration variables:

  • baseoid (Required): The SNMP BaseOID which to poll for the state of the switch and which to set in order to turn the switch on and off.
  • host (Optional): The IP/host which to control. Defaults to localhost.
  • port (Optional): The port on which to communicate. Defaults to 161.
  • community (Optional): community string to use for authentication. Defaults to private.
  • version (Optional): SNMP version to use - either 1 or 2c. Defaults to 1.
  • payload_on (Optional): What return value represents an On state for the switch. The same value is used in writes to turn on the switch. Defaults to 1.
  • payload_off (Optional): What return value represents an Off state for the switch. The same value is used in writes to turn off the switch. Defaults to 0.

You should check with your device's vendor to find out the correct BaseOID and what values turn the switch on and off.

A complete example:

switch:
  - platform: snmp
    name: SNMP switch
    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