BACnetStack_SetFaultListedAlgorithm

bool BACnetStack_SetFaultListedAlgorithm(
  const uint32_t deviceInstance,
  const uint16_t objectType,
  const uint32_t objectInstance,
  const bool enable);

Enables the Fault Listed Algorithm for an object.

The object must exist and have alarms and events enabled by BACnetStack_SetAlarmsAndEventsForObjectEnabled(…, enabled=true) - an Event Enrollment object carries its own and needs no such call; otherwise this returns false.

This function will enable the required properties and store the initial values in memory.

BACnet reference: ANSI/ASHRAE 135-2024 clause 13.4.8 (FAULT_LISTED Fault Algorithm).

Parameters

Parameter	Direction	Description
`deviceInstance`	in	The instance number of the device that owns this object.
`objectType, objectInstance`	in	The object for alarms and events: one BACnet Object Identifier, carried as two parameters (see the API conventions).
`enable`	in	Initial inhibit state, inverted - NOT a remove. true arms the algorithm; false leaves it armed but INHIBITED through the object’s Event_Algorithm_Inhibit property (or Reliability_Evaluation_Inhibit for a fault algorithm). Both of those properties are made WRITABLE by BACnetStack_SetAlarmsAndEventsForObjectEnabled(), so a remote client can change the state afterwards. To genuinely remove an armed algorithm, disable the object with BACnetStack_SetAlarmsAndEventsForObjectEnabled(…, enabled=false). Recommended value: true

Returns

True on success; false if the device or object does not exist, the object type does not support this algorithm, or Alarm-and-Event support was not compiled (STACK_OPTION_ALARMS_AND_EVENTS).

Topic: Alarms and events. Declared in CASBACnetStackDLL.h.