Overview

Like
The Temboo service has moved away from Arduino support. The service access in this older guide will no longer work.

This guide will introduce you to the basics of programming your Arduino Yún to interact with APIs using the Temboo platform. We'll build a simple device that checks Twitter for user mentions when a button is pressed, and then turns on an LED if there is a new mention. Of course, the same steps we take here can be adapted to work with all sorts of different sensors and any of the different processes in the Temboo Library.

learn_arduino_Twitter_Cover_Image.jpg

Get Set Up

To build this example project, you'll be using an Arduino Yún, a push button, and an LED. You’ll need:

learn_arduino_Arduino_Yun.jpg

An Arduino Yún

learn_arduino_USB_Micro.jpg

A USB A – Micro B cable

learn_arduino_Push_Button.jpg

An arcade-style push button

learn_arduino_LED.jpg

An LED

learn_arduino_Resistor.jpg

A 1K Ohm resistor

learn_arduino_Breadboard.jpg

A half-size breadboard

learn_arduino_Wire_2.jpg

Some wires

You'll also need a Temboo account and a Twitter account. To set up your Temboo account (if you don't already have one) you can create one for free here. You can create a Twitter account here, and register a Twitter application using the Twitter dev console. After creating the app, you'll find API keys for that application in the API Keys tab; you’ll need these later.

Generate Your Sketch

The Temboo service has moved away from Arduino support. The service access in this older guide will no longer work.

Now that you're all set up, log in to Temboo and go to the Twitter > Timelines > Mentions Choreo in the Temboo Library. Turn on IoT Mode and select Arduino Yún from the dropdown menu.

learn_arduino_IoT_Mode_4.png

Fill out the Input fields using your Twitter keys, and click Optional Inputs at the bottom of the Input box to reveal a list of more input values that you can pass to the Choreo. Specify “1” for the Count input, since we only need to check the most recent tweet to determine whether any new mentions have come in since the last check. Test the Choreo from your browser by clicking Run at the bottom of the window. Now, if you scroll down and check the Response box under Output, you’ll see the JSON response returned by Twitter.

learn_arduino_Twitter_Inputs.png

Upload and Run

The Temboo service has moved away from Arduino support. The service access in this older guide will no longer work.

Now that you've tested the Choreo successfully, scroll down to find the Code section of the page. When you're in IoT Mode and you run a Choreo, Temboo automatically generates code that can be used to make the same API call from an Arduino sketch. Copy the code, and paste it into a new sketch in the Arduino IDE.

learn_arduino_Twitter_Code.png

In order to run this sketch on your Arduino, it needs to be configured with an appropriate TembooAccount.h header file that contains your Temboo account information. To create the header file, make a new tab in the Arduino IDE, and name it TembooAccount.h.

On the Mentions Choreo page beneath the sketch code that you previously copied and pasted into the Arduino IDE, you’ll find another block of generated code containing #define statements. This is your header file. Copy the contents of the header into the TembooAccount.h tab in your Arduino IDE.

learn_arduino_Header_File.png

With both files in place, you are ready to searching Twitter from your Arduino. Make sure your Yún is connected to the Internet by following the directions here. Then, save and upload the sketch to the Yún and open the serial monitor; after a few seconds, the sketch will begin to run. By default we’ve set the Choreo to run ten times, executing once every thirty seconds.

Wiring Your Circuit

Now that your Yún is successfully interacting with Twitter, let’s add the push button and LED. This will require two steps: first, you’ll wire the extra components to your Arduino, and second, you’ll modify your code slightly so that the Arduino knows when a new mention has come in. We'll begin with the circuit.

