xChip Setup - VCSFA-MARS/ThinSat-Program GitHub Wiki

Installing Arduino IDE

Before beginning Arduino Tutorials, make sure that you have completed configuration on all computers that will use Arduino.

The Arduino IDE is an open-source software for programming various electronic devices. IDE stands for "Integrated Development Environment", which means you can write, test and upload your code all from the same place.

  1. Download and install from Arduino.cc. Use the "Windows Installer" version.
  2. Follow the installer prompts. It may ask you for permission to install some drivers. Select 'Yes'.
  3. Launch Arduino after install.

You will see a programming window with an empty program template. This is the basic required structure of the Arduino language.

Arduino IDE with a new program in the editor window

If you have already used the Arduino IDE, your window may have different text. Arduino IDE starts up with the last program file open when you launch the program.

Install xChip Drivers

XinaBox is not supported "out of the box" by the Arduino IDE. So we will have to install the drivers. Fortunately, it's easy to get up and running.

Step 1:

Ensure that Arduino IDE is open. On Windows computers click on File > Preferences. For Mac users Arduino > Preferences.

This will bring up the preferences pane:

Now click on the "Additional Board Manager URLs" item, which will bring up a small editing window. Add the following URL to the list.

http://arduino.esp8266.com/stable/package_esp8266com_index.json

Your window should look something like this:

Click OK to add the URL and click OK to accept the changes to your Arduino IDE's preferences.

Step 2

Now that the Arduino IDE knows where to look for the xChip drivers, it's time to add them.

Click on Tools > Board > Boards Manger...

The Boards Manager window will pop up. Type into the search bar ESP8266 and you will find the esp8266 by ESP8266 Community item, select Install to install the driver.

Step 3

Select the board we are working with by clicking Tools > Board

This will bring up a list of all the different Arduino boards the IDE supports. In our case, we want Generic ESP8266. Do not change any default settings.

Careful: Make sure you select "Generic ESP8266 Module" not "Generic ESP8265 Module"

Install xChip Libraries

To use XinaBox, we need to install a library for xChip module. A library is a toolkit for programmers, that includes a set of premade commands to make programming easier and more functional. You only need to install libraries once.

The first library we will install is called xCore and it contains all the code that ties the xChip system together.

Step 1

Download the library files below. Do not unzip them.

For Mac users, your default Safari settings may cause downloaded .ZIP files to be automatically unzipped. In that case, your .ZIP file was moved to your Trash Can, and you will need to retrieve it.

xCore Library

xOD01 Library

xSW01 Library

xSL01 Library

Step 2

  1. In the Arduino IDE, select Sketch > Include Library > Add .ZIP Library... Browse to the location of your xCore-master.zip file.
  2. Select the file and click "Choose". This will add the Zip file to your library.

Repeat for the other three “master” files.

Arduino will then import the library. To verify installation select Sketch > Include Library in the Arduino IDE toolbar and scroll to the bottom of the list.

Configuring Ports

  1. Open Arduino IDE and plug your IP01 xChip in.

  2. Select the port the xChip is connected to by clicking the Tools menu and selecting Port. This will bring up a list of available connections.

    • Windows users are looking for something like COM4
    • Mac users should have something like /dev/cu.usbmodem1411411

Click the port so that your Arduino IDE knows at which USB port to look for your xSystem. Now we need to tell it what kind of board it's going to see.

NOTE: If you plug your Arduino into a different USB Port later, the IDE may not know where your xSystem is anymore and you will have to redo this step. This is a common troubleshooting problem.