mrangle  2.0.0.0
mrangle.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 MRANGLE_H
29 #define MRANGLE_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "drv_digital_out.h"
36 #include "drv_spi_master.h"
37 #include "math.h"
38 
39 
60 #define MRANGLE_MAP_MIKROBUS( cfg, mikrobus ) \
61  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
62  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
63  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
64  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
65  cfg.tce = MIKROBUS( mikrobus, MIKROBUS_RST ); \
66  cfg.pdn = MIKROBUS( mikrobus, MIKROBUS_PWM )
67  // mrangle_map // mrangle
70 
75 typedef struct
76 {
77  // Output pins
78  digital_out_t tce;
79  digital_out_t pdn;
81  // Modules
82  spi_master_t spi;
84  pin_name_t chip_select;
86  float vref;
88 } mrangle_t;
89 
94 typedef struct
95 {
96  // Communication gpio pins
97  pin_name_t miso;
98  pin_name_t mosi;
99  pin_name_t sck;
100  pin_name_t cs;
102  // Additional gpio pins
103  pin_name_t tce;
104  pin_name_t pdn;
106  // static variable
107  uint32_t spi_speed;
108  spi_master_mode_t spi_mode;
109  spi_master_chip_select_polarity_t cs_polarity;
111  float vref;
113 } mrangle_cfg_t;
114 
119 typedef enum
120 {
122  MRANGLE_ERROR = -1
123 
125 
130 typedef enum
131 {
134 
136 
141 typedef enum
142 {
145 
147 
164 
178 err_t mrangle_init ( mrangle_t *ctx, mrangle_cfg_t *cfg );
179 
191 
204 
218 
233 err_t mrangle_generic_write ( mrangle_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
234 
249 err_t mrangle_generic_read ( mrangle_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
250 
264 err_t mrangle_get_adc_sin ( mrangle_t *ctx, uint16_t *sin_adc );
265 
280 err_t mrangle_get_sin ( mrangle_t *ctx, float *sin );
281 
295 err_t mrangle_get_adc_cos ( mrangle_t *ctx, uint16_t *cos_adc );
296 
311 err_t mrangle_get_cos ( mrangle_t *ctx, float *cos );
312 
326 err_t mrangle_get_adc_temp ( mrangle_t *ctx, uint16_t *temp_adc );
327 
341 err_t mrangle_get_temperature ( mrangle_t *ctx, float *temperature );
342 
356 err_t mrangle_get_angle ( mrangle_t *ctx, float *angle );
357 
358 #ifdef __cplusplus
359 }
360 #endif
361 #endif // MRANGLE_H
362  // mrangle
364 
365 // ------------------------------------------------------------------------ END
mrangle_get_angle
err_t mrangle_get_angle(mrangle_t *ctx, float *angle)
MR Angle get angle function.
mrangle_powerdown_mode_value_t
mrangle_powerdown_mode_value_t
MR Angle Click powerdown mode value data.
Definition: mrangle.h:131
mrangle_cfg_t::vref
float vref
Definition: mrangle.h:111
mrangle_init
err_t mrangle_init(mrangle_t *ctx, mrangle_cfg_t *cfg)
MR Angle initialization function.
OUTPUT_MODE_VOUT_TEMP
@ OUTPUT_MODE_VOUT_TEMP
Definition: mrangle.h:144
mrangle_get_adc_temp
err_t mrangle_get_adc_temp(mrangle_t *ctx, uint16_t *temp_adc)
MR Angle get ADC temperature function.
POWERDOWN_MODE_ENABLE
@ POWERDOWN_MODE_ENABLE
Definition: mrangle.h:133
mrangle_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: mrangle.h:109
mrangle_t::pdn
digital_out_t pdn
Definition: mrangle.h:79
POWERDOWN_MODE_DISABLE
@ POWERDOWN_MODE_DISABLE
Definition: mrangle.h:132
mrangle_cfg_t::spi_speed
uint32_t spi_speed
Definition: mrangle.h:107
mrangle_get_adc_cos
err_t mrangle_get_adc_cos(mrangle_t *ctx, uint16_t *cos_adc)
MR Angle get ADC cosine function.
mrangle_cfg_t::miso
pin_name_t miso
Definition: mrangle.h:97
mrangle_cfg_t::mosi
pin_name_t mosi
Definition: mrangle.h:98
MRANGLE_OK
@ MRANGLE_OK
Definition: mrangle.h:121
mrangle_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: mrangle.h:108
OUTPUT_MODE_VOUT_SIN_COS
@ OUTPUT_MODE_VOUT_SIN_COS
Definition: mrangle.h:143
mrangle_t
MR Angle Click context object.
Definition: mrangle.h:76
mrangle_t::vref
float vref
Definition: mrangle.h:86
mrangle_t::chip_select
pin_name_t chip_select
Definition: mrangle.h:84
MRANGLE_ERROR
@ MRANGLE_ERROR
Definition: mrangle.h:122
mrangle_cfg_t::cs
pin_name_t cs
Definition: mrangle.h:100
mrangle_t::spi
spi_master_t spi
Definition: mrangle.h:82
mrangle_output_mode_value_t
mrangle_output_mode_value_t
MR Angle Click output mode value data.
Definition: mrangle.h:142
mrangle_cfg_t::tce
pin_name_t tce
Definition: mrangle.h:103
mrangle_generic_write
err_t mrangle_generic_write(mrangle_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
MR Angle data writing function.
mrangle_cfg_t::sck
pin_name_t sck
Definition: mrangle.h:99
mrangle_cfg_setup
void mrangle_cfg_setup(mrangle_cfg_t *cfg)
MR Angle configuration object setup function.
mrangle_cfg_t::pdn
pin_name_t pdn
Definition: mrangle.h:104
mrangle_return_value_t
mrangle_return_value_t
MR Angle Click return value data.
Definition: mrangle.h:120
mrangle_get_temperature
err_t mrangle_get_temperature(mrangle_t *ctx, float *temperature)
MR Angle get temperature function.
mrangle_get_cos
err_t mrangle_get_cos(mrangle_t *ctx, float *cos)
MR Angle get cosine function.
mrangle_output_mode
void mrangle_output_mode(mrangle_t *ctx, mrangle_output_mode_value_t output_mode)
MR Angle output mode function.
mrangle_t::tce
digital_out_t tce
Definition: mrangle.h:78
mrangle_default_cfg
void mrangle_default_cfg(mrangle_t *ctx)
MR Angle default configuration function.
mrangle_powerdown_mode
void mrangle_powerdown_mode(mrangle_t *ctx, mrangle_powerdown_mode_value_t pd_mode)
MR Angle powerdown mode function.
mrangle_get_adc_sin
err_t mrangle_get_adc_sin(mrangle_t *ctx, uint16_t *sin_adc)
MR Angle get ADC sine function.
mrangle_get_sin
err_t mrangle_get_sin(mrangle_t *ctx, float *sin)
MR Angle get sine function.
mrangle_generic_read
err_t mrangle_generic_read(mrangle_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
MR Angle data reading function.
mrangle_cfg_t
MR Angle Click configuration object.
Definition: mrangle.h:95