auto() will generate the name of the attribute as value
classmethod
from_str
this function will create the enum object based on its string value
Args: text(str): the string value of the enum default(AutoNameEnum): a default value if text could not be used Returns: the enum object or None if the text is None or the default value
Bases: FunctionalChannel
this is the representative of the BLIND_CHANNEL channel
set_shutter_level
sets the shutter level
Args: level(float): the new level of the shutter. 0.0 = open, 1.0 = closed channelIndex(int): the channel to control Returns: the result of the _restCall
set_shutter_stop
stops the current operation Returns: the result of the _restCall
set_slats_level
sets the slats and shutter level
Args: slatsLevel(float): the new level of the slats. 0.0 = open, 1.0 = closed, shutterLevel(float): the new level of the shutter. 0.0 = open, 1.0 = closed, None = use the current value channelIndex(int): the channel to control Returns: the result of the _restCall
stop
stops the current shutter operation
Returns: the result of the _restCall
Bases: FunctionalChannel
this is the representative of the CODE_PROTECTED_PRIMARY_ACTION_CHANNEL channel (HmIP-WKP)
Bases: FunctionalChannel
this is the representative of the CODE_PROTECTED_SECONDARY_ACTION_CHANNEL channel (HmIP-WKP)
Bases: DeviceBaseChannel
this is the representative of the DEVICE_BASE_FLOOR_HEATING channel
set_minimum_floor_heating_valve_position
sets the minimum floot heating valve position
Args: minimumFloorHeatingValvePosition(float): the minimum valve position. must be between 0.0 and 1.0
Returns: the result of the _restCall
Bases: DeviceOperationLockChannel
this is the representation of the DeviceOperationLockChannelWithSabotage channel
Bases: DeviceSabotageChannel
this is the representative of the DEVICE_RECHARGEABLE_WITH_SABOTAGE channel
Bases: FunctionalChannel
This respresents of the DoorLockChannel
async
async_set_lock_state
sets the door lock state
Args: doorLockState(float): the state of the door. See LockState from base/enums.py pin(string): Pin, if specified. channelIndex(int): the channel to control. Normally the channel from DOOR_LOCK_CHANNEL is used. Returns: the result of the _restCall
set_lock_state
sets the door lock state
Args: doorLockState(float): the state of the door. See LockState from base/enums.py pin(string): Pin, if specified. channelIndex(int): the channel to control. Normally the channel from DOOR_LOCK_CHANNEL is used. Returns: the result of the _restCall
Bases: FunctionalChannel
this represents the EXTERNAL_BASE_CHANNEL function-channel for external devices
Bases: FunctionalChannel
this represents the EXTERNAL_UNIVERSAL_LIGHT_CHANNEL function-channel for external devices
async
set_dim_level_async
Set the dim level of the light channel.
async
set_dim_level_with_time_async
Set the dim level of the light channel with a specified time.
Bases: FunctionalChannel
this is the representative of the FLOOR_TERMINAL_BLOCK_LOCAL_PUMP_CHANNEL channel
Bases: FunctionalChannel
this is the representative of the class FLOOR_TERMINAL_BLOCK_MECHANIC_CHANNEL(FunctionalChannel) channel
Bases: HomeMaticIPObject
this is the base class for the functional channels
add_on_channel_event_handler
Adds an event handler to the update method. Fires when a device is updated.
fire_channel_event
Trigger the methods tied to _on_channel_event
from_json
this function will load the functional channel object from a json object and the given groups
Args: js(dict): the json object groups(Iterable[Group]): the groups for referencing
Bases: FunctionalChannel
this is the representation of the IMPULSE_OUTPUT_CHANNEL
send_start_impulse
Toggle Wall mounted Garage Door Controller.
Bases: DimmerChannel, SwitchChannel
this is the representative of the NOTIFICATION_LIGHT_CHANNEL channel
async
async_set_optical_signal
sets the signal type for the leds
Args: opticalSignalBehaviour(OpticalSignalBehaviour): LED signal behaviour rgb(RGBColorState): Color dimLevel(float): usally 1.01. Use set_dim_level instead
Returns: Result of the _restCall
async
async_set_rgb_dim_level_with_time
sets the color and dimlevel of the lamp
Args: channelIndex(int): the channelIndex of the lamp. Use self.topLightChannelIndex or self.bottomLightChannelIndex rgb(RGBColorState): the color of the lamp dimLevel(float): the dimLevel of the lamp. 0.0 = off, 1.0 = MAX onTime(float): rampTime(float): Returns: the result of the _restCall
set_rgb_dim_level
sets the color and dimlevel of the lamp
Args: channelIndex(int): the channelIndex of the lamp. Use self.topLightChannelIndex or self.bottomLightChannelIndex rgb(RGBColorState): the color of the lamp dimLevel(float): the dimLevel of the lamp. 0.0 = off, 1.0 = MAX
Returns: the result of the _restCall
Bases: FunctionalChannel
this is the representative of the SHADING_CHANNEL channel
async
async_set_shutter_stop
stops the current operation Returns: the result of the _restCall
Bases: FunctionalChannel
this is the representative of the SHUTTER_CHANNEL channel
async
async_set_shutter_level
sets the shutter level
Args: level(float): the new level of the shutter. 0.0 = open, 1.0 = closed Returns: the result of the _restCall
async
async_set_shutter_stop
stops the current shutter operation
Args: channelIndex(int): the channel to control Returns: the result of the _restCall
Bases: FunctionalChannel
This is the representative of the SOIL_MOISTURE_SENSOR_INTERFACE_CHANNEL channel.
from_json
Update the channel attributes from a JSON dictionary.
Bases: FunctionalChannel
this is the representative of the TEMPERATURE_SENSOR_2_EXTERNAL_DELTA_CHANNEL channel
Bases: FunctionalChannel
this is the representative of the UniversalActuatorChannel UNIVERSAL_ACTUATOR_CHANNEL
Bases: FunctionalChannel
Represents Universal Light Channel.
async
set_dim_level_async
Set the dim level of the light channel.
async
set_dim_level_with_time_async
Set the dim level of the light channel with a specified time.
async
start_light_scene_async
Start a light scene.
Bases: FunctionalChannel
this is the representative of the WALL_MOUNTED_THERMOSTAT_PRO_CHANNEL channel
Bases: WallMountedThermostatProChannel
this is the representative of the WALL_MOUNTED_THERMOSTAT_WITH_CARBON_DIOXIDE_SENSOR_CHANNEL channel
Bases: ClimateSensorChannel
this is the representative of the WALL_MOUNTED_THERMOSTAT_WITHOUT_DISPLAY_CHANNEL channel
Bases: FunctionalChannel
this is the representative of the WATERING_ACTUATOR_CHANNEL channel
async
reset_water_volume_async
Resets the water volume counter of the specified device.
async
set_watering_switch_state_async
Sets the watering switch state of the specified device.
async
set_watering_switch_state_with_time_async
async
toggle_watering_state_async
Toggles the watering state of the specified device.
Bases: WeatherSensorPlusChannel
this is the representative of the WEATHER_SENSOR_PRO_CHANNEL channel