aiovantage.objects

Vantage object definitions.

This module provides a (non-exhaustive) collection of classes that represent the various object types that are managed by a Vantage system.

Vantage objects define configuration properties, which are properties that are set during system programming, through Design Center.

Objects are hierarchical, with all objects ultimately deriving from SystemObject.

Each object implements one or more object interfaces, which provide state properties and methods for interacting with the object.

Classes:

• AnemoSensor –

  AnemoSensor (wind sensor) object.

• Area –

  Area object.

• BackBox –

  BackBox object.

• Blind –

  Blind object.

• BlindGroup –

  BlindGroup object.

• Button –

  Button object.

• ChildDevice –

  Base class for child device (driver-provided) objects.

• ContactInput –

  Contact Input.

• CustomDevice –

  Base class for custom device (driver provided) objects.

• DCPowerProfile –

  DCPowerProfile object.

• Dimmer –

  ScenePoint Dimmer Station.

• DINContactInput –

  DIN Contact Input Station.

• DINLowVoltageRelayStation –

  DIN Low Voltage Relay Station.

• DINStation –

  Base class for DIN station objects.

• DryContact –

  DryContact object.

• DualRelayStation –

  ScenePoint Dual Relay Station.

• EqCtrl –

  Equinox 40 Station.

• EqUX –

  Equinox 41 or Equinox 73 touchscreen.

• GMem –

  GMem (variable) object.

• HighVoltageRelayStation –

  High Voltage Relay Station.

• IRX2 –

  IRX II.

• Keypad –

  Keypad Station.

• LightSensor –

  Light sensor object.

• Load –

  Load object.

• LoadGroup –

  LoadGroup object.

• LocationObject –

  Base class for system objects in an area.

• LowVoltageRelayStation –

  Low Voltage Relay Station.

• Master –

  Master (InFusion Controller) object.

• Module –

  Module object.

• ModuleGen2 –

  ModuleGen2 object, eg. SDM12-EM, UDM08-EM.

• OmniSensor –

  OmniSensor object.

• ParentDevice –

  Base class for parent device objects.

• PortDevice –

  Base class for Vantage port device (driver-provided) objects.

• PowerProfile –

  Power Profile object.

• PWMPowerProfile –

  PWM power profile object.

• QISBlind –

  QIS Shade object.

• QubeBlind –

  Qz Shade object.

• RelayBlind –

  Relay blind object.

• RS232Station –

  RS-232 Station.

• RS485Station –

  RS-485 Station.

• ScenePointRelay –

  ScenePoint Relay Station.

• Sensor –

  Sensor object.

• SomfyRS485GroupChild –

  Somfy RS-485 SDN 2.0 blind group.

• SomfyRS485SDN20Port –

  Somfy RS-485 SDN 2.0 port device.

• SomfyRS485ShadeChild –

  Somfy RS-485 SDN 2.0 blind.

• SomfyURTSI2GroupChild –

  Somfy URTSI 2 blind group.

• SomfyURTSI2Port –

  Somfy URTSI 2 port device.

• SomfyURTSI2ShadeChild –

  Somfy URTSI 2 blind.

• StationBus –

  Station bus object.

• StationObject –

  Base class for all station objects.

• SystemObject –

  Base class for all objects.

• Task –

  Task object.

• Temperature –

  Temperature object.

• Thermostat –

  Thermostat object.

• Parent –

  Vantage parent type.

• VantageDDGColorLoad –

  DMX/DALI Gateway color load object.

• VantageDGColorLoad –

  DMX Gateway color load object.

• VantageDmxDaliGateway –

  DMX/DALI Gateway station.

• VantageDmxGateway –

  DMX Gateway.

• VantageGenericHVACRS485CompoundChild –

  Vantage Generic HVAC RS485 compound child device.

• VantageGenericHVACRS485Port –

  Vantage Generic HVAC RS485 port device.

• VantageGenericHVACRS485TechContactsChild –

  Vantage Generic HVAC RS485 tech contacts child device.

• VantageGenericHVACRS485ZoneChild –

  Vantage Generic HVAC RS485 zone child device.

• VantageGenericHVACRS485ZoneWithoutFanSpeedChild –

  Vantage Generic HVAC RS485 zone child device without fan speed.

