set_state(state: bool, color_mode: LightColorMode | None = None, color: tuple[int | float, ...] | None = None, brightness: int | None = None, color_temp: int | None = None, effect: str | None = None) → None[source]¶

brightness: bool¶

brightness_scale: int¶

color_temp_kelvin: bool¶

command_callback: ComponentCallback[Light]¶

command_topic: CommandTopic¶

effect: bool¶

effect_list: list[str] | str¶

flash_time_long: int¶

flash_time_short: int¶

max_kelvin: int¶

max_mireds: int¶

min_kelvin: int¶

min_mireds: int¶

optimistic: bool¶

platform: Annotated[Platform, Required]¶

retain: bool¶

schema_: Annotated[str, FieldInfo(annotation=NoneType, required=True, alias_priority=2, serialization_alias='schema'), Required]¶

state_topic: StateTopic¶

supported_color_modes: list[LightColorMode]¶

white_scale: int¶

class nirahmq.components.Lock[source]¶

Bases: StatefulComponent, CallableComponent, EntityBase

set_state(state: LockState) → None[source]¶

code_format: str¶

command_callback: ComponentCallback[Lock]¶

command_template: str¶

command_topic: CommandTopic¶

optimistic: bool¶

payload_lock: str¶

payload_open: str¶

payload_reset: str¶

payload_unlock: str¶

platform: Annotated[Platform, Required]¶

retain: bool¶

state_jammed: str¶

state_locked: str¶

state_locking: str¶

state_topic: StateTopic¶

state_unlocked: str¶

state_unlocking: str¶

value_template: str¶

class nirahmq.components.Notify[source]¶

Bases: CallableComponent, EntityBase

command_callback: ComponentCallback[Notify]¶

command_template: str¶

command_topic: CommandTopic¶

platform: Annotated[Platform, Required]¶

retain: bool¶

class nirahmq.components.Number[source]¶

Bases: StatefulComponent, CallableComponent, EntityBase

set_number(value: float | int) → None[source]¶

command_callback: ComponentCallback[Number]¶

command_template: str¶

command_topic: CommandTopic¶

device_class: NumberClass | None¶

max: float¶

min: float¶

mode: NumberMode¶

optimistic: bool¶

payload_reset: str¶

platform: Annotated[Platform, Required]¶

retain: bool¶

state_topic: StateTopic¶

step: float¶

unit_of_measurement: str | None¶

value_template: str¶

class nirahmq.components.Scene[source]¶

Bases: CallableComponent, EntityBase

command_callback: ComponentCallback[Scene]¶

command_topic: CommandTopic¶

payload_on: str¶

platform: Annotated[Platform, Required]¶

retain: bool¶

class nirahmq.components.Select[source]¶

Bases: StatefulComponent, CallableComponent, EntityBase

set_index(index: int) → None[source]¶

set_option(value: str) → None[source]¶

command_callback: ComponentCallback[Select]¶

command_template: str¶

command_topic: CommandTopic¶

optimistic: bool¶

options: list[str]¶

platform: Annotated[Platform, Required]¶

retain: bool¶

state_topic: StateTopic¶

value_template: str¶

class nirahmq.components.Sensor[source]¶

Bases: StatefulComponent, EntityBase

set_value(value: float | int | str) → None[source]¶

device_class: SensorClass | None¶

expire_after: int¶

force_update: bool¶

last_reset_value_template: str¶

options: Annotated[list[str], Len(min_length=1, max_length=None)]¶

platform: Annotated[Platform, Required]¶

state_class: SensorStateClass¶

state_topic: StateTopic¶

suggested_display_precision: int¶

unit_of_measurement: str | None¶

value_template: str¶

class nirahmq.components.Siren[source]¶

Bases: StatefulComponent, CallableComponent, EntityBase

set_state(state: bool, tone: str | None = None, duration: int | None = None, volume: float | None = None) → None[source]¶

available_tones: list[str]¶

command_callback: ComponentCallback[Siren]¶

command_off_template: str¶

command_template: str¶

command_topic: CommandTopic¶

optimistic: bool¶

payload_off: str¶

payload_on: str¶

platform: Annotated[Platform, Required]¶

retain: bool¶

state_off: str¶

state_on: str¶

state_topic: StateTopic¶

state_value_template: str¶

support_duration: bool¶

support_volume_set: bool¶

class nirahmq.components.Switch[source]¶

Bases: StatefulComponent, CallableComponent, EntityBase

set_state(state: bool) → None[source]¶

command_callback: ComponentCallback[Switch]¶

command_template: str¶

command_topic: CommandTopic¶

device_class: SwitchClass | None¶

optimistic: bool¶

