Consulting * Research * Training * Certification Testing Since 1981 FCC ID: PQS-BM28001 Exhibit 9 User’s Manual August 2002 APREL Project No.
Boomer II OEM Modem User Manual and Integrator’s Guide August 2002
© Wavenet Technology Pty Ltd ACN 079 965 003 Publication No. BM210012WT11 (11 September 2002) Published August 2002 This publication is copyright and no part may be reproduced or copied without the prior consent of: Wavenet Technology Pty Ltd. 140 Burswood Rd Burswood, 6100 Western Australia Telephone: Facsimile: E-mail: Web Site: +61 8 9262 0200 +61 8 9355 5622 wavenet@wavenet.com.au www.wavenet.com.au This manual is intended to be used for the operation of Wavenet Technology equipment.
Boomer II User Manual & Integrator’s Guide __________________________________________________Contents Contents Introduction...................................................................................................................7 Applications ..............................................................................................................8 Compliance Statement ...........................................................................................9 Information for Your Safety.....
Contents _________________________________________________ Boomer II User Manual & Integrator’s Guide SCR Functions .................................................................................................. 64 Application Development......................................................................................... 77 Roaming Issues .................................................................................................... 78 Roaming Requirements......................................
Boomer II User Manual & Integrator’s Guide __________________________________________________Contents Command SDUs (CMND, ASCII A).....................................................110 q Event Report SDUs (EVENT, ASCII B) ..............................................113 q Response Status SDUs (RESP, ASCII C) .........................................114 Wavenet specific NCL Extensions ...................................................................116 q GET STATUS COMMANDS:............................
Contents _________________________________________________ Boomer II User Manual & Integrator’s Guide Wavenet Technology 6 BM210012WT09
Boomer II User Manual & Integrator’s Guide ________________________________________________Introduction Introduction The Boomer II OEM Modem is a radio packet modem, intended for use on the Motorola DataTAC 4000 SFR and DataTAC 5000 MFR data communication networks. It is primarily designed to be integrated into customer equipment as an OEM modem. There are two versions available, an 800MHz version (A band) and a 900MHz version (B band).
Introduction _______________________________________________ Boomer II User Manual & Integrator’s Guide Features The Boomer II OEM modem is approximately the size of a credit card and just 9mm thick. The modem is easily connected to many other devices and can be incorporated into a variety of package formats. The modem has a TTL serial port.
Boomer II User Manual & Integrator’s Guide ________________________________________________Introduction despatched to the required sites maximising truck carrying capacity and consequently efficiency. Fire Alarm Detection Conventional telephone wire connections are slow to dial out and can burn before the emergency call can be placed. Laws in many states and countries require businesses to have an on-line dial out fire alarm system. The Boomer II OEM Modem offers a real solution to this problem.
Introduction _______________________________________________ Boomer II User Manual & Integrator’s Guide Information for Your Safety Please read these safety instructions and the operation instructions provided in this manual before operating the Boomer II OEM Modem. Safe Use Switch the modem off in areas where radio devices are forbidden, or when it may cause interference or danger.
Boomer II User Manual & Integrator’s Guide ________________________________________________Introduction Host Requirements The minimum system requirements of the host interface PC in order to utilise the Software Development Kit (SDK) are: BM210012WT09 q Intel compatible Pentium computer or higher q Windows 95 or later q 16MB RAM (memory) minimum, 32MB recommended q 1MB available hard disk space q 9-pin serial Port using a 16550 UART q 3.
Introduction _______________________________________________ Boomer II User Manual & Integrator’s Guide Wavenet Technology 12 BM210012WT09
Boomer II User Manual & Integrator’s Guide _________________________________________________Installation Installation This section will help you to successfully integrate the Boomer II OEM Modem into your custom application. Before using your modem you must: q Mount the Boomer II OEM Modem to your device q Connect the Data Interface Port q Connect and position the antenna q Supply power A picture of the Boomer II OEM Modem is shown below.
Installation ________________________________________________ Boomer II User Manual & Integrator’s Guide Mounting the Boomer II OEM Modem to Your Device The Boomer II OEM Modem has an M2 Mounting Bolt hole in each corner, which should be used to bolt the modem onto an appropriate surface. The mounting hole pattern is four holes in a 60mm X 46mm X 42mm trapezoid, with each hole to suit an M2 (2.0mm) bolt. Refer to the following diagram. 52 9 70 Hole diameter: 4 x 2.
Boomer II User Manual & Integrator’s Guide _________________________________________________Installation Connecting the Data Interface Port There are two connectors to interface the Boomer II OEM Modem with your device. q RF Connector (described in the next section), and q Data Interface Port The data interface port is used to interface the modem to a serial computing device and a power supply. The power supply requirements are described in the next section.
Installation ________________________________________________ Boomer II User Manual & Integrator’s Guide 19 SS3 Status Signal 3 20 HOST 3.8V Supply Voltage (3.4 – 4.2V) 21 HOST3.8V Supply Voltage (3.4 – 4.2V) 22 HOST 3.8V Supply Voltage (3.4 – 4.2V) 23 HOST3.8V Supply Voltage (3.4 – 4.
Boomer II User Manual & Integrator’s Guide _________________________________________________Installation Status Input / Output lines Note: Not currently supported but may be added in future releases. The status lines (SS0 to SS3) may be software configured for bidirectional operation. Each line has a 33Ù series resistor and clamp diode to the internal supply line for protection. The electrical interface capability and function of these signals are as follows: Input Voltage Range 0 – 3.
Installation ________________________________________________ Boomer II User Manual & Integrator’s Guide LED Receive LED Wavenet Technology Green flashes when data is received 18 BM210012WT09
Boomer II User Manual & Integrator’s Guide _________________________________________________Installation LED Output Lines In addition to the on-board LEDs there are three signal lines (Low Battery, Message Waiting, In-range), which are controllable by the modem for connection to an external LED. Each line has a 33Ù series resistor and clamp diode to the internal supply line for protection. It is recommended a series resistor be used with the external LED to limit current accordingly.
Installation ________________________________________________ Boomer II User Manual & Integrator’s Guide Connecting & Positioning the Antenna The Boomer II OEM Modem provides an MMCX RF connector interface located at the top of the unit, to attach to the antenna cable. The antenna does not plug directly into the modem but uses an antenna cable to interface between your device and the modem.
Boomer II User Manual & Integrator’s Guide _________________________________________________Installation reduce the radio frequency reflections if the device is placed on a metal surface. If your device is hand held or is worn next to the body, the antenna should be positioned to radiate away from the body. Supplying Power The Boomer II OEM Modem must be provided with a clean power source capable of delivering bursts of high current. The modem draws its power in bursts.
Installation ________________________________________________ Boomer II User Manual & Integrator’s Guide Automotive Supplies Extra protection is required from an automotive supply to protect the Boomer II OEM Modem from power fluctuations when used in an automobile. The electrical transient conditions (e.g. battery jump start), may damage the modem if not adequately clamped and filtered.
Boomer II User Manual & Integrator’s Guide ___________________________________________________Test Jig Test Jig The Boomer II Test Jig provides RS-232 serial interface ports between a PC and the modem. It is designed to enable you to quickly interface the Boomer II to a standard PC (through a COM port) or a terminal device with an RS-232 serial port.
Test Jig __________________________________________________ Boomer II User Manual & Integrator’s Guide Exploring the Boomer II Test Jig The test jig comprises the following components: DC Jack Input Supply On/Off Switch 3 RDW Header connector VCC test pin 3.
Boomer II User Manual & Integrator’s Guide ___________________________________________________Test Jig Port 2 / SPY PC Connector DB9 connector used for two purposes depending upon the settings of the jumper switches located just behind the connector on the PCB. If the jumpers are used to connect the centre column to the right hand outer column (TX, RTS etc), then the port acts as a spy connection for the data between the PC and the modem via the PC connector. An analyser program such as “spy.
Test Jig __________________________________________________ Boomer II User Manual & Integrator’s Guide Audio Out Connector for monitoring an audio output. Used to monitor baseband signal, BIT Error Rate (requires a PER test jig), receiver and demodulation. Warning : Must use a high impedance monitor, 100kÙ. Audio In Connector for monitoring an audio input. Used to monitor modulation and transmission. Warning : Must use a high impedance monitor, 100kÙ.
Boomer II User Manual & Integrator’s Guide ___________________________________________________Test Jig Initial Calibration Without connecting a Boomer II OEM Modem to the Test Jig, initially check the calibration of the on-board voltage regulator. (This regulator supplies the RS232 converter and other on-board circuitry only. It does not supply power to the modem). 1. Connect the centre pin of the DC jack to the +3.8V power supply with 2A capability and the external pin to the ground. 2.
Test Jig __________________________________________________ Boomer II User Manual & Integrator’s Guide Set Up With the power off, 1. Connect the Boomer II OEM modem to the lower FPC connector on the test jig using a 30-way FPC cable. Use the following procedure to insert the cable into the FPC connector. a. Lift up the lock lever of the FPC connector by flipping it up with the nail of your thumb or index finger. Lock Lever b.
Boomer II User Manual & Integrator’s Guide ___________________________________________________Test Jig Use the following procedure to remove the cable from the FPC connector. a. Lift up the lock lever of the FPC connector by flipping it up with the nail of your thumb or index finger. Lock Lever b. Remove the cable after the lock is released. 2. Install an antenna to the modem.
Test Jig __________________________________________________ Boomer II User Manual & Integrator’s Guide RSUSER The Radio Service Utility software (RSUSER ) enables a user to exercise and configure Wavenet Modems. This software runs in a DOS window under Windows 95, 98, NT, or 2000. RSUSER interfaces with the Boomer II OEM Modem via a PC’s communications port and the Test Jig’s PC port using an RS-232 cable with DB9 connectors. RSUSER is issued with the following files: q RSUSER.
Boomer II User Manual & Integrator’s Guide ___________________________________________________Test Jig Using RSUSER 1. Supply power to the modem (e.g. via the test jig), switch it on and plug the modem into the communications port of the computer. (Refer to the modem’s user or test jig documentation for cabling and connection instructions). 2. Execute RSUSER.EXE 3. Check that the communication port settings displayed are correct under the Miscellaneous Heading. 4.
Test Jig __________________________________________________ Boomer II User Manual & Integrator’s Guide You should see two “CMND…..ILLEGAL BYTE” lines, followed by two “SUCCESS” lines. This is normal. You must reset the modem ( 66 ) before the changes will take effect. If you do not receive the “SUCCESS” responses, reset the modem, reset RSUSER, and try again. + <6> Group LLI Programming This allows you to program up to 16 group LLIs into the non-volatile memory of the modem.
Boomer II User Manual & Integrator’s Guide ___________________________________________________Test Jig Set Destination LLI Similar to the above option, but sets the destination LLI for messages sent by the "SEND MESSAGES" options. Automatically Set SRC/Dest LLIs And Home Area Automatically queries the modem for its LLI and home area, and sets the above two options with that LLI for loopback tests, and the next option with that home area address.
Test Jig __________________________________________________ Boomer II User Manual & Integrator’s Guide + Change Baud Rate This option changes the baud rate the RSUSER program uses. You will be asked for the baud rate you wish to change to. Valid baud rates are 300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600 or 115200. The change will take effect immediately. The baud rate is not preserved on exit from RSUSER. It defaults back to 9600 on next invocation.
Boomer II User Manual & Integrator’s Guide ___________________________________________________Test Jig <<> A sequential sequence of ASCII characters will form the data portion of the message. You will be prompted for the length of the data portion of the message. A number from 1 to 2010 is allowed. Message Loopback Options The F9 and F10 commands, together with the above “send message” commands can be used to set up some automatic message sending and loopback tests.
Test Jig __________________________________________________ Boomer II User Manual & Integrator’s Guide Wavenet Technology 36 BM210012WT09
Boomer II User Manual & Integrator’s Guide ____________________________________________ SDK – SCR API Software Development Kit DataTAC networks allow wireless communication and are installed in many different countries around the world. The Wavenet Software Development Kit (SDK), has been developed to facilitate development of applications for these networks by providing a simple program interface for communicating with the network devices.
SDK - SCR API ____________________________________________ Boomer II User Manual & Integrator’s Guide Native Control Language Application Programmer’s Interface The Native Control Language Application Programmer's Interface (NCL API) is the client component of the WAPI. The NCL API provides routines for sending and receiving data messages through the DataTAC wireless network, using a radio packet modem (RPM).
Boomer II User Manual & Integrator’s Guide ____________________________________________ SDK – SCR API Logical Architecture The following table lists the required functionality for the API per layer. The code forms a DLL, with only a subset of functions available for third party developers. LAYER NAME CONTENT FUNCTION 7. APPLICATION Application specific data.
SDK - SCR API ____________________________________________ Boomer II User Manual & Integrator’s Guide the applications have successfully opened a VDD session the VDD will pass the RX events to those applications.
Boomer II User Manual & Integrator’s Guide ____________________________________________ SDK – SCR API NCL Interpreter The NCL Interpreter strips NCL API function calls from application messages, queue the calls and execute the calls on a FIFO basis. Received messages will be queued and matched against an appropriate request (if not an event), and passed to the router with the corresponding tags.
SDK - SCR API ____________________________________________ Boomer II User Manual & Integrator’s Guide q Close Session Applications can call this function to close its session with the VDD. An application should call this function before it terminates if a session was earlier established with the VDD. The reason for this is to ensure that all created MSMQ queues for the client are deleted. This will prevent irrelevant/outdated messages from being posted to inactive MSMQ queues.
Boomer II User Manual & Integrator’s Guide ____________________________________________ SDK – SCR API Input: Ø usSduTag Pointer to a word where the SDU tag can be stored Ø szHostId Pointer to a buffer specifying the Host identity. The Host ID is typically 3 bytes in length for DataTac systems. The NCL API will truncate Host ID’s longer than NCL_MAX_UH_LEN (63) bytes in length.
SDK - SCR API ____________________________________________ Boomer II User Manual & Integrator’s Guide The RCV_MSG_NOTIFICATION event will be handled by the VDD, which will read the messages from the RPM and pass the messages to all clients with open sessions. Other Event types shall be posted to all clients with open sessions registered for that event. If no applications are registered for that event the event will be disabled in the modem.
Boomer II User Manual & Integrator’s Guide ____________________________________________ SDK – SCR API /*** Define types for retrieving data from the RPM ***/ typedef unsigned char typedef unsigned short BYTE; WORD; /*Parameter Structure IDs - Do not alter sequence*/ enum { NCLNone_ID = 0, NCLEvent_ID, NCLProdId_ID, NCLVersion_ID, NCLRpmId_ID, NCLConfigBlock_ID, NCLStatusBlock_ID, NCLChanBlock_ID, NCLGroupLlis_ID, NCLChannelTable_ID, NCLWaveSettings_ID, NCLWaveRadio_ID, NCLWaveGen_ID, NCLByte_ID, NCLByte2
SDK - SCR API ____________________________________________ Boomer II User Manual & Integrator’s Guide NCLProdId NCLVersion NCLRpmId WORD WORD }NCLConfigBlock; /* Status block structure */ typedef struct NCLStatusBlock { BYTE BYTE BYTE BYTE BYTE BYTE BYTE WORD WORD WORD }NCLStatusBlock; /* Channel block structure */ typedef struct NCLChanBlock { BYTE WORD BYTE BYTE BYTE }NCLChanBlock; prod_id; sw_version; rpm_id; reserved; max_data_size; rx_status; tx_status; antenna; radio_in_range; flow_control; rcv_mod
Boomer II User Manual & Integrator’s Guide ____________________________________________ SDK – SCR API typedef struct NCLWaveRadio { BYTE BYTE BYTE BYTE BYTE BYTE BYTE BYTE BYTE BYTE BYTE BYTE } NCLWaveRadio; rssi[2]; reserved1; reserved2; reserved3; reserved4; reserved5; reserved6; reserved7; reserved8; frequency[4]; channel[2]; base_id; /* Vendor Spesific: Wavenet Generic*/ typedef struct NCLWaveGen { BYTE byte[100]; } NCLWaveGen; /* NCL status information structure */ typedef union NCLStatus { NCLProdI
SDK - SCR API ____________________________________________ Boomer II User Manual & Integrator’s Guide /* NCL_RCV_ERR_EVENT /* NCL_CONTROL_EVENT 'F' 'G' Unreceivable Message Event Control Event */ */ BYTE EventCode; /* NCL_MSG_NOTIFICATION_LEN N- Number of buffered msgs to be read */ /* NCL_TX_EVENT_KEYED ‘1’ Transmitter keyed */ /* NCL_TX_EVENT_DEKEYED ‘2’ Transmitter dekeyed */ /* NCL_RX_EVENT_INRANGE ‘1’ RF in range */ /* NCL_RX_EVENT_OUTRANGE ‘2’ RF out of range */ /* NCL_RX_EVENT_PSENAB ‘3’ Power S
Boomer II User Manual & Integrator’s Guide ____________________________________________ SDK – SCR API q Get RPM Status Information The application can call this function to obtain status information about the RPM.
SDK - SCR API ____________________________________________ Boomer II User Manual & Integrator’s Guide Prototype: int nclGetStatus (word *usSduTag, byte ucVendor, byte ucType, byte ucRequest); Description: Command the RPM to send the requested status information. Input: Ø usSduTag Pointer to a word where the SDU tag can be stored Ø ucVendor Vendor identifier.
Boomer II User Manual & Integrator’s Guide ____________________________________________ SDK – SCR API q Reset RPM The application can call this function to reset the RPM.
SDK - SCR API ____________________________________________ Boomer II User Manual & Integrator’s Guide q Register Event Callback Function Since the RX events will be posted to private Receive MSMQ queues the VDD is not required to support callback functions. Applications can call the API function ‘nclReceiveData()’, to wait on response and event messages from the RPM on their on account.
Boomer II User Manual & Integrator’s Guide ____________________________________________ SDK – SCR API Output: × Return value = 0 Operation was successful × Return value Operation failed. Value specifies the error type × usSduTag q 0 Pointer to a word containing a reference of the corresponding SDU tag which was generated by the NCL API for this command to the RPM. Get Error Description The application can call this function to obtain a string representation for a specified error code.
SDK - SCR API ____________________________________________ Boomer II User Manual & Integrator’s Guide Error Code Value Description NCL_ERR_MSGS_PENDING 'M' Execution error: Pending inbound messages NCL_ERR_SW_ERROR 'N' Execution error: Software error has been encountered NCL_ERR_OUT_OF_RANGE 'O’ Execution error: Cannot send data when out of range NCL_ERR_PACKET_ERROR 'Z' Execution error: SDU data corruption detected Error Not Listed All other values Unknown error Prototype: char * nclGetE
Boomer II User Manual & Integrator’s Guide ____________________________________________ SDK – SCR API Description: Register an application for wakeup when specified events occur. Input: Ø usAppName Ø usWakeupReason Pointer to a buffer specifying the full path name (Null terminated) of the application to execute on a wakeup.
SDK - SCR API ____________________________________________ Boomer II User Manual & Integrator’s Guide q Switch RPM On/Off The application can call this function to switch the RPM on or off. Prototype: int nclSwitchRPMPower (word usSetting); Description: Switch the RPM power to the desired setting. Input: Ø usSetting If this value is zero, the RPM should power down else it should power up Output: × Return value = 0 Operation was successful × Return value Operation failed.
Boomer II User Manual & Integrator’s Guide ____________________________________________ SDK – SCR API q Get Software Version The application can call this function obtain the software version of the server application or the VDD DLL. Prototype: int VDDgetVersion (WORD* usVersion); Description: Obtain the software version of the specified software entity.
SDK - SCR API ____________________________________________ Boomer II User Manual & Integrator’s Guide Standard Context Routing Application Programmer’s Interface The Standard Context Routing Application Programmer's Interface (SCR API) is the server component of the SDK. The SCR API provides routines for encoding and decoding SCR messages for communication with the DataTAC ® network switch or radio network gateway (RNG). Decoded SCR messages are stored in structures defined to represent SCR messages.
Boomer II User Manual & Integrator’s Guide ____________________________________________ SDK – SCR API Windows compilers come with a standard developer's kit to interface to the Winsock routines. Implementation The SCR API is implemented as a library of routines written in ANSI C and compiled for Windows NT using the Microsoft Visual C++ compiler. All default project settings were used to compile the .lib file. SCR Structures The SCR API makes use of several important structures to store the SCR messages.
SDK - SCR API ____________________________________________ Boomer II User Manual & Integrator’s Guide / * Th e SCR Me s s a g e d a t a s t t y p e d e f s t r u c t SCRMs g { i nt ms g_t ype ; uni on{ SCRhr r r ; SCRa r SCRl r SCRhc SCRa c SCRl c SCRmi SCRc i SCRdi SCRr s SCRr r SCRi b SCRob SCRa b SCRr e qs t a t SCR_REQ_STAT*/ SCRs t a t r s p SCR_STAT_RSP*/ SCRt one t SCR_TO_NET*/ SCRf r omne t SCR_FROM_NET*/ SCRa c k } u; } SCRMs g; r uc t ur e .
Boomer II User Manual & Integrator’s Guide ____________________________________________ SDK – SCR API DataTAC 4000 networks, or a Host Request (HR) message for DataTAC 5000 or 6000 networks. SCR_ACK Generic Acknowledgment message. This is used to receive an acknowledgment for data sent to a wireless device. SCR_TO_NET messages may be passed to scr_Encode(), and they will be encoded as the appropriate message type for the current network, as set in the call to scr_Init().
SDK - SCR API ____________________________________________ Boomer II User Manual & Integrator’s Guide decoded structure may be interpreted as an SCR_OB structure with no side effects.
Boomer II User Manual & Integrator’s Guide ____________________________________________ SDK – SCR API Data Header All data messages (MI, HR, OB, IB, TO_NET, FROM_NET) contain a data header field. This field is used to route messages to the correct server from client RPM devices. The data header is also sometimes referred to as the session, and this is reflected in some of the NCL API function parameters.
SDK - SCR API ____________________________________________ Boomer II User Manual & Integrator’s Guide SCR Functions q scr_Init() Prototype: int scr_Init(byte l_network_type); Description: This routine initialises the library and sets the network type being usedDataTAC ® 4000, 5000, or 6000. The network type affects the encoding and decoding of messages by validating that the message type is applicable to this network type.
Boomer II User Manual & Integrator’s Guide ____________________________________________ SDK – SCR API q scr_Encode() Prototype: int scr_Encode(byte *l_buf, SCRMsg *l_msg) Description This routine encodes a SCRMsg structure into an SCR encoded data buffer. This routine transparently converts and encodes IB, OB, AB, HC, HR, and MI messages for the correct network type.
SDK - SCR API ____________________________________________ Boomer II User Manual & Integrator’s Guide Example #i nc l ude { SCRMs g l ms g; byt e l da t a [ 200] ; b y t e l b u f f e r [ SCR_ MAX_ LEN] ; */ i nt l l e n; */ . . / * SCR me s s a g e s t r u c t * / / * da t a t o s e nd t o hos t */ / * buf f e r f or e nc ode d SCR ms g / * l e n g t h o f e n c o d e d SCR ms g .
Boomer II User Manual & Integrator’s Guide ____________________________________________ SDK – SCR API q scr_Decode() Prototype: int scr_Decode(int l_len, byte *l_buf, SCRMsg *l_msg) Description This routine is used to decode an SCR message from a received buffer and produce an SCRMsg structure representing the received message. When this routine returns successfully, some memory may have been allocated within the SCRMsg structure.
SDK - SCR API ____________________________________________ Boomer II User Manual & Integrator’s Guide Example #i nc l ude { SCRMs g l ms g; / * SCR me s s a g e s t r u c t */ byt e l b u f f e r [ SCR_ MAX_ LEN] ; / * b u f f e r f o r r e c e i v e d SCR ms g i nt l l e n; / * l e n g t h o f r e c e i v e d SCR ms g i nt l us e d; / * r e t ur n c od e f r o m s c r _ De c o d e */ */ */ . . . / * r e c e i ve da t a i nt o l buf f e r */ l l e n = x25r e c v( . . .
Boomer II User Manual & Integrator’s Guide ____________________________________________ SDK – SCR API q scr_FreeDecoding() Prototype: void scr_FreeDecoding(SCRMsg *l_msg) Description This routine is used to free any memory allocated inside an SCRMsg structure by a successful call to scr_Decode().
SDK - SCR API ____________________________________________ Boomer II User Manual & Integrator’s Guide q scr_EncodeLogin() Prototype: int scr_EncodeLogin(byte *l_buf, char *l_hostid, char *l_passwd) Description For DataTAC® 5000 Networks Only. This function is used to encode the RNG login packet that is sent to the RNG when the connection is first established. Input: Ø *l_buf The buffer for the encoded login packet to be returned in.
Boomer II User Manual & Integrator’s Guide ____________________________________________ SDK – SCR API BM210012WT09 71 Wavenet Technology
SDK - SCR API ____________________________________________ Boomer II User Manual & Integrator’s Guide q scr_Print() Prototype: void scr_Print(FILE *l_fp, SCRMsg *lmsg) Description This routine prints an ASCII representation of the SCR message structure to the given file. This is intended to be used for debugging or tracing purposes. Input: Ø *l_fp The file pointer to write the message details to. Ø *l_msg The message structure to print. Output: None Example #i nc l ude
Boomer II User Manual & Integrator’s Guide ____________________________________________ SDK – SCR API Sample Output The output from the scr_Print() function shows the message type, followed by all the appropriate fields from the message structure. Shown here are several examples of possible output from the scr_Print() function: FROM_NET Message The FROM_NET message is printed as an OB message for a DataTAC 4000 network.
SDK - SCR API ____________________________________________ Boomer II User Manual & Integrator’s Guide q scr_NakReasonText() Prototype: char *scr_NakReasonText(char *l_reason_code) Description This routine converts a response code from an HC or AB message into a text string describing that code. The returned pointer is a pointer to a static text string within the library. This string must not be overwritten or freed. This string pointer will stay valid for the duration of the program's execution.
Boomer II User Manual & Integrator’s Guide ____________________________________________ SDK – SCR API q scr_ACReasonText() Prototype: char *scr_ACReasonText(char *I_reason_code) Description For the DataTAC 5000 Network Only. This routine converts a reason code from an Activity Confirmation (AC) message into a text string describing that code. The returned pointer is a pointer to a static text string within the library. This string must not be overwritten or freed.
SDK - SCR API ____________________________________________ Boomer II User Manual & Integrator’s Guide q scr_DIReasonText() Prototype: char *scr_DIReasonText(char *l_reason_code) Description For DataTAC 5000 Dynamic Routed Sessions Only This routine converts a reason code from a Disconnect Indication (DI) message into a text string describing that code. The returned pointer is a pointer to a static text string within the library. This string must not be overwritten or freed.
Boomer II User Manual & Integrator’s Guide _____________________________________ Application Development Application Development This section provides comments and advice that can help you develop successful wireless enabled applications for DataTAC systems. Application development for NCL-compliant wireless modem devices is a two-part process. q q The first step sets up the interface between the device host and the wireless modem.
Application Development _____________________________________ Boomer II User Manual & Integrator’s Guide Roaming Issues During development, consider how the coverage for your wireless enabled application could be affected by a user moving in and out of the network coverage area. Coverage can be temporarily impacted by moving from one side of a building to another. Coverage can be lost for a longer time by moving beyond the network coverage boundary.
Boomer II User Manual & Integrator’s Guide _____________________________________ Application Development repeated after a delay interval. See “Conserve battery life when out of range” below. Conserve battery life when out-of-range When all channels (from both dynamic and static channel lists) are scanned and network contact is not established, the wireless modem enters a scan-delay state.
Application Development _____________________________________ Boomer II User Manual & Integrator’s Guide Inbound SDU Failures Potential SDU inbound failure codes are described below. The list identifies all likely SDU failure responses. The remaining SDU responses that appear in the NCL 1.2 reference manual are not expected to occur within the Motorola DataTAC wireless modem. Inbound SDU failure, no response from network The SDU was transmitted, but not acknowledged by the network.
Boomer II User Manual & Integrator’s Guide _____________________________________ Application Development Outbound SDU Failure Due to the unreliable delivery of RF data packets (and their responses), a client application must consider the possibility of an outbound SDU being delivered to the client, with the transport confirmation of that data packet being lost (RF acknowledgment and/or transport level acknowledgment).
Application Development _____________________________________ Boomer II User Manual & Integrator’s Guide Usually this situation does not produce notification of network contact and reacquisition. Low battery Network contact is dropped when a low battery condition is reached. This follows a battery alert notification (warning) that occurs while the battery still has some remaining usable capacity.
Boomer II User Manual & Integrator’s Guide _____________________________________ Application Development To keep the wireless modem card from disconnecting from the network (and turn off its radio) following an undeliverable outbound message, disable the host inactivity timeout by issuing an S_INACTIVITY_TIMEOUT command to the wireless modem card. Set the timeout value to 255 (the default).
Application Development _____________________________________ Boomer II User Manual & Integrator’s Guide In DataTAC 5000 systems, unsolicited outbound messages (or messages that have missed the previous transmit opportunity) are delivered in the “root” (that is, home) window for the recipient device. Once the device is thus awakened, it remains awake for about n seconds after each message or ACK transmission from the device.
Boomer II User Manual & Integrator’s Guide _____________________________________ Application Development Application Efficiency One goal of application development is to provide the required functionality with the least amount of messaging. The consideration here is to minimize the number of interactions in an information exchange. Doing so addresses the limited data capacity and increased costs of wireless messaging.
Application Development _____________________________________ Boomer II User Manual & Integrator’s Guide The application developer must develop operational scenarios to accommodate the variable transit time in the application design.
Boomer II User Manual & Integrator’s Guide _____________________________________ Application Development BM210012WT09 87 Wavenet Technology
Message Routing and Migration________________________________ Boomer II User Manual & Integrator’s Guide Message Routing and Migration This section offers developers advice on how to migrate their applications. That is, how to create new versions of their wireless applications for porting to other DataTAC ® systems. You can also use this information to plan ahead for portability as you begin your initial application development effort.
Boomer II User Manual & Integrator’s Guide ________________________________ Message Routing and Migration Network Link Layers Before a message can be routed, it must contain a header and be wrapped in a link layer protocol supported by the DataTAC network. Many link layer protocols are available, but not all are supported by each DataTAC network. The X.25 protocol is common to all three systems and supports both PVC and SVC host connection line types. X.
Message Routing and Migration________________________________ Boomer II User Manual & Integrator’s Guide Standard Context Routing (SCR) SCR allows the central host to communicate with hundreds, even thousands of terminals across a single host connection. But the real advantage of using SCR is economic: The host only pays for a single connection to the network, significantly reducing communications cost.
Boomer II User Manual & Integrator’s Guide ________________________________ Message Routing and Migration SCR Message Types Fleet mode of communications uses three types of messages: q q q Commands / Host Requests (host-to-network) EXAMPLE: Send Message #1 to LLI 87654321 Responses / Host Confirmations (network-to-host) EXAMPLE: Message #1 to LLI 87654321 was ACKed Events / Mobile Information (terminal-to-network-to-host) EXAMPLE: Message received from LLI 12345678 A fourth type of message, the status
Message Routing and Migration________________________________ Boomer II User Manual & Integrator’s Guide ASCII versus Binary Encoding DataTAC 4000 system SCR fields are all ASCII encoded fields of numeric values or alphanumeric strings. DataTAC 5000 and 6000 systems use a mixture of ASCII and binary encoded fields. All three systems allow the user to send binary data, regardless of header encoding.
Boomer II User Manual & Integrator’s Guide ________________________________ Message Routing and Migration On DataTAC 6000 systems the host ID field consists of: q 1 to 4 bytes q ASCII ‘;’ (semicolon) delimiter q Host password of 1 to 8 bytes q Carriage return On DataTAC 4000 systems the RNG (ARDIS switch) locates the calling X.25 address to verify it is in the database. A valid calling address is then associated with only those terminals allocated to a particular host.
Message Routing and Migration________________________________ Boomer II User Manual & Integrator’s Guide Note: To run your application on DataTAC 4000 or 6000 systems, you must isolate the use of extended SCR or avoid it entirely. Service Data Unit (SDU) Size An application SDU consists of the complete message; both user data and data header. See “Data Header Routing” below. The maximum size of an application SDU is 2048 bytes for DataTAC 5000 and 6000 systems, and 2550 bytes for DataTAC 4000 systems.
Boomer II User Manual & Integrator’s Guide ________________________________ Message Routing and Migration DataTAC Header Fields Data Header Offset Data Header Data System Type (Not Shown) 4000 ... 03 T E1 Hello World 5000 ... 03 TE1 Hello World 6000 ... 03 T E1 Hello World In this example the data header TE1 is a sample. The data header could also have been RO3, TX4, SS2, or many others, depending on the configuration of the network infrastructure.
Message Routing and Migration________________________________ Boomer II User Manual & Integrator’s Guide The list preceding each chart describes the contents of the header fields. Host Request Message Header Fields Wavenet Technology Save Bytes Supplied by the host and used by the network to tie the confirmation to the original host request. Save bytes are ASCII for DataTAC 4000 systems. Save bytes can be ASCII or binary for DataTAC 5000 and 6000 systems.
Boomer II User Manual & Integrator’s Guide ________________________________ Message Routing and Migration Information BM210012WT09 For all systems, these fields include the data header and user data for the application.
Message Routing and Migration________________________________ Boomer II User Manual & Integrator’s Guide Host Confirmation Message Header Fields Length Prefix DataTAC 5000 systems require all SCR messages to designate the length of the message. The length count does not include the length prefix itself, but does include everything else in the message packet. Type Code Identifies the type of the SCR message: Use ‘A’ ‘B’ for DataTAC 4000 systems. Use ‘H’ ‘C’ for the other systems.
Boomer II User Manual & Integrator’s Guide ________________________________ Message Routing and Migration BM210012WT09 99 Wavenet Technology
Message Routing and Migration________________________________ Boomer II User Manual & Integrator’s Guide Mobile Information Message Header Fields Wavenet Technology Length Prefix DataTAC 5000 systems require all SCR messages to designate the length of the message. The length count does not include the length prefix itself, but does include everything else in the message packet. Type Code Identifies the type of the SCR message: Use ‘O’ ‘B’ for DataTAC 4000 systems. Use ‘M’ ‘I’ for the other systems.
Boomer II User Manual & Integrator’s Guide ________________________________ Message Routing and Migration data header and user data for the application.
Message Routing and Migration________________________________ Boomer II User Manual & Integrator’s Guide DataTAC Messaging (DM) DM allows one terminal to communicate with up to ten other terminals by routing a message through the DataTAC system network. As such, DM provides the protocol for basic E-mail functionality. System differences with regard to DM appear mainly as differences in DM syntax.
Boomer II User Manual & Integrator’s Guide ________________________________ Message Routing and Migration DM Header Charts The charts in this section allow you to compare DM syntax across all three DataTAC systems. Each chart displays a different set of headers based on message type. The charts show the differences you need to be aware of for your particular project. The list preceding each chart describes the contents of the header fields.
Message Routing and Migration________________________________ Boomer II User Manual & Integrator’s Guide Wavenet Technology 104 BM210012WT09
Boomer II User Manual & Integrator’s Guide ________________________________ Message Routing and Migration Receive Header Fields BM210012WT09 Type All systems use ASCII ‘R’ ‘M’ to indicate a Receive Message type message header. Sender ID The ID of the originating wireless terminal. On DataTAC 4000 systems this field is 8 bytes. On other systems it is 14 bytes. First Destination ID The ID of the destination terminal Flag Bytes Settings for optional delivery services.
Message Routing and Migration________________________________ Boomer II User Manual & Integrator’s Guide Wavenet Technology 106 BM210012WT09
Boomer II User Manual & Integrator’s Guide ________________________________ Message Routing and Migration Host Messaging (HM) Host Messaging (HM) is achieved by placing a DM header inside an SCR header. In addition, the first two bytes (either MG or RM) must be replaced with HM to signify the message was received from a host, rather than a peer. HM used in conjunction with DM allows the terminal to use the same routing protocol regardless of its destination.
Message Routing and Migration________________________________ Boomer II User Manual & Integrator’s Guide Special Text Formatting The display of dates, numbers, and monetary values varies among locales. Support for these differences may be provided by your programming environment to simplify the development of code. If your programming environment doesn’t provide such support, include alternative tables or options for use when localizing.
Boomer II User Manual & Integrator’s Guide ________________________________ Message Routing and Migration BM210012WT09 109 Wavenet Technology
Appendix A - NCL Interface___________________________________ Boomer II User Manual & Integrator’s Guide Appendix A - NCL Interface The Boomer II is compliant to Native Control Language (NCL) 1.2. Wavenet Vendor-specific extensions are also listed here. The specification for the NCL protocol may be obtained in Adobe Acrobat format from the Motorola website at http://www.mot.com/MIMS/WDG/pdf_docs/8-.
Boomer II User Manual & Integrator’s Guide ___________________________________ Appendix A - NCL Interface Commands SET_CNF Value Parameters Value Sub-values and Descriptions R_SYSID ASCII C Vendor-specific: Get system ID of current RF system. R_SW_VERSION ASCII D Get software version number. R_RPM_ID ASCII E Get RPM address. R_RF_BLOCK_SHORT ASCII E Vendor-specific: Get short form of RF status block. ASCII F Reserved. R_MAX_DATA_SIZE ASCII G Get SDU data limit.
Appendix A - NCL Interface___________________________________ Boomer II User Manual & Integrator’s Guide Commands Value Parameters Value Sub-values and Descriptions S_CUR_CNF ASCII F Save the modem configuration R_DEF_CNF ASCII G Restore the modem configuration R_STO_CNF ASCII H Read the modem configuration: CNF_EVENT_ Event control flag ASCII 0 FLAGS settings CNF_DELIVERY_ Outbound SDU del.
Boomer II User Manual & Integrator’s Guide ___________________________________ Appendix A - NCL Interface Commands Value Parameters Value Sub-values and Descriptions BAUD_38K4 38400 baud ASCII 5 S_ANTENNA RESET_RPM VENDOR Undefined Select the antenna ASCII L..Z Reserved. ASCII 6 Reset RPM. FLUSH_INBOUND ASCII 1 Flush inbound message queue. FLUSH_OUTBOUND ASCII 2 Flush outbound message queue. FLUSH_BOTH ASCII 3 Flush inbound and outbound message queues.
Appendix A - NCL Interface___________________________________ Boomer II User Manual & Integrator’s Guide registration denial. HW_EVENT RCV_ERR ASCII E HW_EVENT_BIT $01 Hardware event. HW_SELF_TEST ASCII 1 Self-test failed. HW_LOW_BATT ASCII 2 Low battery. HW_MEM_FULL ASCII 3 Memory full. HW_BATT_OK ASCII 4 Battery level OK. HW_MEM_OK ASCII 5 Memory OK. HW_OFF ASCII 6 Device shutdown imminent. HW_BATT_WARN ASCII 7 Battery at warning level. ASCII F Unreceivable message event.
Boomer II User Manual & Integrator’s Guide ___________________________________ Appendix A - NCL Interface P..Y, 1..9 SYNTAX VENDOR ASCII 3 ASCII Z BM210012WT09 Command SDU syntax error. Note the following error codes: INVALID ASCII b Invalid options. TOO_LONG ASCII c Data is too long. ASCII Z Vendor-specific response.
Appendix A - NCL Interface___________________________________ Boomer II User Manual & Integrator’s Guide Wavenet specific NCL Extensions The following table describes Wavenet specific extensions to the NCL 1.2 specification. All SDUs include three VENDOR control byte and the vendor Id. (the ‘\’ character is used as an escape character for hexadecimal bytes below): Command Type 1. Get status commands 2. Generic “Set RPM configuration” command. 3. Generic “Get RPM configuration” command.
Boomer II User Manual & Integrator’s Guide ___________________________________ Appendix A - NCL Interface OPERAND DESCRIPTIONS AND RESPONSES: q The various Vendor Status Requests that can be made, and the format of their response information in the SUCCESS response SDU, are described as follows. Please note that all multiple byte fields are stored MSB first. Get radio status information (NCL string “ZF?r”).
Appendix A - NCL Interface___________________________________ Boomer II User Manual & Integrator’s Guide Get modem battery status information WN_GET_BATT_VOLT: (NCL string “ZF?v”). SUCCESS is followed by a block of status information in the format shown below: WN_GET_BATT_VOLT Response For mat: 7 6 5 4 3 2 1 0 Battery Voltage (2 bytes) Battery Percentage Where: Battery Voltage: Battery Percentage: WN_GET_TIME: “ZF?t”). Two byte unsigned integer representing the Voltage of the battery in mV.
Boomer II User Manual & Integrator’s Guide ___________________________________ Appendix A - NCL Interface WN_GET_SETTINGS : string “ZF?u”). Get configuration information (NCL SUCCESS is followed by a block of status information in the format shown below: WN_GET_SETTINGS Response Format: 7 6 5 4 3 2 1 0 LLI [4 bytes] Serial Number [16 bytes] .......
Appendix A - NCL Interface___________________________________ Boomer II User Manual & Integrator’s Guide Indicate the start-up state for the NCL settings for RX_STATUS and TX_STATUS respectively. A zero indicates disabled, a one indicates enabled. NCL Event Flags: Byte which indicates the start-up state of the NCL event reporting. A set bit indicates the relevant event is enabled. A cleared bit indicates the event is disabled.
Boomer II User Manual & Integrator’s Guide ___________________________________ Appendix A - NCL Interface q Generic set RPM Configuration command (WN_SET_PARAM): This command allows the DTE to set the configuration settings of certain aspects of the modem.
Appendix A - NCL Interface___________________________________ Boomer II User Manual & Integrator’s Guide Parameter name : Parameter number : Parameter length : Parameter contents : WN_PWR_SAVE_MODE 0x7000 (“Byte1Byte2”) (ASCII 0x70 = ‘p’) 0x0001 (“Byte3Byte4”) One unsigned byte (“Byte5”) indicating the PowerSave mode as follow: ASCII ‘0’ : EXPRESS (Disabled PowerSave or “full awake” mode). ASCII ‘1’ : MAXIMUM (4 windows). ASCII ‘2’ : AVERAGE (8 windows). ASCII ‘3’ : MINIMUM (16 windows).
Boomer II User Manual & Integrator’s Guide ___________________________________ Appendix A - NCL Interface q Generic get RPM Configuration command (WN_GET_PARAM): This command allows the DTE to get the configuration settings of certain aspects of the modem. This section should be seen together with the previous section (“Generic GET RPM Configuration command”).
Appendix A - NCL Interface___________________________________ Boomer II User Manual & Integrator’s Guide SUCCESS is followed by a block of information in the format shown below: WN_GET_PROFILE_LIST Response Format: Number of profiles (n) [1 byte] Active profile number [1 byte] Profile Name 1 (up to 24 byte null terminated string) Profile Name 2 (up to 24 byte null terminated string) . . .
Boomer II User Manual & Integrator’s Guide ___________________________________ Appendix A - NCL Interface SAR Routine Function An SAR limiting function is available for end user applications to limit the average transmitted power by preventing new data transmissions until the previous period’s average transmitted power is less than the required SAR level. During all transmission times a Retransmit Delay Accumulator is incremented by a value of: time Td = Duty Factor constant x actual time of block.
Appendix A - NCL Interface___________________________________ Boomer II User Manual & Integrator’s Guide SAR Algorithm Initialise duty cycle of non transmit time, back off timer and Tx on timer. Then execute the following state machine.
Boomer II User Manual & Integrator’s Guide ________________________________ Appendix B - Sample Programs Appendix B - Sample Programs Sample programs are provided with the SDK. The purpose of these sample programs is to show how a complete working client server application can be built using the SDK NCL API with the client program and the SDK SCR API with the server program.
Appendix B - Sample Programs ________________________________ Boomer II User Manual & Integrator’s Guide The status tab displays the modem’s current channel (if registered) and it’s RSSI level. If the device is not registered it will be in scan mode, scanning the channels from the channel list in its current profile. The versions Tab displays the devices LLI, serial number, Hardware Platform and software version.
Boomer II User Manual & Integrator’s Guide ________________________________ Appendix B - Sample Programs The messages Tab allows a user to send and receive messages from the channel the device is currently registered on.
Appendix B - Sample Programs ________________________________ Boomer II User Manual & Integrator’s Guide Server Application The server program is a Windows NT command line program that connects to the DataTAC ® network switch and waits to receive data from wireless client devices. Any data received from wireless clients is echoed back to the same client on the same session. The server program can handle simultaneous connections from multiple clients.
Boomer II User Manual & Integrator’s Guide ________________________________ Appendix B - Sample Programs Initialisation and Login zEstablishConnection() establishes the connection to the RNG, using either TCP/IP or X.25. When either a DataTAC(D 4000 or DataTAC 6000 network is used, this is all that is needed for the server to connect to the DataTAC network. When a DataTAC 5000 network is being used, the server application must login to the RNG to identify itself.
Appendix B - Sample Programs ________________________________ Boomer II User Manual & Integrator’s Guide The following pseudo code gives an overview of the implementation of zHandleMessage().
Boomer II User Manual & Integrator’s Guide _________________________________Appendix C – Wavenet Loader Appendix C - Wavenet Application Loader The Application Loader software is used to upgrade the resident software installed on your Wavenet OEM modem. For optimum performance ensure that you are using the latest application version. This appendix, for your convenience, explains the procedure for updating the Application Loader software and has a troubleshooting section to assist with any problems.
Appendix C – Wavenet Loader ________________________________ Boomer II User Manual & Integrator’s Guide Note: The message shown above will appear if you are attempting to upgrade using ApploaderM408.exe with a Dualwave V modem. 7. The following screen is displayed. Displays the current version of Application software on your modem. Select the appropriate com port on your PC that the modem is connected to. Click the Download Application button to download the latest version.
Boomer II User Manual & Integrator’s Guide _________________________________Appendix C – Wavenet Loader 12. Press the modem’s On/Off button and click 13. A message is then displayed in the status bar, informing you that that the application software on the modem is up to date. 14. Click to exit the program. This will automatically switch your modem off. Troubleshooting You shouldn’t encounter any problems updating the Application Loader software, however the following messages may appear.
Appendix C – Wavenet Loader ________________________________ Boomer II User Manual & Integrator’s Guide The ApploaderM408.exe is applicable to the Dualwave M modem and ApploaderV233.exe is applicable to the Dualwave V modem. The letter preceding the three numerical characters at the end of the Apploader file name denotes which modem the file is appropriate for, i.e. BM2 for the Dualwave Boomer II OEM modem, M for Dualwave M modem and V for Dualwave V modem.
Boomer II User Manual & Integrator’s Guide _________________________ Appendix D - Numeric Conversion Chart Appendix D - Numeric Conversion Chart Binary/Octal/Decimal/Hex/C/ASCII Conversion Table Binary 00000000 00000001 00000010 00000011 00000100 00000101 00000110 00000111 00001000 00001001 00001010 00001011 00001100 00001101 00001110 00001111 00010000 00010001 00010010 00010011 00010100 00010101 00010110 00010111 00011000 00011001 00011010 00011011 00011100 00011101 00011110 00011111 00100000 00100001 001
Appendix D - Numeric Conversion Chart_________________________ Boomer II User Manual & Integrator’s Guide Wavenet Technology 138 BM210012WT09
Boomer II User Manual & Integrator’s Guide ___________________________________ Appendix E - Specifications Appendix G - Specifications Physical Properties Weight < 50g Size (L x W x H) 70mm x 52mm x 9mm Communication Protocols Modem to radio network protocol RD-LAP 3.1, 3.2, 3.3 Modem to terminal (e.g. handheld) protocol NCL 1.
Appendix E - Specifications ___________________________________ Boomer II User Manual & Integrator’s Guide Synthesiser Frequency range 806 – 825MHz (A), 890 – 902MHz (B) Channel spacing 25kHz (A) 12.5kHz (B) Frequency Error ±1.5ppm (<1300Hz) (A) (-30º ~ +60º C) ±0.8ppm (750Hz) (B) Transmitter Frequency range 806 – 825MHz (A), 896 – 902MHz (B) Channel spacing 25kHz (A) 12.5kHz (B) Data rate MDC 4.8kbps (A) RDLAP 9.6kbps (A) RDLAP 19.2kbps (A) RDLAP 9.6kbps (B) Modulation 2-Level FSK MDC 4.
Boomer II User Manual & Integrator’s Guide ___________________________________ Appendix E - Specifications RSSI Reading BM210012WT09 -120dBm ~ -45dBm 141 Wavenet Technology
