Class ClassicRegistry

Central in-memory registry of all MELCloud models (buildings, floors, areas, devices). Synced from the Classic API response and queryable by ID or parent relationship.

Index

Constructors

constructor

new ClassicRegistry(): ClassicRegistry

Returns ClassicRegistry

Properties

`Readonly`areas

areas: { getById: (id: number) => ClassicArea<number | null> | undefined } = ...

Type Declaration

getById: (id: number) => ClassicArea<number | null> | undefined

Returns the area with the given id, or undefined when no such area is registered.

`Readonly`buildings

buildings: { getById: (id: number) => ClassicBuilding | undefined } = ...

Type Declaration

getById: (id: number) => ClassicBuilding | undefined

Returns the building with the given id, or undefined when no such building is registered.

`Readonly`devices

devices: { getById: (id: number) => ClassicDeviceAny | undefined } = ...

Type Declaration

getById: (id: number) => ClassicDeviceAny | undefined

Returns the device with the given id, or undefined when no such device is registered.

`Readonly`floors

floors: { getById: (id: number) => ClassicFloor | undefined } = ...

Type Declaration

getById: (id: number) => ClassicFloor | undefined

Returns the floor with the given id, or undefined when no such floor is registered.

Methods

getAreasByBuildingId

getAreasByBuildingId(id: ClassicBuildingID): ClassicArea<number | null>[]
Get all areas within a specific building.
Parameters
- id: ClassicBuildingID
  The building ID to look up areas for.
Returns ClassicArea<number | null>[]
The areas belonging to the specified building.
- Defined in src/entities/classic-registry.ts:223

getAreasByFloorId

getAreasByFloorId(id: ClassicFloorID): ClassicArea<number | null>[]
Returns the areas attached to the given floor (excluding building-level areas).
Parameters
- id: ClassicFloorID
  Floor identifier.
Returns ClassicArea<number | null>[]
The areas under that floor.
- Defined in src/entities/classic-registry.ts:232

getBuildings

getBuildings(root0?: { type?: ClassicDeviceType }): ClassicBuildingZone[]
Build a hierarchical zone structure from the registry, optionally filtered by device type.
Parameters
- root0: { type?: ClassicDeviceType } = {}
  Options object.
  - Optionaltype?: ClassicDeviceType
    
    Optional device type to filter the zone structure.
Returns ClassicBuildingZone[]
The hierarchical building zone structure.
- Defined in src/entities/classic-registry.ts:242

getDevices

getDevices(): ClassicDeviceAny[]
Returns every device currently held in the registry.

Returns ClassicDeviceAny[]
All devices.
- Defined in src/entities/classic-registry.ts:279

getDevicesByAreaId

getDevicesByAreaId(id: ClassicAreaID): ClassicDeviceAny[]
Returns the devices attached directly to the given area.
Parameters
- id: ClassicAreaID
  Area identifier.
Returns ClassicDeviceAny[]
The devices in that area.
- Defined in src/entities/classic-registry.ts:288

getDevicesByBuildingId

getDevicesByBuildingId(id: ClassicBuildingID): ClassicDeviceAny[]
Returns every device under the given building (regardless of floor or area placement).
Parameters
- id: ClassicBuildingID
  Building identifier.
Returns ClassicDeviceAny[]
The devices under that building.
- Defined in src/entities/classic-registry.ts:297

getDevicesByFloorId

getDevicesByFloorId(id: ClassicFloorID): ClassicDeviceAny[]
Returns every device under the given floor (regardless of area placement).
Parameters
- id: ClassicFloorID
  Floor identifier.
Returns ClassicDeviceAny[]
The devices under that floor.
- Defined in src/entities/classic-registry.ts:306

getDevicesByType

getDevicesByType<T extends ClassicDeviceType>(type: T): ClassicDevice<T>[]
Returns every device whose Type matches the given device type.
Type Parameters
- T extends ClassicDeviceType
Parameters
- type: T
  Ata, Atw, or Erv discriminator.
