Laird RM024 User Manual

Ramp wireless module
Hide thumbs Also See for RM024:

Advertisement

Quick Links

A
RAMP Wireless Module
RM024
Version 3.5

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the RM024 and is the answer not in the manual?

Questions and answers

Subscribe to Our Youtube Channel

Summary of Contents for Laird RM024

  • Page 1 RAMP Wireless Module RM024 Version 3.5...
  • Page 2 Fixed header of RSSI Control (0x68) settings table and 18 July 2017 Jennifer Gibbs RSSI control table. Americas: +1-800-492-2320 Embedded Wireless Solutions Support Center: Europe: +44-1628-858-940 http://ews-support.lairdtech.com Hong Kong: +852 2923 0610 www.lairdtech.com/ramp © Copyright 2017 Laird. All Rights Reserved...
  • Page 3: Table Of Contents

    Overview ................................42 Upgrading Via Windows OEM Configuration Utility ................... 42 Upgrading FW Commands ........................... 43 Command Descriptions ............................43 Process to Manually Upgrade RM024 ......................... 45 API Operation ................................46 API Send Data Complete ............................46 API Receive Packet .............................. 46 API Transmit Packet .............................
  • Page 4: Ramp Modules

    Overview The RM024 RAMP module is based on Laird LT2510 core technology, enhanced with a new RF front end for improved sleep, improved link budget, and a switchable antenna output. The RM024 is available in two versions, one with 125 mW maximum conducted output power which is approved for North American and similar markets, and one with 10 mW maximum conducted output power which is approved for European and similar markets.
  • Page 5: Theory Of Operation

    Adjustable RF Data Rate The RM024’s RF data rate can be adjusted to provide a trade-off between throughput and range. Table 1: RM024 RF Data Rate Receiver Sensitivity...
  • Page 6: Modes Of Operation

    Transparent Mode When operating in transparent mode, the RM024 can act as a direct serial cable replacement in which RF data is forwarded over the serial interface and vice versa. In transparent mode, the radio needs to be programmed with the MAC address of the desired recipient.
  • Page 7: Serial Interface Baud Rate

    Baud Rate Tips:  The RM024 supports a majority of standard as well as non-standard baud rates. To select a standard baud rate, use the value shown for EEPROM address 0x42 in Table 2. To enable a non-standard baud rate, program EEPROM address 0x42 (Custom Baud Enable) to 0xE3 and then use the equation above to solve for BAUD_M and BAUD_E.
  • Page 8: Interface Timeout/Rf Packet Size

    3 slots 500 kbps Enabled 0x01B – 0x4B 2 slots 500 kbps Enabled 0x4C – 0xE2 1 slot Americas: +1-800-492-2320 Embedded Wireless Solutions Support Center: Europe: +44-1628-858-940 http://ews-support.lairdtech.com Hong Kong: +852 2923 0610 www.lairdtech.com/ramp © Copyright 2017 Laird. All Rights Reserved...
  • Page 9: Flow Control

    RXD Data Buffer and CTS As data is sent from the OEM host to the radio over the serial interface, it is stored in the RM024’s buffer until the radio is ready to transmit the data packet. The radio waits to transmit the data until one of the following conditions occur (whichever occurs first): ...
  • Page 10: Force 9600

    TXD Data Buffer and RTS As data to be forwarded to the OEM Host accumulates, it is stored in the RM024’s outgoing buffer until the radio is ready to begin sending the data to the OEM Host. Once the data packet has been sent to the Host over the serial interface, it will be removed from the buffer and the radio will begin processing the next data packet in the buffer.
  • Page 11: Radio Configurations

    Selects either integrated chip antenna or U.FL connector for external antenna. Note: On RM024 –C units with no integrated antenna, the RF switch is still active and it is possible, though not advised to switch to the integrated antenna option, even though there is no antenna connected.
  • Page 12 1 mA average current consumption. Americas: +1-800-492-2320 Embedded Wireless Solutions Support Center: Europe: +44-1628-858-940 http://ews-support.lairdtech.com Hong Kong: +852 2923 0610 www.lairdtech.com/ramp © Copyright 2017 Laird. All Rights Reserved...
  • Page 13 Specific RF Profiles are reserved to enable Forward Error Correction (FEC). Forward Error Correction can be used to decrease the packet error rate in the presence of bursty errors over the air. The RM024 uses convolutional coding and interleaving to allow the receiver to recover from small bit errors. When enabled, FEC will cause the radio to transmit additional bits of data over the air to allow for error recovery.
  • Page 14 (generally less than 2 ft or 0.6 m with 2.5 dBi antennas), the maximum power should be reduced. On 10mW RM024 radios, the Max Power setting will have no effect on the output power, all four power settings are fixed at 10mW.
  • Page 15 Americas: +1-800-492-2320 Embedded Wireless Solutions Support Center: Europe: +44-1628-858-940 http://ews-support.lairdtech.com Hong Kong: +852 2923 0610 www.lairdtech.com/ramp © Copyright 2017 Laird. All Rights Reserved...
  • Page 16 PWM output should not be set to output to that pin or conflicting signals will be sent on that output pin. Americas: +1-800-492-2320 Embedded Wireless Solutions Support Center: Europe: +44-1628-858-940 http://ews-support.lairdtech.com Hong Kong: +852 2923 0610 www.lairdtech.com/ramp © Copyright 2017 Laird. All Rights Reserved...
  • Page 17  RSSI_Dec = (RSSI_dBm + 82) * 2 +128 Then convert this from decimal to hexadecimal notation. Americas: +1-800-492-2320 Embedded Wireless Solutions Support Center: Europe: +44-1628-858-940 http://ews-support.lairdtech.com Hong Kong: +852 2923 0610 www.lairdtech.com/ramp © Copyright 2017 Laird. All Rights Reserved...
  • Page 18 To prohibit transceivers from receiving broadcast packets, Unicast Only can be enabled. Unicast Only restricts the transceiver to only receive addressed packets. Americas: +1-800-492-2320 Embedded Wireless Solutions Support Center: Europe: +44-1628-858-940 http://ews-support.lairdtech.com Hong Kong: +852 2923 0610 www.lairdtech.com/ramp © Copyright 2017 Laird. All Rights Reserved...
  • Page 19: Eeprom Parameters

    EEPROM P ARAMETERS The RM024 utilizes a server-client network architecture to synchronize the frequency hopping. Each network must have one radio configured as a server and all other radios configured as clients. When a radio is configured as a server, it transmits a beacon at the beginning of each hop. Radios configured as clients default to a receive mode where they are scanning the available frequencies listening for a beacon from a server in their network.
  • Page 20 Number of times each packet is Attempts transmitted when Broadcast packets are being sent. Note: A setting of 0x00 selects 256 attempts. Americas: +1-800-492-2320 Embedded Wireless Solutions Support Center: Europe: +44-1628-858-940 http://ews-support.lairdtech.com Hong Kong: +852 2923 0610 www.lairdtech.com/ramp © Copyright 2017 Laird. All Rights Reserved...
  • Page 21 1 = Enable Auto Channel bit-2: RTS 0 = Disable RTS handshaking 1 = Enable RTS handshaking Americas: +1-800-492-2320 Embedded Wireless Solutions Support Center: Europe: +44-1628-858-940 http://ews-support.lairdtech.com Hong Kong: +852 2923 0610 www.lairdtech.com/ramp © Copyright 2017 Laird. All Rights Reserved...
  • Page 22 (200 µs per increment). This is only used when Auto Config is disabled. Americas: +1-800-492-2320 Embedded Wireless Solutions Support Center: Europe: +44-1628-858-940 http://ews-support.lairdtech.com Hong Kong: +852 2923 0610 www.lairdtech.com/ramp © Copyright 2017 Laird. All Rights Reserved...
  • Page 23 5-0 to be all input or all output 1 = Enable pairs with bits 5-0 set bit-6: All Inputs Americas: +1-800-492-2320 Embedded Wireless Solutions Support Center: Europe: +44-1628-858-940 http://ews-support.lairdtech.com Hong Kong: +852 2923 0610 www.lairdtech.com/ramp © Copyright 2017 Laird. All Rights Reserved...
  • Page 24 Reserved. Do not modify bit-5: Reserved. Do not modify bit-4: Reserved. Do not modify bit-3: Reserved. Do not modify Americas: +1-800-492-2320 Embedded Wireless Solutions Support Center: Europe: +44-1628-858-940 http://ews-support.lairdtech.com Hong Kong: +852 2923 0610 www.lairdtech.com/ramp © Copyright 2017 Laird. All Rights Reserved...
  • Page 25 Broadcast Report 0 = Disable Broadcast Report 1 = Reports RSSI on Broadcast packets received Americas: +1-800-492-2320 Embedded Wireless Solutions Support Center: Europe: +44-1628-858-940 http://ews-support.lairdtech.com Hong Kong: +852 2923 0610 www.lairdtech.com/ramp © Copyright 2017 Laird. All Rights Reserved...
  • Page 26 API Control 0xC1 0x01- 0x00 Settings are: Americas: +1-800-492-2320 Embedded Wireless Solutions Support Center: Europe: +44-1628-858-940 http://ews-support.lairdtech.com Hong Kong: +852 2923 0610 www.lairdtech.com/ramp © Copyright 2017 Laird. All Rights Reserved...
  • Page 27 1-2 packet times: 0x01 1-4 packet times: 0x03 1-8 packet times: 0x07 1-16 packet times: 0x0F 1-32 packet times: 0x1F Americas: +1-800-492-2320 Embedded Wireless Solutions Support Center: Europe: +44-1628-858-940 http://ews-support.lairdtech.com Hong Kong: +852 2923 0610 www.lairdtech.com/ramp © Copyright 2017 Laird. All Rights Reserved...
  • Page 28 1 = GIO_2 is initialized High at boot bit 2: GIO_3 Initialize 0 = GIO_3 is initialized Low at boot Americas: +1-800-492-2320 Embedded Wireless Solutions Support Center: Europe: +44-1628-858-940 http://ews-support.lairdtech.com Hong Kong: +852 2923 0610 www.lairdtech.com/ramp © Copyright 2017 Laird. All Rights Reserved...
  • Page 29: Configuring The Rm024

    RF packets are not queued and are not sent to the host immediately. AT Commands sent to the RM024 must still adhere to the interface guidelines specified by the Interface Timeout and RF Packet Size. For this reason, standard terminal emulators, such as HyperTerminal, cannot be used to configure the RM024.
  • Page 30 User Guide On-the-Fly Control Commands The RM024 transceiver contains memory that holds many of the parameters that control the transceiver operation. Using the On-the-Fly command set allows many of these parameters to be viewed and changed during system operation. Because the memory these commands affect is dynamic, when the transceiver is reset, these parameters revert back to the settings stored in the EEPROM.
  • Page 31: Utility Commands

    RF. Command: <0x41> <0x54> <0x2B> <0x2B> <0x2B> <0x0D> Number of Bytes Returned: Response: <0xCC> <0x43> <0x4F> <0x4D> Americas: +1-800-492-2320 Embedded Wireless Solutions Support Center: Europe: +44-1628-858-940 http://ews-support.lairdtech.com Hong Kong: +852 2923 0610 www.lairdtech.com/ramp © Copyright 2017 Laird. All Rights Reserved...
  • Page 32 <RES> = 0x00 = 20 0x01 = 21 0x02 = 22 0x03 = 23 <Timer_H/TIMER_L> = 0x0001 - 0xFFFF Americas: +1-800-492-2320 Embedded Wireless Solutions Support Center: Europe: +44-1628-858-940 http://ews-support.lairdtech.com Hong Kong: +852 2923 0610 www.lairdtech.com/ramp © Copyright 2017 Laird. All Rights Reserved...
  • Page 33: Status Commands

    EEPROM, this bit will always be set. The sleep timer will constantly be calibrated. Command: <0xCC> <0x00> <0x01> Number of Bytes Returned: Response: <0xCC> <Response[32bits]> Americas: +1-800-492-2320 Embedded Wireless Solutions Support Center: Europe: +44-1628-858-940 http://ews-support.lairdtech.com Hong Kong: +852 2923 0610 www.lairdtech.com/ramp © Copyright 2017 Laird. All Rights Reserved...
  • Page 34 <0xCC> <0x8F> <Control> <NumRuns> Number of Bytes Returned: Response: <0xCC> <0x01> Bing Response Stream: <0xCC> <Bin#> <RSSI_1> <RSSI_2> Americas: +1-800-492-2320 Embedded Wireless Solutions Support Center: Europe: +44-1628-858-940 http://ews-support.lairdtech.com Hong Kong: +852 2923 0610 www.lairdtech.com/ramp © Copyright 2017 Laird. All Rights Reserved...
  • Page 35: Command Descriptions

    <Firmware> = Radio Firmware version <Status> = 0x02: Server = 0x03: Clients In Range = 0x01: Client not In Range Americas: +1-800-492-2320 Embedded Wireless Solutions Support Center: Europe: +44-1628-858-940 http://ews-support.lairdtech.com Hong Kong: +852 2923 0610 www.lairdtech.com/ramp © Copyright 2017 Laird. All Rights Reserved...
  • Page 36 <0xCC> <0x0A> <Location> Number of Bytes Returned: Response: <0xCC> <Value> Parameter Range: <Location>: [Dependant of parameter] <Value>: 0x00-0xFF Americas: +1-800-492-2320 Embedded Wireless Solutions Support Center: Europe: +44-1628-858-940 http://ews-support.lairdtech.com Hong Kong: +852 2923 0610 www.lairdtech.com/ramp © Copyright 2017 Laird. All Rights Reserved...
  • Page 37 0x00 - 0xFF corresponding to the 3 LSBs of the destination MAC Address. MAC3 is the LSB. Americas: +1-800-492-2320 Embedded Wireless Solutions Support Center: Europe: +44-1628-858-940 http://ews-support.lairdtech.com Hong Kong: +852 2923 0610 www.lairdtech.com/ramp © Copyright 2017 Laird. All Rights Reserved...
  • Page 38 The OEM host issues this command to write the API Control byte to enable or disable the API features. Command: <0xCC> <0x17> <API Control> Number of Bytes Returned: Response: <0xCC> <API Control> Americas: +1-800-492-2320 Embedded Wireless Solutions Support Center: Europe: +44-1628-858-940 http://ews-support.lairdtech.com Hong Kong: +852 2923 0610 www.lairdtech.com/ramp © Copyright 2017 Laird. All Rights Reserved...
  • Page 39 11: 512 decimation rate (12 bits resolution) <Data bits 3-0>= <Channel> 0000: AD/In (GIO_7) 1100: GND 1101: Positive Voltage Reference Americas: +1-800-492-2320 Embedded Wireless Solutions Support Center: Europe: +44-1628-858-940 http://ews-support.lairdtech.com Hong Kong: +852 2923 0610 www.lairdtech.com/ramp © Copyright 2017 Laird. All Rights Reserved...
  • Page 40 RM024-x50-x or +21dBm for RM024-x125-x. Command: <0xCC> <0x25><Max Pwr> Number of Bytes Returned: Response: 0xCC <Max Pwr> Americas: +1-800-492-2320 Embedded Wireless Solutions Support Center: Europe: +44-1628-858-940 http://ews-support.lairdtech.com Hong Kong: +852 2923 0610 www.lairdtech.com/ramp © Copyright 2017 Laird. All Rights Reserved...
  • Page 41 <Length> = Length of data to be written <Data> = Data to be written <Last byte> = Value of last byte written Americas: +1-800-492-2320 Embedded Wireless Solutions Support Center: Europe: +44-1628-858-940 http://ews-support.lairdtech.com Hong Kong: +852 2923 0610 www.lairdtech.com/ramp © Copyright 2017 Laird. All Rights Reserved...
  • Page 42: Serial Firmware Upgrades

    OEM to program the FW upgrade through a microcontroller. Upgrade of the FW over the air is not supported on the RM024. The firmware upgrade procedure will not affect the radio EEPROM settings except to update the version number.
  • Page 43: Upgrading Fw Commands

    Figure 1: Upgrading firmware in Laird Configuration Utility Upgrading FW Commands These commands are used to upgrade the FW on the RM024; these commands are only valid on FW version 1.3 and above. Command Descriptions Write Flash This command is used to write an encrypted binary file to the reserve flash.
  • Page 44 Command: <0xCC> <0xC6> Number of Bytes Returned: Response: Parameter Range: <0xCC> <0xC6> Americas: +1-800-492-2320 Embedded Wireless Solutions Support Center: Europe: +44-1628-858-940 http://ews-support.lairdtech.com Hong Kong: +852 2923 0610 www.lairdtech.com/ramp © Copyright 2017 Laird. All Rights Reserved...
  • Page 45: Process To Manually Upgrade Rm024

    <Data>: Contents of Flash Process to Manually Upgrade RM024 By using the above AT commands, it is possible to upgrade a RM024 over the UART from a microcontroller or other device. To do this, follow these basic steps: 1. Make sure the OEM host has a copy of an encrypted binary firmware upgrade files.
  • Page 46: Api Operation

    API O PERATION API Operation is a powerful alternative to the default transparent operation of the RM024 and provides dynamic packet accounting abilities to the OEM host without requiring extensive programming by the OEM host. API operation utilizes specific packet formats. The API features can be used in any combination that suits the OEM’s specific needs and can be different between radios operating on the same network.
  • Page 47: Api Transmit Packet

    (Figure Figure 4: Transmit API Packet Format Americas: +1-800-492-2320 Embedded Wireless Solutions Support Center: Europe: +44-1628-858-940 http://ews-support.lairdtech.com Hong Kong: +852 2923 0610 www.lairdtech.com/ramp © Copyright 2017 Laird. All Rights Reserved...
  • Page 48: Related Documents And Files

    Setting the destination address of 0xFF 0xFF 0xFF broadcasts the packet to all available transceivers in the network. ELATED OCUMENTS AND ILES The following additional RM024 technical documents are also available from the RM024 product page under the Documentation tab: ...

Table of Contents