XM112 Module Software. User Guide

Transcription

1 XM112 Module Software User Guide

2 XM112 Module Software User Guide Author: Acconeer Version 0.3: Acconeer AB Page 2 of by Acconeer All rights reserved

3 Table of Contents 1 Introduction Installing module software image Install Tools Upgrade Procedure Physical Interfaces UART protocol Read Request Read Response Write Request Write Response Buffer Read Request Buffer Read Response Buffer Streaming Payload SPI Protocol SPI Read Request Write Request Buffer Read Request SPI Timing I2C Protocol Map General Control and Status s Common Sweep Parameter s Common Result s Power Bin s Envelope s IQ Data s Distance Peak Fixed s Examples Reading Distances Reading Power Bin Data (UART Streaming) Disclaimer Page 3 of by Acconeer All rights reserved

4 1 Introduction The XM112 module software enable register-based access to radar functionality from external devices connected to the XM112 module. The module software is delivered as an image. Typical usages of the XM112 module software are: 1. Integration of radar functionality in your product to decrease development cost and time to market. 2. Module evaluation and algorithm development in Python together with the Acconeer Python Exploration Tool that is available for download on GitHub. The XM112 module software provides a rich register-based API that can be accessed over UART, SPI and I2C 1. The module software will initially support the following services and detectors: - Power Bin Service - Envelope Service - IQ Data Service - Distance peak distance with fixed threshold Support for more detectors is planned for future module software releases. A software image comprising the module software is available for download from Acconeer s website. See chapter 2, Installing, for instruction on how to install the module software. For an introduction to Acconeer s technology and product offer refer to Introduction to Acconeer s sensor technology, available at the Acconeer website. 1 The I2C support is planned but is not available at the time of writing. Page 4 of by Acconeer All rights reserved

5 2 Installing module software image 2.1 Install Tools In order to update the software on the XM112 module we recommend using the BOSSA application. The application along with instructions are available at The application is available for Linux, Windows and Apple Mac OS X. 2.2 Upgrade Procedure The SAM E70 CPU have a ROM boot loader that is used during the software update. In order to enter this boot mode the internal flash must be erased with the following sequence: 1. Connect the XB112 together with XM112 to your PC with a micro USB cable to the USB1/Power/UART0 connector 2. Press and hold the ERASE button on the board 3. Press the NRST button (still holding the ERASE button) 4. Release the NRST button 5. Release the ERASE button The internal flash of the SAM E70 is now erased and the ROM boot code is executing. Start the BOSSA application 1. Select correct port, e.g. /dev/ttyusb0 if running on Linux or COM1 if running on Windows. 2. Press Browse and select the new firmware file 3. Make sure that Erase all and Boot to flash is selected 4. Press Write Note: The Bossa application may have to be restarted between flashing sessions Page 5 of by Acconeer All rights reserved

6 3 Physical Interfaces 3.1 UART protocol Read Request Start marker 0xCC Payload length 0xF8 = Read Request Address End Marker 0xCD Read Response Start marker 0xCC Payload length 0xF6 = Read Response Address value 4 bytes End Marker 0xCD Write Request Start marker 0xCC Payload length 0xF9 = Write Request Address value 4 bytes End Marker 0xCD Write Response Start marker 0xCC Payload length 0xF5 = Write Response Address value 4 bytes End Marker 0xCD Buffer Read Request Start marker 0xCC Payload length 0xFA = Buffer Read Request Buffer Index Buffer Offset End Marker 0xCD Buffer Read Response Page 6 of by Acconeer All rights reserved

7 Start marker 0xCC Payload length 0xF7 = Buffer Read Response Buffer Index Buffer data End Marker 0xCD Buffer Streaming Payload The streaming mode is primarily intended for communication with the Acconeer Python exploration package that is available on GitHub. The format of the steaming payload may be updated in a nonbackward compatible way in future versions of the module software. Start marker 0xCC Packet length 0xFE = Buffer Streaming Payload Streaming Payload End Marker 0xCD Streaming Payload Result_info marker Result_info length Result_info Streaming buffer marker Streaming buffer length Streaming buffer 0xFD 0xFE The result info and the streaming buffer are the outputs from the Acconeer Service APIs encoded in little endian format. The result info contains a sequence number encoded as a 32-bit integer. More data may be added in future versions of the module software. The format of the streaming buffer depends on the service. Service PowerBin Envelope IQ Streaming buffer format Array of 32-bit floats Array of 16-bit unsigned integers Array of complex float (2 x 32bits). Can also be interpreted as an array of floats where the real and imaginary parts of the complex numbers are interleaved. Page 7 of by Acconeer All rights reserved

