PKLR2400 Radio Hardware and Software Interface Specification Version 3.1 13256 W. 98th Street Lenexa, KS 66215 (800) 492-2320 www.aerocomm.com wireless@aerocomm.
Copyright Information/FCC User’s Notice Copyright Information Copyright © 1999 AEROCOMM, Inc. All rights reserved. The information contained in this manual and the accompanying software programs are copyrighted and all rights are reserved by AEROCOMM, Inc. AEROCOMM, Inc. reserves the right to make periodic modifications of this product without obligation to notify any person or entity of such revision.
Revision s Version 1.0 Version 1.1 Description Initial Release Version - 2/4/99 page 24 - System ID Address corrected from 30h to 34h Version 2.0 Add transparent serial modes – 5/25/1999 Added EEPROM Write Protect Changed Pin 27 Definition to Forced API Mode 03 Version 3.0 Add broadcast packet attempts – 6/10/1999 Broadcast Packet size increased from 256Bytes to 2KBytes Correct number of channels from 75 to 77 – 7/22/1999 Change nomenclature for Serial Packet Mode 03 to Serial API Mode 03 Version 3.
Table of Contents 1. OVERVIEW.......................................................................................................................................... 6 2. PKLR2400 SPECIFICATIONS........................................................................................................... 7 3. THEORY OF OPERATION................................................................................................................ 8 3.1 DEFINITIONS ...............................................
PKLR 6.2.2 6.2.3 6.2.4 6.2.5 6.2.6 7. Send data*............................................................................................................................. 28 Send data complete* ............................................................................................................. 29 Received data* ...................................................................................................................... 29 In range*.......................................................
Overview 1. Overview This document contains information about the hardware and software interface between an AeroComm PKLR2400 Radio and an OEM host. Information includes the theory of operation, system issues, and a basic command set for operational control of the system and radio. The Radio is designed to allow flexibility at the hardware interface level with a minimum number of actual hardware pins connecting the radio and the OEM Product.
PKLR2400 Specifications 2. PKLR2400 Specifications GENERAL Bus Interface Interface Data Rate Serial Parallel Compliance Power Consumption TX/RX Active (All Modes) Interface ON/RF OFF (API Mode Only) Sleepwalk (All Modes) Standby (API Mode Only) Channels Security Serial (TTL Level Asynchronous) or Parallel through 40 pin mini connector. Amp P/N 177986-1 or Berg Prog to 800 kbps. Supports PC rates to 57.6 Kbps 4 Mbps Certifiable under: US - FCC15.
PKLR2400 Specifications 3. Theory of Operation 3.1 Definitions Server Host: The server host is the OEM device controlling the server radio Client Host: The client host is the OEM device controlling the client radio Host: Host refers to both the server host and the client host Server Radio: The server radio is the “master” radio. It is the hub of communications Client Radio: The client radio is a “slave” radio.
Theory of Operation 3.2.3 Serial Interface Mode 03 – API Mode 03 specifies API Mode. In this mode, the OEM has control of the radio command set detailed in Section 6.2. Packets are transmitted upon completion of the Send_Data command. In API Serial Interface Mode 03, the OEM host may utilize a set of basic commands to control the radio and system. These commands allow the customer to establish system parameters through the programming of variables in EEPROM as well as monitoring system performance.
Theory of Operation 3.3 Initialization Sequence When operating in the three Transparent Serial Interface Modes, the initilization sequence is managed by the AeroComm protocol. In-Range commands are not issued and there is no acknowledge from the radio on data delivery unless the OEM protocol has built-in acknowledgement. When operating in the API Serial Interface Mode 03, the following initialization sequence occurs.
Hardware Interface 4. Hardware Interface 4.1 Mechanical Overview The PKLR2400 measures 1.65” x 2.65”. Critical parameters are as follows: J1 – 40 pin OEM interface connector (Amp P/N 177986-1) mates with Amp P/N 177985-1 J2 – High frequency MMCX style antenna connector (Huber + Suhner P/N 85-MMCXS50-0-51) mates with any manufacturer MMCX plug (4) Mounting holes are 0.100” diameter. Figure 1.
Developers Kit 4.2 Pin Definitions for Connector J1 The following pinout summary is achieved through a 40 pin mini connector J1 (Amp P/N 177986-1).
Developers Kit 4.3 Pin Descriptions for Connector J1 Special considerations for the hardware interface at connector, J1, are described in this section. All remaining pin descriptions are standard for serial hardware interfaces. 4.3.1 No Connect All No Connect pins 2, 4, 6-19, 22, 28-35 and 37 must not be connected to logic high or low levels, but must be left floating. 4.3.2 Vcc All Vcc pins 3, 5 and 39 require power of 5Vdc + 5% with ripple of less than 50mv p-p. 4.3.
Developers Kit the radio be in API Serial Interface Mode to execute the Command Set or to configure any of the EEPROM parameters. To force the radio into API Serial Interface Mode 03, pin 27 must be held at logic low level and the radio reset. The radio can not be placed into any of the Transparent Serial Interface Modes 01, 02 or 04 until pin 27 is held at logic high level and reset. 4.3.
Developers Kit 5. Developers Kit SDK-PKLR2400P (Parallel) and SDK-PKLR2400S (Serial) Developer Kits help system designers implement radio designs quickly. The kit offers all the cables, power supplies, circuit schematics, documentation and accessories needed to begin using the PKLR2400 quickly. The kit includes: • • • • • • • • (2) PKLR2400 Data Radios either serial or parallel (2) Serial Adapter Boards with 40 pin interface, 40 pin header, LED indicators, power connector and DB9 connector.
Developers Kit 5.1 Serial Adapter Board The Serial Adapter Board allows the use of different forms of communication with the OEM radios. The user must choose between using RS-232 levels or 5 Volt TTL logic levels for interfacing with the OEM radio when using the adapter board. Figure 2.
Developers Kit J3-J9 Level Translator Settings If a PC will be used as the OEM server or client host, then level conversion must be enabled to convert from the RS-232 levels at the PC to the 5 Volt TTL logic levels used on the radio. To enable level conversion, place jumpers J3-J9 on pins 2 and 3, see Figure 3. If another device (0-5 volt TTL logic levels) is to act as the Host for the radio then the user must disable level conversion.
Developers Kit The developer kit includes a 3.5” diskette of software utilities allowing the customer to exercise the radios upon receipt. The software utilities are written for a DOS environment. The software utilities will not operate properly under a DOS shell in Windows or Windows. The software includes several files as follows: • • • • • • OEM.EXE – Interactive Command/EE Edit Software/Transmit Receive Emulator. *.RTC – Script files that automate radio mode setup and demonstrates operation. PORTS.
Developers Kit instructions on how to write a script file can be found in the section below describing *.RTC. While in the Emulator, pressing the ‘Alt’ key will bring up a window with 7 choices: File, Settings, Window, Reset, Enable, Help and About. The File option allows the user to load a script file or execute a mode setup script to ports 1 or 2. The Settings option allows the user to change baud rate and other settings.
Developers Kit *.RTC files contain all of the configuration information for OEM.EXE. *.RTC files can be modified to change timeouts, ports, and commands. *.
Developers Kit S4NS.RTC– Setup server radio to Mode 4 Non-Addressed SP3CS.RTC –This file is used to configure both the client and server radio into Mode 3 Receive mode 1 (Unicast/Broadcast). SP3CS02.RTC – This file is used to configure both the client and server radio into Mode 3, receive mode 2 (unicast only) SP3CS03.
Developers Kit 5.3 Antenna Board The developer kits are provided with (2) patch antennae mounted on a ground plane. In addition, (2) SMA male to MMCX plug, cables are provided to interface the antenna boards to the radio. Optional antennae are available for testing. Antenna selection is instrumental to and will impact overall system performance. 5.4 Power Supply Specification (2) power supplies are also provided to power both units in the developer kit.
Command Set 6. Command Set The basic command set consists of several commands from the Host and Radio. The command set can be used ONLY when the radio is in Serial Interface API Mode 03 determined by the EEPROM address at 4AH (See Chapter 7, Configuring the PKLR2400). The command set is designed as follows: Command Length Data Checksum Command -- 1 Byte. This is the actual command from the appropriate processor. Length -- 2 Bytes. This is the total size of the remaining data for this command.
Command Set 6.1.2 Control* The Host processor will issue this command to Write and Read EEPROM as well as for NOP. Sub Command one byte 2H* Description Read EEPROM. Additional data: first two bytes specify starting address. Second two bytes specify ending address. NOP. Write EEPROM. Additional data first two bytes specify starting address. Second two bytes specify ending address. Remaining bytes specify data to be written.
Command Set 6.1.4 Standby* (THIS COMMAND NOT YET SUPPORTED) This command is issued by the Host processor to put the Radio in one of two low power modes. For mode 0, the Radio should disable the radio and enter a low power state. The hop synching is the only allowed operation in this mode. For mode 1, the Radio should go into deep sleep mode. The Radio should come out of low power modes when a command is issued from the Host processor. This command requires an acknowledge.
Command Set 6.1.7 Status Reply* This command will be sent by the Radio to the OEM Host in response to a Status Request command. All the different parameters pertain to the data link layer and are cumulative totals. Once this command has been sent back to the OEM Product, depending on whether the OEM Product desired an error counter variable reset, the reset operation is carried out.
Command Set 6.1.8 Update EEPROM Checksum* This command is sent by the Host to the AeroComm module to tell it to recalculate the checksum. This is typically done by the Host CPU after it has completed writing data to the EEPROM on the AeroComm module. The response to this command is an acknowledge. 6.1.9 Check EEPROM Checksum* This command is sent by the Host CPU to the AeroComm module to validate the EEPROM checksum. This is typically done after bringing up the AeroComm module out of reset.
Command Set 6.2 Radio Command Set Summary The Radio Commands allow the user to control the flow of data into and out of the radio as well as initialization of the radio in API Serial Interface Mode 03. Name Command Length Data Checksum RF enable* Send Data* Send Data Complete* Received Data* In range* 80H 81H 82H 83H 84H 0H 1 to 7f0h (includes 802.3 Header) 1H 1 to 7f0h (includes 802.
Command Set 6.2.3 Send data complete* The Radio will issue this command upon completion of the data transmission process, as indicated by a RF-layer Acknowledgment from the destination RF-device. An additional byte of data indicates a success or a failure code. This command must be returned for every send data command unless the device power fails. Command: Length: Data: Checksum: Data Frame: 82H 01H 82H 01 0 - indicates success. 1 - Can’t send packet. As required 00H Data Checksum 6.2.
Command Set 6.2.6 Out of range* The Radio will issue this command upon detecting that it is out of range of a Server Radio. This command is only valid after reset or after an in range command has been issued to the Host processor. This command should have some hysterisis so that the Host processor isn’t flooded with these commands in a fringe coverage area. The state of the RF link should be updated with the frequency specified in the configuration command to provide the needed hysterisis.
Configuring the PKLR2400 7. Configuring the PKLR2400 Radio The various configurable parameters are stored in the EEPROM in the Radio. These parameters are read by the AeroComm firmware on power-up reset. These parameters can be configured by AeroComm as AeroComm defaults or customer defaults. These parameters can also be configured by the customer using a PC and an AeroComm provided adapter.
Configuring the PKLR2400 7.1.3 Channel Number EEPROM Address: 2EH Size: 1 byte Default: 00 Range: 01-75 This provides 75 unique and non-interfering pseudorandom hopping sequences or channels. This allows for up-to 75 independent, co-located data networks. Default shipped at 00. It is highly recommended that this be changed to a channel number other than 00. Note: Channel Number AND System ID between clients and server must be identical for radios to communicate. 7.1.
Configuring the PKLR2400 7.1.6 Baud High (BH) and Baud Low (BL) EEPROM Address: 40H and 41H respectively Size: 1 bytes Default: FF for BH and F1 for BL Range: 00-FF for BH and BL Baud High (BH) along with Baud Low (BL) is used to establish the data rate over the interface between the OEM radio and host as follows: Sample BHBL selections for common Baud Rates Baud Rate 300 2,400 4,800 9,600 19,200 28,800 57,600 (default) 115,200 (Using a 28.
Configuring the PKLR2400 7.2 Protocol EEPROM Parameters The protocol EEPROM parameters are related to the Serial Mode interface selection. A summary of the required EEPROM settings is illustrated in Section 7.3. Note: These parameters can only be changed when the API Serial Interface Mode 03 is active. When in Transparent Serial Interface Modes, this can be accomplished by holding pin 27, PKTMODE, low and resetting.
Configuring the PKLR2400 7.2.1 Transmit Data Link Attempts EEPROM Address: 2FH Size: 1 byte Default: 10H Range: 01-FF This parameter specifies the maximum number of attempts over the RF interface. Serial Interface mode 03 will respond with a Send Data Failure when maximum Data Link attempts is achieved. All other modes will not receive an acknowledge. Note: Transmit Data Link Attempts must be set to 01 when operating in the Broadcast Mode of the Address Transparent Control. 7.2.
Configuring the PKLR2400 7.2.4 End Character Definition EEPROM Address: 3EH Size: 1 bytes Default: 0D Range: 00-FF This parameter is used only when the radio is operated in Serial Interface Mode 02 specified by EEPROM address 4AH. Otherwise, this parameter is ignored by the system. The parameter specified by the user will indicate the last character in a data packet. When this end character is seen by the radio, the packet will be transmitted.
Configuring the PKLR2400 Mode 04 specifies Transparent mode with fixed length packets and no timeout. Packets will be transmitted over the RF interface when the number of data bytes received over the interface is equal to the buffer specified by the user in EEPROM address locations 43H and 44H. Note: EEPROM parameters can not be programmed once the radios are programmed and reset in any of the Transparent modes 01, 02 or 04. The radio must be programmed to API mode 03 to access EEPROM parameters.
Configuring the PKLR2400 7.2.9 Broadcast Attempts EEPROM Address: 4EH Size: 1 bytes Default: 04H Range: 01-FF The Broadcast Attempt parameter applies only to the Broadcast modes for all four serial packet modes and specifies the number of times that the RF will broadcast every packet. The receiving radio will discard duplicate packets. 7.
Initializing the PKLR2400 Radio 8. Initializing the PKLR2400 Radio Following is an example of the initialization sequence for both the Client and Server Radios following AeroComm or customer configuration of the EEPROM configuration parameters. This occurs only in the API Serial Interface Mode 03.