Home Assistant Unofficial Reference 2024.12.1
Classes | Functions | Variables
homeassistant.components.snmp.switch Namespace Reference

Classes

class  SnmpSwitch
 

Functions

None async_setup_platform (HomeAssistant hass, ConfigType config, AddEntitiesCallback async_add_entities, DiscoveryInfoType|None discovery_info=None)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
string CONF_COMMAND_OID = "command_oid"
 
string CONF_COMMAND_PAYLOAD_OFF = "command_payload_off"
 
string CONF_COMMAND_PAYLOAD_ON = "command_payload_on"
 
string DEFAULT_COMMUNITY = "private"
 
int DEFAULT_PAYLOAD_OFF = 0
 
int DEFAULT_PAYLOAD_ON = 1
 
dictionary MAP_SNMP_VARTYPES
 
 PLATFORM_SCHEMA
 

Detailed Description

Support for SNMP enabled switch.

Function Documentation

◆ async_setup_platform()

None homeassistant.components.snmp.switch.async_setup_platform ( HomeAssistant  hass,
ConfigType  config,
AddEntitiesCallback  async_add_entities,
DiscoveryInfoType | None   discovery_info = None 
) 
Set up the SNMP switch.

Definition at line 131 of file switch.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.snmp.switch._LOGGER = logging.getLogger(__name__)
private

Definition at line 78 of file switch.py.

◆ CONF_COMMAND_OID

string homeassistant.components.snmp.switch.CONF_COMMAND_OID = "command_oid"

Definition at line 80 of file switch.py.

◆ CONF_COMMAND_PAYLOAD_OFF

string homeassistant.components.snmp.switch.CONF_COMMAND_PAYLOAD_OFF = "command_payload_off"

Definition at line 81 of file switch.py.

◆ CONF_COMMAND_PAYLOAD_ON

string homeassistant.components.snmp.switch.CONF_COMMAND_PAYLOAD_ON = "command_payload_on"

Definition at line 82 of file switch.py.

◆ DEFAULT_COMMUNITY

string homeassistant.components.snmp.switch.DEFAULT_COMMUNITY = "private"

Definition at line 84 of file switch.py.

◆ DEFAULT_PAYLOAD_OFF

int homeassistant.components.snmp.switch.DEFAULT_PAYLOAD_OFF = 0

Definition at line 85 of file switch.py.

◆ DEFAULT_PAYLOAD_ON

int homeassistant.components.snmp.switch.DEFAULT_PAYLOAD_ON = 1

Definition at line 86 of file switch.py.

◆ MAP_SNMP_VARTYPES

dictionary homeassistant.components.snmp.switch.MAP_SNMP_VARTYPES
Initial value:
1 = {
2  "Counter32": Counter32,
3  "Counter64": Counter64,
4  "Gauge32": Gauge32,
5  "Integer32": Integer32,
6  "Integer": Integer,
7  "IpAddress": IpAddress,
8  "Null": Null,
9  # some work todo to support tuple ObjectIdentifier, this just supports str
10  "ObjectIdentifier": ObjectIdentifier,
11  "OctetString": OctetString,
12  "Opaque": Opaque,
13  "TimeTicks": TimeTicks,
14  "Unsigned32": Unsigned32,
15 }

Definition at line 88 of file switch.py.

◆ PLATFORM_SCHEMA

homeassistant.components.snmp.switch.PLATFORM_SCHEMA
Initial value:
1 = SWITCH_PLATFORM_SCHEMA.extend(
2  {
3  vol.Required(CONF_BASEOID): cv.string,
4  vol.Optional(CONF_COMMAND_OID): cv.string,
5  vol.Optional(CONF_COMMAND_PAYLOAD_ON): cv.string,
6  vol.Optional(CONF_COMMAND_PAYLOAD_OFF): cv.string,
7  vol.Optional(CONF_COMMUNITY, default=DEFAULT_COMMUNITY): cv.string,
8  vol.Optional(CONF_HOST, default=DEFAULT_HOST): cv.string,
9  vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
10  vol.Optional(CONF_PAYLOAD_OFF, default=DEFAULT_PAYLOAD_OFF): cv.string,
11  vol.Optional(CONF_PAYLOAD_ON, default=DEFAULT_PAYLOAD_ON): cv.string,
12  vol.Optional(CONF_PORT, default=DEFAULT_PORT): cv.port,
13  vol.Optional(CONF_VERSION, default=DEFAULT_VERSION): vol.In(SNMP_VERSIONS),
14  vol.Optional(CONF_USERNAME): cv.string,
15  vol.Optional(CONF_AUTH_KEY): cv.string,
16  vol.Optional(CONF_AUTH_PROTOCOL, default=DEFAULT_AUTH_PROTOCOL): vol.In(
17  MAP_AUTH_PROTOCOLS
18  ),
19  vol.Optional(CONF_PRIV_KEY): cv.string,
20  vol.Optional(CONF_PRIV_PROTOCOL, default=DEFAULT_PRIV_PROTOCOL): vol.In(
21  MAP_PRIV_PROTOCOLS
22  ),
23  vol.Optional(CONF_VARTYPE, default=DEFAULT_VARTYPE): cv.string,
24  }
25 )

Definition at line 104 of file switch.py.