Diagnostics object (Diag)

The Diagnostics (Diag) object allows for the representation of diagnostics and statistics information. This enables operation and monitoring as well as engineering and commissioning functions to access respective data in a unified, standardized way. Objects holding diagnostics and statistics information of data acquisitions are incorporated into the following object structures:

Diag object properties are:

✳ Indicates a Siemens proprietary property.

Present value

 

 

"Present value" refers to an object property that indicates the current virtual value.

State flag

 

 

"State flag" represents four boolean flags ("Out of service", "Overridden", "Fault", "In-Alarm") that indicate the general status of an object.

Reliability

 

 

'Reliability' indicates whether the property value 'Present value' is reliable. If the 'Present value' is not reliable, the property 'Reliability' indicates the cause of the fault and the bit "Fault" of the state indication is set to 'True'. In a normal case, the property 'Reliability' is set to "No fault".

Property ID: 103

Out of service

 

 

"Out of service" allows decoupling the object from being modified by a control program, system program or peripheral device.

  • If "Out of service" is TRUE, the properties "Present value" and "Reliability" will no longer be updated by the respective control program, system program or peripheral device.
  • If "Out of service" is TRUE, the properties "Present value" and "Reliability" can be modified for simulating and testing purposes.
  • If "Out of service" will be changed from FALSE to TRUE, the properties "Present value" and "Reliability" keep their values. Nevertheless, they can be individually modified afterwards.
  • If "Out of service" will be changed from TRUE to FALSE, the properties "Present value" and "Reliability" keep their values. They will be modified by the next update of the producer.

Property ID: 81

I/O address

 

 

"I/O address" identifies and documents the data source, and facilitates configuring, modifying, and querying the assignment in a standardized way.

The content of "I/O address" is technology-specific and includes:

  • Unique selector to identify and document the respective data acquisition. For example, TX-I/O or KNX PL-Link.
  • Unique address to identify the peripheral data source. For example, TX-I/O 3.4.
  • Blank until assigned to a Module.

Diagnostics

 

 

"Diagnostics" allows triggering dedicated commands. "Diagnostics":

  • Is normally 'Ready', meaning that no command is active.
  • Is a volatile variable.

Ready

Ready for a new request

Reset

Request that "Diagnostics values " is reset. The component referenced by I/O-Address will write Ready to "Diagnostics" as soon as the Reset has been performed. The purpose of writing Ready by a data acquisition after Resetting is to clear the property value indicating that resetting has been finished: improve usability of visualization in client.

Main value index

 

 

"Main value index"allows specifying an index of the "Diagnostics values" property values. The item value is used to update the "Present value" property of the object.

Diagnostics values

 

 

"Diagnostics values" includes an ordered list of Item-Values of data type real.

  • An Item_Value specifically indicates a values whose application-oriented purpose is characterized by the respective Item-Annotation.
  • The Item_Annotation may include additional non-number- based diagnostic information.

Diagnostics description

 

 

"Diagnostics description" includes an ordered list of Item_Annotations.

An Item_Annotation specifically describes the application-oriented purpose of the respective Item_Value. Examples include: 'number of messages', 'number of errors' etc.

Units

 

 

'Units' displays the physical unit of 'Present value'.

Property ID: 117

Resolution

 

 

'Resolution' indicates the accuracy that a value represents. It defines the smallest recognizable change in engineering units of the property 'Present value' and be modified online.
'Resolution' is typically used for operating and monitoring functions to represent the 'Present value':
'Resolution' can only be an integer > 1.
'Resolution' is only used for an abbreviated depiction on the display, e.g. a station for operating and monitoring. It is not used to shorten the actual value that is processed by the program.

Property ID: 106

Object access level

 

 

"Object access level" defines the instance-specific object access level. "Object access level" is used for generic filtering and processing an object by a client application.

  • "Object access level" is a configuration property which can only be set up offline (ABT, application configuration).
  • "Object access level" is evaluated by client applications such as Technical Operator, DB-Import, and APOGEE Point Team mapping.

Access level

Name

Description

7

Basic operation

Access to BACnet objects and properties for a room user e.g. data points visible on a room unit.

6

Standard operation

Access to BACnet objects and properties for standard operation and monitoring (daily business), .e.g. room and plant information on a management station.

5

Extended operation

Access to BACnet objects and properties for extended operation and monitoring such as network and device objects. All I/Os are visible

4

Administrator

Not used by HQ solutions yet.

3

Basic service

Access to BACnet objects and properties used for commissioning, e.g. configuration value extensions, I/O extensions, etc.

2

Extended service

Not used by HQ solutions yet.

1

Internal

Access to all BACnet objects and properties for very specialized actions e.g. during development.

Object usage

 

 

"Object usage" indicates whether the object is used or unused. The "Object usage" property can hide or display respective objects and their functionality in a client. For example, room functionality can be marked for flexible room arrangements as used/unused. An object that is marked as unused behaves as if the object does not exist.

Property ID: 4930

Description

 

 

"Description" is a string of printable characters whose content is not restricted.

Object name

 

 

"Object name" represents a name for the object that is unique internetwork-wide. The minimum length of the string is one character. The set of characters used in the "Object name" are restricted to printable characters.

Object identifier

 

 

"Object identifier" is a numeric code that is used to identify the object. It must be unique internetwork-wide.

Object type

 

 

"Object type " indicates membership in a particular object type class. E.g. "Analog input", "Binary output", "Event enrollment", "Trend log", etc.

Building automation profile

 

 

"Building automation profile" is an enumeration that indicates a particular type of Siemens proprietary object. Siemens objects are based on standard BACnet objects. For example, Siemens Analog Input, Analog Output, Analog Calculated Value, and Analog Configuration Value are based on standard Analog Input, Analog Output, and Analog Value BACnet objects.

Profile name

 

 

"Profile name" indicates the name of an object profile to which this object conforms. To ensure uniqueness, a profile name must begin with a vendor identifier code followed by a dash. All subsequent characters are administered by the organization registered with that vendor identifier code. The vendor identifier code that prefixes the profile name indicates the organization that publishes and maintains the profile document named by the remainder of the profile name.

Comment

A string of printable characters whose content is not restricted. (property is only used in ABT Pro)

Version

Version of a copied object (copied from a library). (property is only used in ABT Pro)

Library reference

Source of a copied object (copied from a library). (property is only used in ABT Pro)