Knowledge base

Definitions

Message Type

A Message Type is a classification system that defines how a specific message should be interpreted and processed within the PLC diagnostic system. It contains essential metadata about the message, including:

  • A unique identifier (ID) for system reference
  • A descriptive label explaining the message's purpose
  • Category classification for grouping similar messages
  • Visual display properties (colors, formatting)
  • Associated downtime type (if applicable)
  • Related message types (e.g., start/stop pairs)

Key Attributes

Attribute Description
ID Unique numerical identifier
Description Human-readable explanation of the message type
Category Broader classification group
Downtime Type Associated downtime classification (if applicable)
End Message Type Reference to the message type that marks the end of this event

Example Message Types

Intake Failed to Retract - Timed Out

Category: Error

Downtime Type: Equipment

Description: Indicates that the intake mechanism failed to return to its starting position within the expected time frame.

Machine Running - Stop Requested

Category: Information

Downtime Type: Operator

Description: Indicates that an operator has initiated a stop sequence while the machine is running.

Screen Battery Low - Change Battery

Category: Warning

Downtime Type: None

Description: Warning message indicating that the display screen's battery needs replacement.

Output Scale Pan Lifted - Hay underneath

Category: Warning

Downtime Type: IdlingAndMinorStops

Description: Indicates that the output scale's accuracy is compromised due to material interference.

Tucker at more than one position - Error

Category: Error

Downtime Type: Equipment

Description: Critical error indicating that the tucker mechanism is reporting multiple positions simultaneously, suggesting a sensor malfunction.

Message Category

A Message Category is a high-level classification system used to group related Message Types together. Categories help organize messages by their general purpose or area of concern within the system.

Standard Categories

Information

General informational messages about normal system operation, status updates, and non-critical notifications.

Warning

Messages indicating potential issues or conditions that require attention but don't immediately affect operation.

Error

Critical messages about system faults, failures, or conditions that require immediate attention.

Statistics

Messages containing performance data, counters, and other numerical measurements of system operation.

Operator Stoppage Reason

Messages specifically related to operator-initiated stops and their associated reasons.

Monitor

Messages used for continuous monitoring of system parameters and conditions.

Diagnostic

Detailed technical messages used for system diagnosis, troubleshooting, and maintenance.

Key Attributes

Attribute Description
ID Unique identifier for the category
Name Human-readable category name
Description Detailed explanation of what the category represents
Default Colors Standard visual styling applied to messages in this category

Item Type

An Item Type defines a specific data point or measurement that can be included within a message. Each Item Type represents a distinct piece of information that the system can track, measure, or record.

Key Attributes

Attribute Description
ID Unique identifier for the item type
Name Human-readable name describing the data point
Data Type The type of data this item represents (e.g., integer, float, string)
Unit The unit of measurement, if applicable (e.g., kg, seconds, count)

Example Item Types

Shift Bale Counter

Data Type: Integer

Unit: Count

Description: Tracks the number of bales processed during a shift.

Operator ID

Data Type: String

Unit: N/A

Description: Unique identifier for the operator currently running the machine.

Input Bale Weight

Data Type: Float

Unit: Kilograms

Description: Weight measurement of incoming bales before processing.

Strapper Cycle Time

Data Type: Float

Unit: Seconds

Description: Time taken to complete one strapping cycle.

Total Shift Weight

Data Type: Float

Unit: Kilograms

Description: Cumulative weight of all processed bales during a shift.

Usage in Messages

Item Types are used within messages to provide specific data points about the system's operation. A single message can contain multiple items, each representing different measurements or values relevant to the event being reported.