Motorola EWB100 Deployment Manual

Compact voice over wireless communication device
Hide thumbs Also See for EWB100:
Table of Contents

Advertisement

Quick Links

EWB100 Usage and Deployment Guide
Rev 1.13
EWB 100 Usage and
Deployment Guide
Rev 1.13
May 1, 2014
Page 1

Advertisement

Table of Contents
loading

Summary of Contents for Motorola EWB100

  • Page 1 EWB100 Usage and Deployment Guide Rev 1.13 EWB 100 Usage and Deployment Guide Rev 1.13 May 1, 2014 Page 1...
  • Page 2: Table Of Contents

    EWB100 User Overview ................14 The Physical Device ................14 The User Interface ................14 Voice Modes ..................15 Internal Elements of the EWB100 ..............16 Two software subsystems ..............16 Configuration Data Base............... 16 802.11 Radio ..................16 IP Stack ....................16 Command Line Interpreter ..............
  • Page 3 EWB100 Usage and Deployment Guide Rev 1.13 4.8.4 clear ....................22 4.8.5 stat ....................22 4.8.6 notify ....................23 4.8.7 cfg ....................23 4.8.8 version ................... 23 4.8.9 roam ....................23 4.8.10 ping ....................23 4.8.11 notes ....................23 802.11 Interface ................... 24 Basic Radio Functionality ..............
  • Page 4 Encrypted User default user password .......... 35 Clearing the certificate on the EWB ............35 Creating a Certificate for the EWB 100 ..........35 Loading Certificates onto the EWB100 ..........36 IP Stack ....................... 40 Basic Functionality ................40 Configuration Commands ..............40 7.2.1...
  • Page 5 EWB100 Usage and Deployment Guide Rev 1.13 7.2.7 Append ..................42 7.2.8 User Defined Append ..............42 7.2.9 IGMP Mode ................... 42 7.2.10 IGMP Request Interval ..............42 7.2.11 Perform DCHP on Roam ............... 42 Walkie Talkie ....................44 Basic Concepts ..................44 Protocol Elements ................
  • Page 6 EWB100 Usage and Deployment Guide Rev 1.13 12.3 General Parameters ................61 12.4 Key Usage .................... 65 12.5 Key Action Data ..................66 12.6 Alerts ....................66 12.7 Timeouts ....................68 User Defined Default ................69 13.1 Basic Concept ..................69 13.2 Supported Parameters................
  • Page 7 EWB100 Usage and Deployment Guide Rev 1.13 17.2.1 Overview ..................76 17.2.2 Packages ..................77 17.2.3 Package and File Headers ............78 17.2.4 Tools to build file headers .............. 78 17.3 Using Airbeam ..................79 17.3.1 Enabling the Airbeam Function ............. 79 17.3.2...
  • Page 8 EWB100 Usage and Deployment Guide Rev 1.13 17.5.20 Airbeam TTS version ..............86 17.5.21 Airbeam Inactivity Timeout ............86 17.5.22 Airbeam Download Timeout ............86 17.5.23 Cradle Wait Time ............... 86 MSP Support .................... 89 18.1.1 MSP Mode ..................89 18.1.2...
  • Page 9 EWB100 Usage and Deployment Guide Rev 1.13 22.2.4 CLI Command Execution ............. 101 22.3 Configuration Commands ..............102 22.3.1 Disable HTTP Server ..............102 22.3.2 Port ....................102 Obtaining Device Status Information ............103 23.1 Basic Concepts ................... 103 23.2 LED Blink Patterns ................103 23.3 Status Key Sequence .................
  • Page 10 EWB100 Usage and Deployment Guide Rev 1.13 23.6.15 Arp Tables ................115 23.6.16 802.1x Key Derivation Counters ..........116 23.6.17 DHCP Counters ............... 116 “IF” Counters ................117 23.6.18 23.6.19 Deployment Counters .............. 117 23.6.20 WTT Counters................117 23.6.21 Unicast Counters ..............119 23.6.22...
  • Page 11: Revision History

    EWB100 Usage and Deployment Guide Rev 1.13 Revision History Revision Description Editor Initial Draft Bob Beach Updates from reader comments Bob Beach Additional review comments Linda Billhymer Additional updates Bob Beach Added Appendix C and D Bob Beach Added screen updates to Appendix D...
  • Page 12 EWB100 Usage and Deployment Guide Rev 1.13 Page 12...
  • Page 13: Introduction

    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.
  • Page 14: Ewb100 User Overview

    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.
  • Page 15: Voice Modes

    EWB100 Usage and Deployment Guide Rev 1.13 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: ...
  • Page 16: Internal Elements Of The Ewb100

    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.
  • Page 17: Profiles

    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.
  • Page 18: The Command Line Interpreter

    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.
  • Page 19: Accessing The Cli

    EWB100 Usage and Deployment Guide Rev 1.13 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.
  • Page 20: Cli Access Control

    The string must be created using the clientencrypttool program found on Motorola’s 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.
  • Page 21: Encrypted Configuration 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 Motorola internal support use only and altering them may result in the EWB100 operating incorrectly or not at all.
  • Page 22: Cli Commands Commands

    EWB100 Usage and Deployment Guide Rev 1.13 4.8 CLI Commands Commands There are the following commands in the runtime software CLI: : set configuration show : show configuration stat : system status system : system control notify : performs a notify op...
  • Page 23: Notify

    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.
  • Page 24: Basic Radio Functionality

    Ideally 2 Mbits should be used but 5.5Mbits is also supported. Due to a lack of antenna diversity, the EWB100 does not operate well at 11Mbits basic rate. Pure 11g operation is supported but again the lowest acceptable rate should be used.
  • Page 25: Radio Configuration Commands

    EWB100 Usage and Deployment Guide Rev 1.13  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.
  • Page 26: Security Modes

    EWB100 Usage and Deployment Guide Rev 1.13 5.2.3 Security modes This command defines the acceptable security modes for the radio. The format set radio security xyz Where xyz is a string that defines the target security mode. Acceptable values are: ...
  • Page 27: Wpa Password

    EWB100 Usage and Deployment Guide Rev 1.13 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.
  • Page 28: User Default Wpakey

    EWB100 Usage and Deployment Guide Rev 1.13 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.
  • Page 29: Deltarssi

    The default is 0x0842 which corresponds to channels 1, 6, and 11. 5.2.18 roamMissBeacon EWB100 uses missed beacons as one of the triggers for roaming away from the current AP. This command defines the number of consecutive missed beacons that will cause a roam to a new AP. The device will not necessarily roam to another AP but will perform a scan.
  • Page 30: Roamrssi

    5.2.21 B rates This command defines the 11b rates that will be requested as basic rates by the EWB100 when associating with an AP. The format is: set radio brates xxxx Where xxxx is a 16 bit hex number in which the bits correspond to the data rates that the AP will not use to send data to the device.
  • Page 31: Cradle Low Power Mode

    The default is 0xe0 (ie. All rates about 24 mbits are not requested during association. It should be noted that the EWB100 can use any rate supported by the AP. This command simply limits what rates the AP can use to send to the EWB100 device.
  • Page 32: Peap Authentication (Rev J)

    EWB100 Usage and Deployment Guide Rev 1.13 6 PEAP Authentication (Rev J) 6.1 Introduction The EWB100 supports PEAP authentication for secure networking. The implemention provides the following features:  PEAP authentication compatible with PEAP v1 specification  Server certification checking to provide mutual authenticate ...
  • Page 33: Enable Checking Of Server Certificate

    EWB100 Usage and Deployment Guide Rev 1.13 6.2.3 Enable Checking of Server Certificate This command enables and disables client authentication of server certificates. It requires a certificate be loaded onto the EWB. It is disabled by default. The command is: Set ra wpa2server x Where x = “”disable”...
  • Page 34: User Name - Wpa2Euser

    EWB100 Usage and Deployment Guide Rev 1.13 where x can be “none”, “pmk”, “okc”. if x=”clear”, then the OKC table will be flushed. It is disabled by default. It operates as do other user default settings. 6.2.7 User name - wpa2euser This command specifies the user name that is used in the authentication sequence.
  • Page 35: Encrypted User Password

    EWB100 Usage and Deployment Guide Rev 1.13 where x is the user password . It can be any length. 6.2.12 Encrypted User password This command specifies the user password that is used in the authentication sequence in an encrypted format. This allows the user password to be placed into a configuration file that is downloaded over the network without any risk the password may be lost.
  • Page 36: Loading Certificates Onto The Ewb100

    Set up Hyperterm with the required CA10 drives – WinXP is preferred as stability issues have been seen when connecting via Win7. With EWB100 turned off and with the USB cable connected to the EWB, plug the other end into an available USB port previously used for hyperterm access to a EWB100.
  • Page 37 EWB100 Usage and Deployment Guide Rev 1.13 Page 37...
  • Page 38 EWB100 Usage and Deployment Guide Rev 1.13 Exit Hyperterm, unplug usb and then plug back in again and re-launch hyperterm. Type “enter” and “D” to the > prompt. Boot device with “load boot G” Page 38...
  • Page 39 EWB100 Usage and Deployment Guide Rev 1.13 Page 39...
  • Page 40: Ip Stack

    Rev 1.13 7 IP Stack 7.1 Basic Functionality This section describes the functionality of the TCP/IP stack within the EWB100.  The EWB supports only IPv4.  The EWB supports three mechanisms for obtaining IP addressing information: Static, “MAC”, and DHCP. The factory default is “MAC” in which the lower 24 bits of the IP address is taken from the lower 24 bits the MAC address.
  • Page 41: User Default Network Mode

    EWB100 Usage and Deployment Guide Rev 1.13 set network mode xxx Where xxx is may be dhcp, static, or mac. If DHCP, the device will obtain IP addressing information using DHCP. If static, then the user must enter the IP address, mask, and default gateway manually using the commands in this section.
  • Page 42: Append

    EWB100 Usage and Deployment Guide Rev 1.13 set network dns a.b.c.d The default is: 192.168.0.1. Where a.b.c.d is the ip address of the DNS for the device. If DHCP is selected, it is supplied as part of the DHCP response and this entry will be ignored.
  • Page 43 EWB100 Usage and Deployment Guide Rev 1.13 The bit value is: 0x0080 The default is disabled. Page 43...
  • Page 44: Walkie Talkie

    Rev 1.13 8 Walkie Talkie 8.1 Basic Concepts One of the primary features of the EWB100 is the “walkie talkie” like voice capability. A user pushes the “Push to Talk Button” and a voice stream goes out to all other devices.
  • Page 45: Protocol Elements

     The EWB100 will communicate across subnets, provided the routers connecting those subnets are configured to pass the class D defined above. As noted previously, the EWB itself will not generally roam across subnets.
  • Page 46: Alternative Channels

    As also noted above, an EWB100 that receives a packet on a channel that it is monitoring (but is not the default transmit channel), will temporarily switch transmit channels so that the user can reply to the message. This window is typically 5-10 seconds (also a configuration parameter).
  • Page 47: Configuration Commands For Wtt Operation

    EWB100 Usage and Deployment Guide Rev 1.13 There are two modes for the alternative channel mechanism. In the first mode, the channel switch is good for one voice transmission or a configuration defined timeout (normally 5-10 seconds). The user may also switch back manually by repeating the button action that triggered the change.
  • Page 48: Guidelines For Using Multiple Channels

    EWB100. This note describes a means to selecting which mechanism to use. 8.5.1 Zero channels (WTT disabled) Disable WTT enable in the profile. Doing this makes the EWB100 a rather useless device in that the WTT functionality is disabled. 8.5.2 One channel Program the pttkeydata field in user profile 0.
  • Page 49 EWB100 Usage and Deployment Guide Rev 1.13 set pr rxwttmask 0 z (where z = (1 << (x-1) ) | (1 << (y-1)) Page 49...
  • Page 50: Two Channels – Equally Used – Listen On Both

    EWB100 Usage and Deployment Guide Rev 1.13 8.5.4 Two channels – equally used – listen on both In this option, there are two channels that the user typically stays on for a long time. It could be two departments or two job related channels. The time on a channel can be minutes or hours.
  • Page 51: Three Or More Channels

    EWB100 Usage and Deployment Guide Rev 1.13 The command sequence is below where x and y are the two channels set pr key ptt 0 wtt set pr data ptt 0 x set pr key sappsc 0 pr set pr rxwttmask 0 z (where z = (1 << (x-1) ) )
  • Page 52 EWB100 Usage and Deployment Guide Rev 1.13 8.7 WTT Session Replay (rev J) Occasionally an incoming audio message may be lost by a user due to noise or to some distraction.There is now a feature that allows a user to replay the last incoming audio clip.
  • Page 53: Private Reply/Unicast Voice

    Private Reply session back to the speaker. On the EWB100, this is done by doing a quick press and release of the FAPP button. If the session is created properly, a quick succession of tones is heard by both parties.
  • Page 54: Uc Command Reference

    EWB100 Usage and Deployment Guide Rev 1.13 When either side terminates the session (or it times out), a SIP “END” packet will be sent and the session will be terminated on both sides following one or more additional packets. The voice stream is half duplex, being controlled by the SIP handshakes. Voice packets are in a compressed format using G729 every 100ms and so contain 100 bytes of voice plus approximately 50-60 bytes of IP, UDP, and RTP headers.
  • Page 55: Device/User Name

    EWB100 Usage and Deployment Guide Rev 1.13 10 Device/User Identity (Rev J) 10.1 Device/User Name There is the option to give the device a name. It is assumed that the assigned name will be the user/owner of the device. This name may be included in the status message as well as appended to the audio clips sent by the silent alarm facility.
  • Page 56: Adding Device/Organization Name To Call Buttonmessages

    EWB100 Usage and Deployment Guide Rev 1.13 The device name is displayed in the “sho misc” command. Unlike the previous parameter, the setting for this parameter is not preserved across configuration resets. 10.3 Adding device/organization name to Call ButtonMessages The device and organization name can be added to call buttom audio messages that are sent over the network.
  • Page 57 EWB100 Usage and Deployment Guide Rev 1.13 Page 57...
  • Page 58: Profiles

    EWB100 Usage and Deployment Guide Rev 1.13 11 Profiles 11.1 Introduction to Profiles (rev J changes) Profiles are a means to change a large number of configuration parameters for the device in a single step. Most of the user visible configuration parameters are set on a per-profile basis;...
  • Page 59 EWB100 Usage and Deployment Guide Rev 1.13 With either approach, the selected profile may become the “default” profile if so enabled by the configuration. If so enabled, the device will remember the last profile selected across resets. If this mode is not set, then the device will revert back to the default profile upon a reset.
  • Page 60 EWB100 Usage and Deployment Guide Rev 1.13 General device functions enable/disable/configure various functions. These parameters include:  WTT enable  Private Reply enable  Profile switching enable (defined as key function value)  Mute enable Parameters for WTT include:  Channel listen mask ...
  • Page 61: Profile Initialization

    EWB100 Usage and Deployment Guide Rev 1.13 Configuration for audio and LED prompts allow a user to change the audio prompt for a function as well as the LED blink pattern. All of the audio alerts a user can hear can be replaced by another audio sequence. One can use this capability to establish novice/expert based prompts or change the language of the prompts.
  • Page 62 EWB100 Usage and Deployment Guide Rev 1.13 11.3.1.2 Name This parameter assigns an ASCII string name to the profile. This name is not used for any purpose except when the distributed name directory function is used. It can consist of any ASCII character and must be between 1 and 16 characters.
  • Page 63 Where n is the profile number (0-7) and y is either enable or disable. The default is enabled. 11.3.1.8 Channel Listen Mask This parameter defines the WTT channels that the EWB100 device listens upon. It is a 32 bit number in which the bit numbers correspond to WTT channels. The format is:...
  • Page 64 EWB100 Usage and Deployment Guide Rev 1.13 20000 40000 80000 100000 200000 400000 800000 1000000 2000000 4000000 8000000 10000000 20000000 40000000 80000000 Multiple bits may be set in the mask in order to allow the device to listen on multiple channels at once.
  • Page 65: Key Usage

    EWB100 Usage and Deployment Guide Rev 1.13 time or until the user exits the command by pressing on the volume up button. It is used when a user does not want to be disturbed for an extended period of time...
  • Page 66: Key Action Data

    EWB100 Usage and Deployment Guide Rev 1.13 11.5 Key Action Data This commands sets a 32 bit data field that is associated with a particular key/action combination. The format is: set profile data x n z Where x is the keyOp from the previous command,n is the profile number (0-7), and z is the 32 bit hex number.
  • Page 67 EWB100 Usage and Deployment Guide Rev 1.13  unvring - this alert is not currently used.  hangup - alert played when full duplex call is hung up  confirm - alert played to confirm various key requests such as status or power down ...
  • Page 68: Timeouts

    EWB100 Usage and Deployment Guide Rev 1.13  cerr - alert played when there is a charging error of some type  ready - alert played when removing ready device from cradle  notready - alert played when removing not ready device from cradle ...
  • Page 69: User Defined Default

    EWB100 Usage and Deployment Guide Rev 1.13 12 User Defined Default 12.1 Basic Concept User Defined Defaults allows users to alter the default values of various network, radio, and airbeam parameters. When the device is restored to “factory defaults”, these parameters will be loaded with values the user specifies rather than the factory defaults.
  • Page 70: Showing User Defined Default Values

    EWB100 Usage and Deployment Guide Rev 1.13 12.3 Showing User Defined Default Values The regular and user default parameters can be shown via the regular show configuration commands :  Show radio  Show network  Show airbeam To see the user defaults, user mode must be enabled (see above). Otherwise they are hidden.
  • Page 71: User Interface Customization

    EWB100 Usage and Deployment Guide Rev 1.13 14 User Interface Customization 14.1 Basic Concepts Some aspects of the user interface may be altered by configuration settings. Some define the behavior of buttons while others control how the device behaves in certain situations. This section defines what may be changed and how to do it.
  • Page 72: Disable Clear Configuration Key Sequence

    EWB100 Usage and Deployment Guide Rev 1.13 14.6 Disable Clear Configuration Key Sequence If set, the capability to clear a configuration using a multiple key sequence is disabled. The function is controlled by the following configuration bit in the “misc new2”...
  • Page 73: Alternative Audio Message For Cradle Removal (Rev J)

    EWB100 Usage and Deployment Guide Rev 1.13 14.10 Profile timeout (Rev J) Since a single button press changes profiles, it is possible that random button presses cause the device to move such a channel and hence when the PTT button a pressed the voice stream will go where it is not intended.
  • Page 74 EWB100 Usage and Deployment Guide Rev 1.13 This command enables a user to change profiles during an active call. The command is: set misc new3 x where x is the bit value 0x80 For this command to operate, the “short form profile switch” must also be enabled.
  • Page 75: Telnet

    Rev 1.13 15 Telnet There is a Telnet server present inside the EWB100 that allows remote access to the CLI. It is reachable using any Telnet client. It supports one client at a time. If the CLI requires a password, the user must enter the password before gaining access with Telnet.
  • Page 76: Airbeam

    16 Airbeam 16.1 Basic Concepts This section explains usage of Airbeam to update and configure the EWB100 The firmware/configuration update process is used for downloading new runtime code, configuration files, and audio clips to the device. It follows the “Airbeam”...
  • Page 77: Packages

    EWB100 Usage and Deployment Guide Rev 1.13 network status. It also contains the latest package number stored in the device. It is sent to a particular IP address. Hence by monitoring status packets a user can determine if a device has updated to the latest package.
  • Page 78: Package And File Headers

    EWB100 Usage and Deployment Guide Rev 1.13 16.2.3 Package and File Headers The package file and each component file begins with a 128 byte header made up of a number of parameters. Each parameter is tagged with a one character identifier and all fields are separated by commas.
  • Page 79: Using Airbeam

    EWB100 Usage and Deployment Guide Rev 1.13 crccalc postCfg.txt 1.0 6320080 111 EWB 100 "07/18/08" "10:07:00" cat header.dat postCfg.txt > postCfg.cli Replace postCfg.txt with the file containing the cli commands. Replace postCfg.cli with your desired output file. You can add date and time as desired 16.3 Using Airbeam...
  • Page 80 EWB100 Usage and Deployment Guide Rev 1.13 This approach, while simple, can cause problems if the IP address of the FTP can change or is different for every site. A more flexible approach is to specify the DNS name of the FTP via the server parameter. The command is: set airb server ftp_dns_name where ftp_dns_name is the DNS name of the FTP server.
  • Page 81: The Ftp Port

    EWB100 Usage and Deployment Guide Rev 1.13 will be written to flash memory and used for subsequent FTP requests. It will also be used as the IP address for the device status packet (described below). The device will then reset itself. The update and reset will take place only if the currently defined values of the two IP addresses in flash memory is not equal to the value contained in the option.
  • Page 82: The Password

    If not specified (and by default) the device will use “motorola”. It is expected that all devices that use the same username will also use the same password.
  • Page 83: Airbeam And User Defaults

    EWB100 Usage and Deployment Guide Rev 1.13 The best option depends on the customer needs. There is sufficient flexibility to handle many situations. Since the filename is a configuration option, the value may be changed during the configuration process. Hence one name might be used for initial deployment and then changed later on.
  • Page 84: User Default Airbeam Ftp Port

    EWB100 Usage and Deployment Guide Rev 1.13 set airbeam port_ab xx where xx is the TCP port number. It is a 16 bit decimal number. The default is: 50555 16.5.6 User Default Airbeam FTP Port This command is the user defined default version of the airbeam FTP port comand.
  • Page 85: User Default Airbeam User Password

    EWB100 Usage and Deployment Guide Rev 1.13 16.5.12 User Default Airbeam user password This command is the user defined default version of the Airbeam user password comand. The command is: set airbeam def_password xx 16.5.13 Airbeam Encrypted user password This command specifies the user password for logging into the Airbeam FTP server.
  • Page 86: Airbeam Bootloader/Minikernel Version

    EWB100 Usage and Deployment Guide Rev 1.13 16.5.18 Airbeam bootloader/minikernel version This command specifies the latest minkernel package version. It is normally used and the value is updated when the minikernel is (re)loaded. Note the minikernel cannot be updated via Airbeam but must be done by CSST. The command is: set airbeam bootloader_ver xx 16.5.19 Airbeam runtime version...
  • Page 87 EWB100 Usage and Deployment Guide Rev 1.13 where xx is the delay in seconds. The default is 1800 seconds. 16.5.23.1 Airbeam Package number update criteria If set, the airbeam subsystem will require a download package number to be numerically greater than the package number last downloaded. If not set, the airbeam subsystem will only require that the package numbers be different.
  • Page 88 EWB100 Usage and Deployment Guide Rev 1.13 16.5.24 New Airbeam Download Types (Rev J) Two new airbeam download types have been added: “Cert” and “Other”. The former is used for downloading PEAP certificates and the latter is available for future TBD uses. Configuration variables for these two types have also been defined.
  • Page 89: Msp Support

    17 MSP Support The EWB100 supports MSP for configuration and firmware updates. Information MSP and how to use it to support the EWB100 is found in the MSP User Documentation. This section describes configuration commands for MSP There are two MSP configuration commands and they only allow MSP to be disabled.
  • Page 90: Misc Cli Commands

    EWB100 Usage and Deployment Guide Rev 1.13 18 Misc CLI Commands This section describes a number of CLI commands that are “standalone” and not associated with another subsystem. 18.1 Ping This command performs an ICMP ping. The format is: Ping [-x] [-t] [-c n] [-l m] [a.b.c.d] ...
  • Page 91: The Cfg Command

    It can be up to 64 characters. If it omitted then the current note associated with the number is deleted. 18.5 Reset Device This command causes the EWB100 to do a reset and restart. The format is: sys reset 18.6 Power Off Device This command causes the EWB100 to power down.
  • Page 92: For Invoking Notifications

    EWB100 Usage and Deployment Guide Rev 1.13 18.7.1 For invoking notifications The command format is: notify l led pattern Where led is an led and can have the value:  green  red  blue Pattern defines the blink pattern used and can have the value: ...
  • Page 93: Audio Services

    Multilanguage support. 19.2 Audio Clips and Audio Tables The EWB100 device does not have a display and only very limited LEDs and so generally uses audio alerts to communicate information and status to the user. The audio alerts can be tones or spoken words or any combination of them.
  • Page 94: Clip Names And Clip-Ids

    EWB100 Usage and Deployment Guide Rev 1.13 There are approximately 400 audio clips stored in the runtime image. This list of clips is called the Default Directory and includes: letters, numbers, status and configuration phrases, common phrases, various tone sequences, phrases for demo applications, etc.
  • Page 95: Clip Names, User Notifications, And Configuration

    19.4 Clip Names, User Notifications, and Configuration On EWB100 devices, the audio clip associated with any given audio alert can be changed using Clip names and/or downloadable Clip Tables. Audio messages to the user fall into one of three categories: ...
  • Page 96: Multilanguage Support

    Replacing the default dictionary would allow the creation of a new and single language version of the EWB100 device. All of the English clips would be replaced by French or German or Spanish clips. For the profile defined clips, the previously defined model works fine. One would define new language clips and give them unique names.
  • Page 97: Detailed Instructions

    19.5.2 Detailed Instructions This section describes how to configure the EWB100 to use non-English voice prompts when not using MSP. This may be done via the Airbeam package files with the DA or via the FTP transfer mechanism. It may also be done line by line using the CLI but this approach may take a long time if many devices are configured..
  • Page 98 EWB100 Usage and Deployment Guide Rev 1.13 set pr alert lostnet 0 xx_n_lost_network set pr alert gotnet 0 xx_n_got_network set pr alert nosignal 0 xx_nosignal set pr alert wac 0 xx_everyone set pr alert home 0 xx_n_home_channel set pr alert busy 0 xx_n_busy...
  • Page 99: Building New Audio Clip Files

    In addition to the configuration values the additional language prompts must have been loaded into the flash memory of the EWB100. At this time there is only one such file required and it supports all of the above languages. The file name is: euro_tts_flash_image.bin.
  • Page 100: Web Server

    EWB100 Usage and Deployment Guide Rev 1.13 20 Web Server 20.1 Basic Concepts EWB 100 supports creation of HTTP server connections. Each server connection has to have a body of code behind it to process incoming connections. Although EWB 100 technically includes a “web server”, it is really a very simple dispatching of requests to dedicated subroutines which will process the HTTP request payload and send a response.
  • Page 101: System Reset

    URL encoding. For example, the URL: http://192.168.0.104/clicmd?cmd=ver Causes the following plain/text response: Motorola CA10 Version 1.1.920 Realtime-CA10 No external mem used 1 2009 13:20:06 EngVer = 4 HwVer = 2 nchip = noProt chip = Locosto-Lite Hawkeye = 0x412b TI_DM = 0x5b66 ES = unknown...
  • Page 102: Configuration Commands

    EWB100 Usage and Deployment Guide Rev 1.13 20.3 Configuration Commands 20.3.1 Disable HTTP Server If set, the device will disable CLI via the HTTP server. Other HTTP functions will still operate. The function is controlled by the following configuration bit in the “misc new3”...
  • Page 103: Obtaining Device Status Information

    21 Obtaining Device Status Information 21.1 Basic Concepts The EWB100 does not have a graphical interface and so the user cannot look at a screen in order to determine the state of the device. However there are four mechanisms by which a user can determine the state of the EWB100: ...
  • Page 104: Information Available

    EWB100 Usage and Deployment Guide Rev 1.13 21.3.2 Information Available After one beep basic status information is played. This includes:  Association status  Signal strength in dbm  Battery strength  Current profile After two beeps important configuration is played. This includes: ...
  • Page 105: Status Message

    EWB100 Usage and Deployment Guide Rev 1.13  3 = enables all information 21.4 Status Message 21.4.1 Device Status Update Mechanism The Device status update process involves the device transmitting via UDP a collection of configuration and status/history information to a particular IP address.
  • Page 106: Enabling Sending The Device Status Packet

    EWB100 Usage and Deployment Guide Rev 1.13  The sending interval 21.4.2 Enabling sending the Device Status Packet The device status packet is always sent once after a reset. This again is a legacy of the DA program. Whether it is sent again after that depends on the configuration command: set airb deployrecord xx where xx can be “manual”...
  • Page 107: Roam Command

    21.6 The Statistics Command This command displays various counters and dynamic tables associated with the various subsystems on EWB100 devices. For most subsystems there is only one parameter associated with the command that is the name of the subsystem. A few subsystems may have a second parameter that identifies a particular set of items within the subystem.
  • Page 108: Wireless Driver Counters

    EWB100 Usage and Deployment Guide Rev 1.13 21.6.1 Wireless Driver Counters This command lists counters associated with the WLAN driver. Many of these counters are meaningful only to developers who are familiar with internals of the WLAN driver. The few that may be of more general interest are noted below (‘*’).
  • Page 109: Umac Counters

    EWB100 Usage and Deployment Guide Rev 1.13 bad gp2 no rx bf tx err ic tx err tx dropped pkt out err trap ovr no kn buf no vo buf not nt q1 not nt qn 21.6.2 UMAC Counters This command lists some of the UMAC statistics. There are two forms, with and without a qualifier.
  • Page 110: Transmit Packet Counters

    EWB100 Usage and Deployment Guide Rev 1.13 rx icv err 21.6.3 Transmit packet counters These counters record the number of each different type of packet transmitted. Voice packets are included in these counts. It also indicates the current transmit rate (in 0.5Mbit increments) and missed beacon %.
  • Page 111: Receive Rate Histogram

    EWB100 Usage and Deployment Guide Rev 1.13 21.6.6 Receive Rate Histogram These counters show how many packets have been received at each rate. Only nonvoice packets are included. >st umac rrx --time: 155.728 5.5: 00 21.6.7 Transmit Rate Histogram These counters show how many packets have been transmited at each rate. All packet types are included.
  • Page 112: Transmit Retry Histogram

    EWB100 Usage and Deployment Guide Rev 1.13 21.6.8 Transmit Retry Histogram These counters show how the distribution of packet transmit retries >st umac rtx --time: 155.728 … 21.6.9 AP Tables This command displays information about the current and known access points.
  • Page 113: Receive Packet Statistics

    EWB100 Usage and Deployment Guide Rev 1.13 21.6.10 Receive Packet Statistics This command displays information received packets. It shows informationon the last 16 received packets. Information includes:  Time in microseconds since last packet  Received data rate  RSSI ...
  • Page 114: Tcp Counters

    EWB100 Usage and Deployment Guide Rev 1.13 21.6.12 TCP Counters This command provides information about the number of TCP connections that have been attempted and established as well as the number and types of packets that have been transmitted and received.
  • Page 115: Icmp Counters

    EWB100 Usage and Deployment Guide Rev 1.13 21.6.14 ICMP Counters This command provides information about the number of ICMP packets that have been transmitted and received. >st icmp --time: 184.940 InMsg InErr InEcho InEchoR OutMsg OutEcho OutEchoR 21.6.15 Arp Tables This command displays information on both the number and types of ARP packets that have been transmitted and received as well as the current “arp...
  • Page 116: X Key Derivation Counters

    EWB100 Usage and Deployment Guide Rev 1.13 21.6.16 802.1x Key Derivation Counters This command displays counters derived from the operation of the 802.1x key derivation handshake protocol. The number of type of each receved packet is displayed. There are are also counters for Michael and Mic errors.
  • Page 117: If" Counters

    EWB100 Usage and Deployment Guide Rev 1.13 21.6.18 “IF” Counters This command provides information about the number of TCP, UDP, ARP, DHCP, etc.. packets that have been transmitted and received. >st if --time: 200.856 InOct InUcP InMcP InDis InErr InUnk...
  • Page 118 EWB100 Usage and Deployment Guide Rev 1.13 21.6.20.1 Simple form (no parameter) This form >st wtt --time: 208.639 pkts tx pkts rx lost 0 lost 1 lost n 21.6.20.2 Form 1 >st wtt 1 --time: 211.286 pkts tx pkts rx...
  • Page 119: Unicast Counters

    EWB100 Usage and Deployment Guide Rev 1.13 21.6.20.3 Form 2 >st wtt 2 --time: 214.216 pkts tx pkts rx lost 0 lost 1 lost n wtt gaps 0: 0 1: 0 2: 0 3: 0 4: 0 5: 0 6: 0...
  • Page 120: Dns Counters And Table

    EWB100 Usage and Deployment Guide Rev 1.13 21.6.22 DNS Counters and table This command displays DNS packet counts, the known DNS servers , and the current name to IP address mappings. >st dns --time: 225.777 DNS client statistics: No DNS servers in list...
  • Page 121: Trace

    Rev 1.13 22 Trace This command sets the level of trace for the various subsystems on the EWB100 device. There are two forms of the trace state, one for umac tracing and the other for all other subsystem. Changes to trace options take effect immediately.
  • Page 122: Umac Tracing

    EWB100 Usage and Deployment Guide Rev 1.13 22.1.2 Umac Tracing Umac tracing is more complex because there are many tracing entities within the umac subsystem. The general format is: set tra umax xx yy Where xx is the tracing entity and yy is either 0 (no tracing) or 7f (full tracing).
  • Page 123: Minikernel Commands

    EWB100 Usage and Deployment Guide Rev 1.13 23 MiniKernel Commands This section describes the minikernel commands. The minikernel cli is entered by entering D (Capital D) immediately after the system boots up. The minikernel will wait a short amount of time (~3-10 seconds, depending on whether the RS232 or USB serial interface is connected) for the D command to be entered before proceeding to start the runtime code.
  • Page 124: Version

    EWB100 Usage and Deployment Guide Rev 1.13 23.2 Version This command displays the version of the minikernel and some hardware information. The command is: version It takes no parameters. The output is: Motorola CA10 Version 1.1.1011 Mini-CA10 Using external mem Apr...
  • Page 125 EWB100 Usage and Deployment Guide Rev 1.13 Appendix A: Status Record Contents (pre Rev J) Fields sent out by the EWB100 devices, in order that they appear Field name Description Example value Device MAC address 001570DC0EA9 PROFILE Current user profile...
  • Page 126 EWB100 Usage and Deployment Guide Rev 1.13 ASSOCTIME Time of last 11733 association (ms) ASSOCTED Associated TRAPSI Internal counter ASSOC Associations REASSOC Reassociations LASTAP Previous AP mac 000000 address LSTARTS Locally started wtt sessions RSTART Remotely started wtt sessions RDECLN...
  • Page 127 EWB100 Usage and Deployment Guide Rev 1.13 Appendix B: Status Record Contents (Rev J) Fields sent out by the EWB100 devices, in order that they appear Field name Description Example value Device MAC address 001570DC0EA9 DNAME Device Name * Ewb100...
  • Page 128 EWB100 Usage and Deployment Guide Rev 1.13 LSTARTS Locally started wtt sessions RSTART Remotely started wtt sessions RDECLN Remote wtt sessions declined Remote wtt sessions ignored Listen timeout value RXTXCNT Wtt rx/tx transitions RXTXWN Wtt sessions “won” RXTXLST Wtt sessions “lost”...
  • Page 129: Appendix C: Utility Program

    EWB100 Usage and Deployment Guide Rev 1.13 Appendix C: Utility Program This section describes how to use a number of “utility programs” that are useful with the EWB100 B.1 clientencrypttool There is a Windows program for calculating encrypted values for WPA and CLI configuration values.
  • Page 130: Appendix D: Utilizing The Usb Interface With Win/Xp

    Kernel and Runtime endpoints are called “CA10” and use the same Windows drivers. The “CA10” is an older model number for the device now known as the EWB100 and is embedded in the EWB100 USB software. Which endpoint is used depends on the state of the EWB100 device. When the device is powered on, the LOCOSTO endpoint is available for only a few seconds.
  • Page 131 EWB100 Usage and Deployment Guide Rev 1.13 The following window sequence will appear after the above window is closed. It will also appear if a running EWB100 is plugged into a PC for the first time. Select Next Page 131...
  • Page 132 EWB100 Usage and Deployment Guide Rev 1.13 Select “Install from a specific location” and select next Then select "Include location in the search" Page 132...
  • Page 133 EWB100 Usage and Deployment Guide Rev 1.13 This assumes the drivers are located in an external drive/directory named: E:\EWB100\drivers The contents of this directory are: Enter this directory in the search box as shown below and select Next. Page 133...
  • Page 134 EWB100 Usage and Deployment Guide Rev 1.13 Wait while the driver installs Wait Page 134...
  • Page 135 The USB connection will appear as a serial port to Hyperterm. The exact port number will generally depend on which physical USB port on the PC the EWB100 is plugged into as well as the presence of other USB peripherals. One can determine the assignment by looking at the “Device Manager” window...
  • Page 136 EWB100 Usage and Deployment Guide Rev 1.13 available from the “Control Panel” as seen below: Alternately one can wait and just open the “properties” menu item on Hyperterm and see the list of possible ports. In any case one must pick the desired port to connect with via this window.
  • Page 137 At this point “Connect” to the port and you should see approximately the following. Alternatively one may just see the CLI prompt “>”. How much one sees depends upon where the EWB100 is in its bootup sequence when the USB is attached to Hyperterm.
  • Page 138: Appendix E: Utilizing The Usb Interface With Vista And Win/7

    Windows 7 (64 bit versions). This process uses the sames USB drivers as used with Windows XP. We assume they are on the external drive/directory: E:\EWB100\drivers. The USB drivers can be found in the EWB100 section of http://support.symbol.com. Prior to proceeding users should first read Appendix C on utilizing the USB interface with Windows XP in order to understand how the various USB endpoints on the EWB100 operate.
  • Page 139 – “Browse my computer for driver software” Select the 2 Enter the location where you have copied the files for the USB CA10 drivers. Point to the expanded folder with the CA10 drivers (E:\EWB100\drivers) and select it. Ignore the unsigned driver warning. Page 139...
  • Page 140 EWB100 Usage and Deployment Guide Rev 1.13 Win7 will now install the software: And the completed pop-up: Page 140...
  • Page 141 EWB100 Usage and Deployment Guide Rev 1.13 At this point the drivers will have been installed. Remove the EWB100 and reinsert it. The drivers should recognize the device now. As noted above, inserting the device into a different physical USB port on the PC may require reinstalling the drivers.
  • Page 142 A final note in operation with Win7: After installing the drivers, but before plugging in device to use with hyperterm, have hyperterm running and ready to open the device as you plug in the EWB100/CA10. A pre-saved profile can be created to facilitate this: Use file->open to select your previously saved connection.
  • Page 143 EWB100 Usage and Deployment Guide Rev 1.13 While the device is connected in this fashion with hyperterm executing in admin mode, you should not experience any resets due to Win7 of the device. Page 143...
  • Page 144: Appendix F: Creating A New Audio Clip File

    EWB100 Usage and Deployment Guide Rev 1.13 Appendix F: Creating a New Audio Clip File This section describes how to create a new audio clip file. A description of the purpose of the clip files is described in section 20, this section is on the mechanics of creating the file.
  • Page 145 The file “audioclipimage.bin” should be replaced by a filename that is meaningful to the developer. This file can be loaded on the ewb100 device by any of the usual means (USB or Airbeam, but not the Deployment Application (DA)).
  • Page 146 EWB100 Usage and Deployment Guide Rev 1.13 Page 146...

Table of Contents