background image

EWB100 Usage and Deployment Guide 

 

 

Rev 1.13 

 

Page 56  

 

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. To enable use the following command: 

 

set mis new3 x 

where x is the bit map 0x800. It is disabled by default.  

 

 

 

Summary of Contents for TEAM Badge (EWB100)

Page 1: ...EWB100 Usage and Deployment Guide Rev 1 13 Page 1 EWB 100 Usage and Deployment Guide Rev 1 13 May 1 2014 ...

Page 2: ...3 4 IP Stack 16 3 5 Command Line Interpreter 16 3 6 Profiles 17 3 7 Airbeam and MSP 17 3 8 Audio Clips and Default Dictionary 17 3 9 Web Server 17 4 The Command Line Interpreter 18 4 1 Basic Concepts 18 4 2 The CLI and the ConfigurationData Base 18 4 3 Accessing the CLI 19 4 4 CLI Access Control 20 4 4 1 Basic Concept 20 4 4 2 Configuration Commands 20 4 5 Encrypted Configuration Parameters 21 4 6...

Page 3: ...25 5 2 3 Security modes 26 5 2 4 User Default Security Mode 26 5 2 5 WEP Security Key 26 5 2 6 WEP index 26 5 2 7 WPA Password 27 5 2 8 User Default WPA Password 27 5 2 9 Encrypted WPA Password 27 5 2 10 Encrypted User Default WPA Password 27 5 2 11 Wpakey 27 5 2 12 User Default Wpakey 28 5 2 13 Encrypted Wpakey 28 5 2 14 Encrypted Default Wpakey 28 5 2 15 Minrssi 28 5 2 16 Deltarssi 29 5 2 17 Cha...

Page 4: ...keycaching 33 6 2 7 User name wpa2euser 34 6 2 8 Encrypted User name ewpa2euser 34 6 2 9 User default user name defwpa2euser 34 6 2 10 Encrypted User default user name 34 6 2 11 User Password 34 6 2 12 Encrypted User password 35 6 2 13 User default user Password 35 6 2 14 Encrypted User default user password 35 6 3 Clearing the certificate on the EWB 35 6 4 Creating a Certificate for the EWB 100 3...

Page 5: ...nd occasionally secondary listen on both 48 8 6 4 Two channels equally used listen on both 50 8 6 5 Two channels listen on only one at time 50 8 6 6 Three or More Channels 51 8 7 WTT Command Reference 51 8 7 1 Private Reply Timeout 51 8 7 2 Maximum WTT Session Duration 51 8 8 WTT Session Replay rev H 52 9 Private Reply Unicast Voice 53 9 1 Basic Concepts 53 9 2 Protocol Elements 53 9 3 UC Command ...

Page 6: ...r down 71 15 3 Eliminate Flashing of Green LED 71 15 4 Out of Range Audio Alert Repeat 71 15 5 Low Battery Audio Alert Repeat 71 15 6 Disable Clear Configuration Key Sequence 72 15 7 Return to Default Profile when inserted into charging cradle 72 15 8 Simplfied Profile Selection Mode 72 15 9 Set current profile as default profile 72 15 10 Profile timeout Rev K 73 15 11 Alternative Audio message fo...

Page 7: ... Default Mode 83 17 5 3 Airbeam FTP Server IP address 83 17 5 4 User Default Airbeam FTP Server IP address 83 17 5 5 Airbeam FTP Port 83 17 5 6 User Default Airbeam FTP Port 84 17 5 7 Airbeam server name 84 17 5 8 User Default Airbeam server name 84 17 5 9 Airbeam user name 84 17 5 10 User Default Airbeam user name 84 17 5 11 Airbeam user password 84 17 5 12 User Default Airbeam user password 85 1...

Page 8: ...19 6 Power Off Device 91 19 7 The Notify Command 91 19 7 1 For invoking notifications 92 19 7 2 For invoking audio alerts 92 20 Audio Services 93 20 1 Introduction 93 20 2 Audio Clips and Audio Tables 93 20 3 Clip names and clip ids 94 20 4 Clip Names User Notifications and Configuration 95 20 5 Multilanguage support 96 20 5 1 Basic Model 96 20 5 2 Detailed Instructions 97 20 6 Building New Audio ...

Page 9: ...bling sending the Device Status Packet 106 23 4 3 Specifying where the packet is to be sent 106 23 4 4 Specifying how often the packet is to be sent 106 23 5 Roam Command 107 23 6 The Statistics Command 107 23 6 1 Wireless Driver Counters 108 23 6 2 UMAC Counters 109 23 6 3 Transmit packet counters 110 23 6 4 Roaming statistics 110 23 6 5 Scanning counters 110 23 6 6 Receive Rate Histogram 111 23 ...

Page 10: ...le 120 23 6 23 Configuration Counters 120 24 Trace 121 24 1 1 NonUmac Tracing 121 24 1 2 Umac Tracing 122 25 MiniKernel Commands 123 25 1 Load Boot 123 25 2 Version 124 Appendix A Status Record Contents pre Rev K 125 Appendix B Status Record Contents Rev K 127 Appendix C Utility Program 129 B 1 clientencrypttool 129 Appendix D Utilizing the USB Interface with Win XP 130 Appendix E Utilizing the US...

