mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-13 12:26:50 +00:00
Update documentation for SNMP switch component to reflect changes. (#4190)
This commit is contained in:
parent
6496e3ef21
commit
3a068a85a5
@ -29,13 +29,16 @@ switch:
|
||||
|
||||
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.
|
||||
- **baseoid** (*Required*): The SNMP BaseOID which to poll for the state of the switch.
|
||||
- **command_oid** (*Optional*): The SNMP OID which to set in order to turn the switch on and off, if different from `baseoid`.
|
||||
- **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`.
|
||||
- **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`.
|
||||
- **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`.
|
||||
- **command_payload_on** (*Optional*): The value to write to turn on the switch, if different from `payload_on`.
|
||||
- **command_payload_off** (*Optional*): The value to write to turn off the switch, if different from `payload_off`.
|
||||
|
||||
You should check with your device's vendor to find out the correct BaseOID and what values turn the switch on and off.
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user