Waspmote Utilities

Programming Guide

Index
Document Version: v4.0 - 02/2013
Libelium Comunicaciones Distribuidas S.L.

INDEX
1. Introduction.......................................................................................................................................... 4
2. USB Library........................................................................................................................................... 4
2.1. Waspmote Libraries......................................................................................................................................................................4
2.1.1. Waspmote USB Files.....................................................................................................................................................4
2.1.2. Constructor......................................................................................................................................................................4
2.1.3. Pre-Defined Constants................................................................................................................................................4
2.2. Initialization....................................................................................................................................................................................4
2.3. Reading data...................................................................................................................................................................................4
2.4. Printing data ..................................................................................................................................................................................5

3. Utilities Library..................................................................................................................................... 7
3.1. Waspmote Libraries......................................................................................................................................................................7
3.1.1. Waspmote Utilities Files .............................................................................................................................................7
3.1.2. Constructor......................................................................................................................................................................7
3.1.3. Pre-Defined Constants................................................................................................................................................7
3.2. Using LEDs.......................................................................................................................................................................................7
3.3. Using EEPROM................................................................................................................................................................................8
3.4. Reading Serial ID...........................................................................................................................................................................8
3.5. Converting types...........................................................................................................................................................................8

4. Input/Output pins............................................................................................................................... 10
4.1. Reading ANALOG inputs ........................................................................................................................................................ 11
4.2. Digital I/O ..................................................................................................................................................................................... 11
4.2.1. Setting DIGITAL pin mode ......................................................................................................................................11
4.2.2. Reading DIGITAL Inputs ...........................................................................................................................................11
4.2.3. Writing DIGITAL Outputs .........................................................................................................................................11
4.2.4. DIGITAL1 pin as PWM output .................................................................................................................................12

5. Getting Free RAM Memory................................................................................................................ 13

5.1. Waspmote Files .......................................................................................................................................................................... 13
5.2. freeMemory function............................................................................................................................................................... 13

6. Reading basic sensors........................................................................................................................ 14

6.1. Temperature Sensor.................................................................................................................................................................. 14
6.2. Light Sensor................................................................................................................................................................................. 15
6.3. Humidity....................................................................................................................................................................................... 15
6.4. DS18B20 Temperature Sensor............................................................................................................................................... 16
-2-

v4.0

7. Code examples and extended information...................................................................................... 17

8. API changelog..................................................................................................................................... 18

-3-

v4.0

Introduction

1. Introduction
Waspmote provides some libraries to manage USB interaction and other general tasks (blinking LEDs, some string conversions,
etc).
To manage these tasks, some functions have been developed and two libraries have been created: USB Library and Utils Library.

2. USB Library
2.1. Waspmote Libraries
2.1.1. Waspmote USB Files
WaspUSB.h ; WaspUSB.cpp

2.1.2. Constructor
To start using Waspmote USB library, an object from class WaspUSB must be created. This object, called USB, is created inside
the Waspmote USB library and it is public to all libraries. It is used through the guide to show how the Waspmote USB library
works.
When creating this constructor, one variable is initialized. This variable specifies the number of the UART that USB is going to
use (UART0 in this case).

2.1.3. Pre-Defined Constants

There are some constants defined in WaspUSB .h related with the different kind of numbers that can be printed on the screen.

2.2. Initialization
Two functions have been created to open and close the UART used to communicate via USB.
Example of use
{
USB.ON(); // Opens the UART at 115200 bps by default
USB.OFF(); // Closes the UART
}

2.3. Reading data

Two functions have been developed for reading data or checking if data is available in the UART. One more function has been
developed to free the UART buffer.
Example of use
{
int data_read=0;
if(USB.available())
{
// If data is available 1 is returned
data_read=USB.read(); // Reads data from UART0
}
USB.flush(); // Frees the UART buffer. All the data unread are lost.
}

-4-

v4.0

USB Library

2.4. Printing data

Some functions have been created to write data to the UART.
Example of use:
Print a character
{
char charac=a;
USB.print(charac); // Writes the char a to the UART
USB.println(charac); // Writes the char a to the UART adding an EOL
USB.println(); // Writes an EOL
}

Print a string
{
char* string=Hello;
USB.print(string); // Writes a string to the UART
USB.println(string); // Writes a string to the UART adding an EOL
}

Print uint8_t (1 Byte)

{
uint8_t unsigned=3;
USB.print(unsigned); // Writes the number 3 to the UART
USB.println(unsigned); // Writes the number 3 to the UART adding an EOL
}

Print int (2 Bytes)

{
int integer=54345;
USB.print(integer); // Writes the number 54345 to the UART
USB.println(integer); // Writes the number 54345 to the UART adding an EOL
}

Print long (4 Bytes)

{
long long_int=1234567;
USB.print(long_int); Writes the number 1234567 to the UART
USB.println(long_int); Writes the number 1234567 to the UART adding an EOL
}

Print float (4 Bytes)

{
float float_num=1.23456;
USB.print(float_num); Writes the number 1.23456 to the UART
USB.println(float_num); Writes the number 1.23456 to the UART adding an EOL
}

Print hexadecimal number (1 Byte)

{
uint8_t num = 0x14;
USB.printHex(num); // Writes the number 0x14 in base 16
}

-5-

v4.0

USB Library
Print numbers in different formats
{
USB.println(78);
USB.println(78, BIN);
USB.println(78, OCT);
USB.println(78, DEC);
USB.println(78, HEX);

//
//
//
//
//

Writes
Writes
Writes
Writes
Writes

78
78
78
78
78

in
in
in
in
in

integer format: 78
binary format: 1001110
octal format: 116
integer format: 78
hexadecimal format: 4E

Print formatted data

{
int var1=0xABCD;
int var2=3.1416;
int var3=32767; //max signed int
int var4=32768; //overflows signed int range
long var5=2147483647; //max signed long int
long var6=2147483648; //overflows signed long range
unsigned long var7=4294967295; //max unsigned long
USB.printf(%s\n, Hello world);
// Writes Hello World with EOL
USB.printf(millis: %lu\n,millis()); // Writes millis: 356 with EOL
USB.printf(hexadecimal: %x\n, var1); // Writes hexadecimal: abcd with EOL
USB.printf(decimal: %d\n, var1);
// Writes decimal: -21555 with EOL
USB.printf(unsigned int: %u\n, var1);// Writes unsigned int: 43981 with EOL
USB.printf(float: %f\n, var2);
// It is not possible to print floats this way
USB.printf(int: %d\n, var3);
// Writes int: 32767 with EOL
USB.printf(32768 overflows: %d\n, var4); // Writes 32768 overflows: -32768
USB.printf(signed long: %ld\n, var5);// Writes signed long: 2147483647 with EOL
USB.printf(2147483648 overflows: %ld\n, var6);Writes 2147483648 overflows: -2147483648
USB.printf(unsigned long: %lu\n, var7); // Writes unsigned long: 4294967295
}

USB function example:

http://www.libelium.com/development/waspmote/examples/usb-01-usb-functions

Formatted print function example:

http://www.libelium.com/development/waspmote/examples/usb-02-usb-printf-function

-6-

v4.0

Utilities Library

3. Utilities Library
3.1. Waspmote Libraries
3.1.1. Waspmote Utilities Files
WaspUtils.h ; WaspUtils.cpp

3.1.2. Constructor
To start using the Waspmote Utilities library, an object from class WaspUtils must be created. This object, called Utils, is created
inside the Waspmote Utilities library and it is public to all libraries. It is used through the guide to show how the Waspmote
Utilities library works.
When creating this constructor, no variables are initialized.

3.1.3. Pre-Defined Constants

There are some constants defined in WaspUtils.h used to make it easier the understanding of the code.

3.2. Using LEDs

These functions are capable of changing the state of the LEDs. It is possible to change their state, to get their state and to blink
both LEDs for a specific time.
Example of use
{
// 1. set LEDs ON
Utils.setLED( LED1, LED_ON); // Sets the green LED ON
Utils.setLED( LED0, LED_ON); // Sets the red LED ON
// 2. set LEDs OFF
Utils.setLED( LED1, LED_OFF); // Sets the green LED OFF
Utils.setLED( LED0, LED_OFF); // Sets the red LED OFF
// 3. Get LEDs state
uint8_t state1=Utils.getLED(LED1); // Gets the state of LED1
uint8_t state0=Utils.getLED(LED0); // Gets the state of LED0
// 4. Blink LEDs
Utils.blinkLEDs(1000); // Blink LEDs using a delay of 1000ms for blinking
}

Using LEDs example:

http://www.libelium.com/development/waspmote/examples/ut-02-using-leds

-7-

v4.0

Utilities Library

3.3. Using EEPROM

This is the microcontrollers EEPROM (4KB) non-volatile memory. EEPROM addresses from 0 to 1023 are reserved by Waspmote
API to save important data, so they must not be over-written. Thus, the available storage addresses go from 1024 to 4095.
RESERVED
0

AVAILABLE
1023 1024

4095

The function that writes the EEPROM is Utils.writeEEPROM. This function does not permit to write reserved EEPROM
addresses.
Example of use
{
Utils.writeEEPROM(1024,B); // Write the value B in the address 1024
uint8_t data=Utils.readEEPROM(1024); // Reads the value stored in the address 1024
}

Using EEPROM example:

http://www.libelium.com/development/waspmote/examples/ut-01-using-eeprom

3.4. Reading Serial ID

This function reads the Waspmote unique serial identifier. This identifier is composed by 8 bytes.
Example of use:
{
unsigned long id = 0;
id = Utils.readSerialID();
}

Using EEPROM example:

http://www.libelium.com/development/waspmote/examples/ut-03-reading-serial-id

3.5. Converting types

Convert from long int to string
{
char number[20];
Utils.long2array(1356, number); // Gets the number 1356 into the string
}

Convert from float to string

{
char number[20];
Utils.float2String(134.54342, number, 3); // Convert 134.54342 to string (3 decimals)
}

-8-

v4.0

Utilities Library
C standard Library allows the user to convert between different variable types. This is a list with some supported function
prototypes:
Convert string to int (2 Bytes):
{
int number = atoi(2341);
}

Convert from string to long integer (4 Bytes):

{
long int number = atol(143413);
}

Converting types example:

http://www.libelium.com/development/waspmote/examples/ut-04-convert-types

-9-

v4.0

Input/Output pins

4. Input/Output pins
Waspmote can communicate with other external devices using different input/output ports.

Figure 1: I/O sockets in Waspmote

ANALOG

3V3 SENSOR POWER

DIGITAL 8

GND

DIGITAL 6

DIGITAL 7

DIGITAL 4

DIGITAL 5

DIGITAL 2

DIGITAL 3

RESERVED

DIGITAL 1

ANALOG 6

ANALOG 7

ANALOG 4

ANALOG 5

ANALOG 2

ANALOG 3

3V3 SENSOR POWER

ANALOG 1

GPS POWER

5V SENSOR POWER

SDA

SCL

Figure 2: Description of sensor socket pins

GND

GND

ANALOG 6

ANALOG 7

3V3 SENSOR

3V3 SENSOR

Figure 3: Description of sensor socket pins

-10-

v4.0

Input/Output pins

4.1. Reading ANALOG inputs

It gets the value read by the corresponding analog input. Waspmote has 7 analog inputs in the sensor connector. Each input
is directly connected to the microcontroller. The microcontroller uses a 10-bit analog to digital converter (ADC). The reference
voltage value for the inputs is 0V (GND). The maximum value of input voltage is 3.3V. To obtain input values, the function
analogRead is used. The value read from this function will be an integer number between 0 and 1023 bits, where 0 corresponds
to 0 V and 1023 to 3.3 V.
Example of use
{
int
int
int
int
int
int
int

val1
val2
val3
val4
val5
val6
val7

=
=
=
=
=
=
=

analogRead(ANALOG1);
analogRead(ANALOG2);
analogRead(ANALOG3);
analogRead(ANALOG4);
analogRead(ANALOG5);
analogRead(ANALOG6);
analogRead(ANALOG7);

//
//
//
//
//
//
//

Read
Read
Read
Read
Read
Read
Read

the
the
the
the
the
the
the

input
input
input
input
input
input
input

ANALOG1
ANALOG2
ANALOG3
ANALOG4
ANALOG5
ANALOG6
ANALOG7

and
and
and
and
and
and
and

store
store
store
store
store
store
store

its
its
its
its
its
its
its

value
value
value
value
value
value
value

in
in
in
in
in
in
in

val1
val2
val3
val4
val5
val6
val7

4.2. Digital I/O

4.2.1. Setting DIGITAL pin mode
It configures the specified pin as an input or an output.
It returns nothing.
Example of use
{
pinMode(DIGITAL1, INPUT); // Sets DIGITAL1 as an input
pinMode(DIGITAL4,OUTPUT); // Sets DIGITAL4 as an output
}

4.2.2. Reading DIGITAL Inputs

It reads the value from the specified digital pin.
It returns 0 or 1.
Example of use
{
int val=0;
pinMode(DIGITAL1, INPUT); // Sets DIGITAL1 as an input
val=digitalRead(DIGITAL1); // Reads the value from Digital 1
}

4.2.3. Writing DIGITAL Outputs

It writes a HIGH or LOW value to a digital pin.
Its voltage will be set to 3.3V for a HIGH value, and 0V for a LOW value.
Example of use
{
pinMode(DIGITAL4, OUTPUT); // Sets DIGITAL4 as an output
digitalWrite(DIGITAL4, HIGH); // Writes High to Digital 4
}

-11-

v4.0

Input/Output pins

4.2.4. DIGITAL1 pin as PWM output

There is one pin that can be used as an analog or digital pin.
This pin is called DIGITAL1.
It returns nothing.
Example of use
{
analogWrite(DIGITAL1, 128); // Writes a value comprised between [0-255] in DIGITAL1
}

-12-

v4.0

Getting Free RAM Memory

5. Getting Free RAM Memory

5.1. Waspmote Files
Inside the Core directory we can find both MemoryFree.cpp and MemoryFree.h which develop the function that allows the user
to get the available free memory in Waspmotes RAM memory.

5.2. freeMemory function

This is the function that returns the Waspmotes available memory in Bytes.
Waspmote RAM
.data
Variables

.bss
Variables

Heap

Free Memory

Stack

Figure 4: RAM Memory spaces

The different sections in RAM memory are explained below:

.data variables/.bss variables: Memory space for initialized and uninitialized variables
Heap: Memory space for dynamic memory allocation.
Stack: Memory space used for calling subroutines and storing local (automatic) variables. This memory space grows downwards.
Example of use
{
USB.print(free Memory (Bytes):);
USB.println(freeMemory()); // prints free RAM
}

Getting free memory example:

http://www.libelium.com/development/waspmote/examples/ut-05-get-free-memory

-13-

v4.0

Reading basic sensors

6. Reading basic sensors

There are some basic sensors that can be plugged directly to Waspmote except for the light sensor which needs some hardware
modifications.

Figure 5: Basic sensors

6.1. Temperature Sensor

The temperature sensor MCP9700A can be plugged directly to the secondary I/O Sensor socket. The sensor pins are described
below indicating where they have to be plugged to:

Pin1: Vcc (3V3 SENSOR)

Pin2: Vout (ANALOG6)

Pin3: GND
Example of use:
{
float temperature;
temperature = Utils.readTemperature();
}
Figure 6: MCP9700A Temperature sensor

Reading temperature sensor example:

http://www.libelium.com/development/waspmote/examples/bs-01-reading-temperature

-14-

v4.0

Reading basic sensors

6.2. Light Sensor

The LDR sensor needs a simple hardware modification so as to be connected directly to Waspmote. This sensor is connected to
the main I/O sensor socket. The modification is presented below:
The sensor pins are connected this way:

Pin Vcc (3V3 SENSOR POWER)

Pin Vout (ANALOG5)

Pin GND (GND)

Figure 7: LDR sensor

Figure 8: LDR sensor hardware modification

Example of use:
{
int light;
light = Utils.readLight();
}

Reading light sensor example:

http://www.libelium.com/development/waspmote/examples/bs-02-reading-light

6.3. Humidity
The humidity sensor 808H5V6 can be plugged directly to the secondary I/O Sensor socket. The sensor pins are described below
indicating where they have to be plugged to:

Pin1: Vcc (3V3 SENSOR)

Pin2: Vout (ANALOG7)

Pin3: GND

Example of use:
{
int humidity;
humidity = Utils.readHumidity();
}

Figure 9: 808H5V6 Humidity sensor

Reading humidity sensor example:

http://www.libelium.com/development/waspmote/examples/bs-03-reading-humidity

Reading all sensors at the same time:

http://www.libelium.com/development/waspmote/examples/bs-04-reading-sensors

-15-

v4.0

Reading basic sensors

6.4. DS18B20 Temperature Sensor

This temperature sensor also needs a simple hardware modification to be directly plugged to Waspmote. Three pins come out
of the sensor: Red (3V3), Black (GND) and White (Output pin). A 4K7 resistor must be connected between the red and white pins.
The Sensor output can be plugged in any Waspmote digital pin. When reading the sensor the output pin is selected as input
parameter:
Example of use:
{
// temperature sensor plugged to DIGITAL8 pin
float temp;
temp = Utils.readTempDS1820(DIGITAL8);
}

Reading DS18B20 temperature sensor example:

http://www.libelium.com/development/waspmote/examples/bs-05-reading-ds18b20

-16-

v4.0

Code examples and extended information

7. Code examples and extended information

In the Waspmote Development section you can find complete examples:

http://www.libelium.com/development/waspmote/examples

-17-

v4.0

API changelog

8. API changelog
Function / File

Changelog

Version

MAX_ARGS

This definition has been deleted

V0.31 v1.0

MAX_ARG_LENGTH

This definition has been deleted

V0.31 v1.0

EEPROM_START

This definition has been created

V0.31 v1.0

SD_SELECT

This definition has been created

V0.31 v1.0

SRAM_SELECT

This definition has been created

V0.31 v1.0

SOCKET0_SELECT

This definition has been created

V0.31 v1.0

SOCKET1_SELECT

This definition has been created

V0.31 v1.0

ALL_DESELECTED

This definition has been created

V0.31 v1.0

char arguments[MAX_ARGS][MAX_ARG_LENGTH];

This attribute has been deleted

V0.31 v1.0

WaspUtils::setMuxGPRS

This function has been renamed to setMuxSocket1

V0.31 v1.0

WaspUtils::setMuxUSB

New function created

V0.31 v1.0

WaspUtils::muxOFF

New function created

V0.31 v1.0

WaspUtils::setMuxSocket0

New function created

V0.31 v1.0

WaspUtils::parse_decimal

Function deleted

V0.31 v1.0

WaspUtils::parse_degrees

Function deleted

V0.31 v1.0

WaspUtils::gpsatol

Function deleted

V0.31 v1.0

WaspUtils::gpsisdigit

Function deleted

V0.31 v1.0

WaspUtils::parse_latitude

Function deleted

V0.31 v1.0

WaspUtils::Dec2hex

Function deleted

V0.31 v1.0

WaspUtils::array2long

Function deleted

V0.31 v1.0

WaspUtils::setID

New function created

V0.31 v1.0

WaspUtils::setAuthKey

New function created

V0.31 v1.0

WaspUtils::readSerialID

New function created

V0.31 v1.0

WaspUtils::readTempDS1820

New function created

V0.31 v1.0

WaspUtils::readTemperature

New function created

V0.31 v1.0

WaspUtils::readHumidity

New function created

V0.31 v1.0

WaspUtils::readLight

New function created

V0.31 v1.0

WaspUtils::strtolong

Function deleted

V0.31 v1.0

WaspUtils::sizeOf

Function deleted

V0.31 v1.0

WaspUtils::strCmp

Function deleted

V0.31 v1.0

WaspUtils::strCp

Function deleted

V0.31 v1.0

WaspUtils::setSPISlave

New function created

V0.31 v1.0

-18-

v4.0