RealTimeOutputMachine

📊 Overview: 10 Properties

1 Constructor

6 Functions

16 Getters

📝 Description

Creates real-time output object for displaying machine status on dashboard, calculates colors and metrics

🕐 Last updated: 2026-01-13T16:04:13.174Z

---

📑 Table of Contents

• 📋 Properties (10)
• 🏗️ Constructor (1 param)
• ⚙️ Functions
  • Regular Functions
    • ProcessColors
    • setPrimaryColors (2 params)
    • setAlternatingColors (2 params)
    • setDateTimeColors (2 params)
    • setAlertColors (2 params)
    • setTimeRemainingText (3 params)
  • Computed Attributes (Getters/Setters/Query/OrderBy)
    • AlertsText 🔍 → Text
    • DeviceMaintenanceActive 🔍 → Boolean
    • MachineDisconnected 🔍 → Boolean
    • MachineNumberText 🔍 → Text
    • MachineRunning 🔍 → Boolean
    • MouldStatusText 🔍 → Text
    • PartNameText 🔍 → Text
    • PartsMadeText 🔍 → Text
    • PercentMade 🔍 → Real
    • PrimaryStatusText 🔍 → Text
    • ScrapText 🔍 → Text
    • SecondaryStatusText 🔍 → Object
    • TimeRemainingText 🔍 → Object
    • UnacknowledgedSensorExceptions 🔍 → Boolean
    • UnicodeSymbolsText 🔍 → Text
    • WorksOrderIsOpen 🔍 → Boolean

---

Properties

Property	Type	Default	Description
RealTimeMachinesEntity	cs.RealTimeMachinesEntity	-	Machine being monitored
WorksOrderEntity	cs.WorksOrderEntity	-	Current works order on machine, can be Null if no order active
ProductEntity	cs.ProductEntity	-	Product being manufactured, Null if no order active
ToolsEntity	cs.ToolsEntity	-	Tool being used, Null if no order active
DownReasonsEntity	cs.DownReasonsEntity	-	Current downtime reason if machine stopped, otherwise Null
AverageCycleTime	Real	-	Average cycle time over recent cycles in seconds
RunningSlow	Boolean	-	True if average cycle time exceeds tool’s target cycle time
MachineWheelsEntity	cs.MachineWheelsEntity	-	Machine wheel/priority configuration
QuantityMade	Integer	-	Total quantity produced on current works order
QuantityScrapped	Integer	-	Total quantity scrapped on current works order

Constructor

constructor

[🏗️ constructor]

Class constructor($RealTimeMachinesEntity : cs.RealTimeMachinesEntity)

Creates real-time output object for displaying machine status on dashboard, calculates colors and metrics

Parameters:

Name	Type	Optional	Description
$RealTimeMachinesEntity	cs.RealTimeMachinesEntity	-	-

---

Functions

Regular Functions

ProcessColors

Function ProcessColors

Determines background and foreground colors for machine display based on machine state, downtime, temperature exceptions, etc.

---

setPrimaryColors

Function setPrimaryColors($BackgroundColor : Integer; $ForegroundColor : Integer)

Sets primary background and foreground colors for machine card display

Parameters:

Name	Type	Optional	Description
$BackgroundColor	Integer	-	-
$ForegroundColor	Integer	-	-

---

setAlternatingColors

Function setAlternatingColors($BackgroundColor : Integer; $ForegroundColor : Integer)

Sets alternating row background and foreground colors for machine details display

Parameters:

Name	Type	Optional	Description
$BackgroundColor	Integer	-	-
$ForegroundColor	Integer	-	-

---

setDateTimeColors

Function setDateTimeColors($BackgroundColor : Integer; $ForegroundColor : Integer)

Sets datetime section background and foreground colors for status display

Parameters:

Name	Type	Optional	Description
$BackgroundColor	Integer	-	-
$ForegroundColor	Integer	-	-

---

setAlertColors

