Enums

Component related enumerations

class nirahmq.enums.Platform

Bases: StrEnum

The platform identifying each Home Assistant component supported by the MQTT integration.

ALARM_CONTROL_PANEL = 'alarm_control_panel'

BINARY_SENSOR = 'binary_sensor'

BUTTON = 'button'

CAMERA = 'camera'

COVER = 'cover'

DEVICE_TRACKER = 'device_tracker'

DEVICE_TRIGGER = 'device_automation'

EVENT = 'event'

FAN = 'fan'

HUMIDIFIER = 'humidifier'

IMAGE = 'image'

CLIMATE = 'climate'

HVAC = 'climate'

LAWN_MOWER = 'lawn_mower'

LIGHT = 'light'

LOCK = 'lock'

NOTIFY = 'notify'

NUMBER = 'number'

SCENE = 'scene'

SELECT = 'select'

SENSOR = 'sensor'

SIREN = 'siren'

SWITCH = 'switch'

UPDATE = 'update'

TAG_SCANNER = 'tag_scanner'

TEXT = 'text'

VACUUM = 'vacuum'

VALVE = 'valve'

WATER_HEATER = 'water_heater'

__new__(value)

class nirahmq.enums.Category

Bases: Enum

The category of a component inside the device.

NORMAL = None

The default category in Home Assistant when not specified.

A component of this category is actively providing useful information about the functionality of the device.

CONFIG = 'config'

The component configures the device in some way

A component of this category represents a configuration state in a device and not a measurement or action.

DIAGNOSTIC = 'diagnostic'

The component is only for diagnostic purposes.

A component of this category represents a state or action of the underlying system in the device.

Device class enumerations

class nirahmq.enums.BinarySensorClass

Bases: StrEnum

NONE = 'None'

BATTERY = 'battery'

BATTERY_CHARGING = 'battery_charging'

CARBON_MONOXIDE = 'carbon_monoxide'

COLD = 'cold'

CONNECTIVITY = 'connectivity'

DOOR = 'door'

GARAGE_DOOR = 'garage_door'

GAS = 'gas'

HEAT = 'heat'

LIGHT = 'light'

LOCK = 'lock'

MOISTURE = 'moisture'

MOTION = 'motion'

MOVING = 'moving'

OCCUPANCY = 'occupancy'

OPENING = 'opening'

PLUG = 'plug'

POWER = 'power'

PRESENCE = 'presence'

PROBLEM = 'problem'

RUNNING = 'running'

SAFETY = 'safety'

SMOKE = 'smoke'

SOUND = 'sound'

TAMPER = 'tamper'

UPDATE = 'update'

VIBRATION = 'vibration'

WINDOW = 'window'

__new__(value)

class nirahmq.enums.ButtonClass

Bases: Enum

NONE = None

IDENTIFY = 'identify'

RESTART = 'restart'

UPDATE = 'update'

class nirahmq.enums.CoverClass

Bases: Enum

NONE = None

AWNING = 'awning'

BLIND = 'blind'

CURTAIN = 'curtain'

DAMPER = 'damper'

DOOR = 'door'

GARAGE = 'garage'

GATE = 'gate'

SHADE = 'shade'

SHUTTER = 'shutter'

WINDOW = 'window'

class nirahmq.enums.EventClass

Bases: StrEnum

NONE = 'None'

BUTTON = 'button'

DOORBELL = 'doorbell'

MOTION = 'motion'

__new__(value)

class nirahmq.enums.HumidifierClass

Bases: Enum

NONE = None

HUMIDIFIER = 'humidifier'

DEHUMIDIFIER = 'dehumidifier'

class nirahmq.enums.NumberClass

Bases: StrEnum

NONE = 'None'

APPARENT_POWER = 'apparent_power'

AQI = 'aqi'

AREA = 'area'

ATMOSPHERIC_PRESSURE = 'atmospheric_pressure'

BATTERY = 'battery'

BLOOD_GLUCOSE_CONCENTRATION = 'blood_glucose_concentration'

CARBON_DIOXIDE = 'carbon_dioxide'

CARBON_MONOXIDE = 'carbon_monoxide'

CURRENT = 'current'

DATA_RATE = 'data_rate'

DATA_SIZE = 'data_size'

DISTANCE = 'distance'

DURATION = 'duration'

ENERGY = 'energy'

ENERGY_DISTANCE = 'energy_distance'

ENERGY_STORAGE = 'energy_storage'

FREQUENCY = 'frequency'

GAS = 'gas'

HUMIDITY = 'humidity'

ILLUMINANCE = 'illuminance'

IRRADIANCE = 'irradiance'

MOISTURE = 'moisture'

MONETARY = 'monetary'

NITROGEN_DIOXIDE = 'nitrogen_dioxide'

NITROGEN_MONOXIDE = 'nitrogen_monoxide'

NITROUS_OXIDE = 'nitrous_oxide'

OZONE = 'ozone'

PH = 'ph'

PM1 = 'pm1'

PM25 = 'pm25'

PM10 = 'pm10'

POWER_FACTOR = 'power_factor'

POWER = 'power'

PRECIPITATION = 'precipitation'

PRECIPITATION_INTENSITY = 'precipitation_intensity'

PRESSURE = 'pressure'

REACTIVE_POWER = 'reactive_power'

SIGNAL_STRENGTH = 'signal_strength'

SOUND_PRESSURE = 'sound_pressure'

SPEED = 'speed'

SULPHUR_DIOXIDE = 'sulphur_dioxide'

TEMPERATURE = 'temperature'

VOLATILE_ORGANIC_COMPOUNDS = 'volatile_organic_compounds'

VOLATILE_ORGANIC_COMPOUNDS_PARTS = 'volatile_organic_compounds_parts'

VOLTAGE = 'voltage'

VOLUME = 'volume'

VOLUME_FLOW_RATE = 'volume_flow_rate'

VOLUME_STORAGE = 'volume_storage'

WATER = 'water'

WEIGHT = 'weight'

WIND_DIRECTION = 'wind_direction'

WIND_SPEED = 'wind_speed'

__new__(value)

class nirahmq.enums.SensorClass

Bases: StrEnum

NONE = 'None'

APPARENT_POWER = 'apparent_power'

AQI = 'aqi'

AREA = 'area'

ATMOSPHERIC_PRESSURE = 'atmospheric_pressure'

BATTERY = 'battery'

BLOOD_GLUCOSE_CONCENTRATION = 'blood_glucose_concentration'

CARBON_DIOXIDE = 'carbon_dioxide'

CARBON_MONOXIDE = 'carbon_monoxide'

CURRENT = 'current'

DATA_RATE = 'data_rate'

DATA_SIZE = 'data_size'

DATE = 'date'

DISTANCE = 'distance'

DURATION = 'duration'

ENERGY = 'energy'

ENERGY_DISTANCE = 'energy_distance'

ENERGY_STORAGE = 'energy_storage'

ENUM = 'enums'

FREQUENCY = 'frequency'

GAS = 'gas'

HUMIDITY = 'humidity'

ILLUMINANCE = 'illuminance'

IRRADIANCE = 'irradiance'

MOISTURE = 'moisture'

MONETARY = 'monetary'

NITROGEN_DIOXIDE = 'nitrous_oxide'

NITROGEN_MONOXIDE = 'nitrous_monoxide'

NITROUS_OXIDE = 'nitrous_oxide'

OZONE = 'ozone'

PH = 'ph'

PM1 = 'pm1'

PM25 = 'pm25'

PM10 = 'pm10'

POWER_FACTOR = 'power_factor'

POWER = 'power'

PRECIPITATION = 'precipitation'

PRECIPITATION_INTENSITY = 'precipitation_intensity'

PRESSURE = 'pressure'

REACTIVE_POWER = 'reactive_power'

SIGNAL_STRENGTH = 'signal_strength'

SOUND_PRESSURE = 'sound_pressure'

SPEED = 'speed'

SULPHUR_DIOXIDE = 'sulphur_dioxide'

TEMPERATURE = 'temperature'

TIMESTAMP = 'timestamp'

VOLATILE_ORGANIC_COMPOUNDS = 'volatile_organic_compounds'

VOLATILE_ORGANIC_COMPOUNDS_PARTS = 'volatile_organic_compounds_parts'

