BACnetStack_SendLifeSafetyOperation

bool BACnetStack_SendLifeSafetyOperation(
  uint8_t * sentInvokeId,
  const uint32_t requestingProcessIdentifier,
  const char * requestingSource,
  const uint8_t requestingSourceLength,
  const uint8_t requestOperation,
  const bool useObjectIdentifier,
  const uint16_t objectType,
  const uint32_t objectInstance,
  const uint8_t * connectionString,
  const uint8_t connectionStringLength,
  const uint32_t networkPortInstance,
  const uint16_t destinationNetwork,
  const uint8_t * destinationAddress,
  const uint8_t destinationAddressLength,
  const uint8_t requestingSourceEncoding);

Sends a confirmed LifeSafetyOperation request, commanding a life-safety operation (e.g. silence, reset) on a remote device, optionally targeted at a specific Life Safety Point/Zone object.

Note

Requires the STACK_OPTION_DM_LSO_LIFE_SAFETY_OPERATION build option (it turns on STACK_OPTION_LIFE_SAFETY_OPERATION, the macro this function checks).

See also: Client response hooks

BACnet reference: ANSI/ASHRAE 135-2024 clause 13.13 (LifeSafetyOperation Service).

Parameters

Parameter	Direction	Description
sentInvokeId	out	The invoke-id of the sent request, valid only if this function returns true.
requestingProcessIdentifier	in	The process identifier of the requester.
requestingSource	in	Identifies the requesting source, e.g. an operator name. REQUIRED - NULL makes this call return false.
requestingSourceLength	in	The exact byte count of requestingSource, taken by pointer-and-length rather than by strlen.
requestOperation	in	The BACnetLifeSafetyOperation to perform. 0..9 are the standard operations and 64..255 are proprietary; THE RESERVED RANGE 10..63 IS REJECTED and this function returns false without sending anything.
useObjectIdentifier, objectType, objectInstance	in	If useObjectIdentifier is true, target this specific object; otherwise the operation targets the device as a whole. The type and instance are one BACnet Object Identifier carried as two parameters (see the API conventions).
connectionString, connectionStringLength	in	The datalink address to send TO (the destination) - not the local address to send from. For IPv4 this is 6 bytes: 4 octets of IPv4 address followed by 2 octets of port, big-endian (e.g. 0xC0,0xA8,0x01,0x05,0xBA,0xC0 = 192.168.1.5:47808; see BACnetStack_SendRegisterForeignDevice() for a worked example); on BACnet/IPv4 the stack refuses to send to a connection string of any other length, except that a broadcast from a device registered as a foreign device goes to its BBMD and does not use the connection string. MS/TP and BACnet/SC use a different connection-string shape; see their respective Set/Send exports.
networkPortInstance	in	The Network Port object instance to send the message on, or BACNET_NETWORK_PORT_DEFAULT (4194303) for the default/single port.
destinationNetwork, destinationAddress, destinationAddressLength	in	The destination to send the request to.
requestingSourceEncoding	in	The character set requestingSource is encoded in (135-2024 cl. 20.2.9): 0 = ANSI X3.4/UTF-8, 1 = IBM/Microsoft DBCS, 2 = JIS X 0208, 3 = ISO 10646 UCS-4, 4 = ISO 10646 UCS-2, 5 = ISO 8859-1. A non-UTF-8 encoding changes byte-level matching/rendering on the peer.

Returns

True if the request was sent, otherwise false.

Topic: Client requests. Declared in CASBACnetStackDLL.h.