amrangle  2.0.0.0
amrangle.h
Go to the documentation of this file.
1 /****************************************************************************
2 ** Copyright (C) 2020 MikroElektronika d.o.o.
3 ** Contact: https://www.mikroe.com/contact
4 **
5 ** Permission is hereby granted, free of charge, to any person obtaining a copy
6 ** of this software and associated documentation files (the "Software"), to deal
7 ** in the Software without restriction, including without limitation the rights
8 ** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 ** copies of the Software, and to permit persons to whom the Software is
10 ** furnished to do so, subject to the following conditions:
11 ** The above copyright notice and this permission notice shall be
12 ** included in all copies or substantial portions of the Software.
13 **
14 ** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15 ** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16 ** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17 ** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18 ** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19 ** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20 ** USE OR OTHER DEALINGS IN THE SOFTWARE.
21 ****************************************************************************/
22 
28 #ifndef AMRANGLE_H
29 #define AMRANGLE_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "mikrosdk_version.h"
36 
37 #ifdef __GNUC__
38 #if mikroSDK_GET_VERSION < 20800ul
39 #include "rcu_delays.h"
40 #else
41 #include "delays.h"
42 #endif
43 #endif
44 
45 #include "drv_digital_out.h"
46 #include "drv_digital_in.h"
47 #include "drv_spi_master.h"
48 #include "drv_analog_in.h"
49 #include "math.h"
50 
71 #define AMRANGLE_ARM_TOOLCHAIN 0x00
72 
77 #define AMRANGLE_PIC_TOOLCHAIN 0x01
78  // sel_toolchain
80 
95 #define AMRANGLE_GAIN_CONTROL_EN 0x01
96 
101 #define AMRANGLE_GAIN_CONTROL_DIS 0x00
102  // gain_control
104 
119 #define AMRANGLE_POWER_DOWN_EN 0x01
120 
125 #define AMRANGLE_POWER_DOWN_DIS 0x00
126  // pd_state
128 
143 #define AMRANGLE_MAP_MIKROBUS( cfg, mikrobus ) \
144  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
145  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
146  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
147  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
148  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
149  cfg.gc = MIKROBUS( mikrobus, MIKROBUS_RST ); \
150  cfg.pd = MIKROBUS( mikrobus, MIKROBUS_PWM )
151  // amrangle_map // amrangle
154 
159 typedef struct
160 {
161  // Output pins
162 
163  digital_out_t gc;
164  digital_out_t pd;
166  // Modules
167 
168  analog_in_t adc;
170  spi_master_t spi;
172  pin_name_t chip_select;
174 } amrangle_t;
175 
180 typedef struct
181 {
182  // Communication gpio pins
183 
184  pin_name_t miso;
185  pin_name_t mosi;
186  pin_name_t sck;
187  pin_name_t cs;
189  // Additional gpio pins
190 
191  pin_name_t an;
192  pin_name_t gc;
193  pin_name_t pd;
195  // static variable
196 
197  uint32_t spi_speed;
198  spi_master_mode_t spi_mode;
199  spi_master_chip_select_polarity_t cs_polarity;
201  analog_in_resolution_t resolution;
202  float vref;
205 
210 typedef enum
211 {
213  AMRANGLE_ERROR = -1
214 
216 
235 void amrangle_cfg_setup ( amrangle_cfg_t *cfg, uint8_t sel_toolchain );
236 
252 
264 
275 
288 err_t amrangle_read_vtp_voltage ( amrangle_t *ctx, float *vtp_volts );
289 
304 
317 void amrangle_gain_control_mode ( amrangle_t *ctx, uint8_t gain_control );
318 
330 void amrangle_power_down_pin ( amrangle_t *ctx, uint8_t pd_state );
331 
332 #ifdef __cplusplus
333 }
334 #endif
335 #endif // AMRANGLE_H
336  // amrangle
338 
339 // ------------------------------------------------------------------------ END
amrangle_t::adc
analog_in_t adc
Definition: amrangle.h:168
amrangle_read_vtp_temp
float amrangle_read_vtp_temp(amrangle_t *ctx)
AMR Angle read temperature function.
amrangle_t
AMR Angle Click context object.
Definition: amrangle.h:160
AMRANGLE_ERROR
@ AMRANGLE_ERROR
Definition: amrangle.h:213
AMRANGLE_OK
@ AMRANGLE_OK
Definition: amrangle.h:212
amrangle_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: amrangle.h:198
amrangle_cfg_t::sck
pin_name_t sck
Definition: amrangle.h:186
amrangle_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: amrangle.h:199
amrangle_cfg_t::gc
pin_name_t gc
Definition: amrangle.h:192
amrangle_cfg_t::spi_speed
uint32_t spi_speed
Definition: amrangle.h:197
amrangle_cfg_t::vref
float vref
Definition: amrangle.h:202
amrangle_cfg_t::miso
pin_name_t miso
Definition: amrangle.h:184
amrangle_cfg_t::mosi
pin_name_t mosi
Definition: amrangle.h:185
amrangle_t::gc
digital_out_t gc
Definition: amrangle.h:163
amrangle_return_value_t
amrangle_return_value_t
AMR Angle Click return value data.
Definition: amrangle.h:211
amrangle_cfg_t::cs
pin_name_t cs
Definition: amrangle.h:187
amrangle_t::spi
spi_master_t spi
Definition: amrangle.h:170
amrangle_angle_read
float amrangle_angle_read(amrangle_t *ctx)
AMR Angle read angle function.
amrangle_read_vtp_voltage
err_t amrangle_read_vtp_voltage(amrangle_t *ctx, float *vtp_volts)
AMR Angle read vtp voltage function.
amrangle_t::chip_select
pin_name_t chip_select
Definition: amrangle.h:172
amrangle_power_down_pin
void amrangle_power_down_pin(amrangle_t *ctx, uint8_t pd_state)
AMR Angle power down function.
amrangle_cfg_t::an
pin_name_t an
Definition: amrangle.h:191
amrangle_cfg_t
AMR Angle Click configuration object.
Definition: amrangle.h:181
amrangle_gain_control_mode
void amrangle_gain_control_mode(amrangle_t *ctx, uint8_t gain_control)
AMR Angle gain control mode function.
amrangle_init
err_t amrangle_init(amrangle_t *ctx, amrangle_cfg_t *cfg)
AMR Angle initialization function.
amrangle_cfg_t::resolution
analog_in_resolution_t resolution
Definition: amrangle.h:201
amrangle_t::pd
digital_out_t pd
Definition: amrangle.h:164
amrangle_cfg_setup
void amrangle_cfg_setup(amrangle_cfg_t *cfg, uint8_t sel_toolchain)
AMR Angle configuration object setup function.
amrangle_default_cfg
void amrangle_default_cfg(amrangle_t *ctx)
AMR Angle default configuration function.
amrangle_cfg_t::pd
pin_name_t pd
Definition: amrangle.h:193