Page 11: ...x 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 L...

Page 12: ...EWB100 Usage and Deployment Guide Rev 1 13 Page 12 ...

Page 13: ...lect 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 t...

Page 14: ...plemented 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 b...

Page 15: ...nd 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 multi...

Page 16: ...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 R...

Page 17: ...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 basisThe EWB 100 also supports MSP for runtime code updates and configuration 3 8 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 cl...

Page 18: ...e 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 configu...

Page 19: ... 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 ...

Page 20: ...e 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 en...

Page 21: ...y 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 fie...

Page 22: ...lt 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 comm...

Page 23: ... 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 Motorola 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 Hawke...

Page 24: ...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 ...

Page 25: ...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 ra...

Page 26: ...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...

Page 27: ... 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 val...

Page 28: ...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 bel...

Page 29: ...he mask corresponds to channel 1 bit 2 channel 2 etc Bit 0 is not used 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 ...

Page 30: ...ating 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 The bits are assigned as follows Bit 0 1 Mbit sec Bit 1 2 Mbit sec Bit 2 5 5Mbit sec Bit 3 11 Mbit sec The default value is 0xf 5 2 22 blockedrates This command defines the 11g data rates that the radio will not re...

Page 31: ...n situations where the cradle is located in an area of poor RF coverage The default is disabled The function is controlled by the following configuration bit in the misc new3 command The bit value is 0x0001 The default value is disabled 5 2 24 Fixes for roaming problems A new option has been added to fix some roaming problems that could cause long periods of no association when the device receives...

Page 32: ...nd Opportunistic Key Caching OKC If supported by the WLAN infrastructure OKC is much more efficient as only one PEAP authentication sequence is required regardless of the number of AP PMK requires the EWB to authenticate at least once with each AP When using PMK the EWB only maintains PMKs for 32 APs If there are more than 32 APs the EWB will reuse the information slot with the oldest PMK 6 2 Conf...

Page 33: ... This command specifies the type of key caching that the EWB will do There are three options None the ewb will do full PEAP authentication on every roam PMK the ewb will cache keys for each AP that is authenticates with If enabled the ewb will do full PEAP authentication only with APs that it has not previously authenticated with subject to key timeouts OKC the ewb will authenticate only once with...

Page 34: ...ed form of the user name It can be any length 6 2 9 User default user name defwpa2euser This command specifies the user default version user name that is used in the authentication sequence The command to set the name is set ra defwpa2euser x where x is the user name It can be any length It operates as do other user default settings 6 2 10 Encrypted User default user name This command specifies th...

Page 35: ...sword It can be any length It operates as do other user default settings 6 2 14 Encrypted User default user password This command specifies the user default version user password that is used in the authentication sequence as an encrypted This allows the default user password to be placed into a configuration file that is downloaded over the network without any risk the password may be lost The en...

Page 36: ...e resulting file ewb der bin can be downloaded on the ewb using the procedure in the next section 6 5 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 hy...

Page 37: ...EWB100 Usage and Deployment Guide Rev 1 13 Page 37 ...

Page 38: ...EWB100 Usage and Deployment Guide Rev 1 13 Page 38 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 39: ...EWB100 Usage and Deployment Guide Rev 1 13 Page 39 ...

Page 40: ...oam may be confusing to some infrastructure products The device will not generally roam across subnets since it does not perform a DHCP request sequence on roams In such a situation the device will continue to use the IP address from the original subnet which will not be acceptable on the new subnet Some infrastructure products permit a device to keep its IP address even when roaming onto a differ...

Page 41: ...mand specifies the IP address for the device It is required if Static mode is selected The format is set network ipadr a b c d Where a b c d is the IP address for the device The default is a mac defined value as defined above 7 2 4 IP mask This command specifies the IP mask for the device It is required if Static mode is selected The format is set network mask a b c d Where a b c d is the ip mask ...

Page 42: ... the IGMP feature on the device If enabled the device will send an IGMP message on each roam and at user specified intervals The command is set misc igmp xx Where xx is off V2 or V3 igmp v2 or V3 The default is off 7 2 10 IGMP Request Interval The command sets the IGMP packet interval The command is set misc jgmpinterval xx Where xx is the interval in seconds Note that the command does being with ...

Page 43: ...EWB100 Usage and Deployment Guide Rev 1 13 Page 43 The bit value is 0x0080 The default is disabled ...

Page 44: ...The first tone is a goahead tone that indicates the user may start speaking The second tone is busy tone which indicates some other user has already gained access to the channel although they may not have started speaking yet This second tone is also played if the user presses the PTT key while a voice stream is already being played While the device can only transmit on a single channel at any giv...

Page 45: ...dress is 239 192 2 2 Note that the latter is a class D address which is generally not passed across subnets by routers without explicit configuration of the routers 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 This configuration may ...

Page 46: ...at 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 After that time the device will switch back to its default transmit channel or home channel There is often a need for a device to switch to another channel in order to communicate with a ...

