EWB100 Usage and Deployment Guide Rev 1.15
EWB 100 Usage and
Deployment Guide
Rev 1.16
April 23, 2015
Page 1
EWB100 Usage and Deployment Guide Rev 1.15
Page 2
EWB100 Usage and Deployment Guide Rev 1.15
Revision History ................................................................................................ 12
1 Introduction .................................................................................................. 14
1.1 The EWB100 ........................................................................................ 14
1.2 This Document ..................................................................................... 14
2 EWB100 User Overview .............................................................................. 15
2.1 The Physical Device ............................................................................. 15
2.2 The User Interface ................................................................................ 15
2.3 Voice Modes ......................................................................................... 16
3 Internal Elements of the EWB100 ................................................................ 17
3.1 Two software subsystems .................................................................... 17
3.2 Configuration Data Base....................................................................... 17
3.3 802.11 Radio ........................................................................................ 17
3.4 IP Stack ................................................................................................ 17
3.5 Command Line Interpreter .................................................................... 17
3.6 Profiles .................................................................................................. 18
3.7 Airbeam ................................................................................................ 18
3.8 Web Server ........................................................................................... 18
4 The Command Line Interpreter .................................................................... 19
4.1 Basic Concepts ..................................................................................... 19
4.2 The CLI and the ConfigurationData Base ............................................. 19
4.3 Accessing the CLI ................................................................................. 20
4.4 CLI Access Control ............................................................................... 21
4.4.1 Basic Concept ................................................................ ............... 21
4.4.2 Configuration Commands .............................................................. 21
4.5 Encrypted Configuration Parameters .................................................... 23
4.6 “new”, “new2”, and “new3” parameters ................................................. 23
4.7 Undocumented commands and parameters ......................................... 23
4.8 CLI Commands Commands ................................................................. 24
4.8.1 set .................................................................................................. 24
4.8.2 show ................................................................ .............................. 24
4.8.3 help ................................................................................................ 24
4.8.4 clear ............................................................................................... 24
Page 3
EWB100 Usage and Deployment Guide Rev 1.15
4.8.5 stat ................................................................................................. 24
4.8.6 notify .............................................................................................. 25
4.8.7 cfg .................................................................................................. 25
4.8.8 version ........................................................................................... 25
4.8.9 roam .............................................................................................. 25
4.8.10 ping ................................................................................................ 25
4.8.11 notes .............................................................................................. 25
5 802.11 Interface ........................................................................................... 26
5.1 Basic Radio Functionality ..................................................................... 26
5.2 Radio Configuration Commands ........................................................... 27
5.2.1 Ess ................................................................................................ 27
5.2.2 User Default Ess............................................................................ 27
5.2.3 Security modes .............................................................................. 28
5.2.4 User Default Security Mode ........................................................... 28
5.2.5 WEP Security Key ......................................................................... 28
5.2.6 WEP index ..................................................................................... 28
5.2.7 WPA Password ............................................................................. 29
5.2.8 User Default WPA Password ......................................................... 29
5.2.9 Encrypted WPA Password ............................................................ 29
5.2.10 Encrypted User Default WPA Password ........................................ 29
5.2.11 Wpakey ......................................................................................... 29
5.2.12 User Default Wpakey ..................................................................... 30
5.2.13 Encrypted Wpakey ........................................................................ 30
5.2.14 Encrypted Default Wpakey ............................................................ 30
5.2.15 Minrssi ........................................................................................... 30
5.2.16 Deltarssi ........................................................................................ 31
5.2.17 Channel mask ............................................................................... 31
5.2.18 roamMissBeacon ........................................................................... 31
5.2.19 scanMissBeacon ........................................................................... 31
5.2.20 roamRssi ....................................................................................... 32
5.2.21 B rates ........................................................................................... 32
5.2.22 blockedrates .................................................................................. 32
Page 4
EWB100 Usage and Deployment Guide Rev 1.15
5.2.23 Cradle low power mode ................................................................. 33
5.2.24 Fixes for roaming problems ........................................................... 33
6 PEAP Authentication (Rev J) ....................................................................... 34
6.1 Introduction ........................................................................................... 34
6.2 Configuration Parameters ..................................................................... 34
6.2.1 Enable peap .................................................................................. 34
6.2.2 User Default peap enable - defwpa2esec ...................................... 34
6.2.3 Enable Checking of Server Certificate ........................................... 35
6.2.4 User Default Enable Checking of Server Certificate ...................... 35
6.2.5 Key Caching Mode ........................................................................ 35
6.2.6 User Default Enable OKC - defwpa2ekeycaching ........................ 35
6.2.7 User name - wpa2euser ................................................................ 36
6.2.8 Encrypted User name - ewpa2euser ............................................. 36
6.2.9 User default user name -defwpa2euser ......................................... 36
6.2.10 Encrypted User default user name ................................................ 36
6.2.11 User Password ............................................................................. 36
6.2.12 Encrypted User password ............................................................. 37
6.2.13 User default user Password .......................................................... 37
6.2.14 Encrypted User default user password .......................................... 37
6.3 Clearing the certificate on the EWB ...................................................... 37
6.4 Creating a Certificate for the EWB 100 ................................................. 37
6.5 Loading Certificates onto the EWB100 ................................................. 38
7 IP Stack ................................ ................................ ................................ ....... 42
7.1 Basic Functionality ................................................................................ 42
7.2 Configuration Commands ..................................................................... 42
7.2.1 Network Mode ................................ ................................ ............... 42
7.2.2 User Default Network Mode .......................................................... 43
7.2.3 IP address ..................................................................................... 43
7.2.4 IP mask ......................................................................................... 43
7.2.5 Default gateway ............................................................................. 43
7.2.6 DNS Server IP Address ................................................................. 43
7.2.7 Append .......................................................................................... 44
Page 5
EWB100 Usage and Deployment Guide Rev 1.15
7.2.8 User Defined Append .................................................................... 44
7.2.9 IGMP Mode ................................................................................... 44
7.2.10 IGMP Request Interval .................................................................. 44
7.2.11 Perform DCHP on Roam ............................................................... 44
8 Walkie Talkie ............................................................................................... 46
8.1 Basic Concepts ..................................................................................... 46
8.2 Protocol Elements ................................................................................ 47
8.3 Alternative Channels ............................................................................ 48
8.4 Configuration Commands for WTT Operation ...................................... 49
8.5 Guidelines for Using Multiple Channels ................................................ 50
8.5.1 Zero channels (WTT disabled) ................................ ...................... 50
8.5.2 One channel .................................................................................. 50
8.5.3 Two channels – primary and occasionally secondary – listen on
both 50
8.5.4 Two channels – equally used – listen on both ............................... 52
8.5.5 Two channels – listen on only one at time ..................................... 52
8.5.6 Three or More Channels ................................................................ 53
8.6 WTT Command Reference .................................................................. 53
8.6.1 Private Reply Timeout ................................................................... 53
8.6.2 Maximum WTT Session Duration .................................................. 53
8.7 WTT Session Replay ............................................................................ 54
9 Private Reply/Unicast Voice......................................................................... 55
9.1 Basic Concepts ..................................................................................... 55
9.2 Protocol Elements ................................................................................ 55
9.3 UC Command Reference ..................................................................... 56
10 Device/User Identity (Rev J) ..................................................................... 57
10.1 Device/User Name ............................................................................... 57
10.2 Organization Name ............................................................................... 57
10.3 Adding device/organization name to Call ButtonMessages .................. 58
11 Profiles ..................................................................................................... 60
11.1 Introduction to Profiles (rev J changes) ................................................ 60
11.2 Profile Initialization ................................................................................ 63
11.3 General Parameters ............................................................................. 63
Page 6
EWB100 Usage and Deployment Guide Rev 1.15
11.4 Key Usage ............................................................................................ 67
11.5 Key Action Data .................................................................................... 68
11.6 Alerts .................................................................................................... 68
11.7 Timeouts ............................................................................................... 70
12 User Defined Default ................................................................................ 71
12.1 Basic Concept ...................................................................................... 71
12.2 Supported Parameters.......................................................................... 71
12.3 Showing User Defined Default Values .................................................. 72
12.4 Enabling User Defined Defaults ............................................................ 72
12.5 Clearing User Default Values ............................................................... 72
12.6 Clearing and Erasing Default Values .................................................... 72
14 User Interface Customization ................................ ................................ ... 73
14.1 Basic Concepts ..................................................................................... 73
14.2 Out of range power down ..................................................................... 73
14.3 Eliminate Flashing of Green LED ......................................................... 73
14.4 Out of Range Audio Alert Repeat ......................................................... 73
14.5 Low Battery Audio Alert Repeat ............................................................ 73
14.6 Disable Clear Configuration Key Sequence .......................................... 74
14.7 Return to Default Profile when inserted into charging cradle ................ 74
14.8 Simplfied Profile Selection Mode .......................................................... 74
14.9 Set current profile as default profile ...................................................... 74
14.10 Profile timeout (Rev J) ....................................................................... 75
14.11 Alternative Audio message for cradle removal (rev J) ....................... 75
14.12 Roam alert timeout (Rev J) ............................................................... 75
14.13 Allow profile switching during active WTT session (Rev J) ............... 75
14.14 Minimum Audio Volume (rev J) ......................................................... 76
14.15 Tx Channel Based on Received Channel ......................................... 76
15 Telnet ....................................................................................................... 77
15.1 Disable Telnet Server ........................................................................... 77
16 Airbeam .................................................................................................... 78
16.1 Basic Concepts ..................................................................................... 78
16.2 The Configuration Process ................................................................... 78
Page 7
EWB100 Usage and Deployment Guide Rev 1.15
16.2.1 Overview ....................................................................................... 78
16.2.2 Packages ....................................................................................... 79
16.2.3 Package and File Headers ............................................................ 80
16.2.4 Tools to build file headers .............................................................. 80
16.3 Using Airbeam ...................................................................................... 81
16.3.1 Enabling the Airbeam Function ..................................................... 81
16.3.2 Getting the IP Address of the FTP Server ..................................... 81
16.3.3 The FTP Port ................................................................................. 83
16.3.4 The User Name ............................................................................. 83
16.3.5 The Password ............................................................................... 84
16.3.6 Package Filename ......................................................................... 84
16.4 Airbeam and User Defaults ................................................................... 85
16.5 Airbeam/Device Status CLI Command Reference ................................ 85
16.5.1 Mode ............................................................................................. 85
16.5.2 User Default Mode......................................................................... 85
16.5.3 Airbeam FTP Server IP address .................................................... 85
16.5.4 User Default Airbeam FTP Server IP address ............................... 85
16.5.5 Airbeam FTP Port .......................................................................... 85
16.5.6 User Default Airbeam FTP Port ..................................................... 86
16.5.7 Airbeam server name .................................................................... 86
16.5.8 User Default Airbeam server name ............................................... 86
16.5.9 Airbeam user name ....................................................................... 86
16.5.10 User Default Airbeam user name ............................................... 86
16.5.11 Airbeam user password ............................................................. 86
16.5.12 User Default Airbeam user password ........................................ 87
16.5.13 Airbeam Encrypted user password ............................................ 87
16.5.14 User Default Airbeam Encrypted user password ....................... 87
16.5.15 Airbeam filename ....................................................................... 87
16.5.16 User Default Airbeam filename .................................................. 87
16.5.17 Airbeam package version .......................................................... 87
16.5.18 Airbeam bootloader/minikernel version ...................................... 88
16.5.19 Airbeam runtime version ............................................................ 88
Page 8
EWB100 Usage and Deployment Guide Rev 1.15
16.5.20 Airbeam TTS version ................................................................. 88
16.5.21 Airbeam Inactivity Timeout ......................................................... 88
16.5.22 Airbeam Download Timeout ....................................................... 88
16.5.23 Cradle Wait Time ....................................................................... 88
16.5.24 New Airbeam Download Types (Rev J) ..................................... 90
17 Misc CLI Commands ................................................................................ 91
17.1 Ping ...................................................................................................... 91
17.2 The Clear Command ............................................................................ 91
17.3 The Cfg Command ................................................................ ............... 92
17.4 Notes .................................................................................................... 92
17.5 Reset Device ........................................................................................ 92
17.6 Power Off Device .................................................................................. 92
17.7 The Notify Command ............................................................................ 92
17.7.1 For invoking notifications ............................................................... 93
17.7.2 For invoking audio alerts ............................................................... 93
18 Audio Services ......................................................................................... 94
18.1 Introduction ........................................................................................... 94
18.2 Audio Clips and Audio Tables ............................................................... 94
18.3 Clip names and clip-ids......................................................................... 95
18.4 Clip Names, User Notifications, and Configuration ............................... 96
18.5 Multilanguage support .......................................................................... 97
18.5.1 Basic Model ................................................................................... 97
18.5.2 Detailed Instructions ...................................................................... 98
18.6 Building New Audio Clip Files ............................................................. 100
18.7 Viewing the phrase book .................................................................... 100
19 Web Server ............................................................................................ 101
19.1 Basic Concepts ................................................................................... 101
19.2 Detailed Description of Functions ....................................................... 101
19.2.1 Playing Audio .............................................................................. 101
19.2.2 LED Control ................................................................................. 101
19.2.3 System Reset .............................................................................. 102
19.2.4 CLI Command Execution ............................................................. 102
Page 9
EWB100 Usage and Deployment Guide Rev 1.15
20 Obtaining Device Status Information ...................................................... 103
20.1 Basic Concepts ................................................................................... 103
20.2 LED Blink Patterns ............................................................................. 103
20.3 Status Key Sequence ......................................................................... 103
20.3.1 Usage .......................................................................................... 103
20.3.2 Information Available ................................................................... 104
20.3.3 Configuration Command .............................................................. 104
20.4 Status Message .................................................................................. 105
20.4.1 Device Status Update Mechanism............................................... 105
20.4.2 Enabling sending the Device Status Packet ................................ 106
20.4.3 Specifying where the packet is to be sent ................................... 106
20.4.4 Specifying how often the packet is to be sent .............................. 106
20.5 Roam Command ................................................................................ 107
20.6 The Statistics Command ..................................................................... 107
20.6.1 Wireless Driver Counters ............................................................. 108
20.6.2 UMAC Counters .......................................................................... 109
20.6.3 Transmit packet counters ............................................................ 110
20.6.4 Roaming statistics ...................................................................... 110
20.6.5 Scanning counters ....................................................................... 110
20.6.6 Receive Rate Histogram .............................................................. 111
20.6.7 Transmit Rate Histogram ............................................................. 111
20.6.8 Transmit Retry Histogram ............................................................ 112
20.6.9 AP Tables .................................................................................... 112
20.6.10 Receive Packet Statistics ......................................................... 113
20.6.11 Voice Packet Transmit Statistics .............................................. 113
20.6.12 Combined Voice Statistics ....................................................... 113
20.6.13 TCP Counters .......................................................................... 115
20.6.14 UDP Counters .......................................................................... 115
20.6.15 ICMP Counters ........................................................................ 116
20.6.16 Arp Tables ............................................................................... 116
20.6.17 802.1x Key Derivation Counters .............................................. 117
20.6.18 DHCP Counters ....................................................................... 117
Page 10
EWB100 Usage and Deployment Guide Rev 1.15
20.6.19 “IF” Counters ............................................................................ 118
20.6.20 Deployment Counters .............................................................. 118
20.6.21 WTT Counters.......................................................................... 118
20.6.22 Unicast Counters ..................................................................... 120
20.6.23 DNS Counters and table .......................................................... 121
20.6.24 Configuration Counters ............................................................ 121
21 Trace ...................................................................................................... 122
21.1.1 NonUmac Tracing........................................................................ 122
21.1.2 Umac Tracing .............................................................................. 123
22 MiniKernel Commands ........................................................................... 124
22.1 Load Boot ........................................................................................... 124
22.2 Version ............................................................................................... 125
Appendix A: Status Record Contents (pre Rev J) ............................................ 126
Appendix B: Status Record Contents (Rev J) .................................................. 128
Appendix C: Utility Program .............................................................................. 130
B.1 clientencrypttool ...................................................................................... 130
Appendix D: Utilizing the USB Interface with Win/XP ...................................... 131
Appendix E: Utilizing the USB Interface with Vista and Win/7 ......................... 139
Appendix F: Creating a New Audio Clip File ..................................................... 145
Page 11
EWB100 Usage and Deployment Guide Rev 1.15
Revision
Description
Editor
0.0
Initial Draft
Bob Beach
1.0
Updates from reader comments
Bob Beach
1.1
Additional review comments
Linda Billhymer
1.2
Additional updates
Bob Beach
1.3
Added Appendix C and D
Bob Beach
1.4
Added screen updates to Appendix D
Bob Beach
1.5
Additional corrections/additions
Bob Beach
1.6
Version released for final review
Linda Billhymer
1.7
Final release
Linda Billhymer
1.8
Add information on Rev H, J, and K
Bob Beach
1.9
Cleanup from v1.8
Bob Beach
1.10
Changes for Rev K release
Bob Beach
1.11
Move some items from K to J
Bob Beach
1.12
Document Release for Rev J
Linda Billhymer
1.13
Update to Document fo r Rev J
Linda Billhymer
1.14
Fix typos, add v1281 features, Rev K
Bob Beach
1.15
Cleanup
Bob Beach
1.16
Removed company specific information.
Corrections by Ed.
Bob Greenway
Revision History
Page 12
EWB100 Usage and Deployment Guide Rev 1.15
Page 13
EWB100 Usage and Deployment Guide Rev 1.15
1 Introduction
1.1 The EWB100
The EWB100 is a compact Voice over wireless LAN (VoWLAN) communications
device designed to operate throughout the wireless local area network of an
enterprise environment. The EWB 100 provides Push-to-Talk style
communications, similar to any normal Push-to-Talk radio. EWB100 badges
enable instant employee accessibility through a simultaneous call to a group of
workers and a person-to-person reply call from a group member. They can
communicate with other mobile computers and enterprise devices
communicating over Wi-Fi.
The EWB 100 can be clipped onto clothing, worn on a lanyard, or slipped inside
a pocket and can be deployed either as a personal or shared device. In
environments where workers change shifts daily, an employee can select any
available badge.
1.2 This Document
This document is intended for those who select, configure, deploy, and support
the EWB100 device. It is not directed at those who are the end users of it. The
EWB100 Quick Start Guide is intended for such users.
This document describes the capabilities of the EWB100 and how the device can
be configured to take advantage of those capabilities. While the EWB100 is
typically used for its “Walkie talkie” like functions it is capable of much more and
this document describes those capabilities.
This document also describes how the device can be deployed and updated over
time. It does not describe the “Deployment Application” but instead describes
how many of the same functions can be achieved with existing network software
packages.
Also included in this document is a description of the mechanisms that are
available to diagnose and fix problems that may arise during deployment or in an
installation. The EWB100 has a number of powerful mechanisms that will allow
on-site or remote maintenance.
Finally this document will describe enough of the internal architecture so as to
make the process of configuring, optimizing, and supporting the device an easier
task.
Page 14
EWB100 Usage and Deployment Guide Rev 1.15
2 EWB100 User Overview
2.1 The Physical Device
The image below shows the EWB100 with the important user elements identified
2.2 The User Interface
The user interface of the EWB100 is very simple, consisting of 5 buttons,a
tricolor LED, a microphone, and a speaker. There are also optional headsetsthat
can substitute for the microphone and/or speaker. There is not a screen of any
type. This means that most of the user interactions take the form of audio (mostly
output) and button presses, perhaps supplemented by LED blink patterns.
Furthermore two of the buttons (VOLUP and VOLDN) are usually reserved for
volume control functions (although they can be used for certain other tasks). That
leaves 3 application oriented buttons: PTT, FAPP, and SAPP. The PTT button is
used almost exclusively as a “”push to talk” trigger;there are really only two
“application oriented” buttons.
The EWB gets around this limitation by two mechanisms: the first is to define
certain button actions beyond just press and release. The first is a “single click”,
which is a quick press and release. The second is a “double click” which is two
quick press and release sequences. The third is a sustained press and hold. The
EWB 100 treats each of these as a distinct event from a UI perspective.
Page 15
EWB100 Usage and Deployment Guide Rev 1.15
The second mechanism is by multiple button sequences. At this time only two
button sequences are used but potentially there could be three and four button
sequences but they would be very awkward to use. There are currently 3 two
button sequences defined:
PTT + FAPP => Power off
PTT + SAPP => Status/configuration
VOLDN + SAPP (while in the cradle) => set to factory defaults
The LEDs are used mostly to indicate general device state. Blinking Green
means everything is working properly. Blinking Red means something is wrong.
Amber is not used at the moment.
Most of the use oriented “feedback” to the user is via the speaker. The EWB 100
uses a combination of tones and voice responses to indicate state and events to
the user. All of these tones and voice responses can be replaced with silence or
different audio sequences, including different languages.
2.3 Voice Modes
There are two primary voice modes. One is a walkie talkie (one to many) type.
One user presses the PTT button and talks and lots of people hear. Just like
more traditional walkie talkies, there are multiple channels available and users
can pick which ones they want to use by switching between them.
The second mode is for private point to point calls. This is called Private Reply
and keeps the same “push to talk” modality of the walkie talkie mode except that
it is a private session between two users. Such a session is setup after the
conclusion of a walkie talkie session via a simple button press sequence.
There are other voice modes beyond these two that will be described later in this
document.
Page 16
EWB100 Usage and Deployment Guide Rev 1.15
3 Internal Elements of the EWB100
This section introduces some of the more important internal aspects of the
EWB100 as well as some features beyond just the voice modes mentioned in the
previous section.
3.1 Two software subsystems
There are two software systems that run on the EWB100 device. The first is the
“mini-kernel” or “boot loader” which runs right after power on or reset. This
system does not have a lot of functionality but exists mostly to handle the
reloading of the main system when needed. This software has a limited set of
commands available but for the most part cannot examine or alter the system
configuration (although it can erase it entirely!). The minikernel’s commands are
documented in a separate section of this document
The second software system is the actual runtime code that has lots of
functionality and an extensive set of commands. Most of the commands in this
document apply only to the runtime software.
3.2 Configuration Data Base
There are many configuration parameters for the EWB100 device. Almost all
aspects of the behavior of the device may be altered by configuration
parameters. All configuration parameters have a default value that is part of the
runtime image and cannot be changed by the user except for some limited
values via the “User Defined Defaults” mechanism.
3.3 802.11 Radio
The ewb100 contains an 802.11 radio that operates in the 2.4GHz band. It
supports both 802.11b and 802.11g. The radio has been highly optimized to
reduce power consumption both when operating and when in standby mode.
3.4 IP Stack
The ewb100 contains an IPv4 protocol stack. It supports DHCP for obtaining IP
addresses. It also includes a simple Telnet server that can be used for diagnostic
and maintenance purposes.
3.5 Command Line Interpreter
There is a command line interpreter in the ewb100 that provides a means to
configure, update, monitor, and diagnose it. It provides complete access to the
configuration data base and so is used whenever the device needs to be
configured.
There are two versions of the CLI, one for the miniKernel and one for the runtime
code.
Page 17
EWB100 Usage and Deployment Guide Rev 1.15
3.6 Profiles
A profile is a set of configuration variables that control the user interface and
overall functionality of a EWB100 device. Different profiles are simply different
sets of the same configuration variables. Profiles define what functions are
associated with particular buttons, the alerts and notifications associated with UI
events, walkie talkie channels, etc. Virtually all user visible configuration
parameters are part of a profile. There are current 8 profiles per EWB100 and
they are accessed by selecting from profile numbers 0 to 7. Users select the
desired profile from the user interface.
3.7 Airbeam
Airbeam may be used to update the runtime code and configuration elements of
the EWB100. All updates are performed over the 802.11 network using the FTP
network protocol. Updates are described in files called “packages” and the EWB
looks for new packages on a regular Audio Clips and Default Dictionary
The EWB does not contain a text to speech engine but rather has a dictionary of
audio files called ”clips”. The device combines these clips into a meaningful
verbal phrase as needed. Some clips are tones while others are words. There
are about 500 audio clips stored in the “default dictionary” of the device by
default. New clips can be added to the device to enhance or replace the contents
of the default dictionary. These clips may be in other languages.
3.8 Web Server
The Ewb100 also contains a simple web server. External applications can use
this web server to command the device to perform simple tasks such as to play
one or more audio clips, flash the LEDs, and reset the device. The CLI is also
available using the Web Server.
Page 18
EWB100 Usage and Deployment Guide Rev 1.15
4 The Command Line Interpreter
4.1 Basic Concepts
The CLI on the ewb100 is used for a wide variety of functions including
configuration, updates, diagnostics, and maintenance. Its primary use, though, is
for configuring the device. The interface is very simple; it features one line
commands consisting of a key word and zero or more parameters. Most
commands take effect immediately.
The CLI is always available on the device and can be reached from a variety of
sources:
USB
Telnet
HTTP
Command Files
MSP
The CLI is the key to configuring the device since it is the only way to access the
configuration data base. Configuration commands may be entered one at a time
or in a sequence. This later technique is used in conjunction with the Airbeam or
MSP client.
4.2 The CLI and the ConfigurationData Base
The Configuration data base contains all the configuration information for the
EWB100 device. It is stored in a special area of flash memory. Configuration
changes are stored as changes from the default value. When the configuration
data base is erased, the system returns to the default values for all the
configuration parameters.
There are three different configuration areas in flash: two for user defined
information and one for manufacturing information. Multiple changes to the same
configuration value will result in prior values in the flash being invalidated and
new entries being created. Hence configuration areas can “fill up” with invalidated
data. Only one of the user defined areas is used at a time. When one area
becomes full (usually because to too many invalidated values), all the valid data
in it will be copied to the other area, which then becomes the current
configuration data base and the other area erased. No such mechanism exists
for the manufacturing area, since the data values are seldom altered. The state
of configuration memory is shown via the “st cfg” command.
User Defined Defaults is a mechanism by which the default values of certain
configuration parameters may be set by the user. These user defined defaults
will override the runtime default values when the device is restored to “factory
defaults.” They are limited to a few subsystems and parameters within those
subsystems. The goal of this feature is to allow a device to upload new
Page 19
EWB100 Usage and Deployment Guide Rev 1.15
configuration information from a remote server even if the current configuration
has been corrupted. The “existing” configuration can be deleted and the “user
defined defaults” will be used to access the update server.
4.3 Accessing the CLI
As noted above, CLI is always available on the device and can be reached from
a variety of sources:
USB
Telnet
HTTP
“Command Files”
MSP
There is a USB interface on the device that also serves at the headset jack.
When used with the proper connector and with a driver on the PC, the CLI can
be accessed via HyperTerm on a Windows PC. The details on how to use the
USB connection is described in Appendix E
The Telnet and HTTP interfaces are available over the network.
Command Files are used to deliver a sequence of CLI command lines to the
device. These are downloaded by the Airbeam or MSP client from a server. They
are typically used to configure the device when there are more than just a few
configuration settings or when there are many devices to be configured.
The input model is very simple. When looking for the next character input, the
CLI routines examine 4 different input buffers. Each of these buffers corresponds
to one of the 4 above sources. The drivers for these sources simply deposit
characters into their buffer and the CLI will pull them out accordingly. With this
model one can mix input from different sources, although in practice this seldom
happens as only one interface is generally active at a time.
Output is directed to whatever source from which the last input character came.
The CLI syntax is simple and consists of a command followed by a number of
parameters. There is a help facility that can be accessed at any time by entering
a “?” (i.e. “set ?)” will display all the possible inputs to the set command). The
help facility is present on most but not all commands. All commands must be
entirely lower case.
Page 20
EWB100 Usage and Deployment Guide Rev 1.15
Most input parameters can be shortened to the minimally unique string. Hence:
“set” can be “se”
“statistics can be “st”
“key” can be “ke” or even “k”
The key to using to the shortened format is that what is entered must be unique
among the possible options for the command.
4.4 CLI Access Control
4.4.1 Basic Concept
A password may be defined that will control access to the CLI via all
mechanisms. If a password is defined, the user must enter the password when
prompted (or must be included in CLI script files). If no password is defined,
access to the CLI is unrestricted. By default access control is disabled.
If access control is enabled, the user must login in using the following command:
login x
Where x is the password. The means to specify the password is defined below.
4.4.2 Configuration Commands
4.4.2.1 set Password Command
This command defines a Customer defined CLI password. If a password is
defined, it must be entered before access the CLI is granted. If no password is
defined, access is unrestricted. By default no password is defined. The command
to set the password is:
set misc clipwd x
Where x is the password. If a password exists and the user wants to disable it,
then x should be set to “none”.
4.4.2.2 Encrypted Customer CLI Password Command
This command defines the Customer defined CLI password, using an encrypted
string. The string must be created using the clientencrypttool program found on
the online support site. If a password is defined, it must be entered before access
to the CLI is granted. If no password is defined, access is unrestricted. By default
no password is defined. The command to set the password is:
set misc eclipwd x
Page 21
EWB100 Usage and Deployment Guide Rev 1.15
Where x is the encrypted version of the password. Note that x must be a multiple
of 32 hex digits up to a maximum of 128 hex digits. If a password exists and the
user wants to disable it, then x should be “none” (in encrypted form).
Page 22
EWB100 Usage and Deployment Guide Rev 1.15
4.5 Encrypted Configuration Parameters
Certain Configuration Parameters may be sent to the device in an encrypted form
that uses AES encryption. The parameters are:
WPA Passphrase and User Default WPA Password
WPA Key and User Default WPA key
Airbeam Password and User Default Airbeam Password
This mechanism allows sensitive information to be placed into CLI files without a
concern that the information will be compromised.
4.6 “new”, “new2”, and “new3” parameters
There is one set of configuration parameters that is somewhat different than most
of the others. These are the “new” configuration items under the “misc”
subsystem tag (i.e. “set misc new xx” and “show misc”). These three values
(new, new2, new3) are defined as bit maps in which each bit controls a particular
element of a particular subsystem. These were added as shortcuts to prevent the
proliferation of many “on/off” configuration variables however they do introduce a
different class of configuration variable. The general format used to set these
commands is:
set misc xx yy
Where xx is “new”, “new2”, or “new3” and yy is a hex value containing the
representation of all the bits that are to be set. If a user wants to change a bit
configuration value, a “show misc” command should be executed to display the
current value of the bit field. Whatever changes (set or clear) should take into
account the currently set bits and not change other bit map settings. One should
only change the bit fields of interest.
Certain bit fields are set by default and should be changed only when directly
instructed by qualified service personnel.
In the rest of this document, those configuration items that utilize the “new” fields
will indicate it and will specify the “new” field and the bit location within that field
that is to be set/cleared.
4.7 Undocumented commands and parameters
This document does not describe all commands and configuration variables that
are available on the EWB100 and so users will encounter such items when using
commands such as “show x” and “set ?”. Many of these items are for developer
or internal support use only and altering them may result in the EWB100
operating incorrectly or not at all. Hence only the commands and parameters that
are defined in this document should be used or altered; executing any CLI
commands not documented in this guide can cause unpredictable behavior and
voids the product warranty.
Page 23
EWB100 Usage and Deployment Guide Rev 1.15
4.8 CLI Commands Commands
There are the following commands in the runtime software CLI:
set : set configuration
show : show configuration
stat : system status
system : system control
notify : performs a notify op
roam : roam History
cfg : configuration operations
help : display general user interface help
clear : clear stats
ping : ip ping
version : version of software
4.8.1 set
This command is used to assign values to various configuration parameters.
There will always be at least 2 parameters and can be as many as 5 or 6.
Parameters are grouped into categories associated with various subsystems on
the device. The current set of parameters is described in this document and is
associated with the subsystem description. It should be noted that there is a
default value for every configuration parameter. Using the set command will
override the default value and result in the value being written to flash. Changes
for many of the parameters will take effect immediately while others will require a
reboot. If in doubt, reset the device after changing any parameter or set of
parameters.
4.8.2 show
This command is used to display the current value of the configuration settings
for the various subsystems. There is generally only one parameter associated
with a Show command which is the name of the subsystem. All configuration
settings for a particular subsystem will be shown. It is generally not possible to
display only one configuration parameter in a subsystem.
4.8.3 help
This command is used to display the syntax for the various commands. It takes
no parameters.
4.8.4 clear
This command is used to clear all counters in all subsystems. It takes no
parameters. It is not possible to clear the counters of only one subsystem.
4.8.5 stat
This command is used to display counters, statistics, and the contents of various
dynamic tables. There is usually only one or two parameters associated with a
Statistics command. Depending on the particular subsystem, the output can be a
Page 24
EWB100 Usage and Deployment Guide Rev 1.15
list of counters (simple incrementing values), statistics (values that have been
computed based upon various internal variables), or the contents of tables that
have been built dynamically
4.8.6 notify
This command is used to play various audio phrases and to control the 3 LEDs.
There are between 3 and 10 parameters associated with this command. The
user can either specify a list of words from the Phrase Book that are to be played
or can cause an LED to display a particular “blink” pattern. It is used primarily by
developers and others who may alter the phrasebook contents.
This command is also used to alter the intensity of the LEDs.
4.8.7 cfg
This command is used to control and monitor the configuration subsystem. It
takes one or two parameters that define the operation. The user can display
various statistics, return the configuration to its default state, etc.
4.8.8 version
This command is used to display the software version as well as certain
hardware information.
version
CA10 Version 1.1.1077 Realtime-CA10 No external mem used Mar 14 2012 08:52:24
EngVer = 4 HwVer = 2 nchip = noProt chip = Locosto-Lite
Hawkeye = 0x412b TI_DM = 0x5b66 ES = unknown
4.8.9 roam
This command takes no parameters. It displays the roam history for the EWB100
device.
4.8.10 ping
This command performs an ICMP ping to a device.
4.8.11 notes
Notes are a means of adding information to a device that is stored in
configuration memory. Notes are text strings that are not used by the device in
anyway but are meaningful in some way to users, support personal, or
developers. Information may include customer details, past history, known
issues, etc.. Notes can be set and displayed. There can be up to 16 lines of
notes.
Page 25
EWB100 Usage and Deployment Guide Rev 1.15
5 802.11 Interface
5.1 Basic Radio Functionality
The following describes the 802.11 related features of the EWB 100.
It is an 802.11 b/g compatible device. As such it operates only in the
2.4GHz band.
It supports operation on channels 1-11 in the US and 1-14 on a worldwide
basis. By default it will assume channels 1-11 are operational. For
operation on other channels, contact support.
To minimize power consumption it will scan only channels 1, 6, and 11.
Other channels are ignored. This may be changed by a configuration
command.
Output power is typically 15dbm or greater.
Receive sensitivity is typically greater than -85dbm for 802.11b packets.
It supports OPEN, WEP, TKIP, and AES encryption.
It supports WPA-PSK and WPA2-PSK authentication
It supports WMM and will use it if supported by the AP. Voice traffic is
sent on AC=0, data traffic is on AC=3.
DTIM = 2 must be used for the device. Other settings will result in
unreliable operation.
The network should be configured to use as low a basic rate for beacons
and broadcast packets as possible. Ideally 2 Mbits should be Due to a
lack of antenna diversity, the EWB100 does not operate well at 5.5 and
11Mbits basic rate. Pure 11g operation is supported but again the lowest
acceptable rate should be used.
To increase receive range the device will associate at lower than the
highest (54Mbits) 802.11g rates, usually 24 Mbits. It will transmit at any
rate supported by the AP.
Page 26
EWB100 Usage and Deployment Guide Rev 1.15
The device operates primarily in PSP mode, even during voice packet
transfers. As such the EWB is very sensitive to variations in Beacon
delivery times. If an infrastructure is configured to support multiple BSS,
the one the EWB uses should be the first one if secondary ones
experience significant variability in delivery times.
Roaming/scanning is triggered primarily by missed consecutive beacons
or by sudden and significant drops in the RSSI value. By default 5 missed
consecutive beacons will trigger a scan.
The device discovers APs only by active scanning use probe requests. It
does not perform “background” or passive discovery of APs.
The device will filter APs based on the RSSI and ignore those with RSSI
below a threshold. This may be changed by a configuration command.
For best performance the network should be designed to support signal
strength of -70dbm or better.
The device maintains a list of 16 APs. It refreshes this list entirely on each
scan.
5.2 Radio Configuration Commands
This section describes the configuration commands associated with the radio.
5.2.1 Ess
This command sets the ess for the radio. The format is:
set radio ess xyz
Where xyz is a string that defines the ess for the radio. It can be from 1 to 31
ASCII characters. This value does not take effect until the device is reset.
The default is “motorola”.
5.2.2 User Default Ess
This command sets the “user default” ess. This value is used when the system
configuration is returned to “system defaults”. It has the same syntax and default
value as the ess command:
set radio defess xyz
The default is “motorola”.
Page 27
EWB100 Usage and Deployment Guide Rev 1.15
5.2.3 Security modes
This command defines the acceptable security modes for the radio. The format
is:
set radio security xyz
Where xyz is a string that defines the target security mode. Acceptable values
are:
none
wep 64 (40 bit wep)
wep128 (128 bit wep)
tkip
aesccmp
The default is “none”
5.2.4 User Default Security Mode
This command sets the “user default” security mode. This value is used when the
system configuration is returned to “system defaults”. It has the same syntax and
default values as the security mode command:
set radio defsecurity xyz
5.2.5 WEP Security Key
This command sets the key values when WEP is used. The format is:
set radio key x abcd
Where x is the WEP key index (0-3) and abcd is a WEP key value associated
with the index..It is either 10 or 26 hex digits depending on the WEP option
selected.
5.2.6 WEP index
This command sets which WEP key will be used for data transfers. The format is
set radio index x
Where x defines the WEP key index to be used. Its values are from 0 to 3.
The default is 0.
Page 28
EWB100 Usage and Deployment Guide Rev 1.15
5.2.7 WPA Password
This command sets the WPA/WPA2 PSK Password . The format is:
set radio password xyz
Where xyz is the password string. It may range from 8 to 63 ASCII characters.
This password must be set only after the ESS for the device has been specified.
This parameter cannot be displayed after being entered.
There is no default value for this parameter
5.2.8 User Default WPA Password
This command sets the “user default” wpa pasword. This value is used when the
system configuration is returned to “system defaults”. It has the same syntax as
the wpa passworde command:
set radio defpassword xyz
5.2.9 Encrypted WPA Password
This command sets the WPA password using an encrypted value. The password
must have been encrypted using the cliencrypttool program with an identical key.
The command format is:
set radio epassword xxx
Where xxx is the encrypted password. Note that xxx must be a multiple of 32 hex
digits up to a maximum of 128 hex digits.
There is no default value for this parameter.
5.2.10 Encrypted User Default WPA Password
This command sets the “user default” WPA password using an encrypted value.
The password must have been encrypted using the cliencrypttool program with
an identical key. The command format is:
set radio edefpassword xxx
Where xxx is the encrypted password. Note that xxx must be a multiple of 32 hex
digits up to a maximum of 128 hex digits.
There is no default value for this parameter.
5.2.11 Wpakey
This command sets the security key when TKIP or AESCCMP are used. It
contains 64 hex digits to create the 256 bit key. The command is
set radio wpakey xyz
Where xyz is the security key.
There is no default value for this parameter.
Page 29
EWB100 Usage and Deployment Guide Rev 1.15
5.2.12 User Default Wpakey
This command sets the user default security key when tkip or aesccmp are used.
It contains 64 hex digits to create the 256 bit key. The command is
set radio defwpakey xyz
Where xyz is the security key.
There is no default value for this parameter.
5.2.13 Encrypted Wpakey
This command sets the security key when tkip or aesccmp are used. It contains
64 hex digits to create the 256 bit key. The WPA key must have been encrypted
using the cliencrypttool program with an identical key. The command is
set radio ewpakey xyz
Where xyz is the security key.
There is no default value for this parameter.
5.2.14 Encrypted Default Wpakey
This command sets the default security key when TKIP or AESCCMP are used.
It contains 64 hex digits to create the 256 bit key. The WPAkey must have been
encrypted using the cliencrypttool program with an identical key. The command
is
set radio edefwpakey xyz
Where xyz is the security key.
There is no default value for this parameter.
5.2.15 Minrssi
This command defines the minimum measured RSSI for AP to be considered
acceptable. APs with a measured RSSI below this number will not be considered
for association, even if they are the only APs that are visible. The command is:
set radio minrssi x
Where x is the RSSI value as a positive, decimal number. Internally the value will
be converted to a negative number (i.e. -78dbm).
The default is -80dbm.
It should also be noted that when this value is displayed using the “show radio”
command, it will be displayed as 65535-x where x is the value that was entered.
The display routines do not handle negative numbers properly and so the value
is displayed as a large positive number.
Page 30
Loading...