magneticrotary5  2.1.0.0
magneticrotary5.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 MAGNETICROTARY5_H
29 #define MAGNETICROTARY5_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_analog_in.h"
38 
59 #define MAGNETICROTARY5_CMD_WRITE_CONFIG 0x17
60 #define MAGNETICROTARY5_CMD_SET_MT_COUNTER 0x14
61 #define MAGNETICROTARY5_CMD_EN_PROG 0x10
62 #define MAGNETICROTARY5_CMD_RD_MT_COUNTER 0x04
63 #define MAGNETICROTARY5_CMD_RD_ANGLE 0x00
64 #define MAGNETICROTARY5_CMD_WRITE_OTP 0x1F
65 #define MAGNETICROTARY5_CMD_PROG_OTP 0x19
66 #define MAGNETICROTARY5_CMD_READ_OTP 0x0F
67 #define MAGNETICROTARY5_CMD_READ_ANA 0x09
68  // magneticrotary5_reg
70 
85 #define MAGNETICROTARY5_MASK_AGC_BITS 0x3F
86 #define MAGNETICROTARY5_MASK_ANGLE_MSB 0x01
87 #define MAGNETICROTARY5_MASK_MT_CNT_MSB 0x01FE
88 #define MAGNETICROTARY5_MASK_MT_CNT_LSB 0x01
89 #define MAGNETICROTARY5_MASK_5_LSB 0x1F
90 #define MAGNETICROTARY5_MASK_3_LSB 0x07
91 #define MAGNETICROTARY5_MAX_DATA_LEN 8
92 #define MAGNETICROTARY5_MIN_DATA_LEN 1
93 #define MAGNETICROTARY5_MAX_MT_CNT 255
94 #define MAGNETICROTARY5_MIN_MT_CNT (-256)
95 #define MAGNETICROTARY5_DEFAULT_MT_CNT 0
96 
101 #define MAGNETICROTARY5_VREF_3V3 3.3
102 #define MAGNETICROTARY5_VREF_5V 5.0
103  // magneticrotary5_set
105 
120 #define MAGNETICROTARY5_MAP_MIKROBUS( cfg, mikrobus ) \
121  cfg.dio = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
122  cfg.ddclk = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
123  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
124  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN );
125  // magneticrotary5_map // magneticrotary5
128 
133 typedef struct
134 {
135  digital_out_t ddclk;
136  digital_out_t cs;
137  pin_name_t dio;
139  analog_in_t adc;
142 
147 typedef struct
148 {
149  pin_name_t ddclk;
150  pin_name_t cs;
151  pin_name_t dio;
152  pin_name_t an;
154  analog_in_resolution_t resolution;
155  float vref;
158 
163 typedef enum
164 {
167 
169 
186 
201 
215 
230 err_t magneticrotary5_write_cmd ( magneticrotary5_t *ctx, uint8_t cmd, uint8_t *data_in, uint8_t len );
231 
246 err_t magneticrotary5_read_cmd ( magneticrotary5_t *ctx, uint8_t cmd, uint8_t *data_out, uint8_t len );
247 
261 err_t magneticrotary5_read_angle ( magneticrotary5_t *ctx, uint8_t *agc, uint16_t *angle );
262 
275 err_t magneticrotary5_read_mt_cnt ( magneticrotary5_t *ctx, int16_t *mt_cnt );
276 
288 err_t magneticrotary5_set_mt_cnt ( magneticrotary5_t *ctx, int16_t mt_cnt );
289 
301 err_t magneticrotary5_read_raw_adc ( magneticrotary5_t *ctx, uint16_t *raw_adc );
302 
314 err_t magneticrotary5_read_voltage ( magneticrotary5_t *ctx, float *voltage );
315 
327 err_t magneticrotary5_set_vref ( magneticrotary5_t *ctx, float vref );
328 
329 #ifdef __cplusplus
330 }
331 #endif
332 #endif // MAGNETICROTARY5_H
333  // magneticrotary5
335 
336 // ------------------------------------------------------------------------ END
magneticrotary5_read_cmd
err_t magneticrotary5_read_cmd(magneticrotary5_t *ctx, uint8_t cmd, uint8_t *data_out, uint8_t len)
Magnetic Rotary 5 read cmd function.
magneticrotary5_t::adc
analog_in_t adc
Definition: magneticrotary5.h:139
MAGNETICROTARY5_OK
@ MAGNETICROTARY5_OK
Definition: magneticrotary5.h:165
magneticrotary5_t::cs
digital_out_t cs
Definition: magneticrotary5.h:136
magneticrotary5_read_raw_adc
err_t magneticrotary5_read_raw_adc(magneticrotary5_t *ctx, uint16_t *raw_adc)
Magnetic Rotary 5 read raw ADC value function.
magneticrotary5_cfg_t
Magnetic Rotary 5 Click configuration object.
Definition: magneticrotary5.h:148
magneticrotary5_init
err_t magneticrotary5_init(magneticrotary5_t *ctx, magneticrotary5_cfg_t *cfg)
Magnetic Rotary 5 initialization function.
magneticrotary5_cfg_setup
void magneticrotary5_cfg_setup(magneticrotary5_cfg_t *cfg)
Magnetic Rotary 5 configuration object setup function.
magneticrotary5_t::dio
pin_name_t dio
Definition: magneticrotary5.h:137
magneticrotary5_read_mt_cnt
err_t magneticrotary5_read_mt_cnt(magneticrotary5_t *ctx, int16_t *mt_cnt)
Magnetic Rotary 5 read multi turn counter function.
magneticrotary5_write_cmd
err_t magneticrotary5_write_cmd(magneticrotary5_t *ctx, uint8_t cmd, uint8_t *data_in, uint8_t len)
Magnetic Rotary 5 write cmd function.
magneticrotary5_t::ddclk
digital_out_t ddclk
Definition: magneticrotary5.h:135
magneticrotary5_cfg_t::vref
float vref
Definition: magneticrotary5.h:155
magneticrotary5_t
Magnetic Rotary 5 Click context object.
Definition: magneticrotary5.h:134
magneticrotary5_cfg_t::cs
pin_name_t cs
Definition: magneticrotary5.h:150
MAGNETICROTARY5_ERROR
@ MAGNETICROTARY5_ERROR
Definition: magneticrotary5.h:166
magneticrotary5_read_voltage
err_t magneticrotary5_read_voltage(magneticrotary5_t *ctx, float *voltage)
Magnetic Rotary 5 read voltage level function.
magneticrotary5_cfg_t::resolution
analog_in_resolution_t resolution
Definition: magneticrotary5.h:154
magneticrotary5_cfg_t::dio
pin_name_t dio
Definition: magneticrotary5.h:151
magneticrotary5_set_mt_cnt
err_t magneticrotary5_set_mt_cnt(magneticrotary5_t *ctx, int16_t mt_cnt)
Magnetic Rotary 5 set multi turn counter function.
magneticrotary5_set_vref
err_t magneticrotary5_set_vref(magneticrotary5_t *ctx, float vref)
Magnetic Rotary 5 set vref function.
magneticrotary5_default_cfg
err_t magneticrotary5_default_cfg(magneticrotary5_t *ctx)
Magnetic Rotary 5 default configuration function.
magneticrotary5_read_angle
err_t magneticrotary5_read_angle(magneticrotary5_t *ctx, uint8_t *agc, uint16_t *angle)
Magnetic Rotary 5 read angle function.
magneticrotary5_return_value_t
magneticrotary5_return_value_t
Magnetic Rotary 5 Click return value data.
Definition: magneticrotary5.h:164
magneticrotary5_cfg_t::ddclk
pin_name_t ddclk
Definition: magneticrotary5.h:149
magneticrotary5_cfg_t::an
pin_name_t an
Definition: magneticrotary5.h:152