| STOMP Destination | X/EGM.<protocol>.<GMID>.EGMStatus |
| STOMP Publish Capability | MAX-EGMMonitoring |
| STOMP Subscribe Capability | MAX-EGMMonitoring, Live-EGM |
| Name | Type | Documentation |
|---|---|---|
| from | egm.EGMStateBase_v1 | EGM, SC, etc identifiers and time |
| faults | egm.status.EGMFaults_v1 | Details of any EGM fault conditions |
| doors | egm.status.EGMDoors_v1 | Door states. |
| gamePlay | egm.status.EGMGamePlay_v1 | State of game play. |
| lockupConditions | egm.status.EGMLockupConditions_v1 | Lockups such as cancel credit. |
| disablingConditions | egm.status.EGMDisablingConditions_v1 | Conditions 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 |
| egmCommunications | egm.status.EGMCommunications_v1 | Communications from the SC to the EGM (or GMIC). |
| system | egm.status.SystemStatusConditions_v1 | System (EMS) status conditions. |
| interface | egm.status.InterfaceConditions_v1 | Interface conditions. |
Used to carry the standard set of identifiers for a sample of any state/value that is from/about an EGM.
| Name | Type | Documentation |
|---|---|---|
| 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. |
| Name | Type | Documentation |
|---|---|---|
| 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. |
| selfAudit | egm.status.Condition_v1 | Information on iself audit fault(s). SDB byte 2, bit 3. |
| memory | egm.status.Condition_v1 | Memory error. SDB byte 2, bit 4. G2S: Non-volatile Storage Fault (CBE311/CBE313), General Memory Fault (CBE312/CBE313). |
| cashIn | egm.status.Condition_v1 | Cash in error. SDB byte 2, bit 5. |
| cashOut | egm.status.Condition_v1 | Cash out error. SDB byte 2, bit 6. |
| display | egm.status.Condition_v1 | Display error. SDB byte 2, bit 2. G2S: Video Display Error (CBE310/CBE313). |
| cancelCredit | egm.status.Condition_v1 | Cancel Credit. SDB byte 4, bit 0. |
| subsidiaryEqpt1 | egm.status.Condition_v1 | SEF Port 1, SDB byte 5, bit 0. |
| subsidiaryEqpt2 | egm.status.Condition_v1 | SEF Port 2, SDB byte 5, bit 1. |
| subsidiaryEqpt3 | egm.status.Condition_v1 | SEF Port 3, SDB byte 5, bit 2. |
| subsidiaryEqpt4 | egm.status.Condition_v1 | SEF Port 4, SDB byte 5, bit 3. |
| subsidiaryEqpt5 | egm.status.Condition_v1 | SEF Port 5, SDB byte 5, bit 4. |
| subsidiaryEqpt6 | egm.status.Condition_v1 | SEF Port 6, SDB byte 5, bit 5. |
| mechanicalMeters | egm.status.Condition_v1 | Mechanical meters. SDB byte 3, bit 4. G2S: Hard Meters Disconnected (CBE326/CBE327). |
| mfgSpecific0 | egm.status.Condition_v1 | Manufacturer Specific fault. SDB byte 3, bit 5. |
| mfgSpecific1 | egm.status.Condition_v1 | Manufacturer Specific fault. SDB byte 3, bit 6. |
| generalCabinetFault | egm.status.Condition_v1 | General Cabinet Fault (CBE309/CBE313). |
| noteAcceptorFault | egm.status.Condition_v1 | G2S: Note Acceptor Fault (NAE102/NAE099). |
| noteAcceptorJammed | egm.status.Condition_v1 | G2S: Note Acceptor Jammed (NAE101/NAE099). |
| coinAcceptorJammed | egm.status.Condition_v1 | G2S: Coin Acceptor Jammed (CAE101/CAE099). |
| coinAcceptorDiverterFault | egm.status.Condition_v1 | G2S: Coin Acceptor Diverter Fault (CAE103/CAE099). |
| coinAcceptorFault | egm.status.Condition_v1 | G2S: Coin Acceptor Fault (CAE102/CAE099). |
| printerPaperOut | egm.status.Condition_v1 | G2S: Printer Paper Out (PTE207). |
| printerFault | egm.status.Condition_v1 | G2S: Printer Fault (PTE205). |
| other | egm.status.Condition_v1 | Other non-specific fault condition. |
| Name | Type | Documentation |
|---|---|---|
| active | "null" | egm.status.period |
| Name | Type | Documentation |
|---|---|---|
| startTime | "long" | updated on condition becoming active |
| endTime | "long" | updated when condition becomes inactive |
| Name | Type | Documentation |
|---|---|---|
| main | egm.status.Condition_v1 | Main door. SDB byte 2, bit 0. G2S: Cabinet Door Open (CBE307/CBE308). |
| processor | egm.status.Condition_v1 | Processor door. SDB byte 2, bit 1. G2S: Logic Door Open (CBE303/CBE304). |
| bellyPanel | egm.status.Condition_v1 | Belly panel door. |
| cashBox | egm.status.Condition_v1 | Cash box door. G2S: Drop Door Open (CAE107/CAE108). |
| noteAcceptor | egm.status.Condition_v1 | Note Acceptor door. G2S: Stacker Access Door Opened (NAE112/NAE113). |
| noteStacker | egm.status.Condition_v1 | Note Stacker removed. G2S: Stacker Removed/Inserted (NAE103/NAE104). |
| mechanicalMeter | egm.status.Condition_v1 | Mechanical Meter door. |
| topBox | egm.status.Condition_v1 | Top Box / Aux door. |
| Name | Type | Documentation |
|---|---|---|
| idle | egm.status.Condition_v1 | EGM idle, SDB byte 0, bit 0. G2S: Game Idle (GPE113). |
| gameCycle | egm.status.Condition_v1 | Game Cycle SDB byte 0, bit 1. G2S: Primary Game Started (GPE103/GPE112). |
| powerUp | egm.status.Condition_v1 | Power Up, SDB byte 0, bit 2. G2S: EGM Power Up/Restart (CBE325). Cleared on commencement of first game play after power up. |
| reset | egm.status.Condition_v1 | EGM 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. |
| playDisabled | egm.status.Condition_v1 | Play disabled due to lockup or disabling condition. G2S: cabinetStatus.egmState = G2S_egmDisabled, G2S_hostDisabled, G2S_transportDisabled, G2S_egmLocked or G2S_hostDisabled or G2S_hostLocked. |
| cashlessMode | egm.status.Condition_v1 | EGM currently in Cashless mode. |
| Name | Type | Documentation |
|---|---|---|
| cancelCredit | egm.status.Condition_v1 | Cancel Credit. SDB byte 1, bit 2. G2S: Handpay Pending (JPE101). |
| progWin | egm.status.Condition_v1 | Progessive Win. SDB byte 1, bit 3. G2S: Progressive Hit (PGE102/PGE104/PGE106). |
| largeWin | egm.status.Condition_v1 | Large Win. SDB byte 1, bit 0. |
| manSpecWin1 | egm.status.Condition_v1 | Manufacturer specific Win 1. SDB byte 1, bit 4. |
| manSpecWin2 | egm.status.Condition_v1 | Manufacturer specific Win 2. SDB byte 1, bit 5. |
| manSpecWin3 | egm.status.Condition_v1 | Manufacturer specific Win 3. SDB byte 1, bit 6. |
| faultCondition | egm.status.Condition_v1 | Fault condition: raised when any EGMFaultCondition true. |
| lockedByHost | egm.status.Condition_v1 | Locked by Host. G2S: Host Action Locked EGM (CBE211/CBE205). |
| lockedByEGM | egm.status.Condition_v1 | Locked by EGM. G2S: Device Action Locked EGM (CBE210/CBE205). |
| lockedViaOperatorMenu | egm.status.Condition_v1 | Locked by EGM. G2S: EGM Locked - Operator Menu (CBE210/CBE205). |
| Name | Type | Documentation |
|---|---|---|
| subSef | egm.status.Condition_v1 | X: Subsidiary equipment play suspended, SDB byte 12 bit 3, QCOM: N/A, G2S: N/A |
| cabinetAccess | egm.status.Condition_v1 | Any door open. Logical OR of door states. |
| disabledByHost | egm.status.Condition_v1 | Disabled by Host. X: N/A, QCOM: MEF=0, G2S: Required for play device disabled by host (CBE204/CBE205). |
| disabledViaOperatorMenu | egm.status.Condition_v1 | Disabled via Operator Menu. G2S: EGM Disabled - Operator Menu (CBE202/CBE205). |
| deviceDisabledEGM | egm.status.Condition_v1 | A 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). |
| eventQueueFull | egm.status.Condition_v1 | Event Queue Full. G2S: Event Handler Queue Overflow (EHE102/EHE103). |
| hopperDisconnected | egm.status.Condition_v1 | Hopper Disconnected. G2S: Device Disconnected (HPE901/HPE902). |
| hopperEmpty | egm.status.Condition_v1 | G2S: Hopper Empty (HPE101). |
| operatorMenuActive | egm.status.Condition_v1 | G2S: Operator Menu Activated (CBE206). |
| Name | Type | Documentation |
|---|---|---|
| established | egm.status.Condition_v1 | Reports whether the communications from the SC to the EGM (or, for X, GMIC) is established. |
| Name | Type | Documentation |
|---|---|---|
| configurationFault | egm.status.Condition_v1 | QCOM: Failed to enable due to configuration mismatch or other configuration action required |
| meterFault | egm.status.Condition_v1 | QCOM: EGM Operation disabled due to meter fault. |
| hashFault | egm.status.Condition_v1 | QCOM: Failed hash check |
| lockupFault | egm.status.Condition_v1 | QCOM: Action needed due to lockup failure |
| ECTFault | egm.status.Condition_v1 | QCOM: Action needed due to ECT failure |
| eventFault | egm.status.Condition_v1 | QCOM: Action needed due to event processing failure |
| Name | Type | Documentation |
|---|---|---|
| battery | egm.status.Condition_v1 | Battery status condition |
| tamper | egm.status.Condition_v1 | Tamper status condition |
| pieEGMConnected | egm.status.Condition_v1 | Pie connection to EGM status condition |