BACnetStack_SetTrendLogTypeToTriggered

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

Sets property values of an existing Trend Log object or Trend Log Multiple Object.

This function should only be called after the AddTrendLogObject or AddTrendLogMultipleObject functions.

This function sets the log object to used the trigger type of logging and users can specify some parameters like if it should be enabled and if logging should stop when full.

Trigger logging occurs when a BACnet client writes to the Trigger property to set it to true. After taking a log, the Trigger property is reset to false

Note

Requires either of the build options STACK_OPTION_T_VMT_TRENDING_VIEWING_AND_MODIFYING_TRENDS or STACK_OPTION_T_VMMV_TRENDING_VIEWING_AND_MODIFYING_MULTIPLE_VALUES.

BACnet reference: ANSI/ASHRAE 135-2024 clause 12.25 (Trend Log Object Type).

Parameters

Parameter	Direction	Description
deviceInstance	in	The instance of the device that contains the Trend Log object.
objectType	in	The type of trend log object. Must be either BACnetObjectType::trendLog or BACnetObjectType::trendLogMultiple. With objectInstance, this is one BACnet Object Identifier carried as two parameters (see the API conventions).
objectInstance	in	The instance of the Trend Log object to update.
enable	in	Whether to enable logging on the Trend Log object (true) or not (false).
stopWhenFull	in	Whether to stop logging when the log buffer is full (true) or not (false).

Returns

True if successful, otherwise false.

Topic: Schedules, calendars, trend logs and other object configuration. Declared in CASBACnetStackDLL.h.