Interface MonitoringService

Service interface for retrieving information related to smart furniture hookups, utility meters, and consumption data.

interface MonitoringService {
    getActiveSmartFurnitureHookups(): Promise<ActiveSmartFurnitureHookup[]>;
    getUtilityConsumptions(
        utilityType: UtilityType,
        filter?: TimeSeriesFilter,
        tagsFilter?: TagsFilter,
    ): Promise<UtilityConsumptionPoint[]>;
    getUtilityMeters(
        filter?: TimeRangeFilter,
        tagsFilter?: TagsFilter,
    ): Promise<UtilityMeters>;
}

Implemented by

MonitoringServiceImpl

Index

Methods

getActiveSmartFurnitureHookups getUtilityConsumptions getUtilityMeters

Methods

getActiveSmartFurnitureHookups

getActiveSmartFurnitureHookups(): Promise<ActiveSmartFurnitureHookup[]>
Returns all currently active smart furniture hookups, i.e. all smart furniture hookups that have sent a measurement in the recent times.

Returns Promise<ActiveSmartFurnitureHookup[]>
A promise resolving to a list of SmartFurnitureHookupID values together with the most recent consumption data.
- Defined in src/domain/ports/MonitoringService.ts:20

getUtilityConsumptions

getUtilityConsumptions(
    utilityType: UtilityType,
    filter?: TimeSeriesFilter,
    tagsFilter?: TagsFilter,
): Promise<UtilityConsumptionPoint[]>
Retrieves consumption points for a specific utility type, optionally filtered by a time-series configuration.
Parameters
- utilityType: UtilityType
- Optionalfilter: TimeSeriesFilter
  Optional time-series filter.
- OptionaltagsFilter: TagsFilter
  Optional measurement tags filter.
Returns Promise<UtilityConsumptionPoint[]>
A promise resolving to an array of consumption points.
- Defined in src/domain/ports/MonitoringService.ts:43

getUtilityMeters

getUtilityMeters(
filter?: TimeRangeFilter,
tagsFilter?: TagsFilter,
): Promise<UtilityMeters>
Retrieves utility meter information, optionally filtered by a time range and additional tags.
Parameters
- Optionalfilter: TimeRangeFilter
  Optional time range filter.
- OptionaltagsFilter: TagsFilter
  Optional measurement tags filter.
Returns Promise<UtilityMeters>
A promise resolving to the set of utility meters.
- Defined in src/domain/ports/MonitoringService.ts:29