Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.sharkiq.vacuum Namespace Reference

Classes

class  SharkVacuumEntity
 

Functions

None async_setup_entry (HomeAssistant hass, ConfigEntry config_entry, AddEntitiesCallback async_add_entities)
 

Variables

string ATTR_ERROR_CODE = "last_error_code"
 
string ATTR_ERROR_MSG = "last_error_message"
 
string ATTR_LOW_LIGHT = "low_light"
 
string ATTR_RECHARGE_RESUME = "recharge_and_resume"
 
string ATTR_ROOMS = "rooms"
 
dictionary FAN_SPEEDS_MAP
 
dictionary OPERATING_STATE_MAP
 
string STATE_RECHARGING_TO_RESUME = "recharging_to_resume"
 

Detailed Description

Shark IQ Wrapper.

Function Documentation

◆ async_setup_entry()

None homeassistant.components.sharkiq.vacuum.async_setup_entry ( HomeAssistant  hass,
ConfigEntry  config_entry,
AddEntitiesCallback  async_add_entities 
)
Set up the Shark IQ vacuum cleaner.

Definition at line 55 of file vacuum.py.

Variable Documentation

◆ ATTR_ERROR_CODE

string homeassistant.components.sharkiq.vacuum.ATTR_ERROR_CODE = "last_error_code"

Definition at line 48 of file vacuum.py.

◆ ATTR_ERROR_MSG

string homeassistant.components.sharkiq.vacuum.ATTR_ERROR_MSG = "last_error_message"

Definition at line 49 of file vacuum.py.

◆ ATTR_LOW_LIGHT

string homeassistant.components.sharkiq.vacuum.ATTR_LOW_LIGHT = "low_light"

Definition at line 50 of file vacuum.py.

◆ ATTR_RECHARGE_RESUME

string homeassistant.components.sharkiq.vacuum.ATTR_RECHARGE_RESUME = "recharge_and_resume"

Definition at line 51 of file vacuum.py.

◆ ATTR_ROOMS

string homeassistant.components.sharkiq.vacuum.ATTR_ROOMS = "rooms"

Definition at line 52 of file vacuum.py.

◆ FAN_SPEEDS_MAP

dictionary homeassistant.components.sharkiq.vacuum.FAN_SPEEDS_MAP
Initial value:
1 = {
2  "Eco": PowerModes.ECO,
3  "Normal": PowerModes.NORMAL,
4  "Max": PowerModes.MAX,
5 }

Definition at line 39 of file vacuum.py.

◆ OPERATING_STATE_MAP

dictionary homeassistant.components.sharkiq.vacuum.OPERATING_STATE_MAP
Initial value:
1 = {
2  OperatingModes.PAUSE: STATE_PAUSED,
3  OperatingModes.START: STATE_CLEANING,
4  OperatingModes.STOP: STATE_IDLE,
5  OperatingModes.RETURN: STATE_RETURNING,
6 }

Definition at line 32 of file vacuum.py.

◆ STATE_RECHARGING_TO_RESUME

string homeassistant.components.sharkiq.vacuum.STATE_RECHARGING_TO_RESUME = "recharging_to_resume"

Definition at line 45 of file vacuum.py.