egm.EGMStatus_v1



STOMP DestinationX/EGM.<protocol>.<GMID>.EGMStatus
STOMP Publish CapabilityMAX-EGMMonitoring
STOMP Subscribe CapabilityMAX-EGMMonitoring, Live-EGM

NameTypeDocumentation
fromegm.EGMStateBase_v1EGM, SC, etc identifiers and time
faultsegm.status.EGMFaults_v1Details of any EGM fault conditions
doorsegm.status.EGMDoors_v1Door states.
gamePlayegm.status.EGMGamePlay_v1State of game play.
lockupConditionsegm.status.EGMLockupConditions_v1Lockups such as cancel credit.
disablingConditionsegm.status.EGMDisablingConditions_v1Conditions that disable game play but allow cash out (i.e. not lockupus). Note that a fault will typically result in both a specific fault and a more general disabling condition
egmCommunicationsegm.status.EGMCommunications_v1Communications from the SC to the EGM (or GMIC).
systemegm.status.SystemStatusConditions_v1System (EMS) status conditions.
interfaceegm.status.InterfaceConditions_v1Interface conditions.

egm.EGMStateBase_v1

Used to carry the standard set of identifiers for a sample of any state/value that is from/about an EGM.

NameTypeDocumentation
venueId"string"Venue this state was generated in (or is for). Must not be blank.
scId"string"Site Controller (MID) that recorded this state. Should not be blank.
interfaceId"string"a.k.a GMIC ID. EGM interface (X = GMIC ID, G2S = egmId from G2S message body, QCOM=MAC address) that delivered this state. Blank if not from an EGM/EGM interface (e.g. desired config or command to EGM)
egmElectronicId"string"a.k.a GMID. EGM technician entered identifier X = GMID, QCOM=egm electronic id (egm serial number without manufacturer prefix), G2S = cabinetprofile.machineNum. Must not be blank (it is the key!)
manufacturerId"string"QCOM=manufacturer prefix, otherwise blank
floorPosition"string"Provided in desired config and reflected in detected data so that current and historical 'position' of the EGM can be viewed/reported on
updatedTime"long"When the state was recorded/updated.

egm.status.EGMFaults_v1

NameTypeDocumentation
active"boolean"true if any fault is currently active. Redundant as this value = faultEnteredTime > faultExitTime.
startTime"long"Updated on transition from no faults to at least one fault active.
endTime"long"Time at which all faults cleared.
selfAuditegm.status.Condition_v1Information on iself audit fault(s). SDB byte 2, bit 3.
memoryegm.status.Condition_v1Memory error. SDB byte 2, bit 4. G2S: Non-volatile Storage Fault (CBE311/CBE313), General Memory Fault (CBE312/CBE313).
cashInegm.status.Condition_v1Cash in error. SDB byte 2, bit 5.
cashOutegm.status.Condition_v1Cash out error. SDB byte 2, bit 6.
displayegm.status.Condition_v1Display error. SDB byte 2, bit 2. G2S: Video Display Error (CBE310/CBE313).
cancelCreditegm.status.Condition_v1Cancel Credit. SDB byte 4, bit 0.
subsidiaryEqpt1egm.status.Condition_v1SEF Port 1, SDB byte 5, bit 0.
subsidiaryEqpt2egm.status.Condition_v1SEF Port 2, SDB byte 5, bit 1.
subsidiaryEqpt3egm.status.Condition_v1SEF Port 3, SDB byte 5, bit 2.
subsidiaryEqpt4egm.status.Condition_v1SEF Port 4, SDB byte 5, bit 3.
subsidiaryEqpt5egm.status.Condition_v1SEF Port 5, SDB byte 5, bit 4.
subsidiaryEqpt6egm.status.Condition_v1SEF Port 6, SDB byte 5, bit 5.
mechanicalMetersegm.status.Condition_v1Mechanical meters. SDB byte 3, bit 4. G2S: Hard Meters Disconnected (CBE326/CBE327).
mfgSpecific0egm.status.Condition_v1Manufacturer Specific fault. SDB byte 3, bit 5.
mfgSpecific1egm.status.Condition_v1Manufacturer Specific fault. SDB byte 3, bit 6.
generalCabinetFaultegm.status.Condition_v1General Cabinet Fault (CBE309/CBE313).
noteAcceptorFaultegm.status.Condition_v1G2S: Note Acceptor Fault (NAE102/NAE099).
noteAcceptorJammedegm.status.Condition_v1G2S: Note Acceptor Jammed (NAE101/NAE099).
coinAcceptorJammedegm.status.Condition_v1G2S: Coin Acceptor Jammed (CAE101/CAE099).
coinAcceptorDiverterFaultegm.status.Condition_v1G2S: Coin Acceptor Diverter Fault (CAE103/CAE099).
coinAcceptorFaultegm.status.Condition_v1G2S: Coin Acceptor Fault (CAE102/CAE099).
printerPaperOutegm.status.Condition_v1G2S: Printer Paper Out (PTE207).
printerFaultegm.status.Condition_v1G2S: Printer Fault (PTE205).
otheregm.status.Condition_v1Other non-specific fault condition.

egm.status.Condition_v1

NameTypeDocumentation
active"null" | egm.status.period

egm.status.period

NameTypeDocumentation
startTime"long"updated on condition becoming active
endTime"long"updated when condition becomes inactive

egm.status.EGMDoors_v1

NameTypeDocumentation
mainegm.status.Condition_v1Main door. SDB byte 2, bit 0. G2S: Cabinet Door Open (CBE307/CBE308).
processoregm.status.Condition_v1Processor door. SDB byte 2, bit 1. G2S: Logic Door Open (CBE303/CBE304).
bellyPanelegm.status.Condition_v1Belly panel door.
cashBoxegm.status.Condition_v1Cash box door. G2S: Drop Door Open (CAE107/CAE108).
noteAcceptoregm.status.Condition_v1Note Acceptor door. G2S: Stacker Access Door Opened (NAE112/NAE113).
noteStackeregm.status.Condition_v1Note Stacker removed. G2S: Stacker Removed/Inserted (NAE103/NAE104).
mechanicalMeteregm.status.Condition_v1Mechanical Meter door.
topBoxegm.status.Condition_v1Top Box / Aux door.

egm.status.EGMGamePlay_v1

NameTypeDocumentation
idleegm.status.Condition_v1EGM idle, SDB byte 0, bit 0. G2S: Game Idle (GPE113).
gameCycleegm.status.Condition_v1Game Cycle SDB byte 0, bit 1. G2S: Primary Game Started (GPE103/GPE112).
powerUpegm.status.Condition_v1Power Up, SDB byte 0, bit 2. G2S: EGM Power Up/Restart (CBE325). Cleared on commencement of first game play after power up.
resetegm.status.Condition_v1EGM reset, SDB byte 0, bit 3 AND SDB meters zero. Not reported for non-zero-meter resets. G2S: Non-Volatile Storage Cleared/metersReset (CBE322). Cleared on commencement of first game play after power up.
playDisabledegm.status.Condition_v1Play disabled due to lockup or disabling condition. G2S: cabinetStatus.egmState = G2S_egmDisabled, G2S_hostDisabled, G2S_transportDisabled, G2S_egmLocked or G2S_hostDisabled or G2S_hostLocked.
cashlessModeegm.status.Condition_v1EGM currently in Cashless mode.

egm.status.EGMLockupConditions_v1

NameTypeDocumentation
cancelCreditegm.status.Condition_v1Cancel Credit. SDB byte 1, bit 2. G2S: Handpay Pending (JPE101).
progWinegm.status.Condition_v1Progessive Win. SDB byte 1, bit 3. G2S: Progressive Hit (PGE102/PGE104/PGE106).
largeWinegm.status.Condition_v1Large Win. SDB byte 1, bit 0.
manSpecWin1egm.status.Condition_v1Manufacturer specific Win 1. SDB byte 1, bit 4.
manSpecWin2egm.status.Condition_v1Manufacturer specific Win 2. SDB byte 1, bit 5.
manSpecWin3egm.status.Condition_v1Manufacturer specific Win 3. SDB byte 1, bit 6.
faultConditionegm.status.Condition_v1Fault condition: raised when any EGMFaultCondition true.
lockedByHostegm.status.Condition_v1Locked by Host. G2S: Host Action Locked EGM (CBE211/CBE205).
lockedByEGMegm.status.Condition_v1Locked by EGM. G2S: Device Action Locked EGM (CBE210/CBE205).
lockedViaOperatorMenuegm.status.Condition_v1Locked by EGM. G2S: EGM Locked - Operator Menu (CBE210/CBE205).

egm.status.EGMDisablingConditions_v1

NameTypeDocumentation
subSefegm.status.Condition_v1X: Subsidiary equipment play suspended, SDB byte 12 bit 3, QCOM: N/A, G2S: N/A
cabinetAccessegm.status.Condition_v1Any door open. Logical OR of door states.
disabledByHostegm.status.Condition_v1Disabled by Host. X: N/A, QCOM: MEF=0, G2S: Required for play device disabled by host (CBE204/CBE205).
disabledViaOperatorMenuegm.status.Condition_v1Disabled via Operator Menu. G2S: EGM Disabled - Operator Menu (CBE202/CBE205).
deviceDisabledEGMegm.status.Condition_v1A device that is required for play has a fault and has disabled the EGM. X: Any of SDB byte 11 bits 3,4,5,6 or SDB Byte 12 bits 5,6 are set. QCOM: General Status Response FLGB bit 0 set, G2S: cabinetStatus.egmState = G2S_egmDisabled (CBE203/CBE205).
eventQueueFullegm.status.Condition_v1Event Queue Full. G2S: Event Handler Queue Overflow (EHE102/EHE103).
hopperDisconnectedegm.status.Condition_v1Hopper Disconnected. G2S: Device Disconnected (HPE901/HPE902).
hopperEmptyegm.status.Condition_v1G2S: Hopper Empty (HPE101).
operatorMenuActiveegm.status.Condition_v1G2S: Operator Menu Activated (CBE206).

egm.status.EGMCommunications_v1

NameTypeDocumentation
establishedegm.status.Condition_v1Reports whether the communications from the SC to the EGM (or, for X, GMIC) is established.

egm.status.SystemStatusConditions_v1

NameTypeDocumentation
configurationFaultegm.status.Condition_v1QCOM: Failed to enable due to configuration mismatch or other configuration action required
meterFaultegm.status.Condition_v1QCOM: EGM Operation disabled due to meter fault.
hashFaultegm.status.Condition_v1QCOM: Failed hash check
lockupFaultegm.status.Condition_v1QCOM: Action needed due to lockup failure
ECTFaultegm.status.Condition_v1QCOM: Action needed due to ECT failure
eventFaultegm.status.Condition_v1QCOM: Action needed due to event processing failure

egm.status.InterfaceConditions_v1

NameTypeDocumentation
batteryegm.status.Condition_v1Battery status condition
tamperegm.status.Condition_v1Tamper status condition
pieEGMConnectedegm.status.Condition_v1Pie connection to EGM status condition

Avro Schema