Page 47: ...ormally talks on the department channel but can always switch to the global channel if needed The configuration commands to enable configure the alternative channel mechanism are defined on a per profile basis Thus each profile can have its own alternative channel configuration Typical command sequences are set pr key sappsc n x where n is the profile number and x is either wacs for single operati...

Page 48: ... time but the user occasionally wants to transmit on a secondary channel The user wants to listen on both channels all the time It should be noted that if an incoming session arrives on the alternative channel the device will automatically switch to that channel for a few seconds after the voice stream completes to allow the user to respond To operate this way the alternative channel single mode s...

Page 49: ...EWB100 Usage and Deployment Guide Rev 1 13 Page 49 set pr rxwttmask 0 z where z 1 x 1 1 y 1 ...

Page 50: ...sequence again The configuration for this mode is as follows assuming sappsc is used for the channel switch set pr key ptt 0 wtt set pr data ptt 0 x set pr key sappsc 0 wace set pr data sappsc y set pr timeout wac w w timeout in seconds set pr rxwttmask 0 z where z 1 x 1 1 y 1 8 5 5 Two channels listen on only one at time In this mode the user wants to switch between two channels but only listen o...

Page 51: ...he Profiles section for most WTT command reference There are a few parameters that are WTT related and effect all sessions regardless of profile Those are described in this section 8 6 1 Private Reply Timeout This command defines the time following the end of a WTT session during which a private reply session can be started by a single press of the FAPP button The format is set wtt smcto n Where n...

Page 52: ... seconds of the previous audio message will be played There are two steps to configure this feature The first is to assign a key sequence to trigger it Valid key sequences are Single press of SAPP or FAPP keys Double press the FAPP key This is done via a command such as set pr key x y replay where x is one of sappsc fappsc fappdc and y is the profile number This command is specified on a per profi...

Page 53: ...de can begin talking by pushing the PTT button If both try to talk at the same time a special alert tone is played While the session exists there can be any number of voice transmissions by either party The session is terminated when either side presses and releases the FAPP again Alternatively it will be terminated if neither side presses the PTT button for a configuration defined period currentl...

Page 54: ...ts 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 They are addressed to the IP address and UDP port that were defined in the SIP handshake 9 3 UC Command Reference There are no customer visible configuration values for th...

Page 55: ...command To add the device name the device status message use the following command set mis new3 x where x is the bit map 0x800 It is disabled by default The setting of this field is preserved across normal return to factory default commands such as cfg default It may be deleted with the command cfg default userdefaults 10 2Organization Name There is the option to assign the device to an organizati...

Page 56: ...tting for this parameter is not preserved across configuration resets 10 3Adding 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 To enable use the following command set mis new3 x where x is the bit map 0x800 It is disabled by default ...

Page 57: ...EWB100 Usage and Deployment Guide Rev 1 13 Page 57 ...

Page 58: ...rtup If profile switching is not enabled then the default profile will always be used The default profile is set via a configuration parameter The device will switch to the default profile at startup time and whenever it is placed into the charging cradle If profile switching is enabled there are several ways of rotating through profiles The first approach involves pressing a button to enter profi...

Page 59: ...lta from those of profile 0 This allows users to define only the items in the profile that they wish to change from the values in profile 0 For each profile there is an enable flag that is controlled by configuration If a profile is not enabled then the user may not select it nor will it be loaded from profile 0 At least one profile must always be enabled Each profile has an associated audio promp...

Page 60: ...ble click A data value associated with each key sequence These parameters control more than the meaning of key sequences as they enable functions and supply data for those functions For example The data parameter to the PTT down key sequence specifies the default WTT channel Profile switching is enabled by assigning the PR function to a particular key sequence typically SAPP single click Enabling ...

Page 61: ...parameters specified When another profile is enabled the device loads the parameters for such profiles as follows Copy the current values from profile 0 into it Apply any profile specific configuration values to it What this means is that for profiles other than 0 users need only define the desired differences from profile 0 It is not necessary to supply every parameter for every profile At the sa...

Page 62: ...rompt n y Where n is the profile number 0 7 and y is the name of the alert The default is the profile number 11 3 1 4 UC Enable This parameter enables private reply on the device The format is set profile uc n y Where n is the profile number 0 7 and y is either enable or disable The default is enabled 11 3 1 5 WTT Enable This parameter enables WTT voice on the device The format is set profile wt n...

Page 63: ...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 set profile rxwttmask n y Where n is the profile number 0 7 and y is a 32 bit hex number Y is set according to the table Channel Ma...

Page 64: ... This command enables the mute function for this profile The mute function stops audio from the speaker and is invoked by holding down the volume down button It is used when an audio message is being received and the user does not want to listen to it It applies only for the duration of the message The next audio message will be played normally The command format is set profile mute n y Where n is...

Page 65: ...lick sappdc side application double click fappsc front application single click fappdc front application double click ptt push to talk button app is the application to be invoked and is one of the following none no action is assigned pr enter switch profile app wtt enter wtt channel contained in data below Only the ptt key may be assigned to this action wacs switch to an alternative channel contai...

Page 66: ...g wtt session wtinitnogo alert played if the outgoing wtt session fails wtinitend alert played wtinstart alert played at the start of an inbound wtt session wtinend alert played at the end of an inbound wtt session scinitgo alert played as a debugging indication when a GET request is made to the http server scinitnogo alert played when a Private Reply request is terminated by the remote end scrcv ...

Page 67: ...ication state lowbat alert played when battery level is low lostnet alert played when lost WLAN assocation gotnet alert played when WLAN association established wac or wacssc alert played when going to an alt channel via single click of the SAPP wacsdc alert played when going to an alt channel via double click of the SAPP wacsrp sapp repeat alert played when going to an alt channel via hold down o...

Page 68: ...ery charge state 5 nosignal alert played for extended out of range state n is the profile number 0 7 z is an ASCII string that identifies an entry in the phrasebook 11 7Timeouts These commands define the timeout values for various actions and states within the profile They all have the same format set profile timeout x n z Where x is one of the following and n is the profile number 0 7 z is the ti...

Page 69: ...ous versions Configuration may be reset by CLI command cfg default or by holding down both the VOLUME DOWN and SAPP buttons for several seconds while the device is in the cradle If user default mode is enabled the above procedures will result in most configuration parameters being restored to the factory defaults However those with an associated user default will have their values set to the user ...

Page 70: ...4Enabling User Defined Defaults User defined defaults must be enabled by a configuration command The command is set misc user enable disable The default is disabled 12 5Clearing User Default Values Clearing the user defaults which have the same default values as the corresponding parameters is done only via the command cfg default userdefaults It cannot be done via any button sequence 12 6Clearing...

Page 71: ...power down The value is zero The default value is disabled 0 14 3 Eliminate Flashing of Green LED If set the device will not flash the Green LED as a heartbeat The function is controlled by the following configuration bit in the misc new command The bit value is 0x8000 The default is to flash the green LED 14 4 Out of Range Audio Alert Repeat Normally the device will issue only one indication that...

Page 72: ...d if the SAPP button is configured for Profile Switching mode then pressing the SAPP button will rotate through the enabled profiles without any prompt other than the profile alert Each profile is assumed to be configured for a different WTT channel and so this provides an easy way to scroll through up to 8 WTT channels 1 per profile No confirmation is required the the device will simply stay inde...

Page 73: ...r it plays an audio message that indicates whether it is associated and authenticated ready not ready and a battery level 75 50 etc An alternative message may be generated that contains the name of the current profile and the battery level The alternative message is selected via the command set misc new3 x where x contains bit value 0x0400 14 12Roam alert timeout Rev J This command defines the dur...

Page 74: ...a the command set mis new2 x where x is the bit value 0x40 14 14Minimum Audio Volume rev J The minimum output volume can be set via the following commands Such a feature is when it is necessary to ensure a user hears a message regardless of the volume set by the user Essentially the user is not permitted to reduce the volume below some set level The command to define this is set audio minvol x whe...

Page 75: ... is intended for lightweight usage such as setting variables or examining configuration or statistics It should be not be used for capturing trace logs as doing so may crash the device 15 1Disable Telnet Server If set the internal telnet server will not be enabled If the telnet server is disabled and is enabled via the command it will not startup until the device is restarted The function is contr...

Page 76: ...n firmware version They are distinguished by pathname and file name A single package file can service any number of devices if so desired Alternatively there can be a package per device The choice is up to the system administrator The current DA implements a package per device model but nothing in the model requires this The EWB uses FTP to access the package files On a regular basis the EWB will ...

Page 77: ...nformation about each of the component files There are 3 fields in each line The first is the type of file There are five keywords Profile profile related cli commands Network network radio related cli commands Postcfg other cli commands Runtime new runtime code binary Tts text to speech files binary The second is the file type version It is separated from the file type by a colon For each file ty...

Page 78: ...w to decode the header static I EWB 100 static Z 111 dynamic V Version dynamic B Memory location to store file dynamic C CRC dynamic N Flash component frame size dynamic S CLI script length dynamic D Date dynamic T Time Runtime files are stored at the memory location 0x6020000 Network Postcfg files are stored at the memory location 0x6320000 TTS files are stored at the memory location tbd 16 2 4 T...

Page 79: ...he user enters a certain CLI command If enabled the airbeam process will run when any of these triggers occur no matter how many times the trigger occurs Upon each occurrence of a trigger airbeam will attempt to locate the package file and act on the contents as needed The CLI command is system airbeam update 16 3 2 Getting the IP Address of the FTP Server The first step in fetching the package fi...

Page 80: ... name is ftp server and the domain name is store123 retailer com then the combined name would be ftp server store123 retailer com As noted above the domain name is usually included as an option in the DHCP response The option of whether to append or not is controlled by the append parameter in the network configuration The command is set network append enable disable Append is disabled by default ...

Page 81: ...tained in DHCP Option 161 If present the name contained in the option will be written to flash and used for subsequent accesses and the device reset This update to flash and reset will take place only if the contents of the server name in flash is equal to 0 This method is disabled by default but can be enabled via the command set misc new2mode x Where x has the 0x1000 bit set In summary the best ...

