Trident IoT SDK
 
Loading...
Searching...
No Matches
Getting started with Trident IoT SDK

Table of Contents

Welcome

Welcome to the Trident IoT SDK! This is the starting point for developing both Z-Wave and Zigbee based IoT products. This guide will explain how to get started using the Trident IoT development tools and do a short run through of the steps necessary to create a project, build it, and flash it to a board. This is intended to be a high level overview with more detailed explanations for the various pieces found at:

  • elcap - elcap documentation page
  • Trident Hardware - hardware documentation page (TODO - this link is probably incorrect)
  • Z-Wave - Z-Wave protocol implementation
  • Zigbee - Zigbee protocol implementation

Prerequisites

Software

Make sure that elcap has been previously installed and is passing all checks from command:

elcap doctor

Please see the elcap documentation page for instructions on how to do this.

Hardware

You will need one of the Trident development kits and a USB-C cable to get started. Please see the Trident Hardware page for available development kits.

Creating a Project

A new project is created by using the elcap new command. Running elcap new from a terminal window will walk you through the steps to create a project. These steps are:

  1. Start new project wizard with command:
    elcap new
  2. Enter the name you would like to use for your project
  3. Enter the path to where you would like the project directory to get created (default = project name in the current directory)
  4. Select SDK version
  5. Select a project category (protocol of interest or bootloader to make a standalone bootloader application)
  6. Select a sample applications
  7. Select a chip target
  8. Confirm project generation
Note
Protocol specific sample applications contain the bootloader within the project and will create combined hex files as part of the build. It is not required to create a standalone bootloader to get the sample applications to run.

Building a Project

Once the project has been created, building it can happen using 2 different methods. The first is from the terminal window by invoking elcap commands directly within the project directory. The second is using custom Trident IoT tasks from within VS Code. See VS Code Integration for more details around VS Code support.

Note
A Trident IoT VS Code extension is currently in development, but in the meantime, we've provided custom Tasks to support Trident projects within VS Code.

Method 1: Terminal Window

  1. Navigate to the previously created project directory from a terminal window
  2. Run command
    elcap build

Method 2: VS Code

  1. Open previously created project directory in VS Code
  2. Open the command palette using Ctrl+Shift+P on Linux and Windows, or Cmd+Shift+P on MacOS.
  3. Type "Tasks: Run Task" into the command palette and select the "Tasks: Run Task" option.
  4. Observe the "[Trident-IoT]" tasks appear in the task list.
  5. Select "[Trident-IoT] Build (Debug)" and press enter.
    • Debug build can also be invoked using Ctrl+Shift+B on Linux and Windows, or Cmd+Shift+B on MacOS.
Note
If the CMake extension is installed in VS Code, then an invalid CMakeCache.txt file is created when the Trident project is first opened. To fix this run the task "[Trident-IoT] Clean Build" before performing the build step.

Flashing a Project

Similarly to building a project, flashing can be done from either the terminal window using elcap commands directly or from VS Code using the custom Trident IoT Tasks. See VS Code Integration for more details around VS Code support.

Method 1: Terminal Window

  1. Verify that the terminal window is within the previously built project directory.
  2. Discover all attached development kits/programmers with command:
    elcap device discover
  3. Use the serial number for your development kit found in step 2 to flash your device with command:
    elcap flash --usb <serial-no>

Method 2: VS Code

  1. Verify that previously built project directory is open inside VS Code.
  2. Open the command palette using Ctrl+Shift+P on Linux and Windows, or Cmd+Shift+P on MacOS.
  3. Type "Tasks: Run Task" into the command palette and select the "Tasks: Run Task" option.
  4. Observe the "[Trident-IoT]" tasks appear in the task list.
  5. Select "[Trident-IoT] Discover Attached Devboards" and press enter.
  6. Note the serial number for the attached development kit in the VS Code terminal window.
  7. Open the tasks.json file inside the .vscode directory within the Trident project.
  8. Search for EditVsCodeTasksJsonToAddDevboardSerialNumber and replace it with the serial number from step 7.
  9. Open the command palette to run Task "[Trident-IoT] Flash Hexfile".
  10. Observe flash status in the VS Code terminal window.