Arduino_MKRIoTCarrier

This is a basic documentation about the library for the MKR IoT Carrier .

The library can be downloaded from the Arduino IDE’s library manager or by going to the github repository

This carrier has a lot of features and sensors to play with, some of them are the capacitive buttons, 5 RGB LEDs, the 240x240 RGB display and much more!

Its included in some kits:

• Explore IoT Kit
• Oplà IoT Kit

and Standalone:

• MKR IoT Carrier

Examples Included

• Actuators
  • Buzzer_Melody
  • Relays_blink
• All Features
• Display
  • Compose_Images
  • Graphics
  • Show_GIF (needs external library)
• LEDs
• SD_card
• Sensors
  • Environment
  • IMU
  • Light
  • Pressure
• TouchPads
  • CustomSensitivity
  • getTouch
  • Relays_control_Qtouch
  • Touch_Signals
  • Touch_and_LEDs
  • TouchTypes
• Interruptions (TODO)
• Arduino Cloud (TODO)

Classes

MKRIoTCarrier

Constructor of the object

1MKRIoTCarrier yourName; //In the examples we name it as *carrier*

Initialization example sketch

1#include <Arduino_MKRIoTCarrier.h>
2MKRIoTCarrier carrier;
3
4setup(){
5Serial.begin(9600);
6if(!carrier.begin(){  //It will see any sensor failure
7   Serial.println("Failure on init");
8   while(1);
9 }
10}

SD CARD

This can be accessed using the SD library commands that is already #included inside the library

The SD class initialized in the main

begin()

The chip select (CS) pin can be known with SD_CS

Syntax Example

1#include <Arduino_MKRIoTCarrier.h>
2MKRIoTCarrier carrier;
3
4File myFile;
5
6setup(){
7   carrier.begin();  //SD card initialized here
8   
9   myFile = SD.open("test.txt", FILE_WRITE);
10}

Buttons class

Init the calaibration and the set up for the touchable pads (Already done in the MKRIoTCarrier class' begin())

1Buttons.begin()

Read the state of the pads and save them to be analyze in the different type of touch events

1Buttons.update()

Use TOUCHX being X a number from 0 to 4 (Button00 - Button04)

Get if the pad is getting touched, true until it gets released

1Buttons.getTouch(TOUCHX)

Get when have been a touch down

1Buttons.onTouchDown(TOUCHX)

Get when the button has been released

1Buttons.onTouchUp(TOUCHX)

Get both, touched and released

1Buttons.onTouchChange(TOUCHX)

In case you have another enclosure you can change the sensitivity of the pads, 3-100 Automatically configured when you call

carrier.withCase()

1Buttons.updateConfig(int newSens)

Syntax example

1#include <Arduino_MKRIoTCarrier.h>
2MKRIoTCarrier carrier;
3
4void setup(){
5   Serial.begin(9600);
6   carrier.begin();
7}
8
9void loop(){
10   carrier.Buttons.update();    // Read the buttons state
11   
12   //Check if the Button 0 is being touched
13   if (carrier.Buttons.getTouch(TOUCH0)){
14      Serial.println("Touching Button 0");
15   }
16   
17   //You can replace getTouch(), with the other types of touch events
18   //If you use more than one type of events in the same Button its not going to be stable, watch out
19   //In case you need it, after each touch event make a Buttons.update() to read it correctly
20}

Buzzer class

Equivalent to tone(), it will make the tone with the selected frequency

1Buzzer.sound(freq)

Equivalent to noTone(), it will stop the tone signal

1Buzzer.noSound()

To emit a beep you can use the

beep()

1Buzzer.beep();

Relay class

Control both relays and get the status of them

You can control them by using

Relay1 

Relay2

Swap to the NormallyOpen (NO) circuit of the relay

1RelayX.open()

Swap to the NormallyClosed (NC) circuit of the relay, default mode on power off

1RelayX.close()

Bool, returns the status LOW means NC and HIGH means NO

1RelayX.getStatus()

DotStar LEDs

It is controlled with the Adafruit’s DotStar library

The documentation form Adafruit here

Syntax Example

1#include <Arduino_MKRIoTCarrier.h>
2MKRIoTCarrier carrier;
3
4uint32_t myCustomColor = carrier.leds.Color(255,100,50);
5
6void setup(){
7   carrier.begin();
8   carrier.leds.fill(myCustomColor, 0, 5);
9   carrier.leds.show();
10}
11
12void loop(){}

Some examples Init the LEDs strip, done by default using the main begin()

1leds.begin()

Sets the color of the index’s LED

1leds.setPixelColor(index, red, green, blue)

In case you have custom colors you can use this method too

1leds.setPixelColor(index, color)

Set the overall brightness

1leds.setBrightness(0-255)

Update the LEDs with the new values

1leds.show()

Clear the buffer of the LEDs

1leds.clear()

Fill X amount of the LEDs with the same color

1leds.fill(color, firstLedToCount, count)

Save your custom color:

1uint32_t myColor = carrier.leds.Color(red, green, blue)

Pressure sensor - LPS22HB (Barometric)

Visit our reference about LPS22HB

Syntax Example

1float pressure; 
2pressure = carrier.Pressure.readPressure()

IMU - LSM6DS3

Visit our reference about LSM6DS3

Syntax Example

1float aX,aY,aZ;
2carrier.IMUmodule.readAcceleration(aX, aY, aZ);

Humidity and Temperature - HTS221

Visit our reference about HTS221

Syntax Example

1float humidity;
2humidity = carrier.Env.readHumidity();

Ambient light, Gesture and Proximity - APDS9960

Visit our reference about APDS9960

Syntax Example

1int proximity;
2proximity = carrier.Light.readProximity();

Display

It is controlled through the Adafruit-ST7735-Library

The resolution is 240 x 240.

Initialized inside the main

begin()

Colors : every color with the prefix ‘ST77XX_’ i.e. ST77XX_BLACK. Colors available from the library are BLACK, WHITE, RED, GREEN, BLUE, CYAN, MAGENTA, YELLOW, ORANGE

In order to turn on the screen you will need to add this inside the setup() (already inside the main begin())

1display.init(240, 240);
2pinMode(TFT_BLACKLIGHT, OUTPUT);
3digitalWrite(TFT_BLACKLIGHT,HIGH);

Colors : every color with the prefix ‘ST77XX_’ i.e. ST77XX_BLACK. Colors available from the library are BLACK, WHITE, RED, GREEN, BLUE, CYAN, MAGENTA, YELLOW, ORANGE

General:

Fill the entire screen with the selected color

1display.fillScreen(color)

Get width and height

1display.width() / height()

Rotates the coordinate system (number between 0 and 3)

1display.setRotation(0-3)

Text:

Set the cursor to write text in the selected pixels

1display.setCursor(screenX, screenY)

1display.print(text)

It will print the string inside in the current cursor position

1display.setTextColor(color)

Saves the selected color to print the text until the color is changed again

1display.setTextSize(size)

Sets the size of the text that is going to be printed

1display.setTextWrap(True/False)

Set the auto wrap of the text, if it is not the text will not jump to the next line.

Drawings:

Draw a Line from the start Vector to the End vector with the selected color, Use drawFastVLine() and drawFastHLine() introducing the same settings, to avoid the agular calc.

1display.drawLine(startX, startY, endX, endY, color)

Draw a Circle from the center Vector with the selected radius and color

1display.drawCircle(centerX, centerY, radius, color)

Draw a rectangle

1display.drawRect(topLeftX, topLeftY, width, height, color)

Draw a filled rectangle

1display.fillRect(topLeftX, topLeftY, width, height, color)

Draw a filled circle from the center Vector, with the selected radius and color

1display.fillCircle(centerX, centerY, radius, color)

Draw a rounded rectangle

1display.drawRoundRect(topLeftX, topLeftY, width, height, curveRadius, color)

Draw a filled and rounded rectangle

1display.fillRoundRect(topLeftX, topLeftY, width, height, curveRadius, color)

Draw a triangle by introducing the 3 points and color

1display.drawTriangle(x0, y0, x1, y1, x2, y2, color)

Draw a filled triangle

1display.fillTriangle(x0, y0, x1, y1, x2, y2, color)

Draw a character

1display.drawChar(topLeftX, topLeftY, character, color, backgroundColor, size)

Draw a bitmap, the bitmap needs to be with PROGMEM

1display.drawBitmap(startX, startY, bitmap, width, height, color)