8.17 EquipmentModuleLiveStatusType ObjectType

8.17.1 Overview

The EquipmentModuleLiveStatusType ObjectType contains information about the real time status of the equipment module and provides affordances to control the control module remotely in real time.

The EquipmentModuleLiveStatusType is formally defined in the following table.

Table 67 – EquipmentModuleLiveStatusType Definition
Attribute Value
BrowseNameEquipmentModuleLiveStatusType
IsAbstractFalse
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:HasComponentMethodAcknowledgeAlarmsSee below.O
0:HasComponentObjectAlarms0:FolderTypeM
0:HasPropertyVariableControlModeControlModeEnumeration0:PropertyTypeM, RW
0:HasComponentObjectData0:FolderTypeO
0:HasComponentMethodSendCommandSee below.O
0:HasComponentMethodSetControlModeSee below.O
0:HasPropertyVariableStateStateEnumeration0:PropertyTypeM, RO
0:HasComponentObjectStateMachineTMCStateMachineTypeO
0:GeneratesEventObjectTypeDiscreteAlarmType
0:GeneratesEventObjectTypeControlModeChangeLogType
0:GeneratesEventObjectTypeStateChangeLogType
Conformance Units
TMC Basic Visualisation and Control
BrowseName Description
AlarmsThe Alarms folder contains alarms of the equipment module.
ControlModeThe ControlMode describes the current control mode of the equipment module.
DataThe Data folder provides additional production data that is not already identified by TMC.
StateThe State Property describes the status of the state machine controlling the equipment module. State provides a subset of the information of the state machine when the latter is implemented.
StateMachineThe state machine describes the current state of the equipment module, the possible transitions, and their conditions.

The components of the EquipmentModuleLiveStatusType have additional subcomponents which are defined in the following table.

Table 68 – EquipmentModuleLiveStatusType Additional Subcomponents
BrowsePath References NodeClass BrowseName DataType TypeDefinition Others
Alarms0:HasComponentObject <Alarm> 0:DiscreteAlarmTypeOP
Data0:HasComponentVariable <DataItem> 0:BaseDataType 0:BaseDataVariableTypeOP, RO

8.17.2 AcknowledgeAlarms Method

The AcknowledgeAlarms method acknowledges the alarms of the equipment module and control modules belonging to it.

The signature of this Method is specified below. Table 69 specifies the Arguments representation.

Signature 

	AcknowledgeAlarms (
	  [out] 	MethodExecutionFeedbackType		ExecutionFeedback);
Table 69 – AcknowledgeAlarms Method Arguments
Argument Description
ExecutionFeedbackThe extended feedback returning a detailed message in case of execution failure.

8.17.3 SendCommand Method

The Method SendCommand sends a command to change the state of the equipment module state machine remotely.

The signature of this Method is specified below. Table 70 specifies the Arguments representation.

Signature 

	SendCommand (
	  [in]  CommandEnumeration				Command,
	  [out] MethodExecutionFeedbackType		ExecutionFeedback);
Table 70 – SendCommand Method Arguments
Argument Description
CommandThe command to be sent to the machine module.
ExecutionFeedbackThe extended feedback returning a detailed message in case of execution failure.

8.17.4 SetControlMode Method

The SetControlMode Method sets the control mode of the equipment module.

The signature of this Method is specified below. Table 71 specifies the Arguments representation.

Signature 

	SetControlMode (
	  [in]  ControlModeEnumeration			ControlMode,
	  [out] MethodExecutionFeedbackType		ExecutionFeedback);
Table 71 – SetControlMode Method Arguments
Argument Description
ControlModeThe control mode to be set to the machine module.
ExecutionFeedbackThe extended feedback returning a detailed message in case of execution failure.