L. S. Research, Inc.
About This Manual This document provides the user with details in setting up and using the FreeStar evaluation kit (Part # FS24-100ST-KIT). The document also provides information and references for software developers to write applications for use with the FreeStar module (Part # FS24-100ST).
Index CHAPTER 1 FreeStar Evaluation Kit Overview ...........................................................................Page 4 1.1 Description ...................................................................................................Page 4 1.2 Contents.......................................................................................................Page 4 CHAPTER 2 Quick Start.........................................................................................................
CHAPTER 1 FreeStar Evaluation Kit Overview 1.1 Description The evaluation kit provides the end user the ability to quickly become familiar with the FreeStar module. Included in the kit are two FreeStar modules and a quick start guide to demonstrate the communication link between the two modules. Also included is a GUI interface referred to as the FreeStar Evaluation Test Tool (TT) to quickly communicate with the RF modules. The Evaluation software demonstration is presented in Chapter 4.
CHAPTER 2 Quick Start 2.1 Board Description The FreeStar module is a 2.4GHz 802.15.4 data transceiver module based on the Freescale MC13192 Low Power Transceiver device. It provides enhanced range performance with a 100mW power amplifier. The module also contains the Freescale MC9S08GT60CFD microprocessor and an integrated PCB trace antenna. Power is supplied by the host device through the interface connection in accordance to the operating voltage requirements with a nominal operating voltage of +3.3V.
2.2 Operational Overview The quick start demonstration presented in this chapter is referred to as the ping pong test. The ping pong test allows an end user to easily verify communication between two transceivers and get a feel for the quality of the link via feedback of the flashing LEDs. Operation involves two boards, with one designated as a master device and the other as a slave device. The master periodically transmits packets to the slave.
2.2.4 Ping Pong Mode In ping pong mode, the master and slave boards will flash one or two LEDs with each packet (slave) or acknowledge (master) received, based on message signal strength. In case there is a lot of other traffic on the default channel, it is possible to change the channel. 2.2.5 Channel Changing (can only be peformed if boards have been associated) While in the ping pong mode, the current channel can be changed to one of four other unique channels (five channels total).
CHAPTER 3 FreeStar Interface Module 3.1 Interface Module Overview (See Figure 3 – 1 for Photo) The interface module provides the user the ability to quickly assess the functions of the FreeStar module such as I/O and the mobility to verify operation of a wireless link in any environment of the user’s choosing. This chapter describes in detail the functions of the FreeStar interface board that can be verified using the FreeStar evaluation software provided in this kit.
Programming Header (location 2) • Location 2 refers to programming header for programming FreeStar Module. The suggested programmer for the RF Module is the USB HCS08/HCS12 Multilink programmer (Part # USB-ML-12) Reset Button (location 3) • Location 3 indicates the white button that provides ability to reset the microprocessor on the FreeStar module. Port A Header for Access to I/O Pins (location 4) • Header to provide quick access to Port A pins 4 thru 7 on the microprocessor.
Power Supply Circuitry (location 7) • Location 7 encompasses the power supply circuitry. As shown the jumper is set for bench power supply (3.5 – 5VDC). Bench power supply may be connected to the white header (note positive and negative terminals). • To use battery supply place the jumper as shown in Figure 3-2 below and insert 2 AA batteries in power pack onboard the interface board. Figure 3-2.
CHAPTER 4 Software Overview 4.1 Software Description The FreeStar evaluation software was designed to give the developer an ability to quickly test the features built into the FreeStar module. The evaluation software is described in the following sections. A screen shot of the evaluation software is shown in Figure 4-1. Developers please refer to chapter 5 for information on building custom applications for use on the FreeStar module. Figure 4-1.
4.2 Software Setup Install the Evaluation test tool using the self extracting setup program and execute the FreeStarTT.exe to start the program. Before communication with the module is possible it is necessary to initialize the serial port. Pull down the “Settings” menu and click the “Communications” entry. The screen shown in Figure 4-2 will appear. Figure 4–2. Communication Setup Screen under “Settings” Pull Down Menu Determine serial port in use and select “OK”.
Save Config to NV Memory (command button) • Permanently saves configuration settings from ID and RF Settings pages to non volatile memory. This feature allows user to cycle power or reset the module without losing previous saved settings. 4.2.2 Setting Device Identification (See Figure 4-1) Transceiver Address • Short Address – Device defaults to using short address unless this field is set to 65,534.
Figure 4–3.
4.2.4 I/O Settings (See Figure 4-4) The I/O page can be selected by clicking the I/O tab in the software. This is shown in Figure 4-4. The I/O page can be used to setup select digital and analog pins for desired operation. Figure 4–4.
4.2.5 Statistics (See Figure 4-5) The statistics page can be selected by clicking the Statistics tab in the software. This is shown in Figure 4-5. The statistics option can be used to evaluate the wireless link for packet error rates and throughput. Figure 4-5.
Transceiver • Packets Sent Number of packets transmitted • Acknowledgements (ACK) Sent Number of acknowledgements sent by receiver. • Packets Received Number of packets received. • Acks Received Number of acknowledgements seen by transmitter. “Evaluation Program” Statistics The window toward the bottom the page labeled “Evaluation Program” contains information about the integrity of the link between the host computer and the radio board. 4.2.6 Debug Settings (See Figure 4-6) Figure 4-6.
Debug Mode • Mode 0 – No debug pulses on pins • Mode 1 – Refer to Host Protocol Document for Information LED Functionality (Refer to Host Protocol Document for Information) Red (LED2) = receive Green (LED3) = transmit • RF Activity – LEDs flash when transmitting or receiving device • Serial Activity – LEDs flash when communicating through the serial port. Received RF messages will flash the transmit LED if the message is transmitted out the host serial port.
4.3 Setting Up and testing a Wireless Link Operational testing of the FreeStar RF module requires at least 2 units in order to establish a link. One unit will be the initiator and the other will be the responder. In order for a link to be established it is necessary to setup the transceivers RF Channel, long or short address and PAN id. Link testing may be performed in either a single ended or a round trip fashion.
Device 2 (Refer to Figures 4-8 and 4-9) 1. Set PAN ID to 100 (IDs Page) 2. Set short address to 2 (IDs Page) *Note to use long addressing set short address to 65,534 3. Disable Acknowledgements/Retries (RF Settings Page) 4. Disable Receive All RF Messages (RF Settings Page) 5. Set to RF Channel 23 (RF Settings Page) 6. Set transmitter power setting to 31 (RF Settings Page) 7. Set Short Destination address to 1 (Located Upper left corner of TT) 8.
Figure 4-8. ID Settings for Device 2. Figure 4-9.
Place the 2 units in physically separate locations and apply power to them. The statistics will clear when power is cycled, but they will need to be cleared manually after each test if power is not cycled. Connect each individual PC serial port to each of the units and verify the correct destination address is typed in the address field on the top of the test tool. Type a short message into the “RF Data” window of the initiating device. The message can be any text or numbers.
CHAPTER 5 FreeStar Module Input/Output 5.1 Overview There are a total of 10 user input/output pins on the FreeStar module which consist of 8 configurable digital input/outputs and 2 fixed analog inputs. 5.2 Digital Inputs/Outputs There are 8 configurable digital input/output pins that can be programmed to be either inputs or outputs. In addition if the pins are inputs the internal pullup resistor can either be enabled or disabled. Refer to Table 1 below for a mapping of the digital input and output pins.
Using the digital input output pins consists of the following: • Configuring the pins Select direction (input or output), enabling or disabling pullup resistors for pins configured as digital inputs, and setting the initial output value for pins configured as digital outputs. These parameters define the configuration of the pins when a reset occurs. Also the direction and pullup parameters are used to set the state of the pins after exiting sleep mode.
CHAPTER 6 FreeStar Application Guide 6.1 Overview This Chapter describes the essentials for using the host protocol to configure and use a FreeStar module in an application. Please refer to Host Protocol Document for Further Details on messaging. 6.1.1 Host Protocol The host protocol that is used to communicate with a FreeStar module is a simple binary based protocol. Every message in the protocol consists of a header, a trailer, and potentially some payload information.
Communication Parameters There are six configuration parameters used to setup the FreeStar module for communications, which are outline below. 1. Set PAN ID – The Personal Area Network (PAN) ID is used to establish networks of transceivers. Only devices with the same PAN ID will communicate with one another. 2. Set Transceiver Address – The Transceiver Address is used to differentiate transceivers within a network. Each transceiver should be configured with a different address.
Input/Output Parameters There are three configuration messages used to setup parameters for controlling the user input and output pins, which are outlined below. 1. Set Digital Pin Configuration – This message is used to configure the direction (input or output), whether or not the internal pull-up resistor is enabled for pins configured as inputs, and the initial output value for pins configured as outputs.
Diagnostics and Feedback Parameters There are two configuration parameters used to setup diagnostics and user LED feedback which are outlined below. 1. Set Debug Mode – Setting the debug mode allows the host application to configure what debug information gets displayed on the three mode pins when the mode pins are in their default state. The default state for the mode pins is that none of the external pulldowns are installed.
Host Messages 1. Set PAN ID < 0x01 0x07 0x01 0x64 0x00 0x6D 0x04 > 2. Set Transceiver Address < 0x01 0x0F 0x03 0xF4 0x01 0x00 0x00 0x00 0x00 0x00 0x00 0xFE 0xFF 0x05 0x04> 3. Set RF Channel < 0x01 0x06 0x05 0x12 0x1E 0x04 > 4. Disable Receive All RF Messages < 0x01 0x06 0x07 0x00 0x0E 0x04 > 5. Enable Acknowledgements and Retries < 0x01 0x06 0x09 0x01 0x10 0x04 > 6. Set Transmit Power Level < 0x01 0x06 0x0F 0x1F 0x35 0x04 > 7. Set Digital Pin Configuration < 0x01 0x08 0x01E 0x00 0xFF 0x00 0x26 0x04 > 8.
6.1.3 RF Messaging Overview The FreeStar module provides a versatile command set for communications between modules. Depending on the application’s requirements, either short or long address modes can be used. Short addressing mode uses a two byte transceiver address, while long addressing mode uses eight byte transceiver addresses.
Receive All Receive all mode is used as a diagnostic mode in which a transceiver can listen to and receive all of the messages from any device that is communicating on the same PAN ID and RF channel. Messages with long and short addressing types will be received, and when a message is received it is sent out the host serial port with a message type of 0xA9. In receive all mode it is not possible to transmit messages to other transceivers.
Host Send Mode (Host -> Txcvr A) Short Short Short Short Long Long Long Long Addressing Mode (Txcvr A -> Txcvr B) Txcvr A Txcvr B Short Short Long Long Short Short Long Long Short Long Short Long Short Long Short Long Host Receive Mode (Txcvr B -> Host) Source Destination Short - (Note 1) Long - (Note 1) - (Note 2) Short - (Note 2) Long Short - (Note 1) Short - (Note 1) - (Note 2) Long - (Note 2) Long Broadcast Ok Ok Ok Ok - Table 2 – Addressing Overview Note 1: Since a transceiver is setup with bo
6.1.4 Example Messaging For all of the following examples it is assumed that the PAN ID and RF channel are set to be the same on both FreeStar modules. Also the messages will originate in the host connected to transceiver A and they will be sent to transceiver B. The data contained in the message will be 0x01, 0x02, 0x03. All received messages have a Link Quality Indication (LQI) of 200 (0xC8).
Short To Long Addressing The following example will show details of communications between two FreeStar modules with transceiver A configured to use short addressing and transceiver B configured to use long addressing.
Long To Long Addressing The following example will show details of communications between two FreeStar modules both configured to use long addressing.
2. Query Digital Pin State – This message is used to read the values of the eight potential digital input signals. A bit mask for each digital input/output signal is returned in a host message that gets sent back from the FreeStar module. Only digital pins configured as inputs contain any meaningful information. A zero indicates a low signal is applied to the input, while a one indicates a high signal is applied. Example: Digital Pin Configuration – Inputs = PTC1, PTC5, PTD3, and PTD4.
Appendix A Range Test Results A.1.1 FreeStar with Inverted F (Trace) Antenna Open Field Range Results at 3.3VDC Inverted F (Trace) Antenna 120.00 Two Direction Packet Success Rate (%) 100.00 80.00 60.00 40.00 20.00 0.
Appendix B Agency Statements FCC Statements Compliance Statement (Part 15.19) This device complies with Part 15 of the FCC Rules. Operation is subject to the following two conditions: 1. This device may not cause harmful interference, and 2. This device must accept any interference received, including interference that may cause undesired operation. Warning (Part 15.21) Changes or modifications not expressly approved by L.S. Research Inc. could void the user’s authority to operate the equipment.
Canada Statements Industry Canada Statement The term "IC" before the certification / registration number only signifies that the Industry Canada technical specifications were met. Section 14 of RSS-210 The installer of this radio equipment must ensure that the antenna is located or pointed such that it does not emit RF field in excess of Health Canada limits for the general population. Consult Safety Code 6, obtainable from Health Canada’s website: www.hcsc.gc.
