8.4 MachineModuleLiveStatusType ObjectType
8.4.1 Overview
The MachineModuleLiveStatusType ObjectType contains information about the real time status of the machine module and provides affordances to control the machine module remotely in real time.
The MachineModuleLiveStatusType is formally defined in the following table.
| Attribute | Value | ||||
| BrowseName | MachineModuleLiveStatusType | ||||
| 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. | M | |
| 0:HasComponent | Object | Alarms | 0:FolderType | M | |
| 0:HasProperty | Variable | ControlMode | ControlModeEnumeration | 0:PropertyType | M, RW |
| 0:HasComponent | Object | Data | 0:FolderType | O | |
| 0:HasProperty | Variable | IdleEnergySavingMode | 0:Boolean | 0:PropertyType | M, RW |
| 0:HasComponent | Method | ResetAggregates | See below. | M | |
| 0:HasComponent | Method | SendCommand | See below. | M | |
| 0:HasComponent | Method | SetControlMode | See below. | M | |
| 0:HasComponent | Method | SetIdleEnergySavingMode | See below. | M | |
| 0:HasProperty | Variable | State | StateEnumeration | 0:PropertyType | M, RO |
| 0:HasComponent | Object | StateMachine | TMCStateMachineType | O | |
| 0:GeneratesEvent | ObjectType | ControlModeChangeLogType | |||
| 0:GeneratesEvent | ObjectType | 0:DiscreteAlarmType | |||
| 0:GeneratesEvent | ObjectType | DowntimeLogType | |||
| 0:GeneratesEvent | ObjectType | ExternalAlarmType | |||
| 0:GeneratesEvent | ObjectType | StateChangeLogType | |||
| Conformance Units | |||||
|---|---|---|---|---|---|
| TMC Basic Machine Status | |||||
| TMC Advanced Machine Status |
| BrowseName | Description |
| ControlMode | The ControlMode property describes the current control mode of the machine. |
| IdleEnergySavingMode | The IdleEnergySavingMode Property is set to True when the energy saving mode during the idle phase is set. |
| State | The Property State describes the status of the state machine controlling the machine module. State provides a subset of the information of the state machine, when the latter is implemented. |
| StateMachine | The state machine describes the current state of the machine, the possible transitions and their conditions. |
| Alarms | The Alarms folder contains alarms of the machine module. |
| Data | The Data Folder contains additional data that is not identified elsewhere in this specification. |
The components of the MachineModuleLiveStatusType 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 | |
| Alarms | 0:HasComponent | Object | <ExternalAlarm> | ExternalAlarmType | OP | |
| Data | 0:HasComponent | Variable | <DataItem> | 0:BaseDataType | 0:BaseDataVariableType | OP, RO |
8.4.2 AcknowledgeAlarms Method
The AcknowledgeAlarms Method acknowledges all alarms of the machine module. The acknowledgement is cascades to other objects belonging to the machine module e.g., equipment modules and control modules.
The signature of this Method is specified below. Table 24 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.4.3 ResetAggregates Method
The ResetAggregates resets all the aggregates for the objects contained in the ProcessItems and ProcessControlLoops of the machine module.
The signature of this Method is specified below. Table 25 specifies the Arguments representation.
Signature
ResetAggregates (
[out] MethodExecutionFeedbackType ExecutionFeedback);| Argument | Description |
| ExecutionFeedback | The extended feedback returning a detailed message in case of execution failure. |
8.4.4 SendCommand Method
The Method SendCommand sends a command to change the state of the machine module state machine remotely.
The signature of this Method is specified below. Table 26 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.4.5 SetControlMode Method
The SetControlMode Method sets the control mode of the machine module.
The signature of this Method is specified below. Table 27 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. |
8.4.6 SetIdleEnergySavingMode Method
The Method SetIdleEnergySavingMode activates the energy saving mode when the machine module is idle.
The signature of this Method is specified below. Table 28 specifies the Arguments representation.
Signature
SetIdleEnergySavingMode (
[in] 0:Boolean IdleEnergySavingMode,
[out] MethodExecutionFeedbackType ExecutionFeedback);| Argument | Description |
| IdleEnergySavingMode | The energy saving mode to set. |
| ExecutionFeedback | The extended feedback returning a detailed message in case of execution failure. |