Page 82: ...n that case the password could be any string as the FTP server would not care It should be noted that the user may specify the password in an encrypted form There is a separate command when specifying the password this way 16 3 6 Package Filename This parameter specifies the path and filename of the package file The format of the command is set airb filename xx where xx is the path and name of the...

Page 83: ... enables or disables the airbeam update process The command is set airbeam mode enable disable The default is enabled Changes take effect only after a reset 16 5 2 User Default Mode This command is the user defined default version of the mode comand The command is set airbeam def_mode enable disable The default is disabled 16 5 3 Airbeam FTP Server IP address This parameter specifies the IP addres...

Page 84: ...ified and append is enabled the results may not be what was expected set airbeam server xx Where xx is the DNS name of the server The default is null 16 5 8 User Default Airbeam server name This command is the user defined default version of the Airbeam server name comand The command is set airbeam def_server xx 16 5 9 Airbeam user name This command specifies the user name for logging into the Air...

Page 85: ... password must have been encrypted using the clientencrypttool program The command is set airbeam edef_password xx where xx is the encrypted default user password 16 5 15 Airbeam filename This command specifies the name of the package file that will be fetched by the client The command is set airbeam filename xx where xx is the name of the package file 16 5 16 User Default Airbeam filename This co...

Page 86: ...ever The command is set airbeam tts_ver xx 16 5 21 Airbeam Inactivity Timeout This command specifies the maximum time that a Airbeam may wait for a response from the server for any nondata transfer request may take If it is not completed in this time the process will be aborted The command is set airbeam activity_timeout xx The default is 60 seconds 16 5 22 Airbeam Download Timeout This command sp...

Page 87: ... The default is disabled 16 5 23 2 Load Airbeam Server Name from DHCP Option 161 If set the device will obtain the Airbeam server name from DHCP option 161 if present In addition the server name in the airbeam configuration parameter must also be null It is disabled by default The function is controlled by the following configuration bit in the misc new3 command The bit value is 0x1000 The default...

Page 88: ...ng PEAP certificates and the latter is available for future TBD uses Configuration variables for these two types have also been defined They are listed in the show airbeam command and may be set via the CLI commands a set airbeam cert_vers xxx b set airbeam other_vers xxx where xxx is a version string The expected sequence of items in the package file is runtime tts cert other cli file ...

Page 89: ...tion describes configuration commands for MSP There are two MSP configuration commands and they only allow MSP to be disabled MSP can only be enabled via the MSP staging process 17 1 1 MSP Mode This command disables the MSP client The format is Set msp mode disable The default is enabled 17 1 2 MSP Default Mode This command disables user default mode of the MSP client The format is Set msp def_mod...

Page 90: ... the packet x indicates the ping is to be stopped This is used instead of a Ctl C a b c d is the IP address of the destination It is not required for the x option There is an output displayed for each ping generated as well as summary when the ping is ends Response In 24 ms Response In 49 ms Packets Sent 183 Received 183 Lost 0 If there is not response the output will be timed out It should be not...

Page 91: ...ts the device immediately 18 4Notes This command sets the notes entries in the configuration data base The command is set notes x y Where x is the note number and ranges from 0 to 15 y is a text string that is associated with note It can be up to 64 characters If it omitted then the current note associated with the number is deleted 18 5Reset Device This command causes the EWB100 to do a reset and...

Page 92: ...he value on always on off totally off blink one short blink twice two short blinks slow slow blink pattern fast flast blink pattern Each led can be given its own pattern Fast and slow patterns keep running until set to a different pattern 18 7 2 For invoking audio alerts The command format is notify w p1 p2 p3 pn Where p1 p2 are ascii strings that identify the alerts in the phrasebook that are to ...

Page 93: ... is used to identify it during configuration It is derived from the WAV file used to build the clip Names must be unique within a clip table but not between clip tables The audio format indicates which compression is used for the clip Voice clips generally use G729 Tones use G711u or G711a usually 711u 711a is not used for any clips right now G729 clips consume 1KB sec G711 consumes 8KB sec Audio ...

Page 94: ... RAM These would be used to store very dynamic clips that would be altered frequently The player routines handle such tables but at present there is no way to load them into RAM There can thus be up to 12 clip tables in a system numbered 0 to 11 Tables 0 3 are the default tables 4 7 are the flash downloadable tables and 9 11 would be the RAM tables Whenever the device wants to play an audio sequen...

Page 95: ...nge them requires overlaying the clips defined in the Default Dictionary These are targeted mostly at support personal ie IP address but some can be heard by regular users as well such as the volume up down tone Changing the audio clip defined in the default dictionary can only be done by placing the name of the audio clip in either a flash or ram clip table along with the new audio clip When the ...

Page 96: ... currently much of the default dictionary is not used 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 These names would...

Page 97: ...device Changing this could be a major task 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 Audio prompts a...

Page 98: ...75pc set pr alert l3 0 xx_50pc set pr alert l4 0 xx_25pc set pr alert l5 0 xx_low set pr alert l6 0 xx_critical where xx may be fr French du Dutch gr German po Portuguese sp Spanish blank without both the xx and the _ English Thus to alter the language prompts simply add the above lines to the configuration file and replace the xx in each line with that of the desired language It should be noted t...