8 3.2 SPI Protocol SPI Read Request Address Dummy bytes Toggle SS, wait 50 ms value 0xF8 MISO 4 bytes Write Request Address Dummy bytes Toggle SS, wait 50 ms value 0xF9 4 bytes Buffer Read Request Buffer Index Dummy bytes Toggle SS, wait 50 ms Buffer data 0xFA MISO Page 8 of by Acconeer All rights reserved

9 3.2.4 SPI Timing A 50 ms delay must be inserted between the SPI command and data. Figure 1- SPI timing chart 3.3 I2C Protocol The I2C protocol will be supported in a later release of the XM112 module software. Page 9 of by Acconeer All rights reserved

10 4 Map 4.1 General Control and Status s Address 8-bit Read/ Write Name Function Values 0x02 R/W MODE_SELECTION Selects one of the supported modes for the sensor module. 0x03 W MAIN_CONTROL Main Control. This register is used to control the operation mode of the sensor module. 1: power_bin, 2: envelope, 3: iq, 256: distance_peak_fixed 0: stop, 1: create_configuration, 2: activate_measurement, 3: create_and_activate, 4: clear_status 0x05 R/W STREAMING_CONTROL Controls the streaming functionality. 0: no_streaming, 1: uart_streaming 0x06 R STATUS Sensor Module Status. This register is a bit mask with current status of the Sensor Module. 0x07 R/W UART_BAUDRATE Controls the baudrate for the UART interface : default, : max 0x10 R PRODUCT_IDENTIFICAT ION Sensor Module Identification register : xm112 0x11 R PRODUCT_VERSION Product version register 01:01 0x28 R/W SYSTEM_POWER_STAT E Sensor module power state configuration. 0: running, 1: sleep Page 10 of by Acconeer All rights reserved

11 4.2 Common Sweep Parameter s 0x20 R/W START_RANGE Start range in mm of the measurement. 0x21 R/W RANGE_LENGTH Length of the range in mm. 0x22 R/W REPETITION_MODE Repetition mode for the measurement. 1: fix_frequency 0x23 R/W FREQUENCY The measurement frequency in mhz (1/1000 Hz). 0x24 R/W GAIN Receiver gain, where 0 is the lowest gain and 1000 the highest. 0x25 R/W POWER_SAVE_MODE Sensor power save mode. 0: a, 1: b, 2: c, 3: d 0x26 R/W TX_DISABLE Used to measure RX noise floor and to support TX off spectrum regulation measurements. 0x27 R/W DECREASE_TX_EMISSIO N Used for spectrum regulation measurements. 4.3 Common Result s 0xA0 R SEQUENCE_NUMBER Sequence number of the data. 0xE9 R OUTPUT_DATA_BUFFE R_LENGTH Length of data in output buffer. 4.4 Power Bin s Address 8-bit Read/ Write 0x40 R/W PB_BIN_COUNT Name Function Values Number of requested power bins 0x80 R PB_FREE_SPACE_ABS_OFFSET Sensor specific offset error 0x81 R PB_ACTUAL_START None 0x82 R PB_ACTUAL_LENGTH None 0x83 R PB_ACTUAL_BIN_COUNT None Page 11 of by Acconeer All rights reserved

