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

Public Member Functions

def __init__ (self, name, port_addr, gc100)
 
def is_on (self)
 
def name (self)
 
def set_state (self, state)
 
None turn_off (self, **Any kwargs)
 
None turn_on (self, **Any kwargs)
 
None update (self)
 
- 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)
 
Literal["on", "off"]|None state (self)
 
None toggle (self, **Any kwargs)
 
- 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_added_to_hass (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)
 
Mapping[str, Any]|None extra_state_attributes (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)
 
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)
 

Private Attributes

 _gc100
 
 _name
 
 _port_addr
 
 _state
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 
- Static Public Attributes inherited from homeassistant.helpers.entity.ToggleEntity
 None
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 

Detailed Description

Represent a switch/relay from GC100.

Definition at line 43 of file switch.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.gc100.switch.GC100Switch.__init__ (   self,
  name,
  port_addr,
  gc100 
)
Initialize the GC100 switch.

Definition at line 46 of file switch.py.

Member Function Documentation

◆ is_on()

def homeassistant.components.gc100.switch.GC100Switch.is_on (   self)
Return the state of the entity.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 59 of file switch.py.

◆ name()

def homeassistant.components.gc100.switch.GC100Switch.name (   self)
Return the name of the switch.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 54 of file switch.py.

◆ set_state()

def homeassistant.components.gc100.switch.GC100Switch.set_state (   self,
  state 
)
Set the current state.

Definition at line 75 of file switch.py.

◆ turn_off()

None homeassistant.components.gc100.switch.GC100Switch.turn_off (   self,
**Any  kwargs 
)
Turn the device off.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 67 of file switch.py.

◆ turn_on()

None homeassistant.components.gc100.switch.GC100Switch.turn_on (   self,
**Any  kwargs 
)
Turn the device on.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 63 of file switch.py.

◆ update()

None homeassistant.components.gc100.switch.GC100Switch.update (   self)
Update the sensor state.

Definition at line 71 of file switch.py.

Member Data Documentation

◆ _gc100

homeassistant.components.gc100.switch.GC100Switch._gc100
private

Definition at line 50 of file switch.py.

◆ _name

homeassistant.components.gc100.switch.GC100Switch._name
private

Definition at line 48 of file switch.py.

◆ _port_addr

homeassistant.components.gc100.switch.GC100Switch._port_addr
private

Definition at line 49 of file switch.py.

◆ _state

homeassistant.components.gc100.switch.GC100Switch._state
private

Definition at line 51 of file switch.py.


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