Class HomeDevice<TData>

constructor

• new HomeDevice<TData extends HomeDeviceData = HomeDeviceData>(
      entry: {
          building: HomeBuildingRef;
          device: TData;
          isOwner: boolean;
          type: HomeDeviceType;
      },
  ): HomeDevice<TData>

  Builds a Home device wrapper from a wire-format HomeDeviceData entry tagged with its connection type (Ata or Atw) and ownership origin.

  Type Parameters

  • TData extends HomeDeviceData = HomeDeviceData

    Wrapped wire-format payload variant: a connection-type specific shape once discriminated, or the full HomeDeviceData union by default.

  Parameters

  • entry: {
        building: HomeBuildingRef;
        device: TData;
        isOwner: boolean;
        type: HomeDeviceType;
    }

    Wire-format device payload tagged with its connection type, ownership origin and source building.

    • building: HomeBuildingRef

      Identity of the /context building the payload was sourced from.

    • device: TData

      Wire-format device payload.

    • isOwner: boolean

      true when sourced from an owned building, false when sourced from a guest one.

    • type: HomeDeviceType

      Connection-type discriminator.

  Returns HomeDevice<TData>

Readonlytype

building

• get building(): HomeBuildingRef

  Identity of the /context building this device was sourced from on the latest sync — the account-level grouping key. Restated on every sync, so a device moved between buildings follows its new home.

  Returns HomeBuildingRef

  The building id and display name.

data

• get data(): Readonly<TData>

  Last-synced wire-format payload for this device.

  Returns Readonly<TData>

  A read-only snapshot of the device data.

disconnectedSince

• get disconnectedSince(): Temporal.PlainDateTime | null

  First instant (UTC) since which every sync has reported the unit disconnected, or null while it reads connected. In-memory only: a fresh wrapper (new registry after a re-login, host restart) restarts the clock — deliberately conservative for the availability hysteresis.

  Returns Temporal.PlainDateTime | null

  The start of the current disconnection streak, if any.

id

• get id(): string

  Unique device identifier as assigned by MELCloud Home.

  Returns string

  The GUID string assigned by MELCloud Home.

isOwner

• get isOwner(): boolean

  Whether the current account owns this device (sourced from context.buildings) rather than being a guest of it (sourced from context.guestBuildings). Reports the structural origin only: false does not by itself prove a guest is barred from control.

  Returns boolean

  true when owned, false when shared with this account.

name

• get name(): string

  User-facing display name set in the MELCloud Home app.

  Returns string

  The device's display name.

isAta

• isAta(): this is HomeDevice<HomeAtaDeviceData>

  Type predicate that narrows this wrapper to the ATA variant when its connection-type discriminator is HomeDeviceType.Ata.

  Returns this is HomeDevice<HomeAtaDeviceData>

  true when the wrapped payload is an ATA device.

isAtw

• isAtw(): this is HomeDevice<HomeAtwDeviceData>

  Type predicate that narrows this wrapper to the ATW variant when its connection-type discriminator is HomeDeviceType.Atw.

  Returns this is HomeDevice<HomeAtwDeviceData>

  true when the wrapped payload is an ATW device.

sync

• sync(device: TData, isOwner: boolean, building: HomeBuildingRef): void

  Replaces the internal data snapshot with a fresh payload while preserving the wrapper's object identity. Every sync restates the ownership origin, so a share/unshare between syncs is reflected rather than kept from a stale tag.

  Registry-internal by contract (the Home mirror of Classic's non-exported syncDevice): consumers read, the registry writes.

  Parameters

  • device: TData

    Fresh wire-format device payload.

  • isOwner: boolean

    Ownership origin from the current sync.

  • building: HomeBuildingRef

    Building identity from the current sync.

  Returns void