Platform Docs

Clover DevKits

NOTE

DevKits can only be shipped directly to US addresses. Developers outside the US must use a package forwarding service to ship DevKits to their final destination.

Overview

Clover Developer Kits (DevKits) are Clover devices with special permissions that can simulate transactions in a sandbox environment. This environment is completely separate from the production environment.

The sandbox environment allows you to test apps in preparation for later deployment on the production server. A DevKit allows you to experience transactions end-to-end from both the merchant and customer perspectives.

A Clover DevKit can run unpublished apps and allows connections with Android Debug Bridge (adb). A device is a development model if the Android Settings app on the device includes a Developer options sub-menu.

Once you've placed your order and received your DevKit, familiarize yourself with the hardware by reviewing the accompanying guide. The guide is also available on the Clover Help site. Then, follow the steps below to set up your DevKit for use with your sandbox development account.

IMPORTANT

Repeatedly inserting an active EMV credit card into an EMV-enabled development device that is pointed to a blackhole payment gateway may result in the credit card disabling itself. This is due to EMV protections against repeated inserts that do not result in actual payments.

Create a sandbox account

To create a sandbox account:

  1. On the sandbox Developer Dashboard, enter your email address.
  2. In the confirmation email you receive, follow the instructions to verify your email address. You are redirected to the Developer Dashboard to complete your account information.
  3. Fill in the following information about your account:
    • Developer Info: Either your developer name or company name
    • Account Info: Your identification information in the sandbox environment
    • Test Merchant Info: Your first test merchant. You can edit this information at a later point and also create more test merchants in the Developer Dashboard.
  4. Once you are done with entering your account information, select Submit.

IMPORTANT

You cannot re-provision your DevKit between the sandbox and production environments. In addition, you cannot migrate your developer and merchant accounts between the sandbox and production environments.

Associate your DevKit

After creating your account, do the following:

  1. Unbox and power on your DevKit.
  2. On your sandbox Developer Dashboard, select the DevKit tab.
  3. Under Manage Dev Devices, enter the serial number for your development kit found on the sticker attached to your DevKit's box (for example, C012UQ12345678).
  4. Using the drop-down list, verify that your test merchant is selected.
  5. Select Associate Device. An activation code appears. Clover also sends you an email with the code to your development account. You will need this code to activate your DevKit.

IMPORTANT

If the activation process is not completed within 30 minutes, Clover will disable the activation token, and you will need to begin the association process again.

Activate your DevKit

After you've associated your DevKit, complete the setup and activation steps for your DevKit.

NOTE

The Clover Flex DevKit includes a hub with ports for power, USB type B, and Ethernet to aid in development and testing. This hub replaces the charging cradle that is shipped with merchant devices.

NOTE

As part of your on-screen DevKit setup, you are not charged for selecting a merchant service plan.

Enable Android Debug Bridge

Android Debug Bridge (ADB) allows you to debug your Clover application using a USB or Wi-Fi connection.

IMPORTANT

Sandbox Clover Station cannot be connected for debugging over USB. In order to use ADB with a sandbox Clover Station, connect via Wi-Fi. Clover Station has the TCP/IP port set to 5555.

  1. Using a text editor, open the adb_usb.ini file.
    • On OS X, this file is located at ~/.android/.
    • On Windows, this file is located at C:\Users\[username]\.android.
  2. Add a new line with the value 0x28f3. Your adb_usb.ini file should look similar to the following:
  3. Save and close the file.
# ANDROID 3RD PARTY USB VENDOR ID LIST -- DO NOT EDIT.
# USE 'android update adb' TO GENERATE.
# 1 USB VENDOR ID PER LINE.
0x28f3 #clover vendor id

ADB over USB

You can use Android Debug Bridge (ADB) to access your DevKit directly using the included USB cable. To connect your computer and the DevKit, complete the following steps.

  1. Connect the USB A end of the cable to your computer.
  2. Connect the other end of the cable to your DevKit:
    • For Clover Flex and Mini, connect the USB B end of the cable to the hub.
    • For Clover Mobile, connect the Micro USB end of the cable to the port at the bottom of the handle (this is the same port used to connect the DevKit to the USB wall charger).
    • For Clover Station 2018, connect the Micro USB end of the cable to the debugging port as shown in this video.
  3. In Android Studio, select View > Tool Windows > Terminal (Alt+F12/Option+F12) and run adb devices. Your DevKit's ID (a fourteen-character alphanumeric value) is returned.

NOTE

Some Windows users have experienced issues with their computers not recognizing their DevKits after following the steps above.

If this occurs, please try force-installing the Samsung ADB Driver. For more information, see how to force install a driver.

ADB over Wi-Fi

Once you've configured your computer to recognize Clover DevKits via ADB, you can connect to the device over Wi-Fi. Follow the steps for a standard Android device.

NOTE

You must disconnect or disable any ethernet network connection on your DevKit for the device to fall back to Wi-Fi, which then enables wireless debugging.

Troubleshooting

If you encounter issues with your Clover DevKit, please refer to the DevKits FAQs.


Clover DevKits


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.