12 4.5 Envelope s Address 8-bit Read/ Write 0x0B R/W PROFILE_SELECTIO N 0x40 R/W ENV_PARAM_RUN_ FACTOR 0x41 R/W ENV_PARAM_COM P_PHASE 0x80 0x81 0x82 0x83 R R R R Name Function Values ENV_FREE_SPACE_ ABS_OFFSET ENV_ACTUAL_STAR T ENV_ACTUAL_LEN GTH ENV_DATA_LENGT H TBD The running average factor is the factor of which the most recent sweep is weighed against previous sweeps. Value between 0 and 1000 where 0 means that no history is weighed in, i.e filtering is effectively disabled. The compensate phase flag indicates whether a phase compensation is done during filtering of data. Using phase compensation results in more stable data but can suppress detection of fast moving reflections. None None None None 0: max_depth_resolution, 1: max_snr 0: use phase compensation 1: no phase compensation 4.6 IQ Data s Read/ Write Name Function Values 0x40 R/W IQ_PARAM_RUN_FACTOR None 0x80 R IQ_FREE_SPACE_ABS_OFFSET None 0x81 R IQ_ACTUAL_START None 0x82 R IQ_ACTUAL_LENGTH None 0x83 R IQ_DATA_LENGTH None Page 12 of by Acconeer All rights reserved

13 4.7 Distance Peak Fixed s Address 8-bit read/ Write Name Function Values 0x0B R/W PROFILE_SELECTION TBD 0: max_depth_resolution, 1: max_snr 0x40 R/W PEAK_PARAM_RUN_FACTOR The running average factor is the factor of which the most recent sweep is weighed against previous sweeps. Value between 0 and 1000 where 0 means that no history is weighed in, i.e filtering is effectively disabled. 0x42 R/W PEAK_PARAM_THRESHOLD Threshold value. _AMPLITUDE 0x44 R/W PEAK_PARAM_SORT_BY Set sort reflection by amplitude or distance. 0x80 R PEAK_FREE_SPACE_ABS_OFFSET None 0x81 R PEAK_ACTUAL_START None 0x82 R PEAK_ACTUAL_LENGTH None 0xA1 R PEAK_REFLECTION_COUNT Number of detected peaks. 0xA2 R PEAK_REFLECTION_1_DISTANCE Distance in mm to first peak. 0xA3 R PEAK_REFLECTION_1_AMPLITUDE Amplitude of first peak. 0xA4 R PEAK_REFLECTION_2_DISTANCE Distance in mm to second peak. 0xA5 R PEAK_REFLECTION_2_AMPLITUDE Amplitude of second peak. 0xA6 R PEAK_REFLECTION_3_DISTANCE Distance in mm to third peak. 0xA7 R PEAK_REFLECTION_3_AMPLITUDE Amplitude of third peak. 0xA8 R PEAK_REFLECTION_4_DISTANCE Distance in mm to fourth peak. 0xA9 R PEAK_REFLECTION_4_AMPLITUDE Amplitude of fourth peak. 0: distance, 1: amplitude Page 13 of by Acconeer All rights reserved

14 5 Examples 5.1 Reading Distances Page 14 of by Acconeer All rights reserved

15 5.2 Reading Power Bin Data (UART Streaming) Page 15 of by Acconeer All rights reserved

16 Disclaimer The information herein is believed to be correct as of the date issued. Acconeer AB ( Acconeer ) will not be responsible for damages of any nature resulting from the use or reliance upon the information contained herein. Acconeer makes no warranties, expressed or implied, of merchantability or fitness for a particular purpose or course of performance or usage of trade. Therefore, it is the user s responsibility to thoroughly test the product in their particular application to determine its performance, efficacy and safety. Users should obtain the latest relevant information before placing orders. Unless Acconeer has explicitly designated an individual Acconeer product as meeting the requirement of a particular industry standard, Acconeer is not responsible for any failure to meet such industry standard requirements. Unless explicitly stated herein this document Acconeer has not performed any regulatory conformity test. It is the user s responsibility to assure that necessary regulatory conditions are met and approvals have been obtained when using the product. Regardless of whether the product has passed any conformity test, this document does not constitute any regulatory approval of the user s product or application using Acconeer s product. Nothing contained herein is to be considered as permission or a recommendation to infringe any patent or any other intellectual property right. No license, express or implied, to any intellectual property right is granted by Acconeer herein. Acconeer reserves the right to at any time correct, change, amend, enhance, modify, and improve this document and/or Acconeer products without notice. This document supersedes and replaces all information supplied prior to the publication hereof. Page 16 of by Acconeer All rights reserved