• VantageHVACIULineChild –

  Vantage HVAC-IU line child device.

• VantageHVACIUPort –

  Vantage HVAC-IU port device.

• VantageHVACIUZoneChild –

  Vantage HVAC-IU zone child device.

• VantageVirtualThermostatPort –

  Vantage Virtual Thermostat.

AnemoSensor dataclass

AnemoSensor(*, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, area: int | None = None, location: str | None = None, parent: Parent, out_of_range: int = 0, in_range: int = 0, range_high: float = 10.0, range_low: float = 0.0, hold_on_time: float)

Bases: Sensor, SensorInterface, AnemoSensorInterface

AnemoSensor (wind sensor) object.

Area dataclass

Area(*, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, area: int | None = None, location: str | None = None, area_type: str, enclosure_area: int | None = None)

Bases: LocationObject

Area object.

BackBox dataclass

BackBox(*, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, area: int | None = None, location: str | None = None, keypad_style: int)

Bases: LocationObject

BackBox object.

Blind dataclass

Blind(*, shade_type: str | None = None, shade_orientation: str | None = None, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, area: int | None = None, location: str | None = None, parent: Parent, movement: Movement | None = None)

Bases: LocationObject, BlindInterface

Blind object.

BlindGroup dataclass

BlindGroup(*, shade_type: str | None = None, shade_orientation: str | None = None, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, area: int | None = None, location: str | None = None, category: int, blind_table: list[int] = list[int]())

Bases: LocationObject, BlindInterface

BlindGroup object.

Button dataclass

Button(*, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, parent: Parent, down: int = 0, up: int = 0, hold: int = 0, text1: str, text2: str, placement_table: list[int] = list[int](), button_style: int, led_style: int)

Bases: SystemObject, ButtonInterface

Button object.

Attributes:

• text (str) –

  Return the button text.

text property

text: str

Return the button text.

ChildDevice dataclass

ChildDevice(*, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, area: int | None = None, location: str | None = None, version: float, device_category: str = '', log: str = 'None', parent: Parent)

Bases: CustomDevice

Base class for child device (driver-provided) objects.

ContactInput dataclass

ContactInput(*, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, area: int | None = None, location: str | None = None, serial_number: str, bus: int)

Bases: StationObject

Contact Input.

CustomDevice dataclass

CustomDevice(*, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, area: int | None = None, location: str | None = None, version: float, device_category: str = '', log: str = 'None')

Bases: LocationObject

Base class for custom device (driver provided) objects.

DCPowerProfile dataclass

DCPowerProfile(*, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, min: float, max: float, adjust: int | None = None, freq: int | None = None, inductive: bool | None = None)

Bases: PowerProfile

DCPowerProfile object.

Dimmer dataclass

Dimmer(*, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, area: int | None = None, location: str | None = None, serial_number: str, bus: int, parent: Parent, gang: int, distributed: bool, no_neutral: bool = False, voltage: int | None = None, alert: str | None = None)

Bases: Keypad

ScenePoint Dimmer Station.

DINContactInput dataclass

DINContactInput(*, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, area: int | None = None, location: str | None = None, serial_number: str, bus: int, din_enclosure: DINEnclosure | None = None, module_count: int | None = None)

Bases: DINStation

DIN Contact Input Station.

DINLowVoltageRelayStation dataclass

DINLowVoltageRelayStation(*, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, area: int | None = None, location: str | None = None, serial_number: str, bus: int, din_enclosure: DINEnclosure | None = None, module_count: int | None = None)

Bases: DINStation

DIN Low Voltage Relay Station.

DINStation dataclass

DINStation(*, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, area: int | None = None, location: str | None = None, serial_number: str, bus: int, din_enclosure: DINEnclosure | None = None, module_count: int | None = None)

Bases: StationObject

Base class for DIN station objects.

DryContact dataclass

DryContact(*, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, area: int | None = None, location: str | None = None, parent: Parent, down: int = 0, up: int = 0, reverse_polarity: bool, hold_on_time: float = 0)

Bases: LocationObject, ButtonInterface

DryContact object.

DualRelayStation dataclass

