QuickStart Library Overview

QuickStart Library Overview

 

Introduction

The QuickStart Library (QSL) sits on top of the SmartMesh C Library. It handles most application logic, so the user need only supply low-level hardware drivers and use a handful of APIs to connect to a network and send data. This greatly reduces firmware development time for your microcontroller.  

 

 

The SmartMesh QSL abstracts the complexity of the SmartMesh IP mote startup and network search/join procedure into a few intuitive functions. 

 

Gliffy Diagram

This is a step-by-step guide for how to get started with data publishing from a SmartMesh IP Mote with an external microcontroller (MCU) connected serially. By following these steps, you can make your application publish data into a SmartMesh IP network by utilizing only a few intuitive functions from the SmartMesh QuickStart Library (QSL).  The library also includes example code for certain platforms , and this guide will also cover some details on setting these up.

 

While the QSL provides sufficient functionality for sending/receiving data and configuring the most important network settings on a SmartMesh IP mote, more advanced applications that need access to all parameters should access the mote serial API directly (see Customizing the QSL).

 

Acronyms, Abbreviations, and Definitions

API

Application Programming Interface

CLI

Command Line Interface

FSM

Finite State Machine

GPIO

Genearal-Purpose Input/Output

HDLC

High-Level Data Link Control

OS

Operation System

QSL

QuickStart Library

RPi

Raspberry Pi

UART

Universal Asynchronous Receiver/Transmitter