Chirp SonicLib  2.1.0
ch101_sonicsync.h
Go to the documentation of this file.
1 
13 /*
14  * Copyright © 2016-2019, Chirp Microsystems. All rights reserved.
15  *
16  * Chirp Microsystems CONFIDENTIAL
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21  * DISCLAIMED. IN NO EVENT SHALL CHIRP MICROSYSTEMS BE LIABLE FOR ANY
22  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
25  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  *
29  * You can contact the authors of this program by email at support@chirpmicro.com
30  * or by mail at 2560 Ninth Street, Suite 220, Berkeley, CA 94710.
31  */
32 
33 #ifndef CH101_SONICSYNC_H_
34 #define CH101_SONICSYNC_H_
35 
36 #include "ch101.h"
37 #include "soniclib.h"
38 #include <stdint.h>
39 
40 /* SmartSonic SonicSync firmware registers */
41 #define CH101_SONICSYNC_REG_OPMODE 0x01
42 #define CH101_SONICSYNC_REG_TICK_INTERVAL 0x02
43 #define CH101_SONICSYNC_REG_PERIOD 0x05
44 #define CH101_SONICSYNC_REG_MAX_RANGE 0x07
45 #define CH101_SONICSYNC_REG_TIME_PLAN 0x09
46 #define CH101_SONICSYNC_REG_STAT_RANGE 0x12
47 #define CH101_SONICSYNC_REG_STAT_COEFF 0x13
48 #define CH101_SONICSYNC_REG_READY 0x14
49 #define CH101_SONICSYNC_REG_TOF_SF 0x16
50 #define CH101_SONICSYNC_REG_TOF 0x18
51 #define CH101_SONICSYNC_REG_AMPLITUDE 0x1A
52 #define CH101_SONICSYNC_REG_CAL_TRIG 0x06
53 #define CH101_SONICSYNC_REG_CAL_RESULT 0x0A
54 #define CH101_SONICSYNC_REG_DATA 0x1C
55 
56 #define CH101_SONICSYNC_MAX_SAMPLES (150)
57 
58 #define CH101_SONICSYNC_READY_FREQ_LOCKED (0x02 | 0x04)
59 
60 extern const char * ch101_sonicsync_master_version; // version string in fw .c file
61 extern const char * ch101_sonicsync_slave_version; // version string in fw .c file
62 extern const uint8_t ch101_sonicsync_master_fw[CH101_FW_SIZE];
63 extern const uint8_t ch101_sonicsync_slave_fw[CH101_FW_SIZE];
64 
65 uint16_t get_ch101_sonicsync_master_fw_ram_init_addr(void);
66 uint16_t get_ch101_sonicsync_master_fw_ram_init_size(void);
67 uint16_t get_ch101_sonicsync_slave_fw_ram_init_addr(void);
68 uint16_t get_ch101_sonicsync_slave_fw_ram_init_size(void);
69 
70 const unsigned char * get_ram_ch101_sonicsync_master_init_ptr(void);
71 const unsigned char * get_ram_ch101_sonicsync_slave_init_ptr(void);
72 
73 uint8_t ch101_sonicsync_master_init(ch_dev_t *dev_ptr, ch_group_t *grp_ptr, uint8_t i2c_addr, uint8_t dev_num, uint8_t i2c_bus_index);
74 uint8_t ch101_sonicsync_slave_init(ch_dev_t *dev_ptr, ch_group_t *grp_ptr, uint8_t i2c_addr, uint8_t dev_num, uint8_t i2c_bus_index);
75 
76 uint8_t ch_sonicsync_get_locked_state(ch_dev_t *dev_ptr);
77 
78 #endif
Chirp SonicLib public API and support functions for Chirp ultrasonic sensors.
Internal definitions for the Chirp CH101 ultrasonic sensor.
Chirp sensor device structure.
Definition: soniclib.h:349
Chirp sensor group configuration structure.
Definition: soniclib.h:329