DualRelayStation(*, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, area: int | None = None, location: str | None = None, serial_number: str, bus: int, parent: Parent, shade_controller: bool, reverse_shade: bool)

Bases: Keypad

ScenePoint Dual Relay Station.

EqCtrl dataclass

EqCtrl(*, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, area: int | None = None, location: str | None = None, serial_number: str, bus: int, pages: int, activate: int, style: int, header: Header, zone: int, preset_table: list[int] = list[int]())

Bases: StationObject, SounderInterface

Equinox 40 Station.

EqUX dataclass

EqUX(*, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, area: int | None = None, location: str | None = None, serial_number: str, bus: int, style: int, profile_table: list[int] = list[int](), activate: int)

Bases: StationObject

Equinox 41 or Equinox 73 touchscreen.

GMem dataclass

GMem(*, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, category: int, data: Data, persistent: bool = True, tag: Tag)

Bases: SystemObject, GMemInterface

GMem (variable) object.

Attributes:

• is_bool (bool) –

  Return True if GMem is boolean type.

• is_str (bool) –

  Return True if GMem is string type.

• is_int (bool) –

  Return True if GMem is integer type.

• is_object_id (bool) –

  Return True if GMem is a pointer to an object.

• is_fixed (bool) –

  Return True if GMem is a fixed point number.

is_bool property

is_bool: bool

Return True if GMem is boolean type.

is_str property

is_str: bool

Return True if GMem is string type.

is_int property

is_int: bool

Return True if GMem is integer type.

is_object_id property

is_object_id: bool

Return True if GMem is a pointer to an object.

is_fixed property

is_fixed: bool

Return True if GMem is a fixed point number.

HighVoltageRelayStation dataclass

HighVoltageRelayStation(*, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, area: int | None = None, location: str | None = None, serial_number: str, bus: int)

Bases: StationObject

High Voltage Relay Station.

IRX2 dataclass

IRX2(*, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, area: int | None = None, location: str | None = None, serial_number: str, bus: int, ir_pass_thru: IRPassThru, led_auto_off: bool = False)

Bases: StationObject

IRX II.

Keypad dataclass

Keypad(*, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, area: int | None = None, location: str | None = None, serial_number: str, bus: int, parent: Parent)

Bases: StationObject, SounderInterface

Keypad Station.

LightSensor dataclass

LightSensor(*, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, area: int | None = None, location: str | None = None, parent: Parent)

Bases: Sensor, SensorInterface, LightSensorInterface

Light sensor object.

Load dataclass

Load(*, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, area: int | None = None, location: str | None = None, parent: Parent, contractor_number: str, load_type: str = 'Incandescent', power: int = 100, power_profile: int, override_level: Decimal = Decimal('100'))

Bases: LocationObject, LoadInterface

Load object.

Attributes:

• is_relay (bool) –

  Return True if the load type is a relay.

• is_motor (bool) –

  Return True if the load type is a motor.

• is_light (bool) –

  Return True if the load type is inferred to be a light.

• is_on (bool) –

  Return True if the load is on.

is_relay property

is_relay: bool

Return True if the load type is a relay.

is_motor property

is_motor: bool

Return True if the load type is a motor.

is_light property

is_light: bool

Return True if the load type is inferred to be a light.

is_on property

is_on: bool

Return True if the load is on.

LoadGroup dataclass

LoadGroup(*, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, area: int | None = None, location: str | None = None, load_table: list[int] = list[int]())

Bases: LocationObject, LoadInterface

LoadGroup object.

LocationObject dataclass

LocationObject(*, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, area: int | None = None, location: str | None = None)

Bases: SystemObject

Base class for system objects in an area.

LowVoltageRelayStation dataclass

LowVoltageRelayStation(*, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, area: int | None = None, location: str | None = None, serial_number: str, bus: int)

Bases: StationObject

Low Voltage Relay Station.

Master dataclass

Master(*, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, number: int, boot: int = 0, volts: float = 24.0, amps: float = 2.5, din_enclosure: DINEnclosure | None = None, module_count: int | None = None, power_supply: int | None = None, serial_number: int | None = None)

Bases: SystemObject, IntrospectionInterface, ConfigurationInterface

Master (InFusion Controller) object.

Module dataclass

