Program object (Pgm)

The Program (Pgm) object represents standardized characteristics of a Control Program. Any automating & controlling and/or operating & monitoring function may use the Program object to monitor and manipulate the state of a control program. When programming tool is not available (such as a handheld terminal used for commissioning only), the Program object will be important during commissioning.

The Program object's representation of control programs may depend on the specific type of control programs. However, it is not intended to represent the state of an individual control program application or functional unit. For the purpose of automating & controlling, and operating & monitoring the state of an individual control program application or functional unit, Input, Output, and Value objects will be used. For example, a Value object will be used to manipulate a plant mode or room application mode.

Pgm object properties are:

✳ Indicates a Siemens proprietary property.

Program state

 

 

"Program state" reflects the current logical state of the process running the application program this object represents. The values that can taken on by this property are:

  • IDLE - Process is not running
  • LOADING - Application program being loaded
  • RUNNING - Process is currently running
  • WAITING - Process is waiting for some external event
  • HALTED - Process is halted because of some error condition
  • UNLOADING - Process has been requested to finish

Program change

 

 

"Program change" is used to request changes to the operating state of the process this object represents. The "Program change" property provides one means for changing the operating state of this process. The process can also change its state as a consequence of running. The values that can be taken on by this property are:

  • READY - Ready for change request (the normal state)
  • LOAD - Request that the application program be loaded, if not already loaded
  • RUN - Request that the process begins running
  • HALT - Request that the process stops
  • RESTART - Request that the process restarts at its initialization point
  • UNLOAD - Request that the process stops and unloads

The default value of the property is READY, meaning that the program is ready to accept a new request to change its operating state.

Reason for halt

 

 

"Reason for halt" reflects the reason why the process was halted if the process running the application program encounters any type of error that causes the running of the process. The values that may be taken on by this property are:

NORMAL

Process is not halted due to any error condition.

LOAD_FAILED

The application program could not complete loading.

INTERNAL

Process is halted by some internal mechanism.

PROGRAM

Process is halted by a program change request.

OTHER

Process is halted for some other reason.

Description of halt

 

 

"Description of halt" is a character string used to describe the reason why a program has been halted. This property provides essentially the same information as the "Reason for halt" property, except in a human-readable form. The content of this string is specified locally.

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.

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

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.

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)