homeassistant.components.zwave_js.discovery_data_template.ConfigurableFanValueMappingDataTemplate Class Reference

Inheritance diagram for homeassistant.components.zwave_js.discovery_data_template.ConfigurableFanValueMappingDataTemplate:

Collaboration diagram for homeassistant.components.zwave_js.discovery_data_template.ConfigurableFanValueMappingDataTemplate:

Public Member Functions
FanValueMapping|None	get_fan_value_mapping (self, dict[str, ZwaveConfigurationValue|None] resolved_data)
dict[str, ZwaveConfigurationValue|None]	resolve_data (self, ZwaveValue value)
Iterable[ZwaveConfigurationValue|None]	values_to_watch (self, dict[str, ZwaveConfigurationValue|None] resolved_data)
Public Member Functions inherited from homeassistant.components.zwave_js.discovery_data_template.BaseDiscoverySchemaDataTemplate
set[str]	value_ids_to_watch (self, Any resolved_data)
Iterable[ZwaveValue|None]	values_to_watch (self, Any resolved_data)
Public Member Functions inherited from homeassistant.components.zwave_js.discovery_data_template.FanValueMappingDataTemplate
FanValueMapping|None	get_fan_value_mapping (self, dict[str, Any] resolved_data)

Additional Inherited Members
Static Public Attributes inherited from homeassistant.components.zwave_js.discovery_data_template.BaseDiscoverySchemaDataTemplate
	None

Detailed Description

Gets fan speeds based on a configuration value.

Example:
  ZWaveDiscoverySchema(
      platform="fan",
      hint="has_fan_value_mapping",
      ...
      data_template=ConfigurableFanValueMappingDataTemplate(
        configuration_option=ZwaveValueID(
            property_=5, command_class=CommandClass.CONFIGURATION, endpoint=0
        ),
        configuration_value_to_fan_value_mapping={
            0: FanValueMapping(speeds=[(1,33), (34,66), (67,99)]),
            1: FanValueMapping(speeds=[(1,24), (25,49), (50,74), (75,99)]),
        },
      ),

`configuration_option` is a reference to the setting that determines which
value mapping to use (e.g., 3 speeds or 4 speeds).

`configuration_value_to_fan_value_mapping` maps the values from
`configuration_option` to the value mapping object.

Definition at line 532 of file discovery_data_template.py.

Member Function Documentation

get_fan_value_mapping()

FanValueMapping | None homeassistant.components.zwave_js.discovery_data_template.ConfigurableFanValueMappingDataTemplate.get_fan_value_mapping	(		self,
		dict[str, ZwaveConfigurationValue | None]	resolved_data
	)

Get current fan properties from resolved data.

Definition at line 580 of file discovery_data_template.py.

resolve_data()

dict[str, ZwaveConfigurationValue | None] homeassistant.components.zwave_js.discovery_data_template.ConfigurableFanValueMappingDataTemplate.resolve_data	(		self,
		ZwaveValue	value
	)

Resolve helper class data for a discovered value.

Reimplemented from homeassistant.components.zwave_js.discovery_data_template.BaseDiscoverySchemaDataTemplate.

Definition at line 562 of file discovery_data_template.py.

values_to_watch()

Iterable[ZwaveConfigurationValue | None] homeassistant.components.zwave_js.discovery_data_template.ConfigurableFanValueMappingDataTemplate.values_to_watch	(		self,
		dict[str, ZwaveConfigurationValue | None]	resolved_data
	)

Return list of all ZwaveValues that should be watched.

Definition at line 572 of file discovery_data_template.py.

---

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

• core/homeassistant/components/zwave_js/discovery_data_template.py