Module(*, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, parent: Parent, line_feed_table: list[LineFeed] = list[LineFeed](), join1: bool, join2: bool, join3: bool, join4: bool, quiet_mode: bool)

Bases: SystemObject

Module object.

ModuleGen2 dataclass

ModuleGen2(*, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, parent: Parent, line_feed_table: list[LineFeed] = list[LineFeed](), quiet_mode: bool = False, legacy_mode: bool = False, alert: int)

Bases: SystemObject

ModuleGen2 object, eg. SDM12-EM, UDM08-EM.

OmniSensor dataclass

OmniSensor(*, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, area: int | None = None, location: str | None = None, parent: Parent, get: Get, set: Set)

Bases: Sensor, SensorInterface

OmniSensor object.

Methods:

• get_level –

  Get the value of the OmniSensor object, using cached value if available.

• set_level –

  Set the value of the OmniSensor object.

Attributes:

• is_current_sensor (bool) –

  Return True if the sensor is a current sensor.

• is_power_sensor (bool) –

  Return True if the sensor is a power sensor.

• is_temperature_sensor (bool) –

  Return True if the sensor is a temperature sensor.

is_current_sensor property

is_current_sensor: bool

Return True if the sensor is a current sensor.

is_power_sensor property

is_power_sensor: bool

Return True if the sensor is a power sensor.

is_temperature_sensor property

is_temperature_sensor: bool

Return True if the sensor is a temperature sensor.

get_level async

get_level(*, hw: bool = False) -> Decimal

Get the value of the OmniSensor object, using cached value if available.

Parameters:

• hw (bool, default: False ) –

  Fetch the value from hardware instead of cache.

Returns:

• Decimal –

  The level of the sensor.

set_level async

set_level(level: Decimal, *, sw: bool = False) -> None

Set the value of the OmniSensor object.

Parameters:

• level (Decimal) –

  The value to set the sensor to.

• sw (bool, default: False ) –

  Set the cached value instead of the hardware value.

ParentDevice dataclass

ParentDevice(*, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, area: int | None = None, location: str | None = None, version: float, device_category: str = '', log: str = 'None')

Bases: CustomDevice

Base class for parent device objects.

PortDevice dataclass

PortDevice(*, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, area: int | None = None, location: str | None = None)

Bases: LocationObject

Base class for Vantage port device (driver-provided) objects.

PowerProfile dataclass

PowerProfile(*, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, min: float, max: float, adjust: int | None = None, freq: int | None = None, inductive: bool | None = None)

Bases: SystemObject

Power Profile object.

Attributes:

• is_dimmable (bool) –

  Return True if loads with this profile are dimmable.

is_dimmable property

is_dimmable: bool

Return True if loads with this profile are dimmable.

PWMPowerProfile dataclass

PWMPowerProfile(*, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, min: float, max: float, adjust: int | None = None, freq: int | None = None, inductive: bool | None = None, inverted: bool = False)

Bases: DCPowerProfile

PWM power profile object.

QISBlind dataclass

QISBlind(*, shade_type: str | None = None, shade_orientation: str | None = None, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, area: int | None = None, location: str | None = None, serial_number: str, bus: int, upper_limit: float, lower_limit: float, movement: Movement)

Bases: StationObject, BlindInterface

QIS Shade object.

QubeBlind dataclass

QubeBlind(*, shade_type: str | None = None, shade_orientation: str | None = None, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, area: int | None = None, location: str | None = None, serial_number: str, bus: int, upper_limit: float, lower_limit: float, movement: Movement, alert: int = 0, low_battery_threshold: float = 20.0)

Bases: StationObject, BlindInterface

Qz Shade object.

RelayBlind dataclass

RelayBlind(*, shade_type: str | None = None, shade_orientation: str | None = None, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, area: int | None = None, location: str | None = None)

Bases: LocationObject, BlindInterface

Relay blind object.

RS232Station dataclass

RS232Station(*, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, area: int | None = None, location: str | None = None, serial_number: str, bus: int)

Bases: StationObject

RS-232 Station.

RS485Station dataclass

RS485Station(*, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, area: int | None = None, location: str | None = None, serial_number: str, bus: int)

Bases: StationObject

RS-485 Station.