Function setAlertColors($BackgroundColor : Integer; $ForegroundColor : Integer)

Sets alert/exception background and foreground colors for warnings display

Parameters:

Name	Type	Optional	Description
$BackgroundColor	Integer	-	-
$ForegroundColor	Integer	-	-

---

setTimeRemainingText

Function setTimeRemainingText($Text : Text; $DateTime : Variant; $AdditionalSeconds : Real)

Sets time remaining display text with optional datetime and additional seconds offset for ETA calculation

Parameters:

Name	Type	Optional	Description
$Text	Text	-	-
$DateTime	Variant	-	-
$AdditionalSeconds	Real	-	-

---

Computed Attributes (Getters/Setters/Query/OrderBy)

AlertsText

[🔍 get only]

Function get AlertsText -> Text

Returns formatted alerts text showing setter queue, connected/assigned temperature sensors; empty if no works order

Returns: Text

---

DeviceMaintenanceActive

[🔍 get only]

Function get DeviceMaintenanceActive -> Boolean

Returns true if device is in maintenance mode (negative DownReasonID); indicates scheduled downtime

Returns: Boolean

---

MachineDisconnected

[🔍 get only]

Function get MachineDisconnected -> Boolean

Returns true if machine hasn’t sent data pulse in 2+ minutes; indicates communication loss

Returns: Boolean

---

MachineNumberText

[🔍 get only]

Function get MachineNumberText -> Text

Returns machine number as formatted string for display

Returns: Text

---

MachineRunning

[🔍 get only]

Function get MachineRunning -> Boolean

Returns true if machine is actively running (AutoStatus true and recent activity within 2 minutes)

Returns: Boolean

---

MouldStatusText

[🔍 get only]

Function get MouldStatusText -> Text

Returns mould status indicator: filled circle if closed, open circle with impressions per cycle if running

Returns: Text

---

PartNameText

[🔍 get only]

Function get PartNameText -> Text

Returns product name or trial indicator; shows ‘MACHINE DISCONNECTED’ or ‘NO WORKS ORDER STARTED’ if applicable

Returns: Text

---

PartsMadeText

[🔍 get only]

Function get PartsMadeText -> Text

Returns formatted text showing parts made vs production target; empty if no works order

Returns: Text

---

PercentMade

[🔍 get only]

Function get PercentMade -> Real

Returns production progress as decimal ratio (0-1) based on quantity made vs production target

Returns: Real

---

PrimaryStatusText

[🔍 get only]

Function get PrimaryStatusText -> Text

Returns primary status display text for machine card with emoji prefix/suffix; shows running, down reason, temperature alerts, or robot issues

Returns: Text

---

ScrapText

[🔍 get only]

Function get ScrapText -> Text

Returns formatted scrap quantity text with percentage if scrapped items exist; empty string if no works order

Returns: Text

---

SecondaryStatusText

[🔍 get only]

Function get SecondaryStatusText -> $DateTimeObject : Object

Returns object with status text template and datetime for secondary status line (e.g., last activity, temperature exceptions)

Returns: Object

---

TimeRemainingText

[🔍 get only]

Function get TimeRemainingText -> $DateTimeObject : Object

Returns object with time remaining text template and calculated ETA based on remaining production and cycle time

Returns: Object

---

UnacknowledgedSensorExceptions

[🔍 get only]

Function get UnacknowledgedSensorExceptions -> Boolean

Returns true if works order is open and has unacknowledged temperature sensor exceptions

Returns: Boolean

---

UnicodeSymbolsText

[🔍 get only]

Function get UnicodeSymbolsText -> Text

Returns product emoji character if works order open; used for visual product identification

Returns: Text

---

WorksOrderIsOpen

[🔍 get only]

Function get WorksOrderIsOpen -> Boolean

Returns true if machine is connected and has an open, running works order assigned

Returns: Boolean

---

---

Generated from RealTimeOutputMachine.4dm