Get started

Quick setup instructions to get it up and running.

Some definitions

Let’s start by get in sync with some definitions before we go further in this guide:

  • Host is the USB host system where the YKUSH3 board will be connected to (e.g., a Personal computer).
  • Upstream port is the board port that is used to connect the board to the host.
  • Downstream devices are the ones connected to the board downstream ports, the board has three of these.
  • Self powered mode is when the YKUSH3 board uses the power from the host port it’s connected to power itself and the devices connected to it.
  • Bus powered mode is when the board draws the power from an external supply and not from the upstream port.

Setup process overview

To get started with YKUSH range of boards you’ll need to do the following:

  1. Install the command application on the machine you will be connecting the board to.
  2. Attach the board to a port of the host.
  3. Open a command shell and issue commands to the board.

Let me show you how to do all these steps.

Install the control application

We are going to use the command line application ykushcmd that supports all YKUSH range of boards.

For Windows

Download the installer from our github repository. Once downloaded execute the installer, in this guide we used the ykushcmd-installer-64bit.exe, and follow the installation wizard.

After installation, to open the command line and start issuing ykushcmd commands, click on the Windows start menu and type ykushcmd. Now click on the Yepkit ykushcmd app that shows in the results list.

For Linux

Prerequisites

You will need the libusb-1.0.0 and libusb-1.0.0-dev libraries in your system to build the ykushcmd.

For example, to install them in Debian run the following commands in a terminal.

sudo apt-get install libusb-1.0-0-dev libusb-1.0-0

Build

Get the sources from the ykushcmd github repository

You can download a zip archive from the releases or clone the repository with git.

In the example bellow we cloned the repository, build from source and installed the binary.

git clone https://github.com/Yepkit/ykush.git ykushcmd

cd ykuscmd
./build.sh
./install.sh

Sending some commands

Now that the control application is installed you can control the board. Start by listing the attached boards.

In Linux use the following command to list the attached YKUSH3 boards.

sudo ykushcmd ykush3 -l

In Windows the command is the same just with the omission of sudo.

If what you want is the YKUSH model boards instead of YKUSH3, then use the following command.

sudo ykushcmd ykush -l

One note, because YKUSH model was the first of the range to be released it has some perks like not requiring the board prefix in the command. The following command also list the YKUSH model boards.

sudo ykushcmd -l

What’s next

Take a look into the ykushcmd reference for all the available commands for YKUSH3 boards.

Explore the details each of the YKUSH range boards.

Check the product page of the boards, in our webshop, namely: