Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.raspyrfm.switch Namespace Reference

Classes

class  RaspyRFMSwitch
 

Functions

None setup_platform (HomeAssistant hass, ConfigType config, AddEntitiesCallback add_entities, DiscoveryInfoType|None discovery_info=None)
 

Variables

string CONF_CHANNEL_CONFIG = "channel_config"
 
string CONF_CONTROLUNIT_MANUFACTURER = "controlunit_manufacturer"
 
string CONF_CONTROLUNIT_MODEL = "controlunit_model"
 
string CONF_GATEWAY_MANUFACTURER = "gateway_manufacturer"
 
string CONF_GATEWAY_MODEL = "gateway_model"
 
string DEFAULT_HOST = "127.0.0.1"
 
 PLATFORM_SCHEMA
 

Detailed Description

Support for switches that can be controlled using the RaspyRFM rc module.

Function Documentation

◆ setup_platform()

None homeassistant.components.raspyrfm.switch.setup_platform ( HomeAssistant  hass,
ConfigType  config,
AddEntitiesCallback  add_entities,
DiscoveryInfoType | None   discovery_info = None 
)
Set up the RaspyRFM switch.

Definition at line 61 of file switch.py.

Variable Documentation

◆ CONF_CHANNEL_CONFIG

string homeassistant.components.raspyrfm.switch.CONF_CHANNEL_CONFIG = "channel_config"

Definition at line 36 of file switch.py.

◆ CONF_CONTROLUNIT_MANUFACTURER

string homeassistant.components.raspyrfm.switch.CONF_CONTROLUNIT_MANUFACTURER = "controlunit_manufacturer"

Definition at line 34 of file switch.py.

◆ CONF_CONTROLUNIT_MODEL

string homeassistant.components.raspyrfm.switch.CONF_CONTROLUNIT_MODEL = "controlunit_model"

Definition at line 35 of file switch.py.

◆ CONF_GATEWAY_MANUFACTURER

string homeassistant.components.raspyrfm.switch.CONF_GATEWAY_MANUFACTURER = "gateway_manufacturer"

Definition at line 32 of file switch.py.

◆ CONF_GATEWAY_MODEL

string homeassistant.components.raspyrfm.switch.CONF_GATEWAY_MODEL = "gateway_model"

Definition at line 33 of file switch.py.

◆ DEFAULT_HOST

string homeassistant.components.raspyrfm.switch.DEFAULT_HOST = "127.0.0.1"

Definition at line 37 of file switch.py.

◆ PLATFORM_SCHEMA

homeassistant.components.raspyrfm.switch.PLATFORM_SCHEMA
Initial value:
1 = SWITCH_PLATFORM_SCHEMA.extend(
2  {
3  vol.Optional(CONF_HOST, default=DEFAULT_HOST): cv.string,
4  vol.Optional(CONF_PORT): cv.port,
5  vol.Optional(CONF_GATEWAY_MANUFACTURER): cv.string,
6  vol.Optional(CONF_GATEWAY_MODEL): cv.string,
7  vol.Required(CONF_SWITCHES): vol.Schema(
8  [
9  {
10  vol.Optional(CONF_NAME, default=DEVICE_DEFAULT_NAME): cv.string,
11  vol.Required(CONF_CONTROLUNIT_MANUFACTURER): cv.string,
12  vol.Required(CONF_CONTROLUNIT_MODEL): cv.string,
13  vol.Required(CONF_CHANNEL_CONFIG): {cv.string: cv.match_all},
14  }
15  ]
16  ),
17  },
18  extra=vol.ALLOW_EXTRA,
19 )

Definition at line 40 of file switch.py.