Model Module

class JciHitachi.model.JciHitachiAC(status, default=-1)[source]

Bases: JciHitachiStatus

Data class representing air conditioner status.

Parameters:
  • status (dict) – Status retrieved from JciHitachiStatusInterpreter.decode_status().

  • default (int, optional) – Default value when a status doesn’t exist, by default -1.

property power

Power. Controllable.

Returns:

One of (“unsupported”, “off”, “on”, “unknown”).

Return type:

str

property mode

Mode. Controllable.

Returns:

One of (“unsupported”, “cool”, “dry”, “fan”, “auto”, “heat”, “unknown”).

Return type:

str

property air_speed

Air speed. Controllable.

Returns:

One of (“unsupported”, “auto”, “silent”, “low”, “moderate”, “high”, “unknown”).

Return type:

str

property target_temp

Target temperature. Controllable.

Returns:

Celsius temperature.

Return type:

int

property indoor_temp

Indoor temperature.

Returns:

Celsius temperature.

Return type:

int

property max_temp

Maximum target temperature.

Returns:

Celsius temperature.

Return type:

int

property min_temp

Minimum target temperature.

Returns:

Celsius temperature.

Return type:

int

property sleep_timer

Sleep timer. Controllable.

Returns:

Sleep timer (hours).

Return type:

int

property vertical_wind_swingable

Vertical wind swingable. Controllable.

Returns:

One of (“unsupported”, “disabled”, “enabled”, “unknown”).

Return type:

str

property vertical_wind_direction

Vertical wind direction. Controllable.

Returns:

Value between 0 to 15.

Return type:

int

property horizontal_wind_direction

Horizontal wind direction. Controllable.

Returns:

One of (“unsupported”, “auto”, “leftmost”, “middleleft”, “central”, “middleright”, “rightmost”, “unknown”).

Return type:

str

property mold_prev

Mold prevention. Controllable.

Returns:

One of (“unsupported”, “disabled”, “enabled”, “unknown”).

Return type:

str

property fast_op

Fast operation. Controllable.

Returns:

One of (“unsupported”, “disabled”, “enabled”, “unknown”).

Return type:

str

property energy_save

Energy saving. Controllable.

Returns:

One of (“unsupported”, “disabled”, “enabled”, “unknown”).

Return type:

str

property sound_prompt

Sound prompt. Controllable.

Returns:

One of (“unsupported”, “enabled”, “disabled”, “unknown”).

Return type:

str

property outdoor_temp

Outdoor temperature.

Returns:

Celsius temperature.

Return type:

int

property power_kwh

Accumulated Kwh in a day.

Returns:

Kwh.

Return type:

float

property freeze_clean

Freeze clean. Controllable.

Returns:

One of (“unsupported”, “off”, “on”, “unknown”).

Return type:

str

class JciHitachi.model.JciHitachiDH(status, default=-1)[source]

Bases: JciHitachiStatus

Data class representing dehumidifier status.

Parameters:
  • status (dict) – Status retrieved from JciHitachiStatusInterpreter.decode_status().

  • default (int, optional) – Default value when a status doesn’t exist, by default -1.

property power

Power. Controllable.

Returns:

One of (“unsupported”, “off”, “on”, “unknown”).

Return type:

str

property mode

Mode. Controllable.

Returns:

One of ( “unsupported”, “auto”, “custom”, “continuous”, “clothes_dry”, “air_purify”, “mold_prev”, “low_humidity”, “eco_comfort”, “unknown” ).

Return type:

str

property target_humidity

Target humidity. Controllable.

Returns:

Relative humidity.

Return type:

int

property indoor_humidity

Indoor humidity.

Returns:

Relative humidity.

Return type:

int

property max_humidity

Maximum target humidity.

Returns:

Relative humidity.

Return type:

int

property min_humidity

Minimum target humidity.

Returns:

Relative humidity.

Return type:

int

property wind_swingable

Wind swingable. Controllable.

Returns:

One of (“unsupported”, “off”, “on”, “unknown”).

Return type:

str

property water_full_warning

Water full warning.

Returns:

One of (“unsupported”, “off”, “on”, “unknown”).

Return type:

str

property clean_filter_notify

Clean filter notify control. Controllable.

Returns:

One of (“unsupported”, “disabled”, “enabled”, “unknown”).

Return type:

str

property air_purify_level

Air purify level. Not implemented.

Returns:

Not implemented.

Return type:

str

property air_speed

Air speed. Controllable.

Returns:

One of (“unsupported”, “auto”, “silent”, “low”, “moderate”, “high”, “unknown”).

Return type:

str

property side_vent

Side vent.

Returns:

One of (“unsupported”, “off”, “on”, “unknown”).

Return type:

str

property sound_control

Sound control. Controllable.

Returns:

One of (“unsupported”, “silent”, “button”, “button+waterfull”, “unknown”).

Return type:

str

property error_code

Error code.

Returns:

Error code.

Return type:

int

property mold_prev

Mold prevention. Controllable.

Returns:

One of (“unsupported”, “off”, “on”, “unknown”).

Return type:

str

property power_kwh

Accumulated Kwh in a day.

Returns:

Kwh.

Return type:

float

property air_quality_value

Air quality value. Not implemented.

Returns:

Not implemented.

Return type:

int

property air_quality_level

Air quality level. Not implemented.

Returns:

Not implemented.

Return type:

str

property pm25_value

PM2.5 value.

Returns:

PM2.5 value.

Return type:

int

property display_brightness

Display brightness. Controllable.

Returns:

One of (“unsupported”, “bright”, “dark”, “off”, “all_off” “unknown”).

Return type:

str

property odor_level

Odor level.

Returns:

One of (“unsupported”, “low”, “middle”, “high”, “unknown”).

Return type:

str

property air_cleaning_filter

Air cleaning filter setting.

Returns:

One of (“unsupported”, “disabled”, “enabled”, “unknown”).

Return type:

str

class JciHitachi.model.JciHitachiHE(status, default=-1)[source]

Bases: JciHitachiStatus

Data class representing heat exchanger status. Not implemented.

Parameters:
  • status (dict) – Status retrieved from JciHitachiStatusInterpreter.decode_status().

  • default (int, optional) – Default value when a status doesn’t exist, by default -1.

class JciHitachi.model.JciHitachiACSupport(status, default=0)[source]

Bases: JciHitachiStatusSupport

Data model representing supported air conditioner status.

Parameters:
  • status (dict) – Supported status retrieved from JciHitachiStatusInterpreter.decode_support().

  • default (int, optional) – Default value when a status doesn’t exist, by default 0.

property power

Power. Controllable.

Returns:

(is_support, off, on).

Return type:

(bool, int, int)

property mode

Mode. Controllable.

Returns:

is_support, (cool, dry, fan, auto, heat, 0…).

Return type:

(bool, Tuple[int])

property air_speed

Air speed. Controllable.

Returns:

is_support, (“auto”, “silent”, “low”, “moderate”, “high”, 0…).

Return type:

(bool, Tuple[int])

property target_temp

Target temperature. Controllable.

Returns:

(is_support, minimum, maximum)

Return type:

(bool, int, int)

property indoor_temp

Indoor temperature.

Returns:

(is_support, minimum, maximum)

Return type:

(bool, int, int)

property sleep_timer

Sleep timer. Controllable.

Returns:

(is_support, maximum).

Return type:

(bool, int)

property vertical_wind_swingable

Vertical wind swingable. Controllable.

Returns:

is_support, (“enabled”, “disabled”, 0…).

Return type:

(bool, Tuple[int])

property vertical_wind_direction

Vertical wind direction. Controllable.

Returns:

is_support, (“auto”, “level1”, “level2”, “level3”, “level4”, “level5”, “level6”, “level7”, 0…).

Return type:

(bool, Tuple[int])

property horizontal_wind_direction

Horizontal wind direction. Controllable.

Returns:

is_support, (“auto”, “leftmost”, “middleleft”, “central”, “middleright”, “rightmost”, 0…).

Return type:

(bool, Tuple[int])

property mold_prev

Mold prevention. Controllable.

Returns:

is_support, (“enabled”, “disabled”, 0…).

Return type:

(bool, Tuple[int])

property fast_op

Fast operation. Controllable.

Returns:

is_support, (“disabled”, “enabled”, 0…).

Return type:

(bool, Tuple[int])

property energy_save

Energy saving. Controllable.

Returns:

is_support, (“enabled”, “disabled”, 0…).

Return type:

(bool, Tuple[int])

property sound_prompt

Sound prompt. Controllable.

Returns:

is_support, (“enabled”, “disabled”, 0…).

Return type:

(bool, Tuple[int])

property outdoor_temp

Outdoor temperature.

Returns:

(is_support, minimum, maximum)

Return type:

(bool, int, int)

property power_kwh

Accumulated Kwh in a day.

Returns:

(is_support, maximum).

Return type:

(bool, int)

class JciHitachi.model.JciHitachiDHSupport(status, default=0)[source]

Bases: JciHitachiStatusSupport

Data model representing supported dehumidifier status.

Parameters:
  • status (dict) – Supported status retrieved from JciHitachiStatusInterpreter.decode_support().

  • default (int, optional) – Default value when a status doesn’t exist, by default 0.

property power

Power. Controllable.

Returns:

(is_support, off, on).

Return type:

(bool, Tuple[int])

property mode

Mode. Controllable.

Returns:

is_support, (auto, custom, continuous, clothes_dry, air_purify, mold_prev, air_supply, human_comfort, low_humidity, eco_comfort, 0…).

Return type:

(bool, Tuple[int])

property target_humidity

Target humidity. Controllable.

Returns:

(is_support, minimum, maximum)

Return type:

(bool, int, int)

property indoor_humidity

Indoor humidity.

Returns:

(is_support, minimum, maximum)

Return type:

(bool, int, int)

property wind_swingable

Wind swingable. Controllable.

Returns:

is_support, (“off”, “on”, 0…).

Return type:

(bool, Tuple[int])

property water_full_warning

Water full warning.

Returns:

is_support, (“off”, “on”, 0…).

Return type:

(bool, Tuple[int])

property clean_filter_notify

Clean filter notify control. Controllable.

Returns:

One of (“unsupported”, “disabled”, “enabled”, “unknown”).

Return type:

str

property air_purify_level

Air purify level. Not implemented.

Returns:

Not implemented.

Return type:

str

property air_speed

Air speed. Controllable.

Returns:

is_support, (“auto”, “silent”, “low”, “moderate”, “high”, 0…).

Return type:

(bool, Tuple[int])

property side_vent

Side vent.

Returns:

is_support, (“off”, “on”, 0…).

Return type:

(bool, Tuple[int])

property sound_control

Sound control. Controllable.

Returns:

is_support, (“silent”, “button”, “button+waterfull”, 0…).

Return type:

(bool, Tuple[int])

property error_code

Error code.

Returns:

(is_support,).

Return type:

(bool,)

property mold_prev

Mold prevention. Controllable.

Returns:

is_support, (“silent”, “off”, “on”,, 0…).

Return type:

(bool, Tuple[int])

property power_kwh

Accumulated Kwh in a day.

Returns:

(is_support, maximum).

Return type:

(bool, int)

property air_quality_value

Air quality value. Not implemented.

Returns:

Not implemented.

Return type:

int

property air_quality_level

Air quality level. Not implemented.

Returns:

Not implemented.

Return type:

str

property pm25_value

PM2.5 value.

Returns:

(is_support, maximum).

Return type:

(bool, int)

property display_brightness

Display brightness. Controllable.

Returns:

is_support, (“bright”, “dark”, “off”, 0…).

Return type:

(bool, Tuple[int])

property odor_level

Odor level.

Returns:

is_support, (“low”, “middle”, “high”, 0…).

Return type:

(bool, Tuple[int])

property air_cleaning_filter

Air cleaning filter setting.

Returns:

is_support, (“enabled”, “disabled”, 0…). status’s reversed order.

Return type:

(bool, Tuple[int])

class JciHitachi.model.JciHitachiHESupport(status, default=0)[source]

Bases: JciHitachiStatusSupport

Data model representing supported heat exchanger status. Not implemented.

Parameters:
  • status (dict) – Supported status retrieved from JciHitachiStatusInterpreter.decode_support().

  • default (int, optional) – Default value when a status doesn’t exist, by default 0.

class JciHitachi.model.JciHitachiAWSStatus(raw_status: dict, legacy=False)[source]

Bases: object

Data class representing AWSThing status.

Parameters:
  • raw_status (dict) – Status retrieved from JciHitachiAWSMqttConnection _on_publish() callback.

  • legacy (bool, optional) – Whether the raw_status is a legacy status, i.e. derived from subclasses of JciHitachiStatus, by default False.

property status

All status.

Returns:

All status.

Return type:

dict

property legacy_status

All legacy status name used by the old API.

Returns:

Status with legacy name.

Return type:

JciHitachiAWSStatus

class JciHitachi.model.JciHitachiAWSStatusSupport(raw_status: dict)[source]

Bases: object

Data class representing AWSThing status support.

Parameters:

raw_status (dict) – Status retrieved from JciHitachiAWSMqttConnection _on_publish() callback.

property status

All status.

Returns:

All status.

Return type:

dict