| STOMP Destination | X/EGM.<protocol>.<GMID>.EGMDetectedConfig |
| 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 |
| egmConfig | egm.detectedconfig.EGMConfig_v1 | The egm config. |
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 |
|---|---|---|
| comms | egm.detectedconfig.CommsConfig | |
| coinAcceptor | "null" | egm.detectedconfig.CoinAcceptorConfig | Non-null if EGM supports a coin acceptor. Whether it is connected/working is not part of config. |
| noteAcceptor | "null" | egm.detectedconfig.NoteAcceptorConfig | Non-null if EGM supports a note and/or ticket acceptor. Whether it is connected/working is not part of config. |
| hopper | "null" | egm.detectedconfig.HopperConfig | Non-null if EGM supports a hopper via protocol. Hopper connected/faults etc is not part of detected config. |
| ticketPrinter | "null" | egm.detectedconfig.TicketPrinterConfig | Non-null if EGM supports a ticket printer. Ticket printer connected etc is not part of config. |
| machineLimits | egm.detectedconfig.MachineLimits | |
| machineCharacteristics | egm.detectedconfig.MachineCharacteristics | Basic characteristics info to avoid need to derive from sometimes more detailed information that is inconsistent between protocols. |
| Name | Type | Documentation |
|---|---|---|
| protocol | "string" | the generic name of the protocol family eg XSeries or QCOM or G2S |
| protocolVersion | "string" | The version of the protocol - not including the protocol itself - exact format protocol dependent. For X, list of detected datablock, version pairs e.g. SDB: 1.02, FDB: 1.00 |
| egmId | "string" | The EGM protocol layer name or identifier for this EGM. This may be different to the way the EGM is identified at a high level e.g. if the protocol uses some hardware serial number but the higher layer uses a configurable machine name/id |
| Name | Type | Documentation |
|---|---|---|
| denominations | {"type":"array","items":"int"} | Accepted coin denomination in base currency units (cents in NSW). Empty if no denominations configured/enabled. Only single denomination coin acceptor supported/expected in NSW. |
| descriptor | "string" | Coin acceptor model/version/firmware etc info - protocol and acceptor type dependent. Should allow identification of type and recognition capability/version |
| Name | Type | Documentation |
|---|---|---|
| denominations | {"type":"array","items":"int"} | Accepted note denomination in base currency units (cents in NSW). Empty if no denominations configured/enabled. Multiple denomination note acceptor supported/expected in NSW. |
| ticketReader | "boolean" | True if Ticket (Voucher) In capable. |
| descriptor | "string" | Note acceptor model/version/firmware etc info - protocol and note acceptor type dependent. Should allow identification of note acceptor type and note acceptor recognition capability/version |
| Name | Type | Documentation |
|---|---|---|
| denominations | {"type":"array","items":"int"} | Denominations dispensed in base currency units (cents in NSW). Empty if no denominations configured/enabled. Multiple denomination hoppers not supported/expected in NSW. |
| Name | Type | Documentation |
|---|---|---|
| descriptor | "string" | Ticket printer model/version/firmware etc info - protocol and printer type dependent. |
Settings applies at the machine/cabinet level impacting overall operation of egm
| Name | Type | Documentation |
|---|---|---|
| creditLimitCashIn | "null" | "int" | if credit is greater than or equal to this value, EGM will not accept further notes or coin in |
| winToCreditMeterLimit | "null" | "int" | requires larger wins to be paid via handpay |
| maxRTP | "null" | "double" | regulatory limit. Null only while awaiting EGM report. If not reported by EGM protocol just echo desired param |
| minRTP | "null" | "double" | regulatory limit. Null only while awaiting EGM report. If not reported by EGM protocol just echo desired param |
| maxBet | "null" | "int" | regulatory limit. Null only while awaiting EGM report. If not reported by EGM protocol just echo desired param |
| maxGameWin | "null" | "int" | regulatory limit. Null only while awaiting EGM report. If not reported by EGM protocol just echo desired param |
| maxSAPWin | "null" | "int" | regulatory limit. Null only while awaiting EGM report. If not reported by EGM protocol just echo desired param |
| maxSecondaryGambleCount | "null" | "int" | regulatory limit. QCOM DUMAX. Maximum consecutive (i.e. per game play) double ups. If not reported by EGM protocol just echo desired param |
| maxSecondaryGambleWin | "null" | "int" | regulatory limit. QCOM DULIMIT. Maximum amount won resulting from secondary play (double up). Prevents a double up play starting if a win would exceed this limit. If not reported by EGM protocol just echo desired param |
| maxHopperPay | "null" | "int" | Amount below which collect will pay from hopper (barring residual amount). QCOM COLLIM. |
| maxTicketPay | "null" | "int" | Collect as a TITO ticket/voucher if maxHopperPay < amount < maxTicketPay. If amount is above both - handpay. QCOM TICKET. |
| Name | Type | Documentation |
|---|---|---|
| shellSoftwareId | "string" | Concept may not exist in all protocols. Report empty string if unsupported or while awaiting response. QCOM BGVN in hex. |
| baseCreditDenom | "null" | "int" | Only report null while awaiting EGM result. If EGM/protocol does not report this value, report as 1. Notional denomination of games - G2S cabinet.reportDenom, QCOM DEN. Actual game denoms may be multiples of this value. |
| numberOfGames | "int" | Every EGM must have at least one game, 0 may be reported while awaiting EGM Result. Must report the number of games available whether or not they are configured and enabled. QCOM NUMG. X will report number of detected games for a multigame EGM based on in game selection SDB and report 0 while awaiting such an SDB from multigame; 1 (NOT 0!) if EGM is single game. |
| SAPConfigured | "boolean" | True if EGM has SAPs. EGMs such as QCOM configurable SAP/LP will only report true once the game(s) are configured as SAP, false when unconfigured or configured as LP. True if X AGM role is SAP. |
| LPConfigured | "boolean" | True if EGM has EGM triggered Linked Progressives. EGMs such as QCOM configurable SAP/LP will only report true once the game(s) are configured as LP, false when unconfigured or configured as SAP. True if X EGM sends FDBs. |
| isLPJS | "boolean" | True if EGM is in the role of a linked jackpot controller. |