Chirp sensor group descriptor structure. More...

#include <soniclib.h>

Public Attributes
ch_dev_t *	device [CHIRP_MAX_NUM_SENSORS]

uint16_t	i2c_drv_flags

uint32_t	io_bus_speed_hz

ch_io_complete_callback_t	io_complete_callback

ch_io_int_callback_t	io_int_callback

uint8_t	num_buses

uint8_t	num_connected [CHIRP_NUM_BUSES]

uint8_t	num_ports

uint32_t	op_frequency

uint32_t	pmut_clock_freq

uint16_t	pretrig_delay_us

chdrv_queue_t	queue [CHIRP_NUM_BUSES]

uint16_t	rtc_cal_pulse_ms

ch_rtc_cal_t	rtc_cal_type

uint8_t	sensor_count

uint8_t	sensor_int_pin

uint8_t	sensor_trig_pin

ch_group_status_t	status

Detailed Description

Chirp sensor group descriptor structure.

Note: The CHIRP_MAX_NUM_SENSORS and CHIRP_NUM_BUSES symbols must be defined by the user. Normally this is done in the chirp_board_config.h header file that is part of the board support package.

Member Data Documentation

◆ device

ch_dev_t* ch_group_t::device[CHIRP_MAX_NUM_SENSORS]

Array of pointers to ch_dev_t structures for individual sensors

◆ i2c_drv_flags

uint16_t ch_group_t::i2c_drv_flags

Flags for special I2C handling by Chirp driver, from chbsp_get_i2c_info()

◆ io_bus_speed_hz

uint32_t ch_group_t::io_bus_speed_hz

I/O bus speed, in Hz

◆ io_complete_callback

ch_io_complete_callback_t ch_group_t::io_complete_callback

Addr of routine to call when non-blocking I/O completes

◆ io_int_callback

ch_io_int_callback_t ch_group_t::io_int_callback

Addr of routine to call when sensor interrupts

◆ num_buses

uint8_t ch_group_t::num_buses

Number of SPI/I2C buses on this board

◆ num_connected

uint8_t ch_group_t::num_connected[CHIRP_NUM_BUSES]

Array of counters for connected sensors per bus

◆ num_ports

uint8_t ch_group_t::num_ports

Number of ports (max possible sensor connections)

◆ op_frequency

uint32_t ch_group_t::op_frequency

group nominal acoustic operating freq, if set

◆ pmut_clock_freq

uint32_t ch_group_t::pmut_clock_freq

group PMUT clock frequency, if used (16 x op freq)

◆ pretrig_delay_us

uint16_t ch_group_t::pretrig_delay_us

Pre-trigger delay for rx-only sensors (in us)

◆ queue

chdrv_queue_t ch_group_t::queue[CHIRP_NUM_BUSES]

Array of SPI/I2C non-blocking transaction queues (one per bus)

◆ rtc_cal_pulse_ms

uint16_t ch_group_t::rtc_cal_pulse_ms

Real-time clock calibration pulse length (in ms)

◆ rtc_cal_type

ch_rtc_cal_t ch_group_t::rtc_cal_type

Type of RTC calibration used by sensors

◆ sensor_count

uint8_t ch_group_t::sensor_count

Number of sensors detected

◆ sensor_int_pin

uint8_t ch_group_t::sensor_int_pin

Sensor interrupt pin (1 or 2)

◆ sensor_trig_pin

uint8_t ch_group_t::sensor_trig_pin

Sensor h/w trigger pin (1 or 2)

◆ status

ch_group_status_t ch_group_t::status

Group initialization status

The documentation for this struct was generated from the following file:

invn/soniclib/soniclib.h

Public Attributes