Returns ClassicDevice<T>[]
The matching devices.
- Defined in src/entities/classic-registry.ts:315

getFloorsByBuildingId

getFloorsByBuildingId(id: ClassicBuildingID): ClassicFloor[]
Returns the floors of the given building.
Parameters
- id: ClassicBuildingID
  Building identifier.
Returns ClassicFloor[]
The floors under that building.
- Defined in src/entities/classic-registry.ts:327

getZones

getZones(root0?: { type?: ClassicDeviceType }): ClassicFlatZone[]
Flattens the hierarchical zone tree returned by getBuildings into a single, name-sorted list.
Parameters
- root0: { type?: ClassicDeviceType } = {}
  Optional filter.
  - Optionaltype?: ClassicDeviceType
    
    Restrict to a single device type.
Returns ClassicFlatZone[]
Every zone (buildings, floors, areas, devices), sorted by name.
- Defined in src/entities/classic-registry.ts:338

syncAreas

syncAreas(areas: ClassicAreaDataAny[]): void
Upserts the area registry and rebuilds the by-building / by-floor indexes; entries absent from areas are pruned.
Parameters
- areas: ClassicAreaDataAny[]
  Fresh wire-format area entries.
Returns void
- Defined in src/entities/classic-registry.ts:351

syncBuildings

syncBuildings(buildings: ClassicBuildingData[]): void
Upserts the building registry; entries absent from buildings are pruned.
Parameters
- buildings: ClassicBuildingData[]
  Fresh wire-format building entries.
Returns void
- Defined in src/entities/classic-registry.ts:376

syncDevices

syncDevices(devices: readonly ClassicListDeviceAny[]): void
Upserts the device registry and rebuilds the by-building / by-floor / by-area indexes; entries absent from devices are pruned.
Parameters
- devices: readonly ClassicListDeviceAny[]
  Fresh wire-format list-device entries.
Returns void
- Defined in src/entities/classic-registry.ts:391

syncFloors

syncFloors(floors: ClassicFloorData[]): void
Upserts the floor registry and rebuilds the by-building index; entries absent from floors are pruned.
Parameters
- floors: ClassicFloorData[]
  Fresh wire-format floor entries.
Returns void
- Defined in src/entities/classic-registry.ts:422

Class ClassicRegistry

Index

Constructors

Properties

Methods

Constructors

constructor

Returns ClassicRegistry

Properties

Readonlyareas

Type Declaration

getById: (id: number) => ClassicArea<number | null> | undefined

Readonlybuildings

Type Declaration

getById: (id: number) => ClassicBuilding | undefined

Readonlydevices

Type Declaration

getById: (id: number) => ClassicDeviceAny | undefined

Readonlyfloors

Type Declaration

getById: (id: number) => ClassicFloor | undefined

Methods

getAreasByBuildingId

Parameters

Returns ClassicArea<number | null>[]

getAreasByFloorId

Parameters

Returns ClassicArea<number | null>[]

getBuildings

Parameters

Optionaltype?: ClassicDeviceType

Returns ClassicBuildingZone[]

getDevices

Returns ClassicDeviceAny[]

getDevicesByAreaId

Parameters

Returns ClassicDeviceAny[]

getDevicesByBuildingId

Parameters

Returns ClassicDeviceAny[]

getDevicesByFloorId

Parameters

Returns ClassicDeviceAny[]

getDevicesByType

Type Parameters

Parameters

Returns ClassicDevice<T>[]

getFloorsByBuildingId

Parameters

Returns ClassicFloor[]

getZones

Parameters

Optionaltype?: ClassicDeviceType

Returns ClassicFlatZone[]

syncAreas

Parameters

Returns void

syncBuildings

Parameters

Returns void

syncDevices

Parameters

Returns void

syncFloors

Parameters

Returns void

Settings

On This Page

`Readonly`areas

`Readonly`buildings

`Readonly`devices

`Readonly`floors

`Optional`type?: ClassicDeviceType

`Optional`type?: ClassicDeviceType