SmartMesh IP Embedded Manager API Guide - …

1 SmartMesh IP Embedded Manager API GuidePage of 1111 SmartMesh IP EmbeddedManager API GuideSmartMesh IP Embedded Manager API GuidePage of 2111 Table of Contents1 About This Guide _____ Documents _____ Used _____ History _____ 82 Introduction _____ _____ 93 Protocol _____ Representation _____ Data Types _____ Representation _____ Order _____ Format _____ _____ Payload _____ Between Manager and Client _____ Communication _____ (Acknowledged) Communication _____ (Unacknowledged) Communication _____ for Writing Forward-Compatible Clients _____ 184 Commands _____ (0x1F) _____ (0x29) _____ (0x45) _____ (0x21) _____ (0x22) _____ (0x43) _____ (0x37) _____ (0x2B) _____ (0x35) _____ (0x2F) _____ (0x41) _____ (0x3E) _____ (0x46) _____ (0x3F) _____ (0x40) _____ (0x28) _____ (0x31) _____ (0x30) _____ (0x26) _____ 46 SmartMesh IP Embedded Manager API GuidePage of (0x2E) _____ (0x17) _____ (0x2A) _____ (0x25) _____ (0x23) _____ (0x15) _____ (0x3D) _____ (0x2C) _____ (0x3B) _____ (0x27)

2 _____ (0x32) _____ (0x3A) _____ (0x42) _____ (0x33) _____ (0x44) _____ (0x38) _____ (0x1A) _____ (0x36) _____ (0x2D) _____ (0x16) _____ 725 Notifications (0x14) _____ Notification _____ Notification _____ Notifications _____ Event _____ Event _____ Event _____ Event _____ Event _____ Event _____ Event _____ Event _____ Event _____ Event _____ Event _____ Event _____ Event _____ Event _____ Event _____ Notification _____ Report Messages _____ Notification _____ Notification _____ 99 SmartMesh IP Embedded Manager API GuidePage of 41116 Definitions _____ and Command Types _____ Types _____ Filters _____ Types _____ Codes _____ Profile _____ State _____ Frame Mode

3 _____ State _____ State _____ Type _____ Frame Mode _____ Filter _____ Direction _____ Priority _____ Finished Result _____ Power _____ Mode _____ Flags _____ Flags _____ User Roles _____ Test Types _____ Failure Reasons _____ 109 SmartMesh IP Embedded Manager API GuidePage of 51111 About This Related DocumentsThe following documents are available for the SmartMesh IP network:Getting Started with a Starter Kit - walks you through basic installation and a few tests to make sure your network isSmartMesh IP Easy Start Guideworking - the Installation section contains instructions for installing the serial drivers and exampleSmartMesh IP Tools Guideprograms used in the Easy Start Guide and other 's Guide - describes network concepts, and discusses how to drive mote and Manager APIs toSmartMesh IP User's Guideperform specific tasks, to send data or collect statistics.

4 This document provides context for the API for Interaction with a Device - used for human interaction with a Manager ( during development of a client, SmartMesh IP Manager CLI Guideor for troubleshooting). This document covers connecting to the CLI and its command set. - used for programmatic interaction with a Manager . This document coversSmartMesh IP Manager API Guideconnecting to the API and its command set. - used for human interaction with a mote ( during development of a sensorSmartMesh IP Mote CLI Guideapplication, or for troubleshooting). This document covers connecting to the CLI and its command set.

5 - used for programmatic interaction with a mote. This document covers connecting toSmartMesh IP Mote API Guidethe API and its command Development Tools - describes the various evaluation and development support tools included in the SmartMesh IP Tools Guide , including tools for exercising mote and Manager APIs and visualizing the SDKA pplication Notes - Cover a wide range of topics specific to SmartMesh IP networks and topics thatSmartMesh IP Application Notesapply to SmartMesh networks in Useful When Starting a New DesignThe Datasheet for the , or one of the based on SoCmodulesThe Datasheet for the.

6 Or one of the based on SoCembedded managersSmartMesh IP Embedded Manager API GuidePage of 6111A for the mote/ Manager SoC or - this discusses best practices for integrating theHardware Integration GuidemoduleSoC or module into your for the Embedded Manager - this discusses best practices for integrating the embeddedHardware Integration Guidemanager into your - For SoC motes and Managers. Discusses how to set default IO configuration andBoard Specific Integration Guidecrystal calibration information via a "fuse table". - contains an SoC design checklist, antenna selection Guide , Integration Application NotesThe - a Guide to the Programmer Board and ESP software used to load firmware on aESP Programmer GuideDC9010 software - used to program firmware images onto a mote or Table software - used to construct the fuse table as discussed in the.

7 Board Specific Configuration GuideOther Useful DocumentsA glossary of wireless networking terms used in SmartMesh documentation can be found in the SmartMesh IP User'sGuideA list of Frequently Asked QuestionsSmartMesh IP Embedded Manager API GuidePage of Conventions UsedThe following conventions are used in this document: indicates information that you enter, such as specifying a type indicates buttons, fields, menu commands, and device states and type is used to introduce a new term, and to refer to APIs and their typeTips provide useful information about the text provides additional information for background and contextNotes provide more detailed information about !

8 Warnings advise you about actions that may cause loss of data, physical harm to the hardware or blocks display examples of codeSmartMesh IP Embedded Manager API GuidePage of Revision HistoryRevisionDateDescription107/18/201 2 Initial Release208/10/2012 Updated radiotestTx API303/18/2013 Numerous Small Changes410/22/2013 Corrected radioTx fields; Clarification of RC handling; Other minor changes504/04/2014 Updated and clarified radiotest commands;610/23/2014 Included command IDs in titles; Clarified maxMotes setting; Other minor changes704/22/2015 Deprecated autostart command; Deprecated setTime command; Fixed queue occupancydescription; Other minor changes812/03/2015 Deprecated software licencing commands; Renamed Guide to focus on Embedded Manager ; Otherminor changes911/07/2016 Added joinFailed and invalidMIC events; Added RC_UNSUPPORTED response code; Added RSSI report description; Added fields to getMoteInfo.

9 Added blink notificationSmartMesh IP Embedded Manager API GuidePage of 91112 IntroductionThis Guide describes the commands used to communicate with the SmartMesh IP Manager through the serial ApplicationProgramming Interface (API). The API is intended for machine-to-machine communications ( a host program talking tothe Manager ).In contrast, the Command Line Interface (CLI) is intended for human interaction with a Manager , during development, orfor interactive troubleshooting. See the for details on that IP Manager CLI CommunicationsMessages are sent using a packet-based protocol.

10 For an overview of the Manager capabilities referenced in this document,please see the . SmartMesh IP User's GuideTo use the Serial API, a client first establishes a session with the Manager as described in Communication between Manager . Once a session is established, the client can send a series of to the Manager to control networkand ClientCommandsoperations or send data to motes in the network. A client uses the command to request from Serial API can be accessed directly via the serial port using the HDLC serial protocol. Each command request, responseand notification is packed as an HDLC frame.