elk-message
Options
All
  • Public
  • Public/Protected
  • All
Menu

This message is used to inform User Interfaces that an alarm memory is present and must be cleared before an arm command will arm the system.

see

4.38 Alarm Memory Update (AM)

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Readonly areas

areas: boolean[]

An array containing the alarm memory status of each area. If the value is true, there is an alarm memory present for the area. Index 0 indicates area 1's alarm memory status, index 1 indicates area 2's alarm memory status, etc.

Optional Readonly checksum

checksum: undefined | string

Readonly data

data: string = ""

Optional Readonly expectedChecksum

expectedChecksum: undefined | string

Optional Readonly expectedPacketLength

expectedPacketLength: undefined | string

Readonly isChecksumValid

isChecksumValid: boolean = false

Readonly isPacketLengthValid

isPacketLengthValid: boolean = false

Readonly isWellFormed

isWellFormed: boolean = false

Optional Readonly messageType

messageType: undefined | string

Optional Readonly packetLength

packetLength: undefined | string

Readonly raw

raw: string

Optional Readonly reserved

reserved: undefined | string

Optional Readonly subMessageType

subMessageType: undefined | string

Optional Readonly terminator

terminator: undefined | string

Static Readonly COMMAND

COMMAND: "AM" = "AM"

Accessors

command

  • get command(): string | null

Methods

isAlarmMemoryPresent

  • isAlarmMemoryPresent(areaNumber: number): boolean

  • Returns a value indicating whether there is an alarm memory present in the given area.

    Parameters

    • areaNumber: number

      The area number (1..8)

    Returns boolean

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Method
  • Inherited constructor
  • Inherited property
  • Static property
  • Static method

Generated using TypeDoc