Skip to content

Commit 3a068a8

Browse files
nkaminskifrenck
authored andcommitted
Update documentation for SNMP switch component to reflect changes. (home-assistant#4190)
1 parent 6496e3e commit 3a068a8

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

source/_components/switch.snmp.markdown

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,16 @@ switch:
2929
3030
Configuration variables:
3131
32-
- **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.
32+
- **baseoid** (*Required*): The SNMP BaseOID which to poll for the state of the switch.
33+
- **command_oid** (*Optional*): The SNMP OID which to set in order to turn the switch on and off, if different from `baseoid`.
3334
- **host** (*Optional*): The IP/host which to control. Defaults to `localhost`.
3435
- **port** (*Optional*): The port on which to communicate. Defaults to `161`.
3536
- **community** (*Optional*): community string to use for authentication. Defaults to `private`.
3637
- **version** (*Optional*): SNMP version to use - either `1` or `2c`. Defaults to `1`.
37-
- **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`.
38-
- **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`.
38+
- **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 if `command_payload_on` is not set. Defaults to `1`.
39+
- **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 if `command_payload_off` is not set. Defaults to `0`.
40+
- **command_payload_on** (*Optional*): The value to write to turn on the switch, if different from `payload_on`.
41+
- **command_payload_off** (*Optional*): The value to write to turn off the switch, if different from `payload_off`.
3942

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

0 commit comments

Comments
 (0)