Qwiic Carrier Board Hookup Guide

Introduction

The MicroMod Qwiic Carrier Board can be used to rapidly prototype with other Qwiic devices; it is available in either a single or double mounting configuration. Just like other MicroMod Carrier Boards, users are free to develop with MicroMod Processor Board of their choice.

added to your cart!

SparkFun MicroMod Qwiic Carrier Board - Single

Only 10 left! DEV-17723

The Single MicroMod Qwiic Carrier Board can be used to rapidly prototype with other Qwiic devices.

$9.95

1

Favorited Favorite 3

Wish List

added to your cart!

SparkFun MicroMod Qwiic Carrier Board - Double

In stock DEV-17724

The Double MicroMod Qwiic Carrier Board can be used to rapidly prototype with other Qwiic devices.

$11.95

Favorited Favorite 5

Wish List

For a quick overview, check out our product video showcasing the MicroMod Qwiic carrier boards:

Required Materials

To get started, users will need a few of items listed below. (You may already have a some of these items; read through the guide and modify your cart accordingly.)

MicroMod Processor Board

Like other MicroMod Carrier Boards, a Processor Board is required for the product to operate. Users will need a Processor Board (of their choice) to attach to the MicroMod M.2 connector; since, one is not included with this product. Below, are few options:

added to your cart!

SparkFun MicroMod Alorium Sno M2 Processor

In stock DEV-18030

The SparkFun MicroMod Alorium Sno Processor features the Snō System on Module (SoM) adapted to the MicroMod M.2 processor fo…

$49.95

Favorited Favorite 11

Wish List

added to your cart!

SparkFun MicroMod mikroBUS Starter Kit

In stock KIT-19935

The SparkFun MicroMod mikroBUS™ Starter Kit is designed to give you just what you need to start using the MicroMod and Clic…

$79.95 $59.95

Favorited Favorite 3

Wish List

added to your cart!

SparkFun MicroMod STM32 Processor

In stock DEV-21326

The SparkFun MicroMod STM32 Processor Board is ready to rock your MicroMod world with its ARM® Cortex®-M4 32-bit RISC core!

$16.50

Favorited Favorite 5

Wish List

added to your cart!

SparkFun Arduino IoT Weather Station

Out of stock KIT-22636

Whether you're an agriculturalist, a professional meteorologist, or a weather hobbyist, building a weather station can be a r…

$124.95

2

Favorited Favorite 10

Wish List

Required Hardware

A Phillips screw driver is necessary to attach the Processor board to the Carrier Board. Additionally, a USB-C cable is needed to connect the Carrier Board to a computer.

added to your cart!

USB 3.1 Cable A to C - 3 Foot

In stock CAB-14743

USB C is fantastic. But until we have converted all our hubs, chargers, and ports over to USB C this is the cable you're goin…

$5.50

4

Favorited Favorite 10

Wish List

added to your cart!

SparkFun Mini Screwdriver

Only 5 left! TOL-09146

This is just your basic reversible screwdriver - pocket sized! Both flat and phillips heads available. Comes with pin clip an…

$1.05

3

Favorited Favorite 14

Wish List

Optional Hardware

To connect Qwiic breakout boards for your MicroMod project, Qwiic cables are required. Users can also attach the Qwiic devices with 4-40 screws or stacked them with standoffs.

added to your cart!

SparkFun Qwiic Cable Kit

In stock KIT-15081

To make it even easier to get started, we've assembled this Qwiic Cable Kit with a variety of Qwiic cables from 50mm to 500mm…

$8.95

22

Favorited Favorite 91

Wish List

added to your cart!

Flexible Qwiic Cable - 100mm

In stock PRT-17259

This polarized I2C cable insulation is made from silicon making it more flexible than our original Qwiic cable particularly i…

$1.60

Favorited Favorite 18

Wish List

added to your cart!