The push button has two wires to connect; one should go to ground, and the other should go to the pin you’re reading from (we've chosen to use pin 2). The LED also has two connections; as with the wire, one will go to ground, and the other to the pin to which you’re writing (we’re using pin 13). The short leg of the LED should connect to ground, and the longer end should connect to the digital pin, with the resistor attached to either—it does not matter which.

learn_arduino_Twitter_Circuit_Diagram.jpg

Adding Code

The Temboo service has moved away from Arduino support. The service access in this older guide will no longer work.

You've already generated all of the code you need to check Twitter using your Yún, so you only need to make a few changes to your sketch to have the Yún determine whether a Tweet is new. First, let’s add an Output Filter so that we only have to worry about the Tweet ID among all the different information that the Twitter API will return. The Output Filter will filter the API response in the cloud so that only the Tweet ID of your most recent Twitter mention is returned to the board. Before

Download File
Copy Code 
// Run the Choreo; when results are available, print them to serial
MentionsChoreo.run();

add

Download File
Copy Code 
MentionsChoreo.addOutputFilter("TweetID", "/[]/id", "Response");

and in void loop(), replace

Download File
Copy Code 
while(MentionsChoreo.available()) {
  char c = MentionsChoreo.read();
  Serial.print(c);

with

Download File
Copy Code 
while(MentionsChoreo.available()) {
  String TweetIDName = MentionsChoreo.readStringUntil('\x1F');
  TweetIDName.trim();
  String TweetIDNumber = MentionsChoreo.readStringUntil('\x1E');
  TweetIDNumber.trim();

Then, we’ll add some code that will let your Yún check the newly retrieved Tweet ID against the previously returned ID to determine whether or not there’s been a new mention. To do it, first initialize a new variable at the top of your code:

Download File
Copy Code 
int LastID = 0;

Then, add the following lines of code after TweetIDNumber.trim();

Download File
Copy Code 
if(TweetIDName == "TweetID"){
  int NewID = TweetIDNumber.toInt();
          
  if(LastID != NewID){
    digitalWrite(13, HIGH);
    delay(5000);
    digitalWrite(13, LOW);
    LastID = NewID;
  }
}

Next, we'll introduce the push button that will trigger your sketch. First, initialize the pin that you will be reading (recall that we chose to use pin 2) by adding a few lines of code to what you already have in void setup(). While we're at it, let's also initialize the output pin to which the LED is attached (we've selected pin 13 for this):

Download File
Copy Code 
// Initialize pin
pinMode(2, INPUT);
pinMode(13, OUTPUT);

Then, add the following two lines of code to void loop() to set the Mentions Choreo to run only when the button is pressed:

Download File
Copy Code 
int sensorValue = digitalRead(13);
if (sensorValue == LOW) {

You should nest the code that you already have in void loop() within this new conditional.

Finally, delete the lines

Download File
Copy Code 
Serial.println("Waiting...");
  delay(30000); // wait 30 seconds between Mentions calls

Since you’re calling the Choreo only when you press the button, that line is no longer necessary.

With that, your sketch is once again ready to go! It should look something like this (note that the Input values in the code below have been replaced by placeholders):

Download File
Copy Code 
#include <Bridge.h>
#include <Temboo.h>
#include "TembooAccount.h" // contains Temboo account information, as described below

int numRuns = 1;   // Execution count, so this doesn't run forever
int maxRuns = 10;   // Maximum number of times the Choreo should be executed
int LastID = 0;

void setup() {
  Serial.begin(9600);
  
  // For debugging, wait until the serial console is connected.
  delay(4000);
  while(!Serial);
  Bridge.begin();
  
  // Initialize pin
  pinMode(2, INPUT);
  pinMode(13, OUTPUT);
}

void loop() {
  int sensorValue = analogRead(2);
  if (sensorValue == LOW) {
    if (numRuns <= maxRuns) {
      Serial.println("Running Mentions - Run #" + String(numRuns++));
    
      TembooChoreo MentionsChoreo;

      // Invoke the Temboo client
      MentionsChoreo.begin();
    
      // Set Temboo account credentials
      MentionsChoreo.setAccountName(TEMBOO_ACCOUNT);
      MentionsChoreo.setAppKeyName(TEMBOO_APP_KEY_NAME);
      MentionsChoreo.setAppKey(TEMBOO_APP_KEY);
    
      // Set Choreo inputs
      MentionsChoreo.addInput("Count", "1");
      MentionsChoreo.addInput("AccessToken", "PLACEHOLDER");
      MentionsChoreo.addInput("AccessTokenSecret", "PLACEHOLDER");
      MentionsChoreo.addInput("ConsumerSecret", "PLACEHOLDER");
      MentionsChoreo.addInput("ConsumerKey", "PLACEHOLDER");
    
      // Identify the Choreo to run
      MentionsChoreo.setChoreo("/Library/Twitter/Timelines/Mentions");
    
      MentionsChoreo.addOutputFilter("TweetID", "[]/id", "Response");
    
      // Run the Choreo; when results are available, print them to serial
      MentionsChoreo.run();
    
      while(MentionsChoreo.available()) {
        String TweetIDName = MentionsChoreo.readStringUntil('\x1F');
        TweetIDName.trim();
        String TweetIDNumber = MentionsChoreo.readStringUntil('\x1E');
        TweetIDNumber.trim();
        
        if(TweetIDName == "TweetID"){
          int NewID = TweetIDNumber.toInt();
          
          if(LastID != NewID){
            digitalWrite(13, HIGH);
            delay(5000);
            digitalWrite(13, LOW);
            LastID = NewID;
          }
        }
      }
      MentionsChoreo.close();
    }
  }
}

You can continue to make changes if you’d like, but no further alterations are required. Save it, upload it to your Arduino, open the serial monitor, and press the button to begin checking your Tweets.

This guide was first published on Feb 01, 2015. It was last updated on Feb 01, 2015.