MAX API Documentation

Advanced Venue Data Access (VDA)

Presently, all gaming machines in NSW must conform to prescribed standards including the Australian/New Zealand Gaming Machine National Standard, the NSW Appendix to the Australia/New Zealand Gaming Machine National Standard and the NSW Gaming Machine Communication Protocol Technical Standard (commonly referred to as X-Standard).

X-Standard prescribes, amongst other things, the Meters that must be supported and transmitted from a gaming machine. The Meter definitions contained in the X-Standard specifically over-write the Meter definitions contained in the Gaming Machine National Standards.

From Dec 2017 Gaming Machines operating with the Queensland Office of Liquor Gaming Regulation QCOM protocol, or the Gaming Standards Associations G2S protocol can be approved for use in NSW.

The Meter definitions between X-Standard, QCOM, G2S and the Gaming Machine National Standard are inconsistent (i.e. different meanings) for a number of gaming machine meters and hence there is a need for agreement on how these inconsistencies will be managed for Monitoring, Reporting, long term data storage and transmission to/from third party systems.

MAX have implemented a Meters Model that provides a comprehensive set of meters able to be reconciled consistently across QCOM, G2S and the incumbent X-Standard protocol in NSW.

This has many benefits to Venue Operators, System Suppliers and the Regulator; including:

Similarly, other information about the status of EGMs is presented consistently regardless of protocol.

Advanced Venue Data Access Capabilities

MAX API capabilities used by a third party client determine the set of Avro messages those clients need to SUBSCRIBE to and/or PUBLISH.

Below is the list of Avro Messages for Advanced VDA - The reference documentation for each message includes the destinations to which the message is published as well as the PUBLISH and SUBSCRIBE capabilities required to access it.

A given API client is given a set of capabilities and has access only to those destinations that match those capabilities.

The API supports 1 class of Advanced VDA client corresponding directly to the Live-EGM capability.

Advanced VDA Avro Messages

MAX API supports read-only clients, who have enrolled with the Live-EGM capability, who can obtain essentially the same information that MAXsys receives about EGM Meters and other activity from EGMs.

Monitoring STOMP Connection Details

Sequence Diagram

Advanced Venue Data Access Subscribe Services

The Advanced Venue Data Access services are focused on providing low latency data availability. There is minimal queueing and the most up-to date values for any given topic is always delivered. Updates are delivered on change but may be rate limited. Stale data is always discarded in favour of delivering the most up-to-date values for each topic.

Configuration Data

The detected and authorised configurations encompass those parts of the device status that is relatively static and determines how the entity behaves.

Status Data

Operational status reflects a wide range of conditions that are part of operation, rather than configuration. This includes items such as fault conditions, the state of doors, the state of game play (in play, in a win lockup state).

Meters Data

EGM Meters provide non-jackpot meters for an EGM while Jackpot Group Meters provide the jackpot meters for a SAP or an LPJS. The hits meter information for an EGM participating in an EGM triggered link (for X, from the FDB) is provided in Jackpot Contributor Meters.

Authorised Configuration

The MAX API provides a common representation for authorised EGM configuration, across protocols. Subscribing to the topic of EGMDesiredConfig provides the authorised EGM configuration.

Detected Configuration

The detected configuration, available by subscribing to the topic of _EGMDetectedConfig_, may be a subset or superset of the authorised configuration information. The amount of configuration information that can be detected is very protocol dependent. While there is a common representation for detected configuration, many elements are optional and not present for all protocols.

Where it is possible (limited by the EGM monitoring protocol for the EGM) to detect the actual value of a configuration element that is included in authorised configuration, this element is named and represented so as to allow direct comparison.

In some cases detected configuration may include detail not present or available in authorised configuration.

EGM Status

The EGM status includes items such as EGM fault and lockup conditions. Subscribing to the topic of EGMStatus provides updates of current status.

EGM Meters

Subscribing to the topic of EGMMeterReading delivers up-to-date values of EGM meters as they are collected. These meters alone are sufficient to reconcile an EGM or SAP EGM.

EGM Game Meters

Subscribing to the topic of EGMMeteredGamePlay delivers the up-to-date sets of per-game meter values as they are collected. X EGMs only publish a game's meters for the currently active game, and only if the EGM is a multi-game EGM.

Linked Jackpot EGM Meters

Subscribing to the topic of EGMJackpotContributorMeterReading provides up-to-date values (where available) of the metered number of EGM triggered linked progressive hits for an EGM.

Stand Alone Progressive and X Linked Progressive Jackpot Controller Meters

Subscribing to the topic of EGMJackpotGroupMeterReading delivers up-to-date values of jackpot meters for a SAP EGM or a LPJS (X only) including wins and current amounts.

SiteDetail

An eager subscription to X/Site.* delivers the SiteDetail message which contains the venueId. For more details on topic structures please refer to the Message Store and Transport User Manual