Class GlobalAlarm

Hierarchy

BaseSubSystem<GlobalAlarmItem>
- GlobalAlarm

Index

Constructors

Properties

client parseItem systemType

Methods

getItem getTrends getTrendsStatuses parseItemTrend

Constructors

constructor

new GlobalAlarm(client): GlobalAlarm
Parameters
- client: LocalClient | RemoteClient
Returns GlobalAlarm
Overrides BaseSubSystem<GlobalAlarmItem>.constructor
- Defined in src/systems/globalAlarm/index.ts:11

Properties

`Protected` `Readonly` client

client: LocalClient | RemoteClient

The client instance

`Protected` `Readonly` parseItem

parseItem: ((status) => GlobalAlarmItem)

Type declaration

- (status): GlobalAlarmItem
- Parameters
  - status: SystemStatusResponse
  Returns GlobalAlarmItem

`Protected` `Readonly` systemType

systemType: SystemType

Methods

getItem

getItem(): Promise<GlobalAlarmItem>
Returns item.

Returns Promise<GlobalAlarmItem>

Throws
ClientError
Inherited from BaseSubSystem.getItem
- Defined in src/systems/base/index.ts:278

getTrends

getTrends(startDate, endDate, count): Promise<Trend>
Returns all trends.
Parameters
- startDate: string
  
  The start date as date string.
- endDate: string
  
  The start date as date string.
- count: number
  
  The data count.
Returns Promise<Trend>

Throws
ClientError
Inherited from BaseSubSystem.getTrends
- Defined in src/systems/base/index.ts:293

`Protected` getTrendsStatuses

getTrendsStatuses(systemType, startDate, endDate, count): Promise<Trend[]>
Return parsed trends.
Parameters
- systemType: SystemType
  
  The system type.
- startDate: string
  
  The start date as date string.
- endDate: string
  
  The start date as date string.
- count: number
  
  The data count.
Returns Promise<Trend[]>

Throws
ClientError
Inherited from BaseSubSystem.getTrendsStatuses
- Defined in src/systems/base/index.ts:84

`Protected` parseItemTrend

parseItemTrend(systemType, item, itemId, startDate, endDate, count): Promise<Trend>
Return a parsed trend.
Parameters
- systemType: SystemType
  
  The system type.
- item: string
  
  The item.
- itemId: string
  
  The item id.
- startDate: string
  
  The start date as date string.
- endDate: string
  
  The start date as date string.
- count: number
  
  The data count.
Returns Promise<Trend>

Throws
ClientError
Inherited from BaseSubSystem.parseItemTrend
- Defined in src/systems/base/index.ts:39

Generated using TypeDoc