ScenePointRelay dataclass

ScenePointRelay(*, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, area: int | None = None, location: str | None = None, serial_number: str, bus: int, parent: Parent)

Bases: Keypad

ScenePoint Relay Station.

Sensor dataclass

Sensor(*, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, area: int | None = None, location: str | None = None)

Bases: LocationObject

Sensor object.

SomfyRS485GroupChild dataclass

SomfyRS485GroupChild(*, shade_type: str | None = None, shade_orientation: str | None = None, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, area: int | None = None, location: str | None = None, version: float, device_category: str = '', log: str = 'None', parent: Parent)

Bases: ChildDevice, BlindInterface

Somfy RS-485 SDN 2.0 blind group.

SomfyRS485SDN20Port dataclass

SomfyRS485SDN20Port(*, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, area: int | None = None, location: str | None = None)

Bases: PortDevice

Somfy RS-485 SDN 2.0 port device.

SomfyRS485ShadeChild dataclass

SomfyRS485ShadeChild(*, shade_type: str | None = None, shade_orientation: str | None = None, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, area: int | None = None, location: str | None = None, version: float, device_category: str = '', log: str = 'None', parent: Parent)

Bases: ChildDevice, BlindInterface

Somfy RS-485 SDN 2.0 blind.

SomfyURTSI2GroupChild dataclass

SomfyURTSI2GroupChild(*, shade_type: str | None = None, shade_orientation: str | None = None, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, area: int | None = None, location: str | None = None, version: float, device_category: str = '', log: str = 'None', parent: Parent)

Bases: ChildDevice, BlindInterface

Somfy URTSI 2 blind group.

SomfyURTSI2Port dataclass

SomfyURTSI2Port(*, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, area: int | None = None, location: str | None = None)

Bases: PortDevice

Somfy URTSI 2 port device.

SomfyURTSI2ShadeChild dataclass

SomfyURTSI2ShadeChild(*, shade_type: str | None = None, shade_orientation: str | None = None, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, area: int | None = None, location: str | None = None, version: float, device_category: str = '', log: str = 'None', parent: Parent)

Bases: ChildDevice, BlindInterface

Somfy URTSI 2 blind.

StationBus dataclass

StationBus(*, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, parent: Parent)

Bases: SystemObject

Station bus object.

StationObject dataclass

StationObject(*, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, area: int | None = None, location: str | None = None, serial_number: str, bus: int)

Bases: LocationObject

Base class for all station objects.

SystemObject dataclass

SystemObject(*, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None)

Bases: ObjectInterface

Base class for all objects.

Methods:

• vantage_type –

  Return the Vantage type for this object.

Attributes:

• id (int) –

  Return the ID of the object.

id property

id: int

Return the ID of the object.

vantage_type classmethod

vantage_type() -> str

Return the Vantage type for this object.

Task dataclass

Task(*, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None)

Bases: SystemObject, TaskInterface

Task object.

Temperature dataclass

Temperature(*, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, area: int | None = None, location: str | None = None, parent: Parent, out_of_range: int = 0, in_range: int = 0, range_high: float, range_low: float, hold_on_time: float, temp: int = 0)

Bases: Sensor, TemperatureInterface

Temperature object.

Thermostat dataclass

Thermostat(*, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, area: int | None = None, location: str | None = None, serial_number: str, bus: int, day_mode_event: int = 0, fan_mode_event: int = 0, operation_mode_event: int = 0, external_temperature: int, display_clock: bool = True, pseudo_mode: bool = True, humidistat: bool = False)

Bases: StationObject, ThermostatInterface

Thermostat object.

Parent dataclass

Parent(*, vid: int, position: int)

Vantage parent type.

VantageDDGColorLoad dataclass

VantageDDGColorLoad(*, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, area: int | None = None, location: str | None = None, parent: Parent, color_type: ColorType, min_temp: int, max_temp: int)

Bases: LocationObject, LoadInterface, RGBLoadInterface, ColorTemperatureInterface

DMX/DALI Gateway color load object.

VantageDGColorLoad dataclass

VantageDGColorLoad(*, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, area: int | None = None, location: str | None = None, parent: Parent, color_type: ColorType, min_temp: int, max_temp: int)