VOLTAGE = 'voltage'

VOLUME = 'volume'

VOLUME_FLOW_RATE = 'volume_flow_rate'

VOLUME_STORAGE = 'volume_storage'

WATER = 'water'

WEIGHT = 'weight'

WIND_DIRECTION = 'wind_direction'

WIND_SPEED = 'wind_speed'

__new__(value)

class nirahmq.enums.SensorStateClass

Bases: StrEnum

MEASUREMENT = 'measurement'

MEASUREMENT_ANGLE = 'measurement_angle'

TOTAL = 'total'

TOTAL_INCREASING = 'total_increasing'

__new__(value)

class nirahmq.enums.SwitchClass

Bases: StrEnum

NONE = 'None'

OUTLET = 'outlet'

SWITCH = 'switch'

__new__(value)

class nirahmq.enums.UpdateClass

Bases: StrEnum

NONE = 'None'

FIRMWARE = 'firmware'

__new__(value)

class nirahmq.enums.ValveClass

Bases: StrEnum

NONE = 'None'

WATER = 'water'

GAS = 'gas'

__new__(value)

Miscellaneous enumerations

class nirahmq.enums.TemperatureUnit

Bases: StrEnum

CELSIUS = 'C'

FAHRENHEIT = 'F'

__new__(value)

class nirahmq.enums.Precision

Bases: Enum

The precision to use for this component.

HIGH = 0.1

Values are multiple of 0.1

MEDIUM = 0.5

Values are multiple of 0.5

LOW = 1.0

Values are multiple of 1

Component specific enumerations

class nirahmq.enums.AlarmControlPanelCode

Bases: StrEnum

NUMERIC = 'REMOTE_CODE'

TEXTUAL = 'REMOTE_CODE_TEXT'

__new__(value)

class nirahmq.enums.AlarmControlPanelFeature

Bases: StrEnum

HOME = 'arm_home'

AWAY = 'arm_away'

NIGHT = 'arm_night'

VACATION = 'arm_vacation'

BYPASS = 'arm_custom_bypass'

TRIGGER = 'trigger'

__new__(value)

class nirahmq.enums.AlarmControlPanelState

Bases: StrEnum

ARMED_AWAY = 'armed_away'

ARMED_BYPASS = 'armed_custom_bypass'

ARMED_HOME = 'armed_home'

ARMED_NIGHT = 'armed_night'

ARMED_VACATION = 'armed_vacation'

ARMING = 'arming'

DISARMED = 'disarmed'

DISARMING = 'disarming'

PENDING = 'pending'

TRIGGERED = 'triggered'

__new__(value)

class nirahmq.enums.ImageEncoding

Bases: StrEnum

BINARY = 'bin'

BASE64 = 'b64'

__new__(value)

class nirahmq.enums.CoverState

Bases: StrEnum

OPEN = 'open'

OPENING = 'opening'

CLOSED = 'closed'

CLOSING = 'closing'

STOPPED = 'stopped'

__new__(value)

class nirahmq.enums.DeviceTrackerSource

Bases: StrEnum

GPS = 'gps'

ROUTER = 'router'

BT = 'bluetooth'

BLE = 'bluetooth_le'

__new__(value)

class nirahmq.enums.DeviceTriggerType

Bases: StrEnum

BUTTON_SHORT_PRESS = 'button_short_press'

BUTTON_SHORT_RELEASE = 'button_short_release'

BUTTON_LONG_PRESS = 'button_long_press'

BUTTON_LONG_RELEASE = 'button_long_release'

BUTTON_DOUBLE_PRESS = 'button_double_press'

BUTTON_TRIPLE_PRESS = 'button_triple_press'

BUTTON_QUADRUPLE_PRESS = 'button_quadruple_press'

BUTTON_QUINTUPLE_PRESS = 'button_quintuple_press'

__new__(value)

class nirahmq.enums.DeviceTriggerSubtype

Bases: StrEnum

TURN_ON = 'turn_on'

TURN_OFF = 'turn_off'

BUTTON_1 = 'button_1'

BUTTON_2 = 'button_2'

BUTTON_3 = 'button_3'

BUTTON_4 = 'button_4'

