Table of Contents
- Overview
- Comm Type
- Port
- Baud Rate
- Model Name
- Serial Number
- VCOM/USB Drivers
- Configuring the Payment Device SDK Server config file
- Common Errors
Overview
The following article is to assist in setting up the Ingenico Lane series with NMI's Payment Device SDK, and how to fill in the various Payment Device SDK Server settings when connecting via serial or VCOM/USB.
Comm Type
The Lane can be set-up to connect via a number of connection methods (model permitting), notably RS-232 (serial), VCOM/USB, and TCPIP. For a successful connection, the Lane device will have to be set to the correct connection method, and can be carried out in the following manner:
- Enter Maintenance Mode
- Select Comms Method
- Select the correct comm. method (RS-232, VCOM/USB, or TCPIP).
After you have setup the device for the correct comm. method, you will then need to modify the Payment Device SDK Server config Protocol section appropriately:<Protocol>serial|tcpip<Protocol>
Port
To initiate a connection to the device via Serial, or VCOM USB, you will need to specify what COM port the host machine has assigned to the device.
Serial:
VCOM/USB:
After you have confirmed what port the device has been assigned, you will need to modify the Payment Device SDK Server config Port section. In the example below, we're basing the COM11 port off of the VCOM/USB connection above:<Port>COM11</Port>
For TCPIP, you will need to set this value to the port defined under the TCPIP Settings on the device.
Baud Rate
This is only relevant to serial connections, and not VCOM/USB. The baud rate of the device should be set to the highest recommended by the device distributor or manufacturer. Once confirmed, you can set the baud rate on the device in the following manner:
- Enter Maintenance Mode
- Select Serial Settings
- Select the desired comm. speed.
Once the device comm. speed has been set on the device, you will need to modify the Payment Device SDK Server config Baud section to match. As an example, if the device is set to 115200, you would set the Payment Device SDK config to the following:<Baudrate>115200</Baudrate>
Model Name
Once you have confirmed the Lane model you are using, you will need to modify the Payment Device SDK Server config Model section to match:<Model>Ingenico-Lane1234-XYZ</Model>
If you're unsure what model you have, please reference the documentation included with the device or confirm with your device distributor.
Serial Number
Please reference Figure 19 and 20 of the Integration Guide for details on how to identify the serial number of the Lane device, and what value to populate the SDK config file with.
VCOM/USB Drivers
If you are connecting the Lane via VCOM/USB on Windows, you will need to install the Ingenico USB device drivers.
VCOM/USB support on Linux is heavily dependant on your chosen Linux distro's driver support, as Ingenico do not supply a Linux driver. It is typically recommended to use an RS-232 (serial) or Ethernet connection when using the Lane with Linux.
Configuring the Payment Device SDK Server config file
Please take note of the following changes within the Payment Device SDK config file:
Model
tag needs to be updated to correctly reflect the Ingenico Lane model in-use:Ingenico-Lane-3000-RAM
Ingenico-Lane-3000-UPP
Ingenico-Lane-5000-UPP
Ingenico-Lane-700-UPP
- Add the
ID
of the Ingenico Lane (serial number) as documented in the Integration Guide. Protocol
tag needs to be set to serial or tcpip.Port
tag needs to be set to the value that matches the COM or TCPIP port assignment.Baudrate
tag needs to be set to the highest recommended value by the device manufacturer. Not needed for TCPIP.Parity
tag should be left as default unless otherwise instructed by NMI support. Not needed for TCPIP.Stopbits
tag should be left as default unless otherwise instructed by NMI support. Not needed for TCPIP.Databits
tag should be left as default unless otherwise instructed by NMI support. Not needed for TCPIP.- If you are changing the config file over from TCPIP to Serial or VCOM/USB, the following tags are not needed:
Address
. - Save the file.
Example config:
<?xml version="1.0" encoding="utf-8"?> <ChipDnaServer version="1.0.0"> ... <Terminals> <Terminal> ... <PaymentDevices> <PaymentDevice> <Model>Ingenico-Lane-1234-Model</Model> <Id>012345678</Id> <Protocol>serial</Protocol> <Port>COM11</Port> <Baudrate>115200</Baudrate> <Parity>none</Parity> <Stopbits>1</Stopbits> <Databits>8</Databits> <StandbyMessage>ChipDNA</StandbyMessage> </PaymentDevice> </PaymentDevices> </Terminal> </Terminals> ... </ChipDnaServer>
Common Errors
The following connection-related errors are normally an indicator that either the Ingenico Lane or the Payment Device SDK Server config file has not been setup correctly. If you see these errors within the Payment Device SDK Server console window or log files, please review your Payment Device SDK Server config and device settings, and if the issues persist, please get in contact with our support team.
Date Time INFO ChipDNA [Ingenico-Lane-1234-Model, SerialNumber] [Disconnected] HeartBeatLoop Connection
Date Time INFO ChipDNA [Ingenico-Lane-1234-Model, SerialNumber] [#ggb, #yk] Connecting
Date Time WARN ChipDNA [Ingenico-Lane-1234-Model, SerialNumber] Connection Error: Error Code: UNABLE_TO_OPEN_CONNECTION
Date Time INFO ChipDNA [Ingenico-Lane-1234-Model, SerialNumber] [DeviceIngenico, #yk] Connecting
Date Time INFO ChipDNA [Ingenico-Lane-1234-Model, SerialNumber] [DeviceIngenico, #Fab] Sending command
Date Time INFO ChipDNA [Ingenico-Lane-1234-Model, SerialNumber] [DeviceIngenico, #C9] Link setup required
Date Time WARN ChipDNA [Ingenico-Lane-1234-Model, SerialNumber] [DeviceIngenico, #C9] Link setup NO ACK
Date Time WARN ChipDNA [Ingenico-Lane-1234-Model, SerialNumber] [DeviceIngenico, #C9] Link setup NO ACK
Date Time WARN ChipDNA [Ingenico-Lane-1234-Model, SerialNumber] [DeviceIngenico, #C9] Link setup NO ACK
Date Time WARN ChipDNA [Ingenico-Lane-1234-Model, SerialNumber] [DeviceIngenico, #C9] Link setup timeout
Date Time INFO ChipDNA #lc.#kc: PaymentDeviceAvailabilityChangeEvent -> Parameters:
[ Key: PAYMENT_DEVICE_MODEL, Value: Ingenico-Lane-1234-Model],
[ Key: PAYMENT_DEVICE_IDENTIFIER, Value: WrongSerialNumber ],
[ Key: IS_AVAILABLE, Value: False ],
[ Key: AVAILABILITY_ERROR, Value: DeviceIdMismatch ]