payload_off: str¶

payload_on: str¶

platform: Annotated[Platform, Required]¶

retain: bool¶

state_off: str¶

state_on: str¶

state_topic: StateTopic¶

value_template: str¶

class nirahmq.components.TagScanner[source]¶

Bases: StatefulComponent, ComponentBase

set_state(data: str) → None[source]¶

platform: Annotated[Platform, Required]¶

topic: StateTopic¶

value_template: str¶

class nirahmq.components.Text[source]¶

Bases: StatefulComponent, CallableComponent, EntityBase

set_text(text: str) → None[source]¶

command_callback: ComponentCallback[Text]¶

command_template: str¶

command_topic: CommandTopic¶

max: int¶

min: int¶

mode: TextMode¶

pattern: Regex¶

platform: Annotated[Platform, Required]¶

retain: bool¶

state_topic: StateTopic¶

value_template: str¶

class nirahmq.components.Update[source]¶

Bases: StatefulComponent, CallableComponent, EntityBase

set_state(installed: str, latest: str | None = None, title: str | None = None, summary: str | None = None, url: AnyUrl | None = None, picture: AnyUrl | None = None, in_progress: bool | None = None, percentage: float | None = None) → None[source]¶

command_callback: ComponentCallback[Update]¶

command_topic: CommandTopic¶

device_class: UpdateClass | None¶

display_precision: int¶

latest_version_template: str¶

latest_version_topic: StateTopic¶

payload_install: str¶

platform: Annotated[Platform, Required]¶

release_summary: Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=255, pattern=None)]¶

release_url: AnyUrl¶

retain: bool¶

state_topic: StateTopic¶

title: str¶

value_template: str¶

class nirahmq.components.Vacuum[source]¶

Bases: StatefulComponent, CallableComponent, BareEntityBase

set_state(state: VacuumState, battery_level: int | None = None, fan_speed: VacuumFanSpeed | None = None) → None[source]¶

command_callback: ComponentCallback[Vacuum]¶

command_topic: CommandTopic¶

encoding: str¶

fan_speed_list: list[str] | str¶

payload_clean_spot: str¶

payload_locate: str¶

payload_pause: str¶

payload_return_to_base: str¶

payload_start: str¶

payload_stop: str¶

platform: Annotated[Platform, Required]¶

retain: bool¶

send_command_callback: ComponentCallback[Vacuum]¶

send_command_topic: CommandTopic¶

set_fan_speed_callback: ComponentCallback[Vacuum]¶

set_fan_speed_topic: CommandTopic¶

state_topic: StateTopic¶

supported_features: list[VacuumFeature] | VacuumFeature¶

class nirahmq.components.Valve[source]¶

Bases: StatefulComponent, CallableComponent, EntityBase

set_position(position: int, state: Literal[ValveState.OPENING, ValveState.CLOSING] | None = None) → None[source]¶

set_state(state: ValveState) → None[source]¶

command_callback: ComponentCallback[Valve]¶

command_template: str¶

command_topic: CommandTopic¶

device_class: ValveClass | None¶

optimistic: bool¶

payload_close: str | None¶

payload_open: str | None¶

payload_stop: str¶

platform: Annotated[Platform, Required]¶

position_closed: int¶

position_open: int¶

reports_position: bool¶

retain: bool¶

state_closed: str¶

state_closing: str¶

state_open: str¶

state_opening: str¶

state_topic: StateTopic¶

value_template: str¶

class nirahmq.components.WaterHeater[source]¶

Bases: StatefulComponent, CallableComponent, EntityBase

set_current_temperature(temperature: float) → None[source]¶

set_mode(mode: WaterHeaterMode) → None[source]¶

set_target_temperature(temperature: float) → None[source]¶

current_temperature_template: str¶

current_temperature_topic: StateTopic¶

initial: int¶

max_temp: float¶

min_temp: float¶

mode_command_callback: ComponentCallback[WaterHeater]¶

mode_command_template: str¶

mode_command_topic: CommandTopic¶

mode_state_template: str¶

mode_state_topic: StateTopic¶

modes: list[WaterHeaterMode]¶

optimistic: bool¶

payload_off: str¶

payload_on: str¶

platform: Annotated[Platform, Required]¶

power_command_callback: ComponentCallback[WaterHeater]¶

power_command_template: str¶

power_command_topic: CommandTopic¶

precision: Precision¶

retain: bool¶

temperature_command_callback: ComponentCallback[WaterHeater]¶

temperature_command_template: str¶

temperature_command_topic: CommandTopic¶

temperature_state_template: str¶

temperature_state_topic: StateTopic¶

temperature_unit: TemperatureUnit¶

value_template: str¶