SmartMesh WirelessHART
User's Guide
SmartMesh WirelessHART User's Guide
Page 1 of 135
Table of Contents
1 About This Guide _________________________________________________________________________________ 5
1.1
1.2
1.3
Related Documents __________________________________________________________________________ 5
Conventions Used ___________________________________________________________________________ 7
Revision History _____________________________________________________________________________ 8
2 SmartMesh Glossary ______________________________________________________________________________ 9
3 The SmartMesh WirelessHART Network ______________________________________________________________ 13
3.1
Introduction _______________________________________________________________________________ 13
3.1.1
3.1.2
3.2
3.2.1
3.2.2
3.3
3.3.1
3.3.2
3.3.3
3.3.4
3.3.5
3.4
3.5
Network Overview ____________________________________________________________________ 13
SmartMesh Network Features ___________________________________________________________ 15
Mote Joining ________________________________________________________________________ 17
Discovery ___________________________________________________________________________ 17
Base Bandwidth ______________________________________________________________________ 18
Services ____________________________________________________________________________ 19
Cascading Links ______________________________________________________________________ 19
Downstream Bandwidth ________________________________________________________________ 19
Fast Services on the Pipe _______________________________________________________________ 19
Network Formation __________________________________________________________________________ 16
Bandwidth and Latency ______________________________________________________________________ 18
Data Traffic ________________________________________________________________________________ 20
Security __________________________________________________________________________________ 21
3.5.1
3.5.2
Security Layers ______________________________________________________________________ 21
Security Modes ______________________________________________________________________ 22
4 The SmartMesh WirelessHART Manager ______________________________________________________________ 23
4.1
Introduction _______________________________________________________________________________ 23
4.1.1
4.1.2
4.2
4.2.1
4.2.2
4.3
4.3.1
4.3.2
4.3.3
4.3.4
4.3.5
4.4
4.4.1
4.4.2
4.4.3
Embeddable Manager _________________________________________________________________ 23
Packaged Manager ____________________________________________________________________ 23
Wired Interfaces ______________________________________________________________________ 25
Software Interfaces ___________________________________________________________________ 26
Connecting the Manager Directly to a Windows Computer _____________________________________ 28
Connecting to the Manager on the LAN ____________________________________________________ 29
Accessing Admin Toolset _______________________________________________________________ 32
Configuring the Firewall ________________________________________________________________ 32
Changing the CLI Password _____________________________________________________________ 33
Root Access _________________________________________________________________________ 34
Network ID __________________________________________________________________________ 34
Network Time ________________________________________________________________________ 35
Manager Interfaces __________________________________________________________________________ 25
Connecting to the Manager ___________________________________________________________________ 28
Administering the Manager ___________________________________________________________________ 34
SmartMesh WirelessHART User's Guide
Page 2 of 135
4.4.4
4.5
4.5.1
4.5.2
4.5.3
4.5.4
4.5.5
4.6
4.7
Software Licensing ___________________________________________________________________ 36
Network Structure and Formation ________________________________________________________ 36
Communicating with Motes _____________________________________________________________ 37
Network Health ______________________________________________________________________ 37
Health Reports _______________________________________________________________________ 37
Optimization _________________________________________________________________________ 37
Network Activity ____________________________________________________________________________ 36
Network Bandwidth Control ___________________________________________________________________ 39
Access Control _____________________________________________________________________________ 41
4.7.1
4.7.2
Network Security _____________________________________________________________________ 41
Limiting the Maximum Number of Motes __________________________________________________ 44
Background _________________________________________________________________________ 44
OTAP through a Serial Port _____________________________________________________________ 45
OTAP Using Admin Toolset _____________________________________________________________ 45
OTAP via Manager API _________________________________________________________________ 46
Troubleshooting an Unsuccessful OTAP ___________________________________________________ 46
4.8
Over-the-Air-Programming ____________________________________________________________________ 44
4.8.1
4.8.2
4.8.3
4.8.4
4.8.5
4.9
Restoring Manager Factory Default Settings ______________________________________________________ 46
4.10 Channel Blacklisting _________________________________________________________________________ 48
4.11 INI Files __________________________________________________________________________________ 49
4.11.1 system.ini __________________________________________________________________________ 49
4.11.2 platform.ini _________________________________________________________________________ 49
4.11.3 dcc.ini _____________________________________________________________________________ 49
4.11.4 Modifying ini variables _________________________________________________________________ 49
4.11.5 Default dcc.ini _______________________________________________________________________ 50
4.11.6 Default platform.ini ___________________________________________________________________ 60
4.11.7 Default system.ini ____________________________________________________________________ 61
4.12 Datalog Utility ______________________________________________________________________________ 63
4.12.1 Overview ___________________________________________________________________________ 64
4.12.2 Using Datalog _______________________________________________________________________ 64
4.12.3 Datalog Output _______________________________________________________________________ 67
4.12.4 How to Restart Datalog on System Reboot _________________________________________________ 69
4.13 Configuring PPP on Serial 1 ___________________________________________________________________ 71
4.13.1 Switching Serial Port Modes ____________________________________________________________ 71
4.13.2 PPP Configuration ____________________________________________________________________ 72
4.13.3 Linux Client Configuration ______________________________________________________________ 72
4.13.4 Windows Client Configuration ___________________________________________________________ 73
4.13.5 Assembling a 9-pin D-SUB Adapter for Serial 1 ______________________________________________ 85
4.14 Manager Redundancy ________________________________________________________________________ 86
4.14.1 Overview ___________________________________________________________________________ 86
4.14.2 Configuration ________________________________________________________________________ 87
4.14.3 Advanced configuration ________________________________________________________________ 87
4.14.4 Firewall configuration __________________________________________________________________ 88
SmartMesh WirelessHART User's Guide
Page 3 of 135
5 The SmartMesh WirelessHART Mote ________________________________________________________________ 89
5.1
5.2
5.3
Introduction _______________________________________________________________________________ 89
5.1.1
Steps in a Mote Design ________________________________________________________________ 89
Mote State Machine _________________________________________________________________________ 90
Joining ___________________________________________________________________________________ 92
5.3.1
5.3.2
5.3.3
5.3.4
5.4
5.4.1
5.4.2
5.4.3
5.4.4
5.4.5
5.4.6
5.4.7
5.4.8
5.5
5.5.1
5.5.2
5.6
5.7
5.8
OEM Microprocessor Boot ______________________________________________________________ 94
Mote Boot __________________________________________________________________________ 94
Pre-join Configuration _________________________________________________________________ 94
Network Joining ______________________________________________________________________ 95
Service Characteristics and Timing Parameters ______________________________________________ 96
Service Types ________________________________________________________________________ 97
Non-Service Bandwidth Control __________________________________________________________ 97
Using the Services API _________________________________________________________________ 97
Maintenance ________________________________________________________________________ 102
Publish ____________________________________________________________________________ 103
Block Transfer ______________________________________________________________________ 108
Events ____________________________________________________________________________ 111
Best-Effort Communication ____________________________________________________________ 113
Reliable Communication ______________________________________________________________ 113
Services __________________________________________________________________________________ 96
Communication ___________________________________________________________________________ 112
Events and Alarms _________________________________________________________________________ 114
Timestamps ______________________________________________________________________________ 114
WirelessHART-Compliant Applications __________________________________________________________ 114
5.8.1
5.8.2
5.8.3
Command Termination _______________________________________________________________ 114
Key WirelessHART Command Support ___________________________________________________ 123
Efficiently Checking for Manager-Originated Services ________________________________________ 129
5.9
Factory Default Settings _____________________________________________________________________ 130
5.10.1 Modes ____________________________________________________________________________ 131
5.10.2 LEDs _____________________________________________________________________________ 131
5.10.3 Master Behavior _____________________________________________________________________ 131
5.10.4 Switching To Slave Mode ______________________________________________________________ 133
5.10.5 Switching To Master Mode ____________________________________________________________ 133
5.10 Master vs. Slave ___________________________________________________________________________ 131
SmartMesh WirelessHART User's Guide
Page 4 of 135
1 About This Guide
1.1 Related Documents
The following documents are available for the SmartMesh WirelessHART network:
Getting Started with a
Starter Kit
SmartMesh WirelessHART Easy Start Guide
- walks you through basic installation and a few tests to make sure your
network is working
SmartMesh WirelessHART Tools Guide
- the Installation section contains instructions for the installing the serial
drivers and example programs used in the Easy Start Guide and other tutorials.
User Guide
SmartMesh WirelessHART User's Guide
- describes network concepts, and discusses how to drive mote and manager
APIs to perform specific tasks, e.g. to send data or collect statistics. This document provides context for the API
guides.
Interfaces for Interaction with a Device
SmartMesh WirelessHART Manager CLI Guide
- used for human interaction with a Manager (e.g. during development
of a client, or for troubleshooting). This document covers connecting to the CLI and its command set.
SmartMesh WirelessHART Manager API Guide
- used for programmatic interaction with a manager. This document
covers connecting to the API and its command set.
SmartMesh WirelessHART Mote CLI Guide
- used for human interaction with a mote (e.g. during development of a
sensor applicaition, or for troubleshooting). This document covers connecting to the CLI and its command set.
SmartMesh WirelessHART Mote API Guide
- used for programmatic interaction with a mote. This document covers
connecting to the API and its command set.
Software Development Tools
SmartMesh WirelessHART Tools Guide
- describes the various evaluation and development support tools included in
the
SmartMesh SDK
including tools for exercising mote and manager APIs and visualizing the network.
Application Notes
SmartMesh WirelessHART Application Notes
- app notes covering a wide range of topics specific to SmartMesh
WirelessHART networks and topics that apply to SmartMesh networks in general.
Documents Useful When Starting a New Design
SmartMesh WirelessHART User's Guide
Page 5 of 135