8.22 ControlModuleLiveStatusType ObjectType
8.22.1 Overview
The ControlModuleLiveStatusType ObjectType contains information about the real time status of the control module and provides affordances to control the control module remotely in real time.
The ControlModuleLiveStatusType is formally defined in the following table.
| Attribute | Value | ||||
| BrowseName | ControlModuleLiveStatusType | ||||
| IsAbstract | False | ||||
| References | Node Class | BrowseName | DataType | TypeDefinition | Other |
|---|---|---|---|---|---|
| Subtype of the BaseObjectType defined in OPC 10000-5 - Part 5: Information Model, i.e. inheriting the Instance Declarations of that Node. | |||||
| 0:HasComponent | Method | AcknowledgeAlarms | See below. | O | |
| 0:HasComponent | Object | Alarms | 0:FolderType | M | |
| 0:HasProperty | Variable | ControlMode | ControlModeEnumeration | 0:PropertyType | M, RW |
| 0:HasComponent | Object | Data | 0:FolderType | O | |
| 0:HasComponent | Object | Interlocks | 0:FolderType | O | |
| 0:HasComponent | Object | Measurements | 0:FolderType | O | |
| 0:HasComponent | Object | ProcessControlLoops | 0:FolderType | O | |
| 0:HasComponent | Method | SendCommand | See below. | O | |
| 0:HasComponent | Method | SetControlMode | See below. | O | |
| 0:HasProperty | Variable | State | StateEnumeration | 0:PropertyType | M, RO |
| 0:HasComponent | Object | StateMachine | TMCStateMachineType | O | |
| 0:GeneratesEvent | ObjectType | ControlModeChangeLogType | |||
| 0:GeneratesEvent | ObjectType | DiscreteAlarmType | |||
| 0:GeneratesEvent | ObjectType | StateChangeLogType | |||
| Conformance Units | |||||
|---|---|---|---|---|---|
| TMC Basic Visualisation and Control |
| BrowseName | Description |
| Alarms | The Alarms folder provides alarms of the control module. |
| ControlMode | The ControlMode describes the current control mode of the equipment module. |
| Data | The Data folder contains additional data whose structure and name are not known in advance. |
| Interlocks | The Interlocks Folder provides the interlocks that, when not True, do not allow the operation of the control module. |
| Measurements | The Measurement Folder provides measurement values produced by the control module that do not require a dedicated process item e.g., actual motor current. |
| ProcessControlLoops | The ProcessControlLoops Folder contains regulation systems of the control module e.g., servo drives. |
| State | The State Property describes the status of the state machine controlling the control module. State provides a subset of the information of the state machine, when the latter is implemented. |
| StateMachine | The StateMachine describes the current state of the control module, the possible transitions, and their conditions. |
The components of the ControlModuleLiveStatusType have additional subcomponents which are defined in the following table.
| BrowsePath | References | NodeClass | BrowseName | DataType | TypeDefinition | Others |
| Alarms | 0:HasComponent | Object | <Alarm> | 0:DiscreteAlarmType | OP | |
| Data | 0:HasComponent | Variable | <DataItem> | 0:BaseDataType | 0:BaseDataVariableType | OP, RO |
| Interlocks | 0:HasComponent | Variable | <InterlockConditionItem> | 0:Boolean | 0:BaseDataVariableType | OP, RO |
| Measurements | 0:HasComponent | Variable | <MeasurementItem> | 0:Number | 0:AnalogItemType | OP, RO |
| ProcessControlLoops | 0:HasComponent | Object | <ProcessControlLoop> | ProcessControlLoopType | OP |
8.22.2 AcknowledgeAlarms Method
The AcknowledgeAlarms Method acknowledges the alarms of the control module.
The signature of this Method is specified below. Table 79 specifies the Arguments representation.
Signature
AcknowledgeAlarms (
[out] MethodExecutionFeedbackType ExecutionFeedback);| Argument | Description |
| ExecutionFeedback | The extended feedback returning a detailed message in case of execution failure. |
8.22.3 SendCommand Method
The Method SendCommand sends a command to change the state of the control module state machine remotely.
The signature of this Method is specified below. Table 80 specifies the Arguments representation.
Signature
SendCommand (
[in] CommandEnumeration Command,
[out] MethodExecutionFeedbackType ExecutionFeedback);| Argument | Description |
| Command | The command to be sent to the machine module. |
| ExecutionFeedback | The extended feedback returning a detailed message in case of execution failure. |
8.22.4 SetControlMode Method
The SetControlMode Method sets the control mode of the control module.
The signature of this Method is specified below. Table 81 specifies the Arguments representation.
Signature
SetControlMode (
[in] ControlModeEnumeration ControlMode,
[out] MethodExecutionFeedbackType ExecutionFeedback);| Argument | Description |
| ControlMode | The control mode to be set to the machine module. |
| ExecutionFeedback | The extended feedback returning a detailed message in case of execution failure. |