angle6  2.0.0.0
angle6.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 ANGLE6_H
29 #define ANGLE6_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_spi_master.h"
38 #include "spi_specifics.h"
39 
60 #define ANGLE6_REG_ZERO_SETTING_LSB 0x00
61 #define ANGLE6_REG_ZERO_SETTING_MSB 0x01
62 #define ANGLE6_REG_BIAS_CURRENT_TIMING 0x02
63 #define ANGLE6_REG_ENABLE_TRIMMING 0x03
64 #define ANGLE6_REG_ABZ_SETTING_LSB 0x04
65 #define ANGLE6_REG_ABZ_SETTING_MSB 0x05
66 #define ANGLE6_REG_MAGNETIC_FIELD_CONFIG 0x06
67 #define ANGLE6_REG_ROTATION_DIRECTION 0x09
68 #define ANGLE6_REG_ALARM_FLAGS 0x1B
69 
74 #define ANGLE6_CMD_READ_ANGLE 0x00
75 #define ANGLE6_CMD_READ_REGISTER 0x40
76 #define ANGLE6_CMD_WRITE_REGISTER 0x80
77  // angle6_reg
79 
94 #define ANGLE6_ROTATION_DIRECTION_CW 0x00
95 #define ANGLE6_ROTATION_DIRECTION_CCW 0x80
96 
101 #define ANGLE6_RESOLUTION 0xFFFF
102 #define ANGLE6_FULL_CIRCLE 360.0
103 
112 #define ANGLE6_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
113 #define ANGLE6_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
114  // angle6_set
116 
131 #define ANGLE6_MAP_MIKROBUS( cfg, mikrobus ) \
132  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
133  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
134  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
135  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
136  cfg.mgh = MIKROBUS( mikrobus, MIKROBUS_RST ); \
137  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
138  cfg.mgl = MIKROBUS( mikrobus, MIKROBUS_INT )
139  // angle6_map // angle6
142 
147 typedef struct
148 {
149  // Input pins
150  digital_in_t mgh;
151  digital_in_t pwm;
152  digital_in_t mgl;
154  // Modules
155  spi_master_t spi;
157  pin_name_t chip_select;
159 } angle6_t;
160 
165 typedef struct
166 {
167  // Communication gpio pins
168  pin_name_t miso;
169  pin_name_t mosi;
170  pin_name_t sck;
171  pin_name_t cs;
173  // Additional gpio pins
174  pin_name_t mgh;
175  pin_name_t pwm;
176  pin_name_t mgl;
178  // static variable
179  uint32_t spi_speed;
180  spi_master_mode_t spi_mode;
181  spi_master_chip_select_polarity_t cs_polarity;
183 } angle6_cfg_t;
184 
189 typedef enum
190 {
192  ANGLE6_ERROR = -1
193 
195 
212 
227 err_t angle6_init ( angle6_t *ctx, angle6_cfg_t *cfg );
228 
243 
256 err_t angle6_write_register ( angle6_t *ctx, uint8_t reg, uint8_t data_in );
257 
270 err_t angle6_read_register ( angle6_t *ctx, uint8_t reg, uint8_t *data_out );
271 
283 err_t angle6_read_angle ( angle6_t *ctx, float *angle );
284 
293 uint8_t angle6_get_pwm_pin ( angle6_t *ctx );
294 
303 uint8_t angle6_get_mgh_pin ( angle6_t *ctx );
304 
313 uint8_t angle6_get_mgl_pin ( angle6_t *ctx );
314 
315 #ifdef __cplusplus
316 }
317 #endif
318 #endif // ANGLE6_H
319  // angle6
321 
322 // ------------------------------------------------------------------------ END
angle6_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: angle6.h:181
angle6_cfg_setup
void angle6_cfg_setup(angle6_cfg_t *cfg)
Angle 6 configuration object setup function.
angle6_cfg_t::pwm
pin_name_t pwm
Definition: angle6.h:175
angle6_init
err_t angle6_init(angle6_t *ctx, angle6_cfg_t *cfg)
Angle 6 initialization function.
angle6_t::spi
spi_master_t spi
Definition: angle6.h:155
spi_specifics.h
This file contains SPI specific macros, functions, etc.
angle6_t::pwm
digital_in_t pwm
Definition: angle6.h:151
angle6_default_cfg
err_t angle6_default_cfg(angle6_t *ctx)
Angle 6 default configuration function.
angle6_t
Angle 6 Click context object.
Definition: angle6.h:148
angle6_get_mgl_pin
uint8_t angle6_get_mgl_pin(angle6_t *ctx)
Angle 6 get mgl pin function.
angle6_cfg_t::cs
pin_name_t cs
Definition: angle6.h:171
angle6_cfg_t::mosi
pin_name_t mosi
Definition: angle6.h:169
angle6_get_pwm_pin
uint8_t angle6_get_pwm_pin(angle6_t *ctx)
Angle 6 get pwm pin function.
angle6_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: angle6.h:180
angle6_cfg_t
Angle 6 Click configuration object.
Definition: angle6.h:166
ANGLE6_OK
@ ANGLE6_OK
Definition: angle6.h:191
angle6_t::mgh
digital_in_t mgh
Definition: angle6.h:150
angle6_cfg_t::miso
pin_name_t miso
Definition: angle6.h:168
ANGLE6_ERROR
@ ANGLE6_ERROR
Definition: angle6.h:192
angle6_get_mgh_pin
uint8_t angle6_get_mgh_pin(angle6_t *ctx)
Angle 6 get mgh pin function.
angle6_cfg_t::mgl
pin_name_t mgl
Definition: angle6.h:176
angle6_read_register
err_t angle6_read_register(angle6_t *ctx, uint8_t reg, uint8_t *data_out)
Angle 6 read register function.
angle6_cfg_t::spi_speed
uint32_t spi_speed
Definition: angle6.h:179
angle6_cfg_t::mgh
pin_name_t mgh
Definition: angle6.h:174
angle6_t::mgl
digital_in_t mgl
Definition: angle6.h:152
angle6_return_value_t
angle6_return_value_t
Angle 6 Click return value data.
Definition: angle6.h:190
angle6_read_angle
err_t angle6_read_angle(angle6_t *ctx, float *angle)
Angle 6 read angle function.
angle6_write_register
err_t angle6_write_register(angle6_t *ctx, uint8_t reg, uint8_t data_in)
Angle 6 write register function.
angle6_cfg_t::sck
pin_name_t sck
Definition: angle6.h:170
angle6_t::chip_select
pin_name_t chip_select
Definition: angle6.h:157