Bases: LocationObject, LoadInterface, RGBLoadInterface, ColorTemperatureInterface

DMX Gateway color load object.

VantageDmxDaliGateway dataclass

VantageDmxDaliGateway(*, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, area: int | None = None, location: str | None = None, serial_number: str, bus: int, ip_address: str, mode: str | None = None)

Bases: StationObject

DMX/DALI Gateway station.

VantageDmxGateway dataclass

VantageDmxGateway(*, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, area: int | None = None, location: str | None = None)

Bases: PortDevice

DMX Gateway.

VantageGenericHVACRS485CompoundChild dataclass

VantageGenericHVACRS485CompoundChild(*, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, area: int | None = None, location: str | None = None, version: float, device_category: str = '', log: str = 'None', parent: Parent, adress_number: int = 1)

Bases: ChildDevice, ThermostatInterface

Vantage Generic HVAC RS485 compound child device.

VantageGenericHVACRS485Port dataclass

VantageGenericHVACRS485Port(*, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, area: int | None = None, location: str | None = None, fan_boost_option: bool = False, fan_speed_settings: FanSpeedSettings, fan_individual_control: bool = False, receive_port: int, sensor_settings: SensorSettings, setpoint_settings: SetpointSettings)

Bases: PortDevice

Vantage Generic HVAC RS485 port device.

VantageGenericHVACRS485TechContactsChild dataclass

VantageGenericHVACRS485TechContactsChild(*, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, area: int | None = None, location: str | None = None, version: float, device_category: str = '', log: str = 'None', parent: Parent)

Bases: ChildDevice

Vantage Generic HVAC RS485 tech contacts child device.

VantageGenericHVACRS485ZoneChild dataclass

VantageGenericHVACRS485ZoneChild(*, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, area: int | None = None, location: str | None = None, version: float, device_category: str = '', log: str = 'None', parent: Parent, indoor_settings: IndoorSettings, position_number: int = 1)

Bases: ChildDevice, ThermostatInterface, FanInterface

Vantage Generic HVAC RS485 zone child device.

VantageGenericHVACRS485ZoneWithoutFanSpeedChild dataclass

VantageGenericHVACRS485ZoneWithoutFanSpeedChild(*, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, area: int | None = None, location: str | None = None, version: float, device_category: str = '', log: str = 'None', parent: Parent, indoor_settings: IndoorSettings, position_number: int = 1)

Bases: ChildDevice, ThermostatInterface, FanInterface

Vantage Generic HVAC RS485 zone child device without fan speed.

VantageHVACIULineChild dataclass

VantageHVACIULineChild(*, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, area: int | None = None, location: str | None = None, version: float, device_category: str = '', log: str = 'None', parent: Parent, device_type: str = 'Daikin', line_number: int = 1, operation_modes: OperationModes, fan_speeds: FanSpeeds)

Bases: ChildDevice

Vantage HVAC-IU line child device.

VantageHVACIUPort dataclass

VantageHVACIUPort(*, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, area: int | None = None, location: str | None = None, temperature_format: str = 'Celcius', outdoor_sensor: int, pauze_time: int = 1, serial_number: str = '0')

Bases: PortDevice

Vantage HVAC-IU port device.

VantageHVACIUZoneChild dataclass

VantageHVACIUZoneChild(*, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, area: int | None = None, location: str | None = None, version: float, device_category: str = '', log: str = 'None', parent: Parent, main_zone: str, grouped_zones: list[str] = list[str](), indoor_sensors: list[IndoorSensor] = list[IndoorSensor]())

Bases: ChildDevice, ThermostatInterface, FanInterface

Vantage HVAC-IU zone child device.

VantageVirtualThermostatPort dataclass

VantageVirtualThermostatPort(*, vid: int, master: int, name: str, model: str, note: str, d_name: str = '', m_time: datetime | None = None, area: int | None = None, location: str | None = None, change_over_valve: int, cool: Cool, fan: Fan, frost_mail_from: str, frost_mail_to: str, heat: Heat, indoor_sensor_holder: IndoorSensorHolder, outdoor_sensor_holder: OutdoorSensorHolder)

Bases: PortDevice, ThermostatInterface, FanInterface

Vantage Virtual Thermostat.