HumanOS MDE Model
This chapter specifies the basic MDE interface. An extended MDE interface is conceivable in the future.
DataNodes
The following data nodes must always be present so that a device has a valid MDE interface. If the controller does not allow to read the data item, the state is BadNotActive.
AlarmState
General informations:
| Information | Description |
|---|---|
| Content of value | Controller specific alarm state id |
| Group in Device.json | root/Controller |
Data Node settings:
| Setting | Value |
|---|---|
| Name | AlarmState |
| Data class | Event |
| Data type | System.Int32 |
| Unit | |
| Mandatory data access | read, receive |
| Default history access | disabled |
Mandatory properties:
| Property Name | Data Type | Value | Description |
|---|---|---|---|
| PortMatchId | System.String | AlarmStateType | Processing port match id. |
Available
General informations:
| Information | Description |
|---|---|
| Content of value | 0 = unavailable, 1 = available |
| Group in Device.json | root |
Data Node settings:
| Setting | Value |
|---|---|
| Name | Available |
| Data class | Event |
| Data type | System.Int32 |
| Unit | |
| Mandatory data access | read, receive |
| Default history access | disabled |
Mandatory properties:
| Property Name | Data Type | Value | Description |
|---|---|---|---|
| EnableAzureIoT | System.Boolean | true | Enables the datanode for azure IoT client data logger plugin |
| EnableInflux | System.Boolean | true | Enables the datanode for influx database data logger plugin |
| EnableMqtt | System.Boolean | true | Enables the datanode for mqtt data logger plugin |
| EnableRest | System.Boolean | true | Enables the datanode for rest data logger plugin |
| EnableRmq | System.Boolean | true | Enables the datanode for rabbit message queue data logger plugin |
| mtc:DataItemId | System.String | Lavail | MtConnect data item id availability |
| mtc:InformationType | System.String | AVAILABILITY | MtConnect information type availability |
| mtc:Values | System.String | 1=AVAILABLE;*=NOT_AVAILABLE | MtConnect value mapping for availability |
| PortMatchId | System.String | AvailableType | Processing port match id. |
CurrentFeed
General informations:
| Information | Description |
|---|---|
| Content of value | Current feed |
| Group in Device.json | root/Controller/NCPath(x) |
Data Node settings:
| Setting | Value |
|---|---|
| Name | CurrentFeed |
| Data class | Stream |
| Data type | System.Double |
| Unit | mm/min |
| Mandatory data access | read, receive |
| Default history access | disabled |
Mandatory properties:
| Property Name | Data Type | Value | Description |
|---|---|---|---|
| mtc:DataItemId | System.String | cf | MtConnect data item id current feed |
| mtc:InformationSubType | System.String | ACTUAL | MtConnect information sub type current feed |
| mtc:InformationType | System.String | PATH_FEEDRATE | MtConnect information type current feed |
CurrentNcBlock
General informations:
| Information | Description |
|---|---|
| Content of value | Current NC Block line of the executing program |
| Group in Device.json | root/Controller/NCPath(x) |
Data Node settings:
| Setting | Value |
|---|---|
| Name | CurrentNcBlock |
| Data class | Event |
| Data type | System.String |
| Unit | |
| Mandatory data access | read, receive |
| Default history access | disabled |
There are no mandatory properties for the data node CurrentNcBlock.
CurrentProgram
General informations:
| Information | Description |
|---|---|
| Content of value | Name of the current program specified by controller |
| Group in Device.json | root/Controller/NCPath(x) |
Data Node settings:
| Setting | Value |
|---|---|
| Name | CurrentProgram |
| Data class | Event |
| Data type | System.String |
| Unit | |
| Mandatory data access | read, receive |
| Default history access | disabled |
Mandatory properties:
| Property Name | Data Type | Value | Description |
|---|---|---|---|
| mtc:DataItemId | System.String | Lpprogram | MtConnect data item id program |
| mtc:InformationSubType | System.String | x:ACTUAL | MtConnect information sub type actual program |
| mtc:InformationType | System.String | PROGRAM | MtConnect information type program |
| PortMatchId | System.String | CurrentProgramType | Processing port match id. |
CurrentSequenceNr
General informations:
| Information | Description |
|---|---|
| Content of value | Current sequence number of the executing program |
| Group in Device.json | root/Controller/NCPath(x) |
Data Node settings:
| Setting | Value |
|---|---|
| Name | CurrentSequenceNr |
| Data class | Event |
| Data type | System.String |
| Unit | |
| Mandatory data access | read, receive |
| Default history access | disabled |
Mandatory properties:
| Property Name | Data Type | Value | Description |
|---|---|---|---|
| mtc:DataItemId | System.String | seq | MtConnect data item id sequence number |
| mtc:InformationType | System.String | SEQUENCE_NUMBER | MtConnect information type sequence number |
CurrentSpindleSpeed
General informations:
| Information | Description |
|---|---|
| Content of value | Current spindle speed |
| Group in Device.json | root/Controller/NCPath(x) |
Data Node settings:
| Setting | Value |
|---|---|
| Name | CurrentSpindleSpeed |
| Data class | Stream |
| Data type | System.Double |
| Unit | 1/min |
| Mandatory data access | read, receive |
| Default history access | disabled |
Mandatory properties:
| Property Name | Data Type | Value | Description |
|---|---|---|---|
| mtc:DataItemId | System.String | Srpm | MtConnect data item id current spindle speed |
| mtc:InformationSubType | System.String | ACTUAL | MtConnect information sub type current spindle speed |
| mtc:InformationType | System.String | ROTARY_VELOCITY | MtConnect information type current spindle speed |
CurrentToolId
General informations:
| Information | Description |
|---|---|
| Content of value | Current tool identifier |
| Group in Device.json | root/Controller/NCPath(x) |
Data Node settings:
| Setting | Value |
|---|---|
| Name | CurrentToolId |
| Data class | Event |
| Data type | System.String |
| Unit | |
| Mandatory data access | read, receive |
| Default history access | disabled |
Mandatory properties:
| Property Name | Data Type | Value | Description |
|---|---|---|---|
| mtc:DataItemId | System.String | tid | MtConnect data item id current tool id |
| mtc:InformationType | System.String | TOOL_NUMBER | MtConnect information type current tool id |
CuttingTime
General informations:
| Information | Description |
|---|---|
| Content of value | total time the machine was cutting |
| Group in Device.json | root/Controller |
Data Node settings:
| Setting | Value |
|---|---|
| Name | CuttingTime |
| Data class | Stream |
| Data type | System.Double |
| Unit | min |
| Mandatory data access | read, receive |
| Default history access | disabled |
Mandatory properties:
| Property Name | Data Type | Value | Description |
|---|---|---|---|
| mtc:DataItemId | System.String | tcltime | MtConnect data item id cutting time |
| mtc:InformationSubType | System.String | x:TOTALCUTTIME | MtConnect information sub type cutting time |
| mtc:InformationType | System.String | ACCUMULATED_TIME | MtConnect information type cutting time |
FeedrateOverride
General informations:
| Information | Description |
|---|---|
| Content of value | Feedrate override potentiometer percent |
| Group in Device.json | root/Controller |
Data Node settings:
| Setting | Value |
|---|---|
| Name | FeedrateOverride |
| Data class | Event |
| Data type | System.Double |
| Unit | % |
| Mandatory data access | read, receive |
| Default history access | disabled |
Mandatory properties:
| Property Name | Data Type | Value | Description |
|---|---|---|---|
| mtc:DataItemId | System.String | LpFovr | MtConnect data item id feedrate override |
| mtc:InformationType | System.String | PATH_FEEDRATE_OVERRIDE | MtConnect information type feedrate override |
| PortMatchId | System.String | FeedrateOverrideType | Processing port match id. |
MainProgram
General informations:
| Information | Description |
|---|---|
| Content of value | Name of the main program specified by controller |
| Group in Device.json | root/Controller/NCPath(x) |
Data Node settings:
| Setting | Value |
|---|---|
| Name | MainProgram |
| Data class | Event |
| Data type | System.String |
| Unit | |
| Mandatory data access | read, receive |
| Default history access | disabled |
Mandatory properties:
| Property Name | Data Type | Value | Description |
|---|---|---|---|
| EnableAzureIoT | System.Boolean | true | Enables the datanode for azure IoT client data logger plugin |
| EnableInflux | System.Boolean | true | Enables the datanode for influx database data logger plugin |
| EnableMqtt | System.Boolean | true | Enables the datanode for mqtt data logger plugin |
| EnableRest | System.Boolean | true | Enables the datanode for rest data logger plugin |
| EnableRmq | System.Boolean | true | Enables the datanode for rabbit message queue data logger plugin |
| PortMatchId | System.String | MainProgramType | Processing port match id. |
MainProgramHeader
General informations:
| Information | Description |
|---|---|
| Content of value | Header of the main program |
| Group in Device.json | root/Controller/NCPath(x) |
Data Node settings:
| Setting | Value |
|---|---|
| Name | MainProgramHeader |
| Data class | Event |
| Data type | System.String |
| Unit | |
| Mandatory data access | read, receive |
| Default history access | disabled |
Mandatory properties:
| Property Name | Data Type | Value | Description |
|---|---|---|---|
| mtc:Ignore | System.Boolean | true | Disables the node for MtConnect |
| PortMatchId | System.String | MainProgramHeaderType | Processing port match id. |
OperationMode
General informations:
| Information | Description |
|---|---|
| Content of value | Controller specific operation mode id (mdi, manual, auto, ...) |
| Group in Device.json | root/Controller |
Data Node settings:
| Setting | Value |
|---|---|
| Name | OperationMode |
| Data class | Event |
| Data type | System.Int32 |
| Unit | |
| Mandatory data access | read, receive |
| Default history access | disabled |
Mandatory properties:
| Property Name | Data Type | Value | Description |
|---|---|---|---|
| EnableAzureIoT | System.Boolean | true | Enables the datanode for azure IoT client data logger plugin |
| EnableInflux | System.Boolean | true | Enables the datanode for influx database data logger plugin |
| EnableMqtt | System.Boolean | true | Enables the datanode for mqtt data logger plugin |
| EnableRest | System.Boolean | true | Enables the datanode for rest data logger plugin |
| EnableRmq | System.Boolean | true | Enables the datanode for rabbit message queue data logger plugin |
| mtc:DataItemId | System.String | Lpmode | MtConnect data item id controller mode |
| mtc:InformationType | System.String | CONTROLLER_MODE | MtConnect information type controller mode |
| mtc:Values | System.String | (x)=MANUAL_DATA_INPUT;(x)=AUTOMATIC;*=MANUAL | MtConnect value mapping for controller mode. CAUTION: (x) must equal the operation mode number of the controller |
| PortMatchId | System.String | OperationModeType | Processing port match id. |
OperationTime
General informations:
| Information | Description |
|---|---|
| Content of value | total time a program was running |
| Group in Device.json | root/Controller |
Data Node settings:
| Setting | Value |
|---|---|
| Name | OperationTime |
| Data class | Stream |
| Data type | System.Double |
| Unit | min |
| Mandatory data access | read, receive |
| Default history access | disabled |
Mandatory properties:
| Property Name | Data Type | Value | Description |
|---|---|---|---|
| mtc:DataItemId | System.String | atime | MtConnect data item id operation time |
| mtc:InformationSubType | System.String | x:AUTO | MtConnect information sub type operation time |
| mtc:InformationType | System.String | ACCUMULATED_TIME | MtConnect information type operation time |
PartCounter
General informations:
| Information | Description |
|---|---|
| Content of value | total number of machined parts |
| Group in Device.json | root/Controller |
Data Node settings:
| Setting | Value |
|---|---|
| Name | PartCounter |
| Data class | Event |
| Data type | System.Int32 |
| Unit | |
| Mandatory data access | read, receive |
| Default history access | disabled |
Mandatory properties:
| Property Name | Data Type | Value | Description |
|---|---|---|---|
| EnableAzureIoT | System.Boolean | true | Enables the datanode for azure IoT client data logger plugin |
| EnableInflux | System.Boolean | true | Enables the datanode for influx database data logger plugin |
| EnableMqtt | System.Boolean | true | Enables the datanode for mqtt data logger plugin |
| EnableRest | System.Boolean | true | Enables the datanode for rest data logger plugin |
| EnableRmq | System.Boolean | true | Enables the datanode for rabbit message queue data logger plugin |
| mtc:DataItemId | System.String | pc | MtConnect data item id part counter |
| mtc:InformationType | System.String | PART_COUNT | MtConnect information type part counter |
| PortMatchId | System.String | PartCounterType | Processing port match id. |
PowerOnTime
General informations:
| Information | Description |
|---|---|
| Content of value | total time the controller was switched on |
| Group in Device.json | root/Controller |
Data Node settings:
| Setting | Value |
|---|---|
| Name | PowerOnTime |
| Data class | Stream |
| Data type | System.Double |
| Unit | min |
| Mandatory data access | read, receive |
| Default history access | disabled |
Mandatory properties:
| Property Name | Data Type | Value | Description |
|---|---|---|---|
| mtc:DataItemId | System.String | yltime | MtConnect data item id power on time |
| mtc:InformationSubType | System.String | x:TOTAL | MtConnect information sub type power on time |
| mtc:InformationType | System.String | ACCUMULATED_TIME | MtConnect information type power on time |
ProgrammedFeed
General informations:
| Information | Description |
|---|---|
| Content of value | Programmed feed |
| Group in Device.json | root/Controller/NCPath(x) |
Data Node settings:
| Setting | Value |
|---|---|
| Name | ProgrammedFeed |
| Data class | Event |
| Data type | System.Double |
| Unit | mm/min |
| Mandatory data access | read, receive |
| Default history access | disabled |
Mandatory properties:
| Property Name | Data Type | Value | Description |
|---|---|---|---|
| mtc:DataItemId | System.String | pf | MtConnect data item id programmed feedrate |
| mtc:InformationSubType | System.String | COMMANDED | MtConnect information sub type programmed feedrate |
| mtc:InformationType | System.String | PATH_FEEDRATE | MtConnect information type programmed feedrate |
ProgrammedSpindleSpeed
General informations:
| Information | Description |
|---|---|
| Content of value | Programmed spindle speed |
| Group in Device.json | root/Controller/NCPath(x) |
Data Node settings:
| Setting | Value |
|---|---|
| Name | ProgrammedSpindleSpeed |
| Data class | Event |
| Data type | System.Double |
| Unit | 1/min |
| Mandatory data access | read, receive |
| Default history access | disabled |
Mandatory properties:
| Property Name | Data Type | Value | Description |
|---|---|---|---|
| mtc:DataItemId | System.String | psrpm | MtConnect data item id programmed spindle speed |
| mtc:InformationSubType | System.String | COMMANDED | MtConnect information sub type programmed spindle speed |
| mtc:InformationType | System.String | ROTARY_VELOCITY | MtConnect information type programmed spindle speed |
RunningState
General informations:
| Information | Description |
|---|---|
| Content of value | Controller specific running state id of cnc program (stopped, running, hold) |
| Group in Device.json | root/Controller |
Data Node settings:
| Setting | Value |
|---|---|
| Name | RunningState |
| Data class | Event |
| Data type | System.Int32 |
| Unit | |
| Mandatory data access | read, receive |
| Default history access | disabled |
Mandatory properties:
| Property Name | Data Type | Value | Description |
|---|---|---|---|
| EnableAzureIoT | System.Boolean | true | Enables the datanode for azure IoT client data logger plugin |
| EnableInflux | System.Boolean | true | Enables the datanode for influx database data logger plugin |
| EnableMqtt | System.Boolean | true | Enables the datanode for mqtt data logger plugin |
| EnableRest | System.Boolean | true | Enables the datanode for rest data logger plugin |
| EnableRmq | System.Boolean | true | Enables the datanode for rabbit message queue data logger plugin |
| mtc:DataItemId | System.String | Lpexecution | MtConnect data item id execution |
| mtc:InformationType | System.String | EXECUTION | MtConnect information type execution |
| mtc:Values | System.String | (x)=FEED_HOLD;x=ACTIVE;*=PROGRAM_STOPPED | MtConnect value mapping for running state. CAUTION: (x) must equal the running state number of the controller |
| PortMatchId | System.String | Type | Processing port match id. |
SignOfLife
General informations:
| Information | Description |
|---|---|
| Content of value | 0 or 1, alternately in 1Hz cycle |
| Group in Device.json | root |
Data Node settings:
| Setting | Value |
|---|---|
| Name | SignOfLife |
| Data class | Event |
| Data type | System.Int32 |
| Unit | |
| Mandatory data access | read, receive |
| Default history access | disabled |
Mandatory properties:
| Property Name | Data Type | Value | Description |
|---|---|---|---|
| EnableAzureIoT | System.Boolean | true | Enables the datanode for azure IoT client data logger plugin |
| EnableInflux | System.Boolean | true | Enables the datanode for influx database data logger plugin |
| EnableMqtt | System.Boolean | true | Enables the datanode for mqtt data logger plugin |
| EnableRest | System.Boolean | true | Enables the datanode for rest data logger plugin |
| EnableRmq | System.Boolean | true | Enables the datanode for rabbit message queue data logger plugin |
SpindleOverride
General informations:
| Information | Description |
|---|---|
| Content of value | Spindle rotational speed override potentiometer percent |
| Group in Device.json | root/Controller |
Data Node settings:
| Setting | Value |
|---|---|
| Name | SpindleOverride |
| Data class | Event |
| Data type | System.Double |
| Unit | % |
| Mandatory data access | read, receive |
| Default history access | disabled |
Mandatory properties:
| Property Name | Data Type | Value | Description |
|---|---|---|---|
| mtc:InformationType | System.String | ROTARY_VELOCITY_OVERRIDE | MtConnect information type spindle override |
| mtc:DataItemId | System.String | LpSovr | MtConnect data item id spindle override |
| PortMatchId | System.String | SpindleOverrideType | Processing port match id. |
Other Node types
The following group nodes must always be present so that a device has a valid MDE interface.
DeviceNode
General informations:
| Information | Description |
|---|---|
| Node type | GroupNode |
| Group content | This is the device node itself. Contains all nodes of the device |
| Group in Device.json |
Data Node settings:
| Setting | Value |
|---|---|
| Name | Must equal the name of the plugin without HumanOS.UHAL. |
| Default history access | disabled |
Mandatory properties:
| Property Name | Data Type | Value | Description |
|---|---|---|---|
| Description | System.String | OEE correlation for (x) machines | Description for the device plugin. CAUTION: (x) must be a suitable name for the controller |
Controller
General informations:
| Information | Description |
|---|---|
| Node type | GroupNode |
| Group content | Contains all datanodes of the cnc controller. |
| Group in Device.json | root |
Data Node settings:
| Setting | Value |
|---|---|
| Name | Controller |
| Default history access | disabled |
Mandatory properties:
| Property Name | Data Type | Value | Description |
|---|---|---|---|
| mtc:ComponentId | System.String | Lct1 | MtConnect component id of controller |
| mtc:ComponentName | System.String | Controller | MtConnect component name of controller |
NCPath(x)
General informations:
| Information | Description |
|---|---|
| Node type | GroupNode |
| Group content | Contains all datanodes of the nc channel. |
| Group in Device.json | root |
Data Node settings:
| Setting | Value |
|---|---|
| Name | NCPath(x) |
| Default history access | disabled |
Mandatory properties:
| Property Name | Data Type | Value | Description |
|---|---|---|---|
| mtc:ComponentId | System.String | Lp(x) | MtConnect component id of nc channel. CAUTION: (x) must equal the nc path index. |
| mtc:ComponentName | System.String | Path | MtConnect component name of nc path |
MachineAlarming
General informations:
| Information | Description |
|---|---|
| Node type | AlarmingNode |
| Group content | Contains all alarm and event tasks. |
| Group in Device.json | root |
Data Node settings:
| Setting | Value |
|---|---|
| Name | MachineAlarming |
| Default history access | SamplingRate = 2000, Retention = 720 |
Mandatory properties:
| Property Name | Data Type | Value | Description |
|---|---|---|---|
| EnableAzureIoT | System.Boolean | true | Enables the datanode for azure IoT client data logger plugin |
| EnableInflux | System.Boolean | true | Enables the datanode for influx database data logger plugin |
| EnableMqtt | System.Boolean | true | Enables the datanode for mqtt data logger plugin |
| EnableRest | System.Boolean | true | Enables the datanode for rest data logger plugin |
| EnableRmq | System.Boolean | true | Enables the datanode for rabbit message queue data logger plugin |
| mtc:DataItemId | System.String | Lsystem | MtConnect data item id system |
| mtc:InformationType | System.String | SYSTEM | MtConnect information type system |
| PortMatchId | System.String | MachineAlarmingType | Processing port match id. |