BUTTON_5 = 'button_5'

BUTTON_6 = 'button_6'

__new__(value)

class nirahmq.enums.HumidifierMode

Bases: StrEnum

NORMAL = 'normal'

ECO = 'eco'

AWAY = 'away'

BOOST = 'boost'

COMFORT = 'comfort'

HOME = 'home'

SLEEP = 'sleep'

AUTO = 'auto'

BABY = 'baby'

__new__(value)

class nirahmq.enums.HumidifierAction

Bases: StrEnum

OFF = 'off'

HUMIDIFYING = 'humidifying'

DRYING = 'drying'

IDLE = 'idle'

__new__(value)

class nirahmq.enums.HVACAction

Bases: StrEnum

OFF = 'off'

HEATING = 'heating'

COOLING = 'cooling'

DRYING = 'drying'

IDLE = 'idle'

FAN = 'fan'

__new__(value)

class nirahmq.enums.HVACFanMode

Bases: StrEnum

AUTO = 'auto'

LOW = 'low'

MEDIUM = 'medium'

HIGH = 'high'

__new__(value)

class nirahmq.enums.HVACMode

Bases: StrEnum

AUTO = 'auto'

OFF = 'off'

COOL = 'cool'

HEAT = 'heat'

DRY = 'dry'

FAN_ONLY = 'fan_only'

__new__(value)

class nirahmq.enums.HVACPresetMode

Bases: StrEnum

ECO = 'eco'

AWAY = 'away'

BOOST = 'boost'

COMFORT = 'comfort'

HOME = 'home'

SLEEP = 'sleep'

ACTIVITY = 'activity'

__new__(value)

class nirahmq.enums.LawnMowerState

Bases: StrEnum

MOWING = 'mowing'

PAUSED = 'paused'

DOCKED = 'docked'

ERROR = 'error'

__new__(value)

class nirahmq.enums.LightColorMode

Bases: StrEnum

ONOFF = 'onoff'

BRIGHTNESS = 'brightness'

COLOR_TEMP = 'color_temp'

HS = 'hs'

XY = 'xy'

RGB = 'rgb'

RGBW = 'rgbw'

RGBWW = 'rgbww'

WHITE = 'white'

__new__(value)

class nirahmq.enums.LockState

Bases: StrEnum

JAMMED = 'jammed'

LOCKED = 'locked'

LOCKING = 'locking'

UNLOCKED = 'unlocked'

UNLOCKING = 'unlocking'

__new__(value)

class nirahmq.enums.NumberMode

Bases: StrEnum

AUTO = 'auto'

BOX = 'box'

SLIDER = 'slider'

__new__(value)

class nirahmq.enums.TextMode

Bases: StrEnum

TEXT = 'text'

PASSWORD = 'password'

__new__(value)

class nirahmq.enums.VacuumFeature

Bases: StrEnum

START = 'start'

STOP = 'stop'

PAUSE = 'pause'

RETURN_HOME = 'return_home'

BATTERY = 'battery'

STATUS = 'status'

LOCATE = 'locate'

CLEAN_SPOT = 'clean_spot'

FAN_SPEED = 'fan_speed'

SEND_COMMAND = 'send_command'

__new__(value)

class nirahmq.enums.VacuumState

Bases: StrEnum

CLEANING = 'cleaning'

DOCKED = 'docked'

PAUSED = 'paused'

IDLE = 'idle'

RETURNING = 'returning'

ERROR = 'error'

__new__(value)

class nirahmq.enums.VacuumFanSpeed

Bases: StrEnum

MIN = 'min'

MEDIUM = 'medium'

HIGH = 'high'

MAX = 'max'

__new__(value)

class nirahmq.enums.ValveState

Bases: StrEnum

OPEN = 'open'

OPENING = 'opening'

CLOSED = 'closed'

CLOSING = 'closing'

__new__(value)

class nirahmq.enums.WaterHeaterMode

Bases: StrEnum

OFF = 'off'

__new__(value)

ECO = 'eco'

ELECTRIC = 'electric'

GAS = 'gas'

HEAT_PUMP = 'heat_pump'

HIGH_DEMAND = 'high_demand'

PERFORMANCE = 'performance'