Page 99: ... 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 It may be loaded as part of the Airbeam Package file mechanism that is described in the EWB100 User Guide 19 6Building New Audio Clip Files This process ...

Page 100: ...h functionality is really just a special callback which is attached to an HTTP server socket It performs all the callback functions associated with incoming HTTP requests it is expected that server dispatch development will generate functionalities for various functions that we expect to support The following functionality can be invoked via the HTTP server 1 Playing Audio 2 LED Control 3 System R...

Page 101: ... device and executed and the command output is sent back to the requestor in the response There is a single cmd parameter which specifies the command to be executed If the command contains spaces then they are replaced with plus signs as is standard for URL encoding For example the URL http 192 168 0 104 clicmd cmd ver Causes the following plain text response ver Motorola CA10 Version 1 1 920 Real...

Page 102: ...HTTP functions will still operate The function is controlled by the following configuration bit in the misc new3 command The bit value is 0x8000 The server is enabled by default 20 3 2 Port This comment specifies the TCP port number used by the http server The command is set http port xx where xx is the TCP port used by the http server The default value is 80 decimal ...

Page 103: ...inking on a regular basis every 10 seconds or so it means the device is associated and authenticated with the 802 11 network and that it has an IP address In general all is well If the Red LED is blinking then there is a problem of some kind The number of Red LED flashes indicates the problem One Flash Low battery Two Flashes Not associated or low signal strength Three Flashs Cannot obtain IP Addr...

Page 104: ...tware version After three beeps a few counters statistics are played This includes The number of roams The time since the last roam The lower 16 bits of the previous BSS in hex The percentage of transmit retries The percentage of missed beacons Battery temperature The exact information played out may be changed from release to release 21 3 3 Configuration Command This command controls what informa...

Page 105: ...ration commands The reason for this is historical as the initial use of the Device Status function was to drive the Deployment Application Since then it has been enhanced to carry all types of status information and that is now its primary use However the deployment term remains In this document the phrase device status will be used except for the actual CLI commands The Device Status or Deploymen...

Page 106: ...h a particular IP address The commands here are simple The IP address is set with the command set airb ip_deployment a b c d where a b c d is the ip address of the system The default is 192 168 0 201 the same as for airbeam The UDP port is set via the command set airb port_deployment xx where xx is the UDP port as a decimal number The default is 48888 which was used on the DA 21 4 4 Specifying how...

Page 107: ...ds Sequence number that increases with each event Action assoc indicates association link dn indicates loss of assoc Time of event from system start AP MAC Address or reason for loss of association One may often have two events that are the same association event separated briefly in time 21 6The Statistics Command This command displays various counters and dynamic tables associated with the vario...

Page 108: ...s with and without a parameter any value will do More counters are shown with the parameter First Form st wd time 105 704 icm in 107 controlIn 36 trapsIn 6 beaconsIn 6 framesIn 71 ucIn 4 mcbcIn 67 packets in 1 icm out 71 ic out busy 0 packets out 14 isr int 108 nt int 108 timer int 60 gp2 0 107 sleep 50 Second Form st wd 1 time 114 355 icm in 111 controlIn 36 trapsIn 6 beaconsIn 6 framesIn 75 ucIn...

Page 109: ...d without a qualifier The options are shown below 21 6 2 1 No Parameter These counters record the total unicast multicast and retry packets st umac time 121 603 tx okay 30 tx mc 0 tx 1 rt 0 tx 1 rt 0 21 6 2 2 Receive packet counters These counters record the numbers of different types of nonvoice packets received Voice packets are counted elsewhere st umac rx time 125 315 rx 79 rx uc 1 rx mc 0 rx ...

Page 110: ...time 128 120 tx rate 22 miss bcn 0 tx failure 0 tx null 14 tx null fl 0 tx poll 0 tx assoc 1 tx auth 1 tx mc 0 tx uc 30 tx retry 0 21 6 4 Roaming statistics These values record a number of items related to roaming including the total number of roams the missed beacon rssi values etc st umac roam time 131 968 roams 0 missed bcn 0 scan rsn 0 old rating 0 new rating 0 21 6 5 Scanning counters These c...

Page 111: ...nly nonvoice packets are included st umac rrx time 155 728 1 00 2 00 5 5 00 11 00 6 00 9 00 12 00 18 00 24 00 30 00 48 00 54 00 21 6 7 Transmit Rate Histogram These counters show how many packets have been transmited at each rate All packet types are included st umac rtx time 155 728 1 00 2 00 5 5 00 11 00 6 00 9 00 12 00 18 00 24 00 30 00 48 00 54 00 ...

Page 112: ...of the command with and without a parameter The first form gives information about the currently associated AP the second gives information about all known APs First Form st ap time 147 882 SysTime 147891 Macadr 00A0F8A1D589 Chan 11 Aid 1 CapInfo 00000000 Rssi 36 Assoc Time 11794 Second Form st ap a time 150 007 00A0F8A1D589 c11 q36 c0021 r000F 0003 a0 All known aps listed First c is channel q is ...