Screw - Phillips Head (1/4", 4-40, 10 pack)

In stock PRT-10453

There are your standard Philips-head 4-40 screws. They are 1/4" long and come in packs of ten. This is the screw size we use …

$1.60

Favorited Favorite 13

Wish List

added to your cart!

Standoff - Metal Hex (4-40; 3/8"; 10 pack)

In stock PRT-10463

Metal Hex Male/Female standoffs. #4-40 thread with 3/8" shank and 3/16" thread length. Can be stacked to create any length. …

$4.50

Favorited Favorite 11

Wish List

A single-cell Lithium-ion battery can be connected to the Qwiic Carrier Board for portability.

added to your cart!

Lithium Ion Battery - 400mAh

Out of stock PRT-13851

This is a very small, extremely lightweight battery based on Lithium Ion chemistry, with the highest energy density currently…

$5.50

11

Favorited Favorite 49

Wish List

added to your cart!

Lithium Ion Battery - 2Ah

In stock PRT-13855

These are very slim, extremely light weight batteries based on Lithium Ion chemistry. Each cell outputs a nominal 3.7V at 200…

$13.95

9

Favorited Favorite 59

Wish List

added to your cart!

Lithium Ion Battery - 110mAh

In stock PRT-13853

This is a very small, extremely light weight battery based on Lithium Ion chemistry. This is the highest energy density curre…

$5.50

4

Favorited Favorite 23

Wish List

Lithium Ion Battery - 1Ah

Retired PRT-13813

Slim, extremely light weight batteries based on Lithium Ion chemistry. Each cell outputs a nominal 3.7V at 1000 mAh!

8 Retired

Favorited Favorite 73

Wish List

To modify the jumpers, users will need soldering equipment and/or a knife.

added to your cart!

Chip Quik No-Clean Flux Pen - 10mL

Out of stock TOL-14579

This 10mL no-clean flux pen from Chip Quik is great for all of your solder, de-solder, rework, and reflow purposes!

$7.95

4

Favorited Favorite 42

Wish List

added to your cart!

Solder Lead Free - 100-gram Spool

In stock TOL-09325

This is your basic spool of lead free solder with a water soluble resin core. 0.031" gauge and 100 grams. This is a good spoo…

$9.95

8

Favorited Favorite 44

Wish List

added to your cart!

Hobby Knife

19 available TOL-09200

It's like an Xacto knife, only better. We use these extensively when working with PCBs. These small knives work well for cutt…

$3.50

2

Favorited Favorite 21

Wish List

Weller WLC100 Soldering Station

Retired TOL-14228

The WLC100 from Weller is a versatile 5 watt to 40 watt soldering station that is perfect for hobbyists, DIYers and students.…

2 Retired

Favorited Favorite 17

Wish List

Suggested Reading

The MicroMod ecosystem is a unique way to allow users to customize their project to their needs. The Qwiic connect system is a simple method for interfacing with I²C devices. Click on the banners below for more information on each system.

For users who aren't familiar with the following concepts, we also recommend reading the following tutorials before continuing.

Hardware Overview

This section will cover the various hardware components and solder jumpers on the MicroMod Qwiic Carrier Board. It will also review the connections of the M.2 connector and how it interfaces with a MicroMod Processor.

Board Dimensions

The Qwiic Carrier Board dimensions are:

• Single: 3.15" x 1.40" (80.00mm x 35.56mm)
• Double: 4.10" x 1.40" (109.22mm x 35.56mm)

The boards also include mounting holes and inserts for a standard 4-40 screw. The inserts are arranged to mount, attach, and/or stack compatible (1" x 1") Qwiic boards.

Common Components

Most SparkFun MicroMod Carrier Boards will have some common components and all MicroMod Carrier Boards will have the keyed M.2 MicroMod connector for a Processor board. The photo and list below outline the common components between the Qwiic carrier board and other MicroMod Carrier Boards.

• M.2 MicroMod Connector - This special keyed M.2 connector lets you install your MicroMod Processor of choice to the Qwiic Carrier Board.
• USB-C Connector - Connect to your computer to program your processor and provide power to the board.
• 3.3V Regulator - Provides a regulated 3.3V and sources up to 1A.
• Qwiic Connectors - The standard Qwiic connectors to connect other Qwiic devices for your MicroMod project.
• Boot/Reset Buttons - Push buttons to enter boot mode on processors and to reset your MicroMod circuit.

Battery Charger

The board also has a MCP73831 Single-Cell Lithium-Ion/Lithium-Polymer Charge IC so you can charge an attached single-cell LiPo battery. The charge IC receives power from the USB connection and can source up to 450mA to charge an attached battery.

Status LEDs

The carrier board has two status LEDs:

• PWR - This LED indicates when 3.3V power is available top the board.
• CHG - This LED indicates the status of the charging circuit operation.

Solder Jumpers

There are four adjustable solder jumpers on the MicroMod Qwiic Carrier Board labeled MEAS, BYP, 3.3V_VE and 3.3V. The table below briefly outlines their functionalities:

MicroMod Pinout

Since this Carrier Board is designed to work with all of the MicroMod Processors we've included the table below to outline which pins are used so, if you would like, you can compare them to the pinout tables in their respective Hookup Guides.

• Qwiic Carrier Board Pinout Table
• MicroMod General Pinout Table
• MicroMod General Pin Descriptions

Breakout Pins

The Qwiic Carrier Board features a 3.3V, a ground, seven I/O breakout pins. The functionality of these pins are detailed in the table above.

Hardware Assembly

For those unfamiliar with the MicroMod ecosystem, be sure to review the Getting Started with MicroMod guide.

Processor Board

To get started with the Qwiic Carrier Board, users will need a compatible Processor. Insert the MicroMod Processor board into the M.2 socket at an angle, with its edge connector aligned to the matching slots.

When inserted properly, the Processor board will rest at an angle:

To secure the processor board, gently hold down on the board and attach the M.2 screw with a Phillip's head (PH0 or PH1) screw driver. Below, is an example of an assembled MicroMod system:

Qwiic Devices

Screw inserts are available in either a single or double configuration to attach/mount 1" x 1" Qwiic devices to the Qwiic carrier board. The inserts are compatible with 4-40 screws; additionally, 4-40 3/8" standoffs can also be used to stack boards vertically.

To electronically connect the Qwiic devices to the Carrier Board, users will need Qwiic cables. For more information, check out our Qwiic ecosystem page.

Programming

To program the processor board utilized on the Qwiic Carrier Board; connect the board to a computer with a USB-C cable. Depending on the Processor board, user may need to install drivers (if they have not done so already).

Example

Below is a simple demonstration of using the MicroMod Qwiic Carrier Board to create a bubble level, using an accelerometer and OLED display. Users will also need other parts and accessories; all parts besides the Qwiic carrier board are listed below:

added to your cart!

SparkFun Qwiic Cable Kit

In stock KIT-15081

To make it even easier to get started, we've assembled this Qwiic Cable Kit with a variety of Qwiic cables from 50mm to 500mm…

$8.95

22

Favorited Favorite 91

Wish List

added to your cart!

SparkFun MicroMod ESP32 Processor

Only 7 left! WRL-16781

This board combines Espressif's ESP32 with our M.2 connector interface to bring a power-packed processor board into our Micro…

$16.95

1

Favorited Favorite 10

Wish List

added to your cart!

USB 3.1 Cable A to C - 3 Foot

In stock CAB-14743

USB C is fantastic. But until we have converted all our hubs, chargers, and ports over to USB C this is the cable you're goin…

$5.50

4

Favorited Favorite 10

Wish List

added to your cart!

SparkFun Mini Screwdriver

Only 5 left! TOL-09146

This is just your basic reversible screwdriver - pocket sized! Both flat and phillips heads available. Comes with pin clip an…

$1.05

3

Favorited Favorite 14

Wish List

added to your cart!

Screw - Phillips Head (1/4", 4-40, 10 pack)

In stock PRT-10453

There are your standard Philips-head 4-40 screws. They are 1/4" long and come in packs of ten. This is the screw size we use …

$1.60

Favorited Favorite 13

Wish List

added to your cart!

Standoff - Metal Hex (4-40; 3/8"; 10 pack)

In stock PRT-10463

Metal Hex Male/Female standoffs. #4-40 thread with 3/8" shank and 3/16" thread length. Can be stacked to create any length. …

$4.50

Favorited Favorite 11

Wish List

SparkFun Micro OLED Breakout (Qwiic)

Retired LCD-14532

The SparkFun Qwiic Micro OLED Breakout is a Qwiic enabled version of our popular MicroView and micro OLED display!

7 Retired

Favorited Favorite 51

Wish List

Triple Axis Accelerometer Breakout - LIS2DH12 (Qwiic)

Retired SPX-15760

[Qwiic](https://www.sparkfun.com/qwiic) has struck again! This MEMS, three axis accelerometer by STMicroelectronics has been …

Retired

Favorited Favorite 5

Wish List

Assembly

The assemble process is relatively straight forward. The primary thing that users need to pay attention to is the orientation of the OLED display relative to the axes of the accelerometer. The x-axis should point to the right of the OLED display and the y-axis should point to the top of the display (see images below).

Some users may find it the movement of the bubble in the example code to be more intuitive if the OLED display is stacked above the accelerometer.

Example Code

Users can download the example code here or by clicking the button below. Besides the RP2040 processor board, users only need to select the proper port and board from the board manager in the Arduino IDE before uploading the code.

The following sections break down the example code execution for users who might want to modify the code. Please note, as defined in our terms of service, that we do not provide technical assistance for any code modifications.

Dependencies

Below are the dependencies for the code including the libraries, pin definitions, and variable instantiations. The example code requires both the Micro OLED and LIS2DH12 Arduino libraries to be installed in the Arduino IDE.

Tip: While in the Arduino IDE, users can click the links in the code (i.e. //Click here to get the library: http://librarymanager/All#SparkFun_LIS2DH12) to pull up the required library in the library manager.

Clicking the link to pull up the required library in the Arduino IDE. (Click to enlarge)

Installing an Arduino Library

January 11, 2013

How do I install a custom Arduino library? It's easy! This tutorial will go over how to install an Arduino library using the Arduino Library Manager. For libraries not linked with the Arduino IDE, we will also go over manually installing an Arduino library.

Favorited Favorite 23

Libraries and Pin Definitions

This section of the code contains the required libraries and pin definitions for the code.

language:c
#include <Wire.h>

// Accelerometer
//=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
#include "SparkFun_LIS2DH12.h" //Click here to get the library: http://librarymanager/All#SparkFun_LIS2DH12
SPARKFUN_LIS2DH12 accel;
//=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=

// External Display
//=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
#include <SFE_MicroOLED.h> //Click here to get the library: http://librarymanager/All#SparkFun_Micro_OLED
//#include "icons.h"

#define PIN_RESET 7
#define DC_JUMPER 1
MicroOLED oled(PIN_RESET, DC_JUMPER);
//=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=

Variables

This section of the code instantiates most of the variables used in the code.

language:c
// Set target and dot size
int radiusLarge = 10; // Target area 2
int radiusSmall = 4;  // Target area 1
int radiusBubble = 2; // Bubble size

// Set initial roll and pitch measurement
double averagedRoll = 0.0;
double averagedPitch = 0.0;

Setup Loop

This section of the code runs the setup loop, which initializes the serial output, I²C connection, the OLED display operation, and the accelerometer operation and configuration.

language:c
void setup()
{
  // Initialize Output for Print Statements
  Serial.begin(115200);
  Serial.println("SparkFun Accel Example");

  // Initialize I2C Connection
  Wire.begin();
  //Wire.setClock(400000);

  beginDisplay(); //Check if an external Qwiic OLED is attached and display splash screen

  // Check for accelerometer
  if (accel.begin() == false)
  {
    Serial.println("Accelerometer not detected. Check address jumper and wiring. Freezing...");
    while (1)
      ;
  }

  // Set sample/data rate for accelerometer
  // The larger the avgAmount the faster we should read the sensor
  //accel.setDataRate(LIS2DH12_ODR_100Hz); //6 measurements a second
  accel.setDataRate(LIS2DH12_ODR_400Hz); //25 measurements a second
}

Setup Functions

These functions are executed in the setup loop, to initialize the OLED display I²C connection and display the splash screen.

language:c
// Ping an I2C address and see if it responds
bool isConnected(uint8_t deviceAddress)
{
  Wire.beginTransmission(deviceAddress);
  if (Wire.endTransmission() == 0)
    return true;
  return false;
}


void beginDisplay()
{
  // Connect to address display is on by pinging addresses
  // 0x3D is default on Qwiic board
  if (isConnected(0x3D) == true || isConnected(0x3C) == true)
  {
    //Init and display splash
    oled.begin();     // Initialize the OLED
    oled.display();   // Display splash screen
    delay(1200);
    oled.clear(PAGE); // Clear the display's internal memory

    oled.setCursor(15, 7); //x, y
    oled.setFontType(0); //Set font to smallest
    oled.print(F("Bubble"));
    oled.setCursor(19, 20); //x, y
    oled.print(F("Level"));

    oled.display();
    delay(1200);
  }
}

Main loop

This section of the code runs the main loop. The code retrieves roll and pitch calculation, clears the display buffer, displays the bubble and target circles or areas. If the position of the bubble is within the target are, the roll and pitch angles are displayed as X and Y coordinates on the screen.

language:c
void loop()
{
  getAngles(); // Calculate roll and pitch angles based on the acceleromter readings
  oled.clear(PAGE); // Clear the display's internal memory

  // Set dot position
  double bubbleX = LCDWIDTH / 2 - averagedPitch; // Bubble location on x-axis
  double bubbleY = LCDHEIGHT / 2 - averagedRoll; // Bubble location on y-axis

  // Limit bubble position to edge of screen
  if (bubbleX < radiusBubble) { bubbleX = radiusBubble; }
  else if (bubbleX > LCDWIDTH - radiusBubble) { bubbleX = LCDWIDTH - radiusBubble - 1; }
  if (bubbleY < radiusBubble) { bubbleY = radiusBubble; }
  else if (bubbleY > LCDHEIGHT - radiusBubble) { bubbleY = LCDHEIGHT - radiusBubble - 1; }

  // Draw circle relative to dot
  oled.circle(LCDWIDTH / 2, LCDHEIGHT / 2, radiusLarge);
  oled.circle(LCDWIDTH / 2, LCDHEIGHT / 2, radiusSmall);
  oled.circleFill(bubbleX, bubbleY, radiusBubble);

  // Display angle/position once bubble is inside larger target area
  if ( sqrt(averagedPitch * averagedPitch + averagedRoll * averagedRoll) < (radiusLarge - radiusBubble))
  {
    oled.setFontType(0); //Set font to smallest

    oled.setCursor(LCDWIDTH/2 - 21, 0); //x, y
    oled.print("X:");
    oled.print(-averagedPitch);
    oled.setCursor(LCDWIDTH/2 - 21, LCDHEIGHT - 8); //x, y
    oled.print("Y:");
    oled.print(averagedRoll);


//    oled.setCursor(LCDWIDTH/2 - 11, 0); //x, y
//    oled.print(averagedRoll);
//    if (-averagedPitch < 0) { oled.setCursor(LCDWIDTH - 29, LCDHEIGHT/2 - 3); }
//    else { oled.setCursor(LCDWIDTH - 23, LCDHEIGHT/2 - 3); }
//    oled.print(-averagedPitch);
  }

  oled.display();
}

getAngles() Function

This function is executed in the main loop. The code retrieves accelerometer readings, translates the readings into roll and pitch angles, and calculates an average based on a sample set size (avgAmount = 16).

language:c
void getAngles()
{
  averagedRoll = 0.0;
  averagedPitch = 0.0;
  const int avgAmount = 16;

  // Average readings after 'avgAmount' samples
  for (int reading = 0 ; reading < avgAmount ; reading++)
  {
    while (accel.available() == false) delay(1); // Wait for accelerometer connection

    // Retrieve data from accelerometer
    float accelX = accel.getX();
    float accelY = accel.getY();
    float accelZ = accel.getZ();

    // Optional modification: https://www.nxp.com/docs/en/application-note/AN3461.pdf
    //int signZ = constrain(accelZ, -1, 1);
    //double roll = atan2(accelY , signZ * sqrt( accelZ * accelZ + .001 *  abs(accelX) ) ) * 57.3;

    // Calculate roll and pitch angles
    double roll = atan2(accelY , accelZ) * 57.3;
    double pitch = atan2((-accelX) , sqrt(accelY * accelY + accelZ * accelZ)) * 57.3;
    if (constrain(accelZ, -1, 1) == -1) { roll = atan2(accelY, -accelZ) * 57.3; } // Invert if upside down

    averagedRoll += roll;
    averagedPitch += pitch;

    // Debug Print Statements
    //Serial.print(roll, 6);
    //Serial.print(", ");
    //Serial.print(pitch, 6);
    //Serial.print(", ");
    //
    //Serial.print(accelX);
    //Serial.print(", ");
    //Serial.print(accelY);
    //Serial.print(", ");
    //Serial.print(accelZ);
    //Serial.println("");
  }

  averagedRoll /= (float)avgAmount;
  averagedPitch /= (float)avgAmount;

  // Debug Print Statements
  //Serial.print(averagedRoll, 6);
  //Serial.print(", ");
  //Serial.print(averagedPitch, 6);
  //Serial.println(", ");

}

Demo Operation

Below is a demonstration of the example code in action. Enjoy!

Troubleshooting

Resources and Going Further

Want more information on the SparkFun Qwiic Carrier Board? Check out these links!

• Schematic
  • Single (PDF)
  • Double (PDF)
• Board Dimensions
  • Single (PDF)
  • Double (PDF)
• Eagle Files
  • Single (ZIP)
  • Double (ZIP)
• GitHub Hardware Repo
• Demo Code
• Product Showcase Video

MicroMod Documentation:

• Getting Started with MicroMod
• Designing with MicroMod
• MicroMod Info Page
• MicroMod Forums

Looking for some inspiration? Check out theses other MicroMod tutorials: