ldc1000  2.0.0.0
ldc1000.h
Go to the documentation of this file.
1 /*
2  * MikroSDK - MikroE Software Development Kit
3  * Copyright© 2020 MikroElektronika d.o.o.
4  *
5  * Permission is hereby granted, free of charge, to any person
6  * obtaining a copy of this software and associated documentation
7  * files (the "Software"), to deal in the Software without restriction,
8  * including without limitation the rights to use, copy, modify, merge,
9  * publish, distribute, sublicense, and/or sell copies of the Software,
10  * and to permit persons to whom the Software is furnished to do so,
11  * subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be
14  * included in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
22  * OR OTHER DEALINGS IN THE SOFTWARE.
23  */
24 
33 // ----------------------------------------------------------------------------
34 
35 #ifndef LDC1000_H
36 #define LDC1000_H
37 
42 #ifdef PREINIT_SUPPORTED
43 #include "preinit.h"
44 #endif
45 
46 #ifdef MikroCCoreVersion
47  #if MikroCCoreVersion >= 1
48  #include "delays.h"
49  #endif
50 #endif
51 
52 #include "drv_digital_in.h"
53 #include "drv_spi_master.h"
54 #include "math.h"
55 
56 // -------------------------------------------------------------- PUBLIC MACROS
67 #define LDC1000_MAP_MIKROBUS( cfg, mikrobus ) \
68  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
69  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
70  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
71  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
72  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
73 
79 #define LDC1000_RETVAL uint8_t
80 
81 #define LDC1000_OK 0x00
82 #define LDC1000_INIT_ERROR 0xFF
83 
89 #define LDC1000_CMD_ID 0x00
90 #define LDC1000_CMD_RPMAX 0x01
91 #define LDC1000_CMD_RPMIN 0x02
92 #define LDC1000_CMD_SENSORFREQ 0x03
93 #define LDC1000_CMD_LDCCONFIG 0x04
94 #define LDC1000_CMD_CLKCONFIG 0x05
95 #define LDC1000_CMD_THRESHILSB 0x06
96 #define LDC1000_CMD_THRESHIMSB 0x07
97 #define LDC1000_CMD_THRESLOLSB 0x08
98 #define LDC1000_CMD_THRESLOMSB 0x09
99 #define LDC1000_CMD_INTCONFIG 0x0A
100 #define LDC1000_CMD_PWRCONFIG 0x0B
101 #define LDC1000_CMD_STATUS 0x20
102 #define LDC1000_CMD_PROXLSB 0x21
103 #define LDC1000_CMD_PROXMSB 0x22
104 #define LDC1000_CMD_FREQCTRLSB 0x23
105 #define LDC1000_CMD_FREQCTRMID 0x24
106 #define LDC1000_CMD_FREQCTRMSB 0x25
107 
113 #define LDC1000_RPMAX_38_785K 0x11
114 #define LDC1000_RPMIN_2_39K 0x3B
115 #define LDC1000_SENSORFREQ_N217_F20 0xD9
116 #define LDC1000_LDCCONFIG_A2V_T6144 0x0F
117 #define LDC1000_CLKCONFIG_EC_ET_ENABLE 0x02
118 #define LDC1000_PWRCONFIG_ACTIVE_MODE 0x01
119 #define LDC1000_CMD_SPI_READ 0x80
120 #define LDC1000_SENSITIVITY 100
121  // End group macro
124 // --------------------------------------------------------------- PUBLIC TYPES
133 typedef struct
134 {
135  digital_out_t cs;
136 
137  // Input pins
138 
139  digital_in_t int_pin;
140 
141  // Modules
142 
143  spi_master_t spi;
144  pin_name_t chip_select;
145 
146 } ldc1000_t;
147 
151 typedef struct
152 {
153  // Communication gpio pins
154 
155  pin_name_t miso;
156  pin_name_t mosi;
157  pin_name_t sck;
158  pin_name_t cs;
159 
160  // Additional gpio pins
161 
162  pin_name_t int_pin;
163 
164  // static variable
165 
166  uint32_t spi_speed;
167  uint8_t spi_mode;
168  spi_master_chip_select_polarity_t cs_polarity;
169 
170 } ldc1000_cfg_t;
171  // End types group
173 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
174 
179 #ifdef __cplusplus
180 extern "C"{
181 #endif
182 
192 
201 
210 
220 void ldc1000_write_byte ( ldc1000_t *ctx, uint8_t address, uint8_t input_data );
221 
230 uint8_t ldc1000_read_byte ( ldc1000_t *ctx, uint8_t address );
231 
240 
249 
258 
259 #ifdef __cplusplus
260 }
261 #endif
262 #endif // _LDC1000_H_
263  // End public_function group
266 
267 // ------------------------------------------------------------------------- END
ldc1000_read_byte
uint8_t ldc1000_read_byte(ldc1000_t *ctx, uint8_t address)
Byte read function.
ldc1000_cfg_t::spi_speed
uint32_t spi_speed
Definition: ldc1000.h:166
ldc1000_cfg_setup
void ldc1000_cfg_setup(ldc1000_cfg_t *cfg)
Config Object Initialization function.
ldc1000_get_int_input
uint8_t ldc1000_get_int_input(ldc1000_t *ctx)
Get interrupt pin input function.
ldc1000_cfg_t::int_pin
pin_name_t int_pin
Definition: ldc1000.h:162
ldc1000_t::spi
spi_master_t spi
Definition: ldc1000.h:143
ldc1000_t
Click ctx object definition.
Definition: ldc1000.h:134
LDC1000_RETVAL
#define LDC1000_RETVAL
Definition: ldc1000.h:79
ldc1000_cfg_t::mosi
pin_name_t mosi
Definition: ldc1000.h:156
ldc1000_cfg_t::miso
pin_name_t miso
Definition: ldc1000.h:155
ldc1000_get_proximity_data
uint16_t ldc1000_get_proximity_data(ldc1000_t *ctx)
Get proximity data function.
ldc1000_t::chip_select
pin_name_t chip_select
Definition: ldc1000.h:144
ldc1000_t::int_pin
digital_in_t int_pin
Definition: ldc1000.h:139
ldc1000_default_cfg
void ldc1000_default_cfg(ldc1000_t *ctx)
Click Default Configuration function.
ldc1000_cfg_t::cs
pin_name_t cs
Definition: ldc1000.h:158
ldc1000_cfg_t::sck
pin_name_t sck
Definition: ldc1000.h:157
ldc1000_t::cs
digital_out_t cs
Definition: ldc1000.h:135
ldc1000_get_inductance_data
float ldc1000_get_inductance_data(ldc1000_t *ctx)
Get inductance data function.
ldc1000_init
LDC1000_RETVAL ldc1000_init(ldc1000_t *ctx, ldc1000_cfg_t *cfg)
Initialization function.
ldc1000_write_byte
void ldc1000_write_byte(ldc1000_t *ctx, uint8_t address, uint8_t input_data)
Byte write function.
ldc1000_cfg_t
Click configuration structure definition.
Definition: ldc1000.h:152
ldc1000_cfg_t::spi_mode
uint8_t spi_mode
Definition: ldc1000.h:167
ldc1000_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: ldc1000.h:168