Audit Reporter

An Audit Reporter object holds a device’s audit settings. A device that reports auditable actions needs at least one. It says which actions are reported, to whom, and how important they must be to be sent.

Typical uses

• Reporting every property write to a central log
• Auditing only object creation and deletion
• Sending audit notices as confirmed messages
• Limiting audit traffic by priority

Key properties

Property	What it holds
Audit_Level	Sets how much of the device’s activity the reporter audits.
Auditable_Operations	Which operations can be audited by this reporter.
Audit_Priority_Filter	The command priorities whose writes are audited, one bit per priority from 1 to 16.
Issue_Confirmed_Notifications	Chooses between confirmed and unconfirmed audit notices.
Monitored_Objects	The objects, or whole object types, this reporter covers. If two reporters cover an object, the one with the lower instance reports it.
Send_Now	A client writes it to push out any notices that are waiting.

How it behaves

The object may report its own fault conditions, but it applies no event algorithm and no standard fault algorithm.

With the CAS BACnet Stack

Enable it with the STACK_OPTION_OBJECT_TYPE_AUDIT_REPORTER build option. Add each object with BACnetStack_AddObject. You serve its properties through your property callbacks.

Related object types

Audit Log, Notification Class, Device

Properties

The properties ASHRAE 135-2024 clause 12.63 defines for this object type.

How to read the table:

• Conformance is what the standard asks of every object of this type: R is required, W is required and writable by a client, O is optional. A digit after the letter marks a condition in the standard that decides when the property is present or writable, such as support for intrinsic reporting.
• Present by default: yes means the stack presents the property as soon as you add the object; no means it is optional and you turn it on with BACnetStack_SetPropertyEnabled. This is the stack’s starting setup, so it can differ from the conformance code.
• Writable is whether a client can write the property by default. Change it with BACnetStack_SetPropertyWritable.
• not in profile means the stack does not offer this property for this object type.
• Value when your callback does not answer: “Held by the stack” means the stack stores and serves the value itself and does not ask your callbacks. Otherwise it is the value the stack answers when your callback declines or is not registered.

Property	Datatype	Conformance	Present by default	Writable	Value when your callback does not answer
Object_Identifier	BACnetObjectIdentifier	R	yes	no	Held by the stack.
Object_Name	CharacterString	R	yes	no	"Object <type>,<instance>", such as "Object 0,1" for Analog Input 1.
Object_Type	BACnetObjectType	R	yes	no	Held by the stack.
Description	CharacterString	O	no	no	""
Status_Flags	BACnetStatusFlags	R	yes	no	Built by the stack from your callbacks.
Reliability	BACnetReliability	R	yes	no	0
Event_State	BACnetEventState	R	yes	no	0
Audit_Level	BACnetAuditLevel	R	yes	no	0
Audit_Source_Reporter	Boolean	R	yes	no	false
Auditable_Operations	BACnetAuditOperationFlags	R	yes	no	An empty bit string.
Audit_Priority_Filter	BACnetPriorityFilter	R	yes	no	An empty bit string.
Issue_Confirmed_Notifications	Boolean	R	yes	no	false
Monitored_Objects	BACnetARRAY[N] of BACnetObjectSelector	O	no	no	No default: the read fails.
Maximum_Send_Delay	Unsigned	O1,2	no	yes	0
Send_Now	Boolean	O1,2	no	yes	false
Event_Detection_Enable	Boolean	O3,5	no	no	false
Notification_Class	Unsigned	O3,5	no	no	0
Event_Enable	BACnetEventTransitionBits	O3,5	no	no	An empty bit string.
Acked_Transitions	BACnetEventTransitionBits	O3,5	no	no	An empty bit string.
Notify_Type	BACnetNotifyType	O3,5	no	no	0
Event_Time_Stamps	BACnetARRAY[3] of BACnetTimeStamp	O3,5	no	no	No default: the read fails.
Event_Message_Texts	BACnetARRAY[3] of CharacterString	O4,5	no	no	""
Event_Message_Texts_Config	BACnetARRAY[3] of CharacterString	O5	no	no	""
Reliability_Evaluation_Inhibit	Boolean	O	no	no	false
Property_List	BACnetARRAY[N] of BACnetPropertyIdentifier	R	yes	no	Held by the stack.
Tags	BACnetARRAY[N] of BACnetNameValue	O	no	no	No default: the read fails.
Profile_Location	CharacterString	O	no	no	""
Profile_Name	CharacterString	O	no	no	""