195 lines
8.7 KiB
C
195 lines
8.7 KiB
C
/*
|
|
* _____________________________________________________________________________
|
|
* Copyright (c) 2020-2021 InvenSense Inc. All rights reserved.
|
|
*
|
|
* This software, related documentation and any modifications thereto
|
|
* (collectively "Software") is subject to InvenSense and its licensors'
|
|
* intellectual property rights under U.S. and international copyright
|
|
* and other intellectual property rights laws.
|
|
*
|
|
* InvenSense and its licensors retain all intellectual property and proprietary
|
|
* rights in and to the Software and any use, reproduction, disclosure or
|
|
* distribution of the Software without an express license agreement from
|
|
* InvenSense is strictly prohibited.
|
|
*
|
|
* EXCEPT AS OTHERWISE PROVIDED IN A LICENSE AGREEMENT BETWEEN THE PARTIES, THE
|
|
* SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. EXCEPT AS OTHERWISE
|
|
* PROVIDED IN A LICENSE AGREEMENT BETWEEN THE PARTIES, IN NO EVENT SHALL
|
|
* INVENSENSE BE LIABLE FOR ANY DIRECT, SPECIAL, INDIRECT, INCIDENTAL, OR
|
|
* CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF
|
|
* USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
|
|
* TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
|
|
* OF THE SOFTWARE.
|
|
* _____________________________________________________________________________
|
|
*/
|
|
|
|
/*! \file app_config.h */
|
|
#ifndef APP_CONFIG_H
|
|
#define APP_CONFIG_H
|
|
|
|
#include "soniclib.h"
|
|
|
|
/*========================= Sensor Firmware Selection ===========================*/
|
|
|
|
/* Select sensor firmware to use
|
|
* The sensor firmware type is specified during the call to ch_init(), by
|
|
* giving the name (address) of the firmware initialization function that will
|
|
* be called. The CHIRP_SENSOR_FW_INIT_FUNC symbol is used to specify the
|
|
* init routine for the sensor firmware to be used.
|
|
*
|
|
* Uncomment ONE of the following lines to use that sensor firmware type.
|
|
* You must choose a firmware type that is appropriate for the sensor model
|
|
* you are using (CH101 or CH201).
|
|
*
|
|
* To use a different sensor firmware type than those listed here (for
|
|
* example, a new distribution from Chirp), simply define
|
|
* CHIRP_SENSOR_FW_INIT_FUNC to equal the name of the init routine for
|
|
* the new firmware.
|
|
*
|
|
* Short Range Firmware:
|
|
* CH101 sensor firmware with "sr" in the name, e.g. ch101_gpr_sr, is
|
|
* optimized for short range. The short range firmware has 4 times the
|
|
* resolution, but only 1/4 the maximum range. If you use this option, you
|
|
* should redefine the CHIRP_SENSOR_MAX_RANGE_MM symbol, below, to 250mm or
|
|
* less.
|
|
*/
|
|
|
|
/* CH101 GPR - general purpose rangefinding, standard range */
|
|
// #define CHIRP_SENSOR_FW_INIT_FUNC ch101_gpr_init
|
|
|
|
/* CH101 GPR NARROW - general purpose rangefinding, narrow FoV */
|
|
// #define CHIRP_SENSOR_FW_INIT_FUNC ch101_gpr_narrow_init
|
|
|
|
/* CH101 GPR SR - general purpose rangefinding, short range */
|
|
// #define CHIRP_SENSOR_FW_INIT_FUNC ch101_gpr_sr_init
|
|
|
|
/* CH101 GPR SR NARROW - general purpose rangefinding, short range, narrow FoV */
|
|
#define CHIRP_SENSOR_FW_INIT_FUNC ch101_gpr_sr_narrow_init
|
|
|
|
/* CH201 GPRMT - general purpose rangefinding / multi threshold */
|
|
// #define CHIRP_SENSOR_FW_INIT_FUNC ch201_gprmt_init
|
|
|
|
|
|
/*=========================== Sensor Configuration ===========================*/
|
|
|
|
/* Maximum detection range for the sensor
|
|
* This value will determine how long the sensor "listens" for an ultrasound
|
|
* signal. Note that the maximum possible range will vary depending on sensor
|
|
* model (CH101 vs. CH201) and sensor firmware type. If the value specified
|
|
* here is greater than the maximum possible range, the maximum possible range
|
|
* will be used.
|
|
*/
|
|
#define CHIRP_SENSOR_MAX_RANGE_MM (250) /* maximum range, in mm */
|
|
|
|
/* Static target rejection range
|
|
* This value specifies if static target rejection (STR) will be used. If
|
|
* CHIRP_SENSOR_STATIC_RANGE is non-zero, STR will be enabled and will apply
|
|
* to the specified number of samples at the beginning of a measurement.
|
|
*/
|
|
#define CHIRP_SENSOR_STATIC_RANGE (40) /* static target rejection sample
|
|
range, in samples (0=disabled) */
|
|
|
|
|
|
/*============================ Application Timing ============================*/
|
|
|
|
/* Define how often the application will get a new sample from the sensor(s)
|
|
* This macro defines the sensor measurement interval, in milliseconds.
|
|
*
|
|
* For sensors in triggered mode (CH_MODE_TRIGGERED_TX_RX or
|
|
* CH_MODE_TRIGGERED_RX_ONLY), the application will use a periodic timer to
|
|
* trigger a sensor measurement each time this period elapses.
|
|
*
|
|
* For sensors in free-running mode (CH_MODE_FREERUN), the application will
|
|
* set this period as the sensor's internal sample interval.
|
|
*/
|
|
|
|
#define MEASUREMENT_INTERVAL_MS (200)
|
|
|
|
|
|
/*================== Application Storage for Sensor Data ====================*/
|
|
|
|
/* Define how many samples per measurement are expected by this application
|
|
* The following macro is used to allocate array storage in the "chirp_data_t"
|
|
* structure, defined in main.c. That structure contains arrays for
|
|
* individual data values (I/Q or amplitude) that describe the raw samples
|
|
* within an ultrasound measurement.
|
|
*
|
|
* Because a Chirp CH201 sensor has more samples in each measurement than a
|
|
* CH101 device, the CH201 sample count is used here by default. If you are
|
|
* ONLY using CH101 devices with this application, you may redefine the
|
|
* following symbol to CH101_MAX_NUM_SAMPLES to use less memory.
|
|
*/
|
|
|
|
#define DATA_MAX_NUM_SAMPLES CH101_MAX_NUM_SAMPLES // use CH101 only
|
|
|
|
|
|
/*=============== Build Options for Amplitude Data Handling =================*/
|
|
|
|
/* The following build options control if and how the full amplitude data for
|
|
* all internal samples within an ultrasound measurement will be read and
|
|
* displayed. This data is separate from the standard range and simple target
|
|
* amplitude values that are normally output.
|
|
*
|
|
* Note that reading the full amplitude data is not required for most basic
|
|
* sensing applications - the reported range value, possibly combined with the
|
|
* simple target amplitude value, is typically all that is required. However,
|
|
* the full set of amplitude values may be read and analyzed for more advanced
|
|
* sensing or data capture needs.
|
|
*
|
|
* Comment or un-comment the various definitions, as appropriate.
|
|
*
|
|
* Define READ_AMPLITUDE_DATA to enable readout of the amplitude data.
|
|
* Define OUTPUT_AMPLITUDE_DATA to enable output of the amplitude data via the
|
|
* serial port, as ascii values, one per line.
|
|
*/
|
|
|
|
// #define READ_AMPLITUDE_DATA /* uncomment to readout amplitude data */
|
|
|
|
// #define OUTPUT_AMPLITUDE_DATA /* uncomment to output data in ascii */
|
|
|
|
|
|
/*================== Build Options for I/Q Data Handling ====================*/
|
|
|
|
/* The following build options control if and how the raw I/Q data is read
|
|
* from the device after each measurement cycle, in addition to the standard
|
|
* range and amplitude.
|
|
*
|
|
* Note that reading the I/Q data is not required for most basic sensing
|
|
* applications - the reported range value is typically all that is required.
|
|
* However, the full data set may be read and analyzed for more advanced
|
|
* sensing or data capture needs.
|
|
*
|
|
* Comment or un-comment the various definitions, as appropriate.
|
|
*
|
|
* Define READ_IQ_DATA to enable readout of the I/Q data.
|
|
*
|
|
* By default, this application will read the I/Q data in blocking mode
|
|
* (i.e. READ_IQ_BLOCKING is defined by default). The data will be read from
|
|
* the device and placed in the I/Q data array field in the application's
|
|
* chirp_data structure. Because the I/Q data is read in blocking mode, the
|
|
* call to ch_get_iq_data() will not return until the data has actually
|
|
* been copied from the device.
|
|
*
|
|
* If, however, READ_IQ_NONBLOCKING is defined instead, the I/Q data will be
|
|
* read in non-blocking mode. The ch_get_iq_data() call will return immediately,
|
|
* and a separate callback function will be called to notify the application
|
|
* when the read operation is complete.
|
|
*
|
|
* Finally, if OUTPUT_IQ_DATA_CSV is defined, the application will write the
|
|
* I/Q data values out through the serial port in ascii form as comma-separated
|
|
* numeric value pairs (Q,I). This can make it easier to take the data
|
|
* from the application and analyze it in a spreadsheet or other program.
|
|
*/
|
|
|
|
// #define READ_IQ_DATA /* uncomment this line to readout I/Q data */
|
|
|
|
// #define READ_IQ_BLOCKING /* use blocking mode when reading I/Q */
|
|
// #define READ_IQ_NONBLOCKING /* use non-blocking mode when reading I/Q */
|
|
|
|
// #define OUTPUT_IQ_DATA_CSV /* uncomment to output I/Q data in CSV format */
|
|
|
|
|
|
#endif /* APP_CONFIG_H */
|