Page 113: ...he table wraps around on itself st rx time 152 707 00014657 0 37 110 00022457 0 36 110 00030258 0 36 110 00038057 0 39 110 00041957 0 37 110 00043907 0 37 110 00047807 0 39 110 21 6 11 Voice Packet Transmit Statistics This command lists the number of retries for the last 32 transmitted voice packets It is a circular list wraps on itself It also indicates the total transmits and average packet retr...

Page 114: ...ts that have been transmitted and received st tcp time 179 689 ConAtt 1 ConAcc 0 ConEst 0 ConDrop 0 ConDrTo 1 ConDrKe 0 ConRtTo 12 ConPeTo 0 SndPkTot 13 SndPkDat 0 SndPkRt 0 SndPkAck 0 RcvPkTot 0 RcvPkDat 0 RcvPkDup 0 RcvPkOor 0 RcvPkDuA 0 RcvPkAck 0 21 6 13 UDP Counters This command provides information about the number of UDP packets that have been transmitted and received st udp time 182 507 In...

Page 115: ...his command displays information on both the number and types of ARP packets that have been transmitted and received as well as the current arp table that provides IP address to MAC address mapping st arp time 189 117 arpRqIn 0 arpRqOut 15 arpRspIn 0 arpRspOut 0 arpRqTossed 0 arpRqPased 0 ARP statistics ARP requests in 0 out 15 ARP replys in 0 out 0 MAC Address i f pend IP create_time last_time IP...

Page 116: ...e are are also counters for Michael and Mic errors st sup time 193 115 Wpa State WSUP_STATE_WPA_IDLE 802 1x Rcvd 0 Msg 1 Rcvd 0 Msg 3 Rcvd 0 GK Rcvd 0 Msg Timeouts 0 Fmt Errs 0 Mich Errs 0 Mic Errs 0 21 6 17 DHCP Counters This command provides information about the number of DHCP packets that have been transmitted and received st dhcp time 198 119 errors 0 discovers 0 offers 0 req 0 acks 0 bpreply...

Page 117: ...16 OutErr 0 21 6 19 Deployment Counters This counters display how many UDP status packets have been sent as well as how many airbeam packets were transmitted received The current state of the Airbeam subsystem is also displayed st deploy time 205 472 OutUDP 4 InAirb 0 InFTP 300 OutFTP 0 Airbeam state 12 21 6 20 WTT Counters This command displays counters associated with the Walkie Talkie subsystem...

Page 118: ... Page 118 21 6 20 1 Simple form no parameter This form st wtt time 208 639 pkts tx 0 pkts rx 0 lost 0 0 lost 1 0 lost n 0 21 6 20 2 Form 1 st wtt 1 time 211 286 pkts tx 0 pkts rx 0 lost 0 0 lost 1 0 lost n 0 TOSS REASONS No voice packets tossed ...

Page 119: ... 0 5 0 6 0 7 0 8 0 9 0 21 6 20 4 Form 3 st wtt 3 time 217 048 pkts tx 0 pkts rx 0 lost 0 0 lost 1 0 lost n 0 21 6 21 Unicast Counters This command displays the counters that record unicast Private Reply sessions and transmit received packets The number of receive packet gaps is also recorded st uc time 221 838 uc sessions 0 pkt tx 0 pkt rx 0 rx gaps 0 rx timeout 0 ...

Page 120: ...e 225 777 DNS client statistics No DNS servers in list DNS cache entries runtime errors 0 requests sent 0 replys received 0 useable replys 0 dnsc_retry 0 timeouts 0 21 6 23 Configuration Counters This command displays information about the state of configuration data base st cfg Flash Statistics rn valid sector 0 valid items 15 invalid items 377 valid bytes 128 invalid bytes 3450 unused bytes 4610...

Page 121: ...ther subsystem Changes to trace options take effect immediately 22 1 1 NonUmac Tracing For all tracing except umac the format is set trace x y Where x is the subsystem name and y is the level of detail Values for x are sys ip telnet fsk scan nt uc play vr arib wnmp mgt dsp ui key wt av bat usb ucos enc sip flashtest kwik led wsup diag1 diag2 hra cb Values for y are none major minor detail off The ...

Page 122: ... generate actual tracing output It is assumed that the user of this command is familiar with the internal structure of the umac software all ic sm alarm bra debug framework global instance lmacbuf lmacnv lmactmr memory object pda pimfor pool rand shmem table timer trap chmask aes aloft antenna bss cce ccx ckip compress concat db dcf dot11d dot11h dpsm fastpath frg fxs hibernate hmac icache led lin...

Page 123: ...m E erase the flash that contains all user defined configuration including user defined defaults M burn the contents of the temporary flash download area into the final flash location The contents of the temporary flash area contain the final flash area address where it is to be placed Once inside the minikernel CLI there are five available Load boot Version 23 1Load Boot This command controls var...

Page 124: ... 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 8 2010 16 43 42 EngVer 4 HwVer 2 nchip noProt chip Locosto Lite Hawkeye 0x412b TI_DM 0x5b66 ES unknown ...

Page 125: ..._DATE Device mfg date 08 20 2009 COUNTRY_CODE Radio operation WW PNAM Profile name 1 WTTTX Wtt channel 0 actual channel 1 WTTTO Alternative wtt channel 0 ditto WTTRXMSK Wtt channels being monitored bit map 1 TIME Time since boot in us 3488500 CTIME Time charging began 3488487 CPLUGIN Plugged into charger 0x010 BVOLT Battery voltage 4 050 CCURRENT Charge current 0 COLOUMBS Charge amt in coloumbs 0 ...

Page 126: ... 0 LTO Listen timeout value 0 RXTXCNT Wtt rx tx transitions 0 RXTXWN Wtt sessions won 0 RXTXLST Wtt sessions lost 0 PKTTX Wtt tx packets 0 PKTRX Wtt rx packets 0 LOST0 Wtt rx zero packet gaps 0 LOST1 Wtt rx 1 packet gaps 0 LOSTN Wtt rx 1 packet gaps 0 UROAMS 802 11 roams 1 USCANS Active scans 0 UASSOC Association 1 DEAUT Deauthentication pkts rcvd 0 MISBEA Missed beacons 12015 DSSlpBlkng Low power...

Page 127: ... SERIAL_NUMBER Device serial number 9232521100042 MFG_DATE Device mfg date 08 20 2009 COUNTRY_CODE Radio operation WW BATTERY Remaining battery 100 APMAC Current AP mac adr 01570dee71 CHAN Current AP channel 11 SIGNAL RSSI 40 RTC Current time 141073 AID AID number 4 CAPINFO AP capabilities 0 ASSOCTIME Time of last association ms 11733 ASSOCTED Associated 1 ASSOC Associations 2 LASTAP Previous AP m...

Page 128: ... LTO Listen timeout value 0 RXTXCNT Wtt rx tx transitions 0 RXTXWN Wtt sessions won 0 RXTXLST Wtt sessions lost 0 PKTTX Wtt tx packets 0 PKTRX Wtt rx packets 0 LOST0 Wtt rx zero packet gaps 0 LOST1 Wtt rx 1 packet gaps 0 LOSTN Wtt rx 1 packet gaps 0 UROAMS 802 11 roams 1 USCANS Active scans 0 UASSOC Association 1 DEAUT Deauthentication pkts rcvd 0 MISBEA Missed beacons 12015 Included only if enabl...

Page 129: ...ulate the encrypted form and print it out as a series of hex digits separated by a colon The string minus the colons should be entered into the CLI Note that the encrypted form will be much longer than the input string and will always contain only hex digits and be a multiple of 32 characters Also note if that if the following special characters are used in a password Then they must be escaped wit...

Page 130: ...Mini Kernel and can generally be ignored unless the user is trying to access the Min Kernel The third endpoint is the EWB100 runtime code Both the Mini 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 EWB...

Page 131: ...sage and Deployment Guide Rev 1 13 Page 131 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 132: ...EWB100 Usage and Deployment Guide Rev 1 13 Page 132 Select Install from a specific location and select next Then select Include location in the search ...

Page 133: ...ment Guide Rev 1 13 Page 133 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 134: ...EWB100 Usage and Deployment Guide Rev 1 13 Page 134 Wait while the driver installs Wait ...

Page 135: ...d and we can startup Hyperterm 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: ...l 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 One must also configure the Port settings The settings should be set as seen below ...

Page 137: ...age 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: ...ing the USB interface with Windows XP in order to understand how the various USB endpoints on the EWB100 operate The EWB100 endpoints operate identically with all versions of windows It should be noted that Hyperterm is no longer included with either Windows Vista or Windows 7 One may purchase a copy from http www hilgraeve com Alternatively there are a number of free terminal emulators available ...

Page 139: ...rivers The following window will appear Select the 2nd option Browse my computer for driver software 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 140: ...EWB100 Usage and Deployment Guide Rev 1 13 Page 140 Win7 will now install the software And the completed pop up ...

Page 141: ...ion procedure described in Appendix C may be used If another emulator is used the configuration process may differ In any case always select the following parameters 115K baud No parity 8 bit data 1 stop bit When using some terminal emulator programs such as Hyperterm ported from Windows XP it is necessary to run the program in WinXP SP3 compatibility mode and as administrator Win7 pro 64bit If th...

Page 142: ...th 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 Page 143 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 144: ...e a file which contains the names of all the files that are to be placed into the audio clip The names will placed one per line Blank lines are permitted The first line of the file must be the string 729 This file must be in the same directory as the audio files All the files in this file must be in the directory If any file in the list of files is not in the directory the process will generate un...

Page 145: ... exactly match the same values provided The user may use the default values if desired Other parameters and the location of each parameter must be identical to the example The output of audiomsgcreate will always be g729AudioTable bin and the output of crccalc will always be header dat When preparing multiple audio clip files one should be aware of these names The file audioclipimage bin should be...

Page 146: ...EWB100 Usage and Deployment Guide Rev 1 13 Page 146 ...

Reviews: