Options
All
  • Public
  • Public/Protected
  • All
Menu

Ethernet Module Test

The “XK” command is automatically sent every 30 seconds. This is done regardless of whether an M1XEP Ethernet Module is present or not. The XK command serves two purposes.

  1. It tests to see if a M1XEP Ethernet Module is connected to the Control.
  2. It includes the Control’s real time clock information (current Date and Time) for general purpose use, including but not limited to clock synchronization by a third party device.

The expected response from a connected M1XEP Ethernet Module is “xk”. However, the Control does not actually care or keep track of a missing “xk” response UNLESS or UNTIL after a M1XEP Ethernet Module has been properly enrolled with the Control. This can be accomplished via the Bus Module Enrollment process (Keypad programming Menu 1) or by the RP software). Once an M1XEP has been enrolled, the Control will now begin tracking each response to an “XK” command, and it will display and log an “Ethernet Trouble” message if an “xk” response is not received within 120 seconds of the “XK” command. This response scenario is also true for alarm reporting commands “AT” and “AR”. Basically, the M1XEP will withhold sending the “xk” response if it should fail to complete an alarm or restoral transmission after 2 attempts. This allows for 1 transmission miss.

NOTE: Control Firmware Version 4.32 and after includes the M1’s real time clock information.

see

4.4.5 Ethernet Module Test (XK)

Hierarchy

Implements

Index

Constructors

constructor

Properties

Optional Readonly checksum

checksum: undefined | string

Readonly data

data: string = ""

Readonly date

date: Date

A date object representing the control's realtime clock values.

Readonly dayOfMonth

dayOfMonth: number

Readonly dayOfWeek

dayOfWeek: DayOfWeek

Optional Readonly expectedChecksum

expectedChecksum: undefined | string

Optional Readonly expectedPacketLength

expectedPacketLength: undefined | string

Readonly hour

hour: number

Readonly is12hourClockMode

is12hourClockMode: boolean

True if the system is using 12-hour clock mode.

Readonly isChecksumValid

isChecksumValid: boolean = false

Readonly isDateModeDayFirst

isDateModeDayFirst: boolean

True if the date display mode is "dd/mm"; fale if it is "mm/dd"

Readonly isDst

isDst: boolean

True if daylight savings time is currently active; Otherwise, false.

Readonly isPacketLengthValid

isPacketLengthValid: boolean = false

Readonly isWellFormed

isWellFormed: boolean = false

Optional Readonly messageType

messageType: undefined | string

Readonly minutes

minutes: number

Readonly monthOfYear

monthOfYear: MonthOfYear

Optional Readonly packetLength

packetLength: undefined | string

Readonly raw

raw: string

Optional Readonly reserved

reserved: undefined | string

Readonly seconds

seconds: number

Optional Readonly subMessageType

subMessageType: undefined | string

Optional Readonly terminator

terminator: undefined | string

Readonly year

year: number

Static Readonly COMMAND

COMMAND: "XK" = "XK"

Accessors

command

  • get command(): string | null

Legend

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

Generated using TypeDoc