Framework

The vmc_framework is the core component of the Marshall SDK, acting as the primary interface between your application and the vending machine controller (VMC). It handles all the essential operations, from initiating and managing sessions to processing transactions and communicating with various peripherals.

Get a framework instance

To begin using the vmc_framework, you need to obtain its singleton instance. The Singleton pattern ensures that only one framework instance is active, providing a consistent and controlled interaction point for all SDK operations.

To initiate the framework instance, you can use the following command:

vmc_framework m_vmc = vmc_framework.getInstance();

vmc_framework vmc_instance = vmc_framework.getInstance();

Where:

• vmc_framework: Main class of the Marshall SDK that manages the interaction with the vending machine controller (VMC).
• m_vmc or vmc_instance: Variable that holds the instance of the vmc_framework.
• getInstance(): This method returns the singleton instance of the vmc_framework. The Singleton pattern ensures that only one framework instance runs in the application.

API Methods

The primary methods to control the lifecycle of the SDK are:

• start(): Initializes and starts the SDK thread, enabling the framework to handle vending operations and device communication.
• stop(): Terminates the SDK thread, halting all operations and safely shutting down the framework

Framework configuration structure

The vmc_configuration class is used to set up various parameters and flags that control the behaviour of the VMC. Proper configuration is crucial for ensuring smooth operation and compatibility with different peripherals. See the following code examples:

public class vmc_configuration 
      public Object port_vpos;
      public int port_vpos_baud;

      public String serial;
      public String model;
      public String sw_ver;
      public int    machine_type;
      boolean explicit_vend_success;
      public boolean price_not_final_support;
      public boolean mag_card_approved_by_vmc_support;
      public boolean mifare_approved_by_vmc_support;

      public boolean debug;
      public int dump_packets_level;

      public boolean reader_always_on;
      public boolean multi_session_support;
      public boolean multi_vend_support;
      public boolean always_idle;
      public 

public class vmc_configuration 
      public string  port_vpos;
      public int port_vpos_baud;

      public string serial;
      public string model;
      public string sw_ver;
      public int    machine_type;

      public bool reader_always_on;
      public bool multi_session_support;
      public bool multi_vend_support;
      public bool always_idle;
      public bool explicit_vend_success;
      public bool price_not_final_support;
      public bool mag_card_approved_by_vmc_support;
      public bool mifare_approved_by_vmc_support;

      public bool debug;
      public int dump_packets_level;

Where:

Refer to SDK Flags Descriptions to learn about other flags that can be initiated to control specific configurations.