Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
202 lines (163 sloc) 11.8 KB

Twilio Breakout SDK Environment Setup

This page documents how to get started using the Breakout SDK and what it provides. Today, the Breakout SDK is built for the STM32F405RG MCU and U-Blox Sara-N410 cellular module in mind. This specific Developer Board was provided in Twilio's Alfa Developer Kit and distributed to SIGNAL attendees, and it came with Grove sensors – humidity, light, and ultrasonic distance.

Alfa Developer Kit

Alfa Developer Kit contents

  • Programmable Wireless Narrowband SIM
  • Alfa Developer Board
  • LTE antenna
  • GPS antenna
  • 3 Grove components:
    1. Button
    2. Ultrasonic
    3. Temperature/Humidity
  • Lithium battery
  • Micro-USB cable

Requirements

The following items are required to use Breakout SDK:

Installing the Narrowband SIM and the LTE Antenna into the Developer Board

  1. Register the Narrowband SIM in the Programmable Wireless Console
  2. Insert the smallest form factor of the Narrowband SIM in the bottom of the two slots available on the Developer Board, closest to the PCB.

Narrowband SIM holder

The smallest form factor of a SIM is the Nano (4FF) SIM size. The top slot is a Micro-SD card slot. If you insert the Narrowband SIM in the top slow, gently pry it out with needle-nose pliers.

  1. Connect the LTE Antenna to the LTE pin located on the bottom of the board.

Set up your development environment

The following steps will guide you from downloading the Arduino IDE to installing sample applications on your Developer board.

Arduino IDE Installation

  1. Download Arduino IDE 1.8.9+

dfu-util Installation

OSX

The following step is required for OSX:

  1. Install Homebrew by typing the following in a Terminal: /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
  2. Install dfu-util using Homebrew by typing the following in a Terminal: brew install dfu-util libusb

Note: Use dfu-util 0.9 or greater if available. Check dfu-util version with brew info dfu-util

Windows

The follow steps are required for Windows:

  1. Install USB Drivers
Ubuntu
  1. Install an updated dfu-util using apt: sudo apt-get install dfu-util
  2. Configure permissions for USB serial port provided by the Alfa developer board. Without this, you may face permission issues when flashing the board unless you run dfu-util setuid to root.
sudo tee -a /etc/udev/rules.d/50-twilio-local.rules << _DONE_
# Twilio Alfa kit
# Bus 001 Device 035: ID 0483:5740 STMicroelectronics STM32F407
SUBSYSTEMS=="usb", ATTRS{idVendor}=="0483", ATTRS{idProduct}=="5740", GROUP="dialout", MODE="0666"
_DONE_
  1. Plug in the developer kit and verify permissions: ls -l /dev/ttyACM* the device should be readable and writable by all users. crw-rw-rw- 1 root dialout 166, 0 Jul 8 16:41 /dev/ttyACM0

Arduino IDE Developer Board Installation

  1. Insert the Micro-USB cable into the Developer Board
  2. Insert the other end of the USB cable in your computer
  3. Open Arduino IDE
  4. Click Arduino > Preferences
  5. Copy the following URL into the Additional Boards Manager URLs field: https://raw.githubusercontent.com/Seeed-Studio/Seeed_Platform/master/package_seeeduino_boards_index.json
  6. Click OK
  7. Click Tools > Boards > Boards Manager
  8. Type "Seeed" into the search field
  9. Select the Seeed STM32F4 Boards version 1.2.5 or later
  10. Click Install
  11. Close the Boards Manager window
  12. Click Tools > Boards > Wio Tracker LTE
  13. Click Tools > Port > {Your Modem Port Here}
    • OSX: /dev/{cu|tty}.usbmodem{XXXX}
    • Linux: /dev/ttyACM{X}
    • Windows: COM{X}

Arduino > Preferences

Arduino Preferences

Tools > Boards > Boards Manager > Seeed STM32F4 Board

Arduino Preferences

Breakout SDK Installation

The Arduino library makes use of a submodule for the shared cellular module code. Please be sure to either install a bundled release zip below or perform a recursive clone locally.

  1. Visit the releases page for this project
  2. Download the most recent recent as a ZIP file, by expanding the Assets section of the release
  3. Make note of the download location
  4. Open Arduino IDE
  5. Select Sketch > Include Library > Add .ZIP Library and select the .zip file downloaded
  6. Restart Arduino IDE

Updating Breakout SDK on your local machine

The library will now be present for Arduino IDE to use. To update the library:

  1. Delete the library from your Arduino directory
    • You can find the library to delete in your Arduino/libraries directory
    • OSX: in ~/Documents/Arduino/libraries
  2. Follow the steps in the Breakout SDK Installation section above

Tip: An alternative to downloading the library as a ZIP is to check the library out using git in the Arduino/libraries directory, or symlink the locally-checked out copy there, just be sure to update the submodules.

Dependency Installation

  1. Open Arduino IDE
  2. Visit Tools -> Manage Libraries
  3. Search for Paho then install the ArduinoMqtt library, version 1.5.1 or better

Flash the Developer Board with sample applications

  1. Open Arduino IDE
  2. Click File > examples and navigate to the Breakout Arduino Library examples
  3. Select File > Examples > Breakout Massive SDK Arduino Library > AlfaKit > Sample.ino
  4. Several tabs should be open now 1.Sample is the top-level file, it contains the sketch's [setup()] (https://www.arduino.cc/reference/en/language/structure/sketch/setup/) and loop() functions. You can uncomment one of the #include Sample* directives, to enable a sample using a specific sensor. If you want to customize your sketch, you can do it directly here, or in the included modules.
  5. SampleButton.h, SampleGPS.h, SampleTemperatureAndHumidity.h and SampleUltrasonic.h include the actual code for setting up and running samples using a button, GPS receiver, temperature/humidity sensor and ultrasonic proximity sensor respectively.
  6. config.h is for you to set up your specific application. * un-comment out #define USE_TLS_CERTIFICATES or #define USE_USERNAME_PASSWORD to enable either TLS + certificates header (see below) or username/password authentication respectively * Set MQTT_BROKER_HOST and MQTT_BROKER_PORT to the location of your MQTT broker * Change MQTT_KEEP_ALIVE to 20 if your broker tends to reset connections on inactivity, you can adjust this keep alive interval to your needs * Set MQTT_CLIENT_ID to whatever you want your client ID to be, please note this must be unique across clients connected to your MQTT broker * Change MQTT_PUBLISH_TOPIC and MQTT_STATE_TOPIC to the topics you want your sample to be publishing and listening to. If you want to go deeper, you can always define more topics to publish/subscribe to, no need to add them to the config.h if you don't want to. * If you are using login/password authentication, set the credentials in MQTT_LOGIN and MQTT_PASSWORD.
  7. tls_credentials.h is for you to paste your TLS credentials, including device's certificate and private key (TLS_DEVICE_CERT, TLS_DEVICE_PKEY) and server's certificate authority certificate (TLS_SERVER_CA)
  8. modem.h contains service procedures to initialize the modem on the AlfaKit. Refer to it if you're curious about what is happening under the hood.
  9. mqtt.h contains shims to integrate with Paho MQTT client, and publishing/subscribing code. It is what you will want to hack on if you want to create more topics.

Note: The example ino files are readonly. Save your changes to a new location.

  1. Enable Bootloader mode on the Developer Board:
    1. Press and hold the BOOT0 button underneath the Developer Board
    2. Press and hold the RST on the top of the Developer Board
    3. Release the RST on the top of the Developer Board
    4. Release the BOOT0 button to enable Bootloader mode
  2. Click Sketch > Upload to upload the example to the Developer Board
  • Do not click Upload Using Programmer
  1. Click the RST button when the sketch has finished uploading
  2. Click Tools > Port > {Your Modem Port Here}
    • OSX: /dev/{cu|tty}.usbmodem{XXXX}
    • Ubuntu and other Linuxes: /dev/ttyACM{X}
    • Windows: COM{X}
  3. Click Tools > Serial Monitor
  4. Monitor the output of the board in the Serial Monitor window

When the board is in Bootloader mode the serial port won't be initialized and not available to monitor.

Receiving the output WARNING: Category 'Device' in library Wio LTE Arduino Library is not valid. Setting to 'Uncategorized' See known #4 under Limitations and Workarounds below.

Note Connecting to the network for the first time can take a minute or two. If the light doesn't go blue, try another location. You may not have cell coverage in your current location.

Developer Board LEDs

The LEDs on the Developer Board are set to function as the following:

  • Red CHG LED - Lights up based on the battery charging level, will flicker dimly when no battery is connected.
  • Yellow Status LED - lights up when the modem module is power on.
  • Blue Network LED - lights up when the modem module is successfully registered to the mobile NB-IoT network.
  • Red RST LED - lights up during the reset procedure. To place the module in firmware flashing mode, press the BOOT0 switch on the board when this LED lights up.
  • WS2812 RGB LED - available for your application and is used in the briefly in the examples to indicate the status of the Breakout SDK.

Note that the lithium battery is recommended to be plugged in at all times, especially if your USB power source does not provide sufficient power for the board at peak levels.

Limitations and Workarounds

  1. Receiving the output WARNING: Category 'Device' in library Wio LTE Arduino Library is not valid. Setting to 'Uncategorized' in Arduino IDE.
    • Problem: Incorrect version of dfu-util. Using 0.8 or lower.
    • Solution: Update dfu-util to 0.9+
      • OSX: Type the following in a Terminal: brew install dfu-util
  2. Unable to remove lithium battery from Developer Board.
    • Problem: JST pings lock lithium battery into place.
    • Solution: If the battery is pushed in a touch too far, it locks. Lift the pins from the JST connector and pull on the lithium battery cable or use a pair of needle nose pliers to get ahold of the connector. Be careful not to damage or puncture the battery as they can be dangerous if damaged. The JST connector has tabs that latch on and are not generally meant to be disconnected again.
  3. No DFU capable USB device available
    • Problem: Unable to upload firmware. Device is not in DFU mode.
    DFU begin
    dfu-util 0.8
    
    Copyright 2005-2009 Weston Schmidt, Harald Welte and OpenMoko Inc.
    Copyright 2010-2014 Tormod Volden and Stefan Schmidt
    This program is Free Software and has ABSOLUTELY NO WARRANTY
    Please report bugs to http://sourceforge.net/p/dfu-util/tickets/
    
    dfu-util: Invalid DFU suffix signature
    dfu-util: A valid DFU suffix will be required in a future dfu-util release!!!
    dfu-util: No DFU capable USB device available
    DFU end
    
You can’t perform that action at this time.