C SDK Integration

This guide shows you how to integrate the Marshall C SDK into your platform. You will learn to configure essential serial port functions, implement required timer ticks, and set up the VMC configuration object to get the SDK running. The C SDK includes working implementations for Linux, Windows, or STM32 microcontrollers. If your platform differs, use these implementations as a reference to adapt the SDK accordingly onto your own platform.

​

Pre-requisites

Before running the C SDK, ensure you configure the following platform-specific elements:

• Serial Port Communication: Implement methods for reading and writing bytes from your platform’s serial port, which connects to Nayax’s device. The SDK interacts with the hardware through this serial interface. You must implement the following functions:
  • drv_usart_rx_byte(): Reads a single byte from the serial port.
  • drv_usart_rx_chunk(): Reads multiple bytes in one operation.
  • drv_usart_get_rx_pending(): Returns the number of pending bytes in the serial buffer.
  • drv_usart_tx_data(): Sends data bytes to the VPOS device.
• Periodic Timer Tick: Implement a periodic timer tick to invoke the vmc_link_background() function. This function should be called with an interval of 5 ms to 10 ms. Additionally, ensure the cpu_platform_get_time() function returns a continuously incrementing millisecond counter since the system startup.
• UART Communication Validation: Verify that the UART communication with Nayax’s device is fully functional.
  • Check for proper data transmission and reception.
  • Validate that event callbacks are triggered correctly.

​

Integrate Marshall

To get started with the C SDK, follow these steps. You can refer to the provided mymain.c file for a sample code and guidance on importing necessary namespaces into your project.

1. Instantiate a VMC configuration object:
   C

   vmc_config_t   	config;
   
2. Fill in the appropriate fields. The following code block presents a standard configuration:
   C

   vmc_init()
   	__strcpy(config.model, "marshall-c-sdk-demo");
   	__strcpy(config.serial, "01234567");
   	__strcpy(config.sw_ver, "vmc app version");
   	__strcpy(config.vmc_hw_ver, “01234567”);
   	__strcpy(config. vmc_manuf_code, “manuf”);
   
   	config.multi_vend_support = __false;
   	config.multi_session_support = __false;
   	config.price_not_final_support = __false;
   	config.reader_always_on = __false;
   	config.always_idle = __false;
   	config.explicit_vend_success = __false;
   	config.vend_denied_policy = vend_denied_policy_persist_e;
   
   	config.mifare_approved_by_vmc_support = __false;
   	config.mag_card_approved_by_vmc_support = __false;
   	config.qr_approved_by_vmc_support  = __false;
   
   	config.dump_packets_level = debug_level_dump_moderate;
   	config.debug = __true;
   
   

3. Configure the SDK and register to link events.
   C

   vmc_link_register_callback((vmc_link_event_handler_cb_t)vmc_link_event_handler_cb);
   vmc_vend_register_callback((vmc_vend_event_handler_cb_t)vmc_vend_event_handler_cb);
   vmc_general_register_callback((vmc_general_event_handler_cb_t)vmc_general_event_handler_cb);
   
4. Start the SDK and wait for the onReady() event:
   C

   vmc_link_start()
   

​

Implement Payment Flows

As explained in Payment Flows, the Marshall SDK supports various payment flows. The pages below explain how to implement each in your VMC using the C SDK.

​

CPU and Memory Requirements

The C SDK has no special hardware requirements. The SDK developer estimates memory usage at around 1KB of RAM, plus a timer tick of roughly 100 lines of code every 5ms. The actual machine code depends on your compiler and platform. It has been run on an Atmel AVR with 2KB of RAM and an 8MHz controller, with plenty left over for the application itself.

​

Update to a Newer SDK Version

To move an existing integration to a newer SDK version, overwrite the previous SDK with the new one and recompile your implementation.

​

See Also