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

Classes

class  RainMachineActivitySwitch
 
class  RainMachineActivitySwitchDescription
 
class  RainMachineBaseSwitch
 
class  RainMachineEnabledSwitch
 
class  RainMachineProgram
 
class  RainMachineProgramEnabled
 
class  RainMachineRestrictionSwitch
 
class  RainMachineRestrictionSwitchDescription
 
class  RainMachineSwitchDescription
 
class  RainMachineZone
 
class  RainMachineZoneEnabled
 

Functions

def _T
 
None async_setup_entry (HomeAssistant hass, RainMachineConfigEntry entry, AddEntitiesCallback async_add_entities)
 

Variables

string ATTR_ACTIVITY_TYPE = "activity_type"
 
string ATTR_AREA = "area"
 
string ATTR_CS_ON = "cs_on"
 
string ATTR_CURRENT_CYCLE = "current_cycle"
 
string ATTR_CYCLES = "cycles"
 
string ATTR_DELAY = "delay"
 
string ATTR_DELAY_ON = "delay_on"
 
string ATTR_FIELD_CAPACITY = "field_capacity"
 
string ATTR_NEXT_RUN = "next_run"
 
string ATTR_NO_CYCLES = "number_of_cycles"
 
string ATTR_PRECIP_RATE = "sprinkler_head_precipitation_rate"
 
string ATTR_RESTRICTIONS = "restrictions"
 
string ATTR_SLOPE = "slope"
 
string ATTR_SOAK = "soak"
 
string ATTR_SOIL_TYPE = "soil_type"
 
string ATTR_SPRINKLER_TYPE = "sprinkler_head_type"
 
string ATTR_STATUS = "status"
 
string ATTR_SUN_EXPOSURE = "sun_exposure"
 
string ATTR_VEGETATION_TYPE = "vegetation_type"
 
string ATTR_ZONE_RUN_TIME = "zone_run_time_from_app"
 
string ATTR_ZONES = "zones"
 
list DAYS = ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"]
 
tuple RESTRICTIONS_SWITCH_DESCRIPTIONS
 
dictionary SLOPE_TYPE_MAP
 
dictionary SOIL_TYPE_MAP
 
dictionary SPRINKLER_TYPE_MAP
 
dictionary SUN_EXPOSURE_MAP = {0: "Not Set", 1: "Full Sun", 2: "Partial Shade", 3: "Full Shade"}
 
string TYPE_RESTRICTIONS_FREEZE_PROTECT_ENABLED = "freeze_protect_enabled"
 
string TYPE_RESTRICTIONS_HOT_DAYS_EXTRA_WATERING = "hot_days_extra_watering"
 
dictionary VEGETATION_MAP
 

Detailed Description

Component providing support for RainMachine programs and zones.

Function Documentation

◆ _T()

def homeassistant.components.rainmachine.switch._T
private

Definition at line 114 of file switch.py.

◆ async_setup_entry()

None homeassistant.components.rainmachine.switch.async_setup_entry ( HomeAssistant  hass,
RainMachineConfigEntry  entry,
AddEntitiesCallback  async_add_entities 
) 
Set up RainMachine switches based on a config entry.

Definition at line 174 of file switch.py.

Variable Documentation

◆ ATTR_ACTIVITY_TYPE

string homeassistant.components.rainmachine.switch.ATTR_ACTIVITY_TYPE = "activity_type"

Definition at line 38 of file switch.py.

◆ ATTR_AREA

string homeassistant.components.rainmachine.switch.ATTR_AREA = "area"

Definition at line 39 of file switch.py.

◆ ATTR_CS_ON

string homeassistant.components.rainmachine.switch.ATTR_CS_ON = "cs_on"

Definition at line 40 of file switch.py.

◆ ATTR_CURRENT_CYCLE

string homeassistant.components.rainmachine.switch.ATTR_CURRENT_CYCLE = "current_cycle"

Definition at line 41 of file switch.py.

◆ ATTR_CYCLES

string homeassistant.components.rainmachine.switch.ATTR_CYCLES = "cycles"

Definition at line 42 of file switch.py.

◆ ATTR_DELAY

string homeassistant.components.rainmachine.switch.ATTR_DELAY = "delay"

Definition at line 43 of file switch.py.

◆ ATTR_DELAY_ON

string homeassistant.components.rainmachine.switch.ATTR_DELAY_ON = "delay_on"

Definition at line 44 of file switch.py.

◆ ATTR_FIELD_CAPACITY

string homeassistant.components.rainmachine.switch.ATTR_FIELD_CAPACITY = "field_capacity"

Definition at line 45 of file switch.py.

◆ ATTR_NEXT_RUN

string homeassistant.components.rainmachine.switch.ATTR_NEXT_RUN = "next_run"

Definition at line 46 of file switch.py.

◆ ATTR_NO_CYCLES

string homeassistant.components.rainmachine.switch.ATTR_NO_CYCLES = "number_of_cycles"

Definition at line 47 of file switch.py.

◆ ATTR_PRECIP_RATE

string homeassistant.components.rainmachine.switch.ATTR_PRECIP_RATE = "sprinkler_head_precipitation_rate"

Definition at line 48 of file switch.py.

◆ ATTR_RESTRICTIONS

string homeassistant.components.rainmachine.switch.ATTR_RESTRICTIONS = "restrictions"

Definition at line 49 of file switch.py.

◆ ATTR_SLOPE

string homeassistant.components.rainmachine.switch.ATTR_SLOPE = "slope"

Definition at line 50 of file switch.py.

◆ ATTR_SOAK

string homeassistant.components.rainmachine.switch.ATTR_SOAK = "soak"

Definition at line 51 of file switch.py.

◆ ATTR_SOIL_TYPE

string homeassistant.components.rainmachine.switch.ATTR_SOIL_TYPE = "soil_type"

Definition at line 52 of file switch.py.

◆ ATTR_SPRINKLER_TYPE

string homeassistant.components.rainmachine.switch.ATTR_SPRINKLER_TYPE = "sprinkler_head_type"

Definition at line 53 of file switch.py.

◆ ATTR_STATUS

string homeassistant.components.rainmachine.switch.ATTR_STATUS = "status"

Definition at line 54 of file switch.py.

◆ ATTR_SUN_EXPOSURE

string homeassistant.components.rainmachine.switch.ATTR_SUN_EXPOSURE = "sun_exposure"

Definition at line 55 of file switch.py.

◆ ATTR_VEGETATION_TYPE

string homeassistant.components.rainmachine.switch.ATTR_VEGETATION_TYPE = "vegetation_type"

Definition at line 56 of file switch.py.

◆ ATTR_ZONE_RUN_TIME

string homeassistant.components.rainmachine.switch.ATTR_ZONE_RUN_TIME = "zone_run_time_from_app"

Definition at line 58 of file switch.py.

◆ ATTR_ZONES

string homeassistant.components.rainmachine.switch.ATTR_ZONES = "zones"

Definition at line 57 of file switch.py.

◆ DAYS

list homeassistant.components.rainmachine.switch.DAYS = ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"]

Definition at line 60 of file switch.py.

◆ RESTRICTIONS_SWITCH_DESCRIPTIONS

tuple homeassistant.components.rainmachine.switch.RESTRICTIONS_SWITCH_DESCRIPTIONS
Initial value:
1 = (
2  RainMachineRestrictionSwitchDescription(
3  key=TYPE_RESTRICTIONS_FREEZE_PROTECT_ENABLED,
4  translation_key=TYPE_RESTRICTIONS_FREEZE_PROTECT_ENABLED,
5  icon="mdi:snowflake-alert",
6  api_category=DATA_RESTRICTIONS_UNIVERSAL,
7  data_key="freezeProtectEnabled",
8  ),
9  RainMachineRestrictionSwitchDescription(
10  key=TYPE_RESTRICTIONS_HOT_DAYS_EXTRA_WATERING,
11  translation_key=TYPE_RESTRICTIONS_HOT_DAYS_EXTRA_WATERING,
12  icon="mdi:heat-wave",
13  api_category=DATA_RESTRICTIONS_UNIVERSAL,
14  data_key="hotDaysExtraWatering",
15  ),
16 )

Definition at line 156 of file switch.py.

◆ SLOPE_TYPE_MAP

dictionary homeassistant.components.rainmachine.switch.SLOPE_TYPE_MAP
Initial value:
1 = {
2  0: "Not Set",
3  1: "Flat",
4  2: "Moderate",
5  3: "High",
6  4: "Very High",
7  99: "Other",
8 }

Definition at line 77 of file switch.py.

◆ SOIL_TYPE_MAP

dictionary homeassistant.components.rainmachine.switch.SOIL_TYPE_MAP
Initial value:
1 = {
2  0: "Not Set",
3  1: "Clay Loam",
4  2: "Silty Clay",
5  3: "Clay",
6  4: "Loam",
7  5: "Sandy Loam",
8  6: "Loamy Sand",
9  7: "Sand",
10  8: "Sandy Clay",
11  9: "Silt Loam",
12  10: "Silt",
13  99: "Other",
14 }

Definition at line 62 of file switch.py.

◆ SPRINKLER_TYPE_MAP

dictionary homeassistant.components.rainmachine.switch.SPRINKLER_TYPE_MAP
Initial value:
1 = {
2  0: "Not Set",
3  1: "Popup Spray",
4  2: "Rotors Low Rate",
5  3: "Surface Drip",
6  4: "Bubblers Drip",
7  5: "Rotors High Rate",
8  99: "Other",
9 }

Definition at line 86 of file switch.py.

◆ SUN_EXPOSURE_MAP

dictionary homeassistant.components.rainmachine.switch.SUN_EXPOSURE_MAP = {0: "Not Set", 1: "Full Sun", 2: "Partial Shade", 3: "Full Shade"}

Definition at line 96 of file switch.py.

◆ TYPE_RESTRICTIONS_FREEZE_PROTECT_ENABLED

string homeassistant.components.rainmachine.switch.TYPE_RESTRICTIONS_FREEZE_PROTECT_ENABLED = "freeze_protect_enabled"

Definition at line 153 of file switch.py.

◆ TYPE_RESTRICTIONS_HOT_DAYS_EXTRA_WATERING

string homeassistant.components.rainmachine.switch.TYPE_RESTRICTIONS_HOT_DAYS_EXTRA_WATERING = "hot_days_extra_watering"

Definition at line 154 of file switch.py.

◆ VEGETATION_MAP

dictionary homeassistant.components.rainmachine.switch.VEGETATION_MAP
Initial value:
1 = {
2  0: "Not Set",
3  1: "Not Set",
4  2: "Cool Season Grass",
5  3: "Fruit Trees",
6  4: "Flowers",
7  5: "Vegetables",
8  6: "Citrus",
9  7: "Bushes",
10  9: "Drought Tolerant Plants",
11  10: "Warm Season Grass",
12  11: "Trees",
13  99: "Other",
14 }

Definition at line 98 of file switch.py.