Skip to main content
Version: v4 (Stable)

Status

Status(StatusId As Integer, nVal As Integer[, bSet As Boolean[, sParam As String]]) As Integer

Gets or sets the status of Alert according to the <StatusId> parameter:

0 = General status (read only):

  • 0 = not ready
  • 1 = demo mode
  • 2 = ready
  • 3 = limited demo

1 = Link status ("Acquisition" led, read only if <sParam> not defined):

  • 0 = link not established (gray led)
  • 1 = connection in progress (yellow led)
  • 2 = link established (green led)
  • 3 = link failure (red led)

2 = Call status ("Alert" led, read/write):

  • 0 = station is active (green led)
  • 1 = station is inactive (red led)

3 = Redundancy status ("Redundancy" led, read only):

  • 0 = redundancy not initialized
  • 1 = redundancy check in progress
  • 2 = redundancy OK
  • 3 = redundancy failure
  • 4 = waiting for redundancy OK on remote station

4 = Link status with the contextual data server (read only):

  • 0 = data server connected, no active or unacknowledged alarm
  • 1 = data server connected, no alarm to be acknowledged, at least one active alarm
  • 2 = data server connected, no active alarm, at least one alarm to be acknowledged
  • 3 = data server connected, at least one active alarm to be acknowledged
  • 4 = link failure with the data server
  • 8 = data server polling stopped

5 = Redundancy station configuration:

  • 0 = secondary station
  • 1 = main station

If <bSet> is not specified or is set to FALSE, the function returns the requested status in <nVal>. If <bSet> is TRUE, the Alert status will be set to <nVal>.

When defined, the optional <sParam> parameter can contain the name of a data server to control the polling status of the data server in question (<StatusId> = 1 and <bSet> = TRUE) according with the value of <nVal> (<nVal> = 1 for polling activation, <nVal> = 0 for polling stop).

Returns an error code (0 if no error).