angle7  2.0.0.0
angle7.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 ANGLE7_H
29 #define ANGLE7_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_i2c_master.h"
48 #include "drv_analog_in.h"
49 
70 #define ANGLE7_REG_ZMCO 0x00
71 #define ANGLE7_REG_ZPOS_MSB 0x01
72 #define ANGLE7_REG_ZPOS_LSB 0x02
73 #define ANGLE7_REG_MPOS_MSB 0x03
74 #define ANGLE7_REG_MPOS_LSB 0x04
75 #define ANGLE7_REG_MANG_MSB 0x05
76 #define ANGLE7_REG_MANG_LSB 0x06
77 #define ANGLE7_REG_CONF_MSB 0x07
78 #define ANGLE7_REG_CONF_LSB 0x08
79 #define ANGLE7_REG_STATUS 0x0B
80 #define ANGLE7_REG_RAW_ANGLE_MSB 0x0C
81 #define ANGLE7_REG_RAW_ANGLE_LSB 0x0D
82 #define ANGLE7_REG_ANGLE_MSB 0x0E
83 #define ANGLE7_REG_ANGLE_LSB 0x0F
84 #define ANGLE7_REG_AGC 0x1A
85 #define ANGLE7_REG_MAGNITUDE_MSB 0x1B
86 #define ANGLE7_REG_MAGNITUDE_LSB 0x1C
87 #define ANGLE7_REG_BURN 0xFF
88  // angle7_reg
90 
105 #define ANGLE7_CONF_WATCHDOG_OFF 0x0000
106 #define ANGLE7_CONF_WATCHDOG_ON 0x2000
107 #define ANGLE7_CONF_WATCHDOG_BIT_MASK 0x2000
108 #define ANGLE7_CONF_FTH_SLOW 0x0000
109 #define ANGLE7_CONF_FTH_6LSB 0x0400
110 #define ANGLE7_CONF_FTH_7LSB 0x0800
111 #define ANGLE7_CONF_FTH_9LSB 0x0C00
112 #define ANGLE7_CONF_FTH_18LSB 0x1000
113 #define ANGLE7_CONF_FTH_21LSB 0x1400
114 #define ANGLE7_CONF_FTH_24LSB 0x1800
115 #define ANGLE7_CONF_FTH_10LSB 0x1C00
116 #define ANGLE7_CONF_FTH_BIT_MASK 0x1C00
117 #define ANGLE7_CONF_SF_16X 0x0000
118 #define ANGLE7_CONF_SF_8X 0x0100
119 #define ANGLE7_CONF_SF_4X 0x0200
120 #define ANGLE7_CONF_SF_2X 0x0300
121 #define ANGLE7_CONF_SF_BIT_MASK 0x0300
122 #define ANGLE7_CONF_PWMF_115HZ 0x0000
123 #define ANGLE7_CONF_PWMF_230HZ 0x0040
124 #define ANGLE7_CONF_PWMF_460HZ 0x0080
125 #define ANGLE7_CONF_PWMF_920HZ 0x00C0
126 #define ANGLE7_CONF_PWMF_BIT_MASK 0x00C0
127 #define ANGLE7_CONF_OUTS_ANALOG_FULL 0x0000
128 #define ANGLE7_CONF_OUTS_ANALOG_REDUCED 0x0010
129 #define ANGLE7_CONF_OUTS_PWM 0x0020
130 #define ANGLE7_CONF_OUTS_BIT_MASK 0x0030
131 #define ANGLE7_CONF_HYST_OFF 0x0000
132 #define ANGLE7_CONF_HYST_1LSB 0x0004
133 #define ANGLE7_CONF_HYST_2LSB 0x0008
134 #define ANGLE7_CONF_HYST_3LSB 0x000C
135 #define ANGLE7_CONF_HYST_BIT_MASK 0x000C
136 #define ANGLE7_CONF_PM_NOM 0x0000
137 #define ANGLE7_CONF_PM_LPM1 0x0001
138 #define ANGLE7_CONF_PM_LPM2 0x0002
139 #define ANGLE7_CONF_PM_LPM3 0x0003
140 #define ANGLE7_CONF_PM_BIT_MASK 0x0003
141 
146 #define ANGLE7_STATUS_MAGNET_DETECTED 0x20
147 #define ANGLE7_STATUS_MAGNET_TOO_WEAK 0x10
148 #define ANGLE7_STATUS_MAGNET_TOO_STRONG 0x08
149 
154 #define ANGLE7_BURN_ANGLE 0x80
155 #define ANGLE7_BURN_SETTING 0x40
156 
161 #define ANGLE7_RESOLUTION 0x0FFF
162 #define ANGLE7_FULL_CIRCLE 360.0
163 #define ANGLE7_ZERO_POSITION 0.0
164 
170 #define ANGLE7_DEVICE_ADDRESS 0x36
171  // angle7_set
173 
188 #define ANGLE7_MAP_MIKROBUS( cfg, mikrobus ) \
189  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
190  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
191  cfg.en = MIKROBUS( mikrobus, MIKROBUS_CS ); \
192  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
193  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
194  // angle7_map // angle7
197 
202 typedef struct
203 {
204  // Output pins
205  digital_out_t en;
207  // Input pins
208  digital_in_t int_pin;
210  // Modules
211  i2c_master_t i2c;
212  analog_in_t adc;
214  // I2C slave address
215  uint8_t slave_address;
219 
220 } angle7_t;
221 
226 typedef struct
227 {
228  pin_name_t scl;
229  pin_name_t sda;
231  pin_name_t en;
232  pin_name_t an;
233  pin_name_t int_pin;
235  uint32_t i2c_speed;
236  uint8_t i2c_address;
238  analog_in_resolution_t resolution;
239  float vref;
241 } angle7_cfg_t;
242 
247 typedef enum
248 {
250  ANGLE7_ERROR = -1
251 
253 
270 
284 err_t angle7_init ( angle7_t *ctx, angle7_cfg_t *cfg );
285 
299 
314 err_t angle7_generic_write ( angle7_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
315 
330 err_t angle7_generic_read ( angle7_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
331 
345 err_t angle7_write_two_bytes ( angle7_t *ctx, uint8_t reg, uint16_t data_in );
346 
360 err_t angle7_read_two_bytes ( angle7_t *ctx, uint8_t reg, uint16_t *data_out );
361 
373 err_t angle7_read_an_pin_value ( angle7_t *ctx, uint16_t *data_out );
374 
388 err_t angle7_read_an_pin_voltage ( angle7_t *ctx, float *data_out );
389 
398 uint8_t angle7_get_int_pin ( angle7_t *ctx );
399 
409 
419 
431 err_t angle7_set_start_position ( angle7_t *ctx, float angle );
432 
444 err_t angle7_get_start_position ( angle7_t *ctx, float *angle );
445 
457 err_t angle7_set_stop_position ( angle7_t *ctx, float angle );
458 
470 err_t angle7_get_stop_position ( angle7_t *ctx, float *angle );
471 
483 err_t angle7_get_raw_angle ( angle7_t *ctx, float *angle );
484 
496 err_t angle7_get_angle ( angle7_t *ctx, float *angle );
497 
509 err_t angle7_get_status ( angle7_t *ctx, uint8_t *status );
510 
522 err_t angle7_get_agc ( angle7_t *ctx, uint8_t *agc );
523 
535 err_t angle7_get_magnitude ( angle7_t *ctx, uint16_t *magnitude );
536 
537 #ifdef __cplusplus
538 }
539 #endif
540 #endif // ANGLE7_H
541  // angle7
543 
544 // ------------------------------------------------------------------------ END
angle7_cfg_t::int_pin
pin_name_t int_pin
Definition: angle7.h:233
angle7_set_start_position
err_t angle7_set_start_position(angle7_t *ctx, float angle)
Angle 7 set start position function.
angle7_enable_device
void angle7_enable_device(angle7_t *ctx)
Angle 7 enable device function.
ANGLE7_ERROR
@ ANGLE7_ERROR
Definition: angle7.h:250
angle7_read_two_bytes
err_t angle7_read_two_bytes(angle7_t *ctx, uint8_t reg, uint16_t *data_out)
Angle 7 read two bytes function.
angle7_t::i2c
i2c_master_t i2c
Definition: angle7.h:211
angle7_cfg_t::vref
float vref
Definition: angle7.h:239
angle7_return_value_t
angle7_return_value_t
Angle 7 Click return value data.
Definition: angle7.h:248
ANGLE7_OK
@ ANGLE7_OK
Definition: angle7.h:249
angle7_write_two_bytes
err_t angle7_write_two_bytes(angle7_t *ctx, uint8_t reg, uint16_t data_in)
Angle 7 write two bytes function.
angle7_t::slave_address
uint8_t slave_address
Definition: angle7.h:215
angle7_t::int_pin
digital_in_t int_pin
Definition: angle7.h:208
angle7_cfg_t::an
pin_name_t an
Definition: angle7.h:232
angle7_t::adc
analog_in_t adc
Definition: angle7.h:212
angle7_set_stop_position
err_t angle7_set_stop_position(angle7_t *ctx, float angle)
Angle 7 set stop position function.
angle7_get_int_pin
uint8_t angle7_get_int_pin(angle7_t *ctx)
Angle 7 get int pin function.
angle7_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: angle7.h:235
angle7_init
err_t angle7_init(angle7_t *ctx, angle7_cfg_t *cfg)
Angle 7 initialization function.
angle7_t
Angle 7 Click context object.
Definition: angle7.h:203
angle7_t::en
digital_out_t en
Definition: angle7.h:205
angle7_cfg_t
Angle 7 Click configuration object.
Definition: angle7.h:227
angle7_generic_read
err_t angle7_generic_read(angle7_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
Angle 7 I2C reading function.
angle7_get_stop_position
err_t angle7_get_stop_position(angle7_t *ctx, float *angle)
Angle 7 get stop position function.
angle7_t::stop_position
float stop_position
Definition: angle7.h:218
angle7_cfg_t::scl
pin_name_t scl
Definition: angle7.h:228
angle7_get_start_position
err_t angle7_get_start_position(angle7_t *ctx, float *angle)
Angle 7 get start position function.
angle7_cfg_t::resolution
analog_in_resolution_t resolution
Definition: angle7.h:238
angle7_disable_device
void angle7_disable_device(angle7_t *ctx)
Angle 7 disable device function.
angle7_cfg_t::sda
pin_name_t sda
Definition: angle7.h:229
angle7_default_cfg
err_t angle7_default_cfg(angle7_t *ctx)
Angle 7 default configuration function.
angle7_get_raw_angle
err_t angle7_get_raw_angle(angle7_t *ctx, float *angle)
Angle 7 get raw angle function.
angle7_cfg_t::en
pin_name_t en
Definition: angle7.h:231
angle7_get_agc
err_t angle7_get_agc(angle7_t *ctx, uint8_t *agc)
Angle 7 get agc function.
angle7_cfg_t::i2c_address
uint8_t i2c_address
Definition: angle7.h:236
angle7_t::start_position
float start_position
Definition: angle7.h:217
angle7_get_magnitude
err_t angle7_get_magnitude(angle7_t *ctx, uint16_t *magnitude)
Angle 7 get magnitude function.
angle7_get_angle
err_t angle7_get_angle(angle7_t *ctx, float *angle)
Angle 7 get angle function.
angle7_read_an_pin_voltage
err_t angle7_read_an_pin_voltage(angle7_t *ctx, float *data_out)
Angle 7 read AN pin voltage level function.
angle7_cfg_setup
void angle7_cfg_setup(angle7_cfg_t *cfg)
Angle 7 configuration object setup function.
angle7_generic_write
err_t angle7_generic_write(angle7_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
Angle 7 I2C writing function.
angle7_read_an_pin_value
err_t angle7_read_an_pin_value(angle7_t *ctx, uint16_t *data_out)
Angle 7 read AN pin value function.
angle7_get_status
err_t angle7_get_status(angle7_t *ctx, uint8_t *status)
Angle 7 get status function.