1.1 Necessary Hardware

• Microcontroller/development board of your choice
  • With necessary programmer
• SmartMesh IP Mote (DC9003A-B)
  • With 6 female-female jumper cables
• SmartMesh IP Manager (DC2274A-A)
• SmartMesh Interface Board (DC9006A)
  • With USB to USB-micro cable
• Computer (should support Python and Java)

1.2 Necessary Software

• FTDI Serial Drivers
• IDE/programmer/debugger of your choice
• SmartMesh C Library
• SmartMesh QuickStart Library
• Git (optional)

2 Prepare Libraries

2.1 About

The SmartMesh QSL abstracts the complexity of the SmartMesh IP mote startup and network search/join procedure into a few intuitive functions. It utilizes the SmartMesh C Library, which provides a full implementation of the serial API of the SmartMesh IP mote.

2.2 Download

There are two ways to download the QuickStart Library:

Clone The Source Code

1. Clone the repository: TODO: Add link when public repo created
2. Checkout the latest release: TODO: Refer to latest release

3. Initialize and update the neccessary C Library submodule:

    

   (...)/QuickStart_Library $ git submodule init (...)/QuickStart_Library $ git submodule update

Download Zip/Tar

1. Go to the QSL release page and download the latest zip/tar: TODO: Add link when public repo created
2. Go to the C Library release page and download the latest zip/tar: TODO: Can possibly be added as attachment to QSL release. If not: Make a note about why it needs to be downloaded separately
3. Unzip the files using your favourite compression tool.

2.3 Directory Structure

The QSL repository contains the following directories:

• sm_qsl/ contains the QuickStart Library as a collection of headers (.h) and source code files (.c).
  
• sm_clib/ is a submodule that contains the underlying C Library, with sample applications for its direct use.
  • sm_clib/ is the C Library itself as a collection of headers (.h) and source code files (.c).
    • ports/ contains an example of the necessary C Library ports.
  • examples/ contains sample applications which use the C Library directly.
• examples/ contains sample applications utilizing the QSL
  • rpi/SimplePublish/ contains an example that connects and starts publishing random data, where the necessary porting functions have been implemented for the Raspberry Pi.
     

The SmartMesh QuickStart Library, and C Library it depends on, are both designed so you can drop their directories into your application without modification, i.e. these two folders from the structure above:

• sm_qsl/
• sm_clib/sm_clib/

You are free to modify them to suit your needs; however, we recommend you avoid changing the contents of these two directories, as this will allow you to easily replace them with future revisions.

In addition to the files in these folders, you need to implement a handful of functions, as discussed in the next section.

2.4 Port to Your Hardware

The QSL and the underlying C Library are written to be used as-is in any C-based platform; however, you have to implement a handful of functions to adapt them to a specific platform. These functions are implemented in the example code provided for certain platforms (presented in later chapters), so you can skip the details of this section for now if you plan on using these (or simply wish to have a look at the examples first).

 The necessary functions are declared in following header files:

• dn_uart.h: These functions allow the SmartMesh C Library to send bytes over the serial port, and receive bytes from the serial port. A "flush" function is provided in case the serial (UART) driver of the user platform is frame-oriented rather than byte-oriented.
• dn_lock.h: These functions allow the SmartMesh C Library to operate in a multi-threaded environment. If this is the case in the user system, the implementation of these functions would typically consist of pending/posting a mutual exclusion semaphore (mutex); if not, simply use stub functions (i.e. "empty functions").
• dn_endianness.h: These functions are used to match multi-byte API fields (which are big-endian) to the endianness of the platform.
• dn_time.h: These functions allows the QSL to perform timing and schedule tasks.
• dn_watchdog.h: These functions allow the QSL to make sure any watchdog in the user application is fed during processes that can take some time (e.g. searching for a network). If no watchdog is present, simply use stub functions.

3 Install FTDI Serial Drivers

To be able to connect to and configure the mote and manager, your computer will need the necessary FTDI Serial Drivers. Most modern OSes come with FTDI drivers pre-installed (e.g. Linux), but you may have to install them manually if they do not configure automatically when you plug in the interface board or manager. Follow the installation guide corresponding to your OS if you have any trouble.

If installed correctly, the interface board or manager should appear as a group of 4 serial ports when connected via USB:

• Windows: 4 COM ports can be viewed using the Device Manager (Control Panel -> System -> Hardware -> Device Manager -> Ports)
• Linux: $ dmesg | grep FTDI should detect FTDI converters attached to /dev/ttyUSBn to /dev/ttyUSBn+3

The ports of interest are the third and fourth, which map to the CLI and API, respectively, as defined by Table 1. 

*: Refers to the serial ports created by the FTDI drivers.
**: Default values (can be changed).

4 Prepare Mote

4.1 Select Slave Mode

 

 

Figure 1: DC9003 mote board (left) connected to a computer via the DC9006 interface board (center).

By default, the motes in starter kits are configured for master mode; a demo mode where the API is disabled and an application is run that generates sample data and controls joining. To use the mote alongside an external MCU, the mote has to be configured for slave mode; the API is enabled and the mote expects a serially attached application to control it.

1. Start by connecting the mote to your computer via the interface board, as shown in Figure 1.
2. Identify the port name that maps to the CLI. For example, if you are in Windows and see the four COM ports pictured below, the CLI will be accessible through COM14.
    
3. Connect to the mote CLI with a third-party serial terminal of your choice (e.g. putty). See Table 1 for configuration details.

4. Use the get mode command to see the current mode:

    

   > get mode master

5. Use the set mode command to switch to slave mode, followed by reset for the change to take effect. After rebooting, a new get mode should confirm the persistent mode change.

    

   > set mode slave   > reset    > SmartMesh IP mote, ver 1.3.3.1 (0x100) > get mode slave

6. Disconnect the mote from the interface board and make sure to remove its battery (if any), as we will power the mote from the MCU.

4.2 Connect to Your Microcontroller

You will need to connect 4 wires between your MCU and the mote for power and serial communication, as shown in Table 2. In addition you need to ground the mote RX Request to Send (RTS) and TX Clear to Send (CTS); unless your MCU cannot wake on data and has to use these accordingly (the mote does not need incoming flow control).

Table 3 lists the names (equal to those found on the silkscreen) of the P1 pin header on the DC9003A mote board visible in Figure 2.

Figure 2: The DC9003A (mote) with the P1 pin header marked in red.

5 Prepare Manager

Figure 3: The DC2274A SmartMesh IP USB Manager

If you installed the correct drivers, you only have to insert the USB port in your computer: The manager will power up and start creating a network automatically.

Similar to the mote via the interface board, you should now see 4 new serial ports, where the third and fourth give you access to the CLI and API, respectively.

5.1 Factory Default Values

By default the manager is shipped with a well-known network ID and join key that your application will need to connect to its network, so you do not need to configure anything. However, it is useful to know about certain commands available through the CLI. These commands are presented in the next section, while relevant default values for its configuration parameters are listed in Table 4.

5.2 Useful CLI Commands

With the manager connected to your computer via USB:

1. Just like with the mote, identify the correct serial port name and connect to the CLI with a serial terminal of your choice (again, see Table 1 for configuration details).

2. Unlike the mote, you will first have to login to have access to the commands we want:

   login

    

   > login user

3. You now have access to a wide range of commands, where the most interesting ones are shown below.