Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.rachio.switch.RachioZone Class Reference
Inheritance diagram for homeassistant.components.rachio.switch.RachioZone:
[legend]
Collaboration diagram for homeassistant.components.rachio.switch.RachioZone:
[legend]

Public Member Functions

None __init__ (self, person, controller, data, current_schedule)
 
def __str__ (self)
 
None async_added_to_hass (self)
 
dict[str, Any] extra_state_attributes (self)
 
None set_moisture_percent (self, percent)
 
None turn_off (self, **Any kwargs)
 
None turn_on (self, **Any kwargs)
 
str zone_id (self)
 
bool zone_is_enabled (self)
 
- Public Member Functions inherited from homeassistant.components.rachio.entity.RachioDevice
None __init__ (self, RachioIro controller)
 
- Public Member Functions inherited from homeassistant.helpers.entity.Entity
None __init_subclass__ (cls, **Any kwargs)
 
str __repr__ (self)
 
None add_to_platform_abort (self)
 
None add_to_platform_finish (self)
 
None add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore|None parallel_updates)
 
bool assumed_state (self)
 
None async_device_update (self, bool warning=True)
 
None async_internal_added_to_hass (self)
 
None async_internal_will_remove_from_hass (self)
 
None async_on_remove (self, CALLBACK_TYPE func)
 
None async_registry_entry_updated (self)
 
None async_remove (self, *bool force_remove=False)
 
None async_removed_from_registry (self)
 
None async_schedule_update_ha_state (self, bool force_refresh=False)
 
None async_set_context (self, Context context)
 
None async_update_ha_state (self, bool force_refresh=False)
 
None async_will_remove_from_hass (self)
 
None async_write_ha_state (self)
 
str|None attribution (self)
 
bool available (self)
 
dict[str, Any]|None capability_attributes (self)
 
DeviceInfo|None device_info (self)
 
bool enabled (self)
 
EntityCategory|None entity_category (self)
 
str|None entity_picture (self)
 
bool entity_registry_enabled_default (self)
 
bool entity_registry_visible_default (self)
 
bool force_update (self)
 
HassJobType get_hassjob_type (self, str function_name)
 
er.EntityOptionsType|None get_initial_entity_options (self)
 
bool has_entity_name (self)
 
str|None icon (self)
 
str|UndefinedType|None name (self)
 
None schedule_update_ha_state (self, bool force_refresh=False)
 
bool should_poll (self)
 
dict[str, Any]|None state_attributes (self)
 
str|None suggested_object_id (self)
 
int|None supported_features (self)
 
str|None translation_key (self)
 
Mapping[str, strtranslation_placeholders (self)
 
str|None unique_id (self)
 
str|None unit_of_measurement (self)
 
bool use_device_name (self)
 
- Public Member Functions inherited from homeassistant.helpers.entity.CachedProperties
None __init__ (cls, str name, tuple[type,...] bases, dict[Any, Any] namespace, **Any kwargs)
 
Any __new__ (mcs, str name, tuple[type,...] bases, dict[Any, Any] namespace, set[str]|None cached_properties=None, **Any kwargs)
 
- Public Member Functions inherited from homeassistant.components.switch.SwitchEntity
SwitchDeviceClass|None device_class (self)
 
- Public Member Functions inherited from homeassistant.helpers.entity.ToggleEntity
None async_toggle (self, **Any kwargs)
 
None async_turn_off (self, **Any kwargs)
 
None async_turn_on (self, **Any kwargs)
 
bool|None is_on (self)
 
Literal["on", "off"]|None state (self)
 
None toggle (self, **Any kwargs)
 

Public Attributes

 id
 
 zone_id
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 

Private Member Functions

None _async_handle_update (self, *args, **kwargs)
 

Private Attributes

 _attr_entity_picture
 
 _attr_is_on
 
 _attr_name
 
 _attr_unique_id
 
 _current_schedule
 
 _person
 
 _shade_type
 
 _slope_type
 
 _summary
 
 _zone_enabled
 
 _zone_number
 
 _zone_type
 

Static Private Attributes

string _attr_icon = "mdi:water"
 

Additional Inherited Members

- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 
- Static Public Attributes inherited from homeassistant.helpers.entity.ToggleEntity
 None
 

Detailed Description

Representation of one zone of sprinklers connected to the Rachio Iro.

Definition at line 345 of file switch.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.rachio.switch.RachioZone.__init__ (   self,
  person,
  controller,
  data,
  current_schedule 
)
Initialize a new Rachio Zone.

Definition at line 350 of file switch.py.

Member Function Documentation

◆ __str__()

def homeassistant.components.rachio.switch.RachioZone.__str__ (   self)
Display the zone as a string.

Definition at line 366 of file switch.py.

◆ _async_handle_update()

None homeassistant.components.rachio.switch.RachioZone._async_handle_update (   self,
args,
**  kwargs 
)
private
Handle incoming webhook zone data.

Reimplemented from homeassistant.components.rachio.switch.RachioSwitch.

Definition at line 432 of file switch.py.

◆ async_added_to_hass()

None homeassistant.components.rachio.switch.RachioZone.async_added_to_hass (   self)
Subscribe to updates.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 450 of file switch.py.

◆ extra_state_attributes()

dict[str, Any] homeassistant.components.rachio.switch.RachioZone.extra_state_attributes (   self)
Return the optional state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 381 of file switch.py.

◆ set_moisture_percent()

None homeassistant.components.rachio.switch.RachioZone.set_moisture_percent (   self,
  percent 
)
Set the zone moisture percent.

Definition at line 426 of file switch.py.

◆ turn_off()

None homeassistant.components.rachio.switch.RachioZone.turn_off (   self,
**Any  kwargs 
)
Stop watering all zones.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 422 of file switch.py.

◆ turn_on()

None homeassistant.components.rachio.switch.RachioZone.turn_on (   self,
**Any  kwargs 
)
Start watering this zone.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 399 of file switch.py.

◆ zone_id()

str homeassistant.components.rachio.switch.RachioZone.zone_id (   self)
How the Rachio API refers to the zone.

Definition at line 371 of file switch.py.

◆ zone_is_enabled()

bool homeassistant.components.rachio.switch.RachioZone.zone_is_enabled (   self)
Return whether the zone is allowed to run.

Definition at line 376 of file switch.py.

Member Data Documentation

◆ _attr_entity_picture

homeassistant.components.rachio.switch.RachioZone._attr_entity_picture
private

Definition at line 356 of file switch.py.

◆ _attr_icon

string homeassistant.components.rachio.switch.RachioZone._attr_icon = "mdi:water"
staticprivate

Definition at line 348 of file switch.py.

◆ _attr_is_on

homeassistant.components.rachio.switch.RachioZone._attr_is_on
private

Definition at line 440 of file switch.py.

◆ _attr_name

homeassistant.components.rachio.switch.RachioZone._attr_name
private

Definition at line 353 of file switch.py.

◆ _attr_unique_id

homeassistant.components.rachio.switch.RachioZone._attr_unique_id
private

Definition at line 363 of file switch.py.

◆ _current_schedule

homeassistant.components.rachio.switch.RachioZone._current_schedule
private

Definition at line 362 of file switch.py.

◆ _person

homeassistant.components.rachio.switch.RachioZone._person
private

Definition at line 357 of file switch.py.

◆ _shade_type

homeassistant.components.rachio.switch.RachioZone._shade_type
private

Definition at line 358 of file switch.py.

◆ _slope_type

homeassistant.components.rachio.switch.RachioZone._slope_type
private

Definition at line 360 of file switch.py.

◆ _summary

homeassistant.components.rachio.switch.RachioZone._summary
private

Definition at line 361 of file switch.py.

◆ _zone_enabled

homeassistant.components.rachio.switch.RachioZone._zone_enabled
private

Definition at line 355 of file switch.py.

◆ _zone_number

homeassistant.components.rachio.switch.RachioZone._zone_number
private

Definition at line 354 of file switch.py.

◆ _zone_type

homeassistant.components.rachio.switch.RachioZone._zone_type
private

Definition at line 359 of file switch.py.

◆ id

homeassistant.components.rachio.switch.RachioZone.id

Definition at line 352 of file switch.py.

◆ zone_id

homeassistant.components.rachio.switch.RachioZone.zone_id

Definition at line 452 of file switch.py.


The documentation for this class was generated from the following file: