magneticrotary3  2.0.0.0
magneticrotary3.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 MAGNETICROTARY3_H
29 #define MAGNETICROTARY3_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 MAGNETICROTARY3_REG_NOP 0x0000
61 #define MAGNETICROTARY3_REG_ERRFL 0x0001
62 #define MAGNETICROTARY3_REG_PROG 0x0003
63 #define MAGNETICROTARY3_REG_DIA 0x3FF5
64 #define MAGNETICROTARY3_REG_AGC 0x3FF9
65 #define MAGNETICROTARY3_REG_SIN_DATA 0x3FFA
66 #define MAGNETICROTARY3_REG_COS_DATA 0x3FFB
67 #define MAGNETICROTARY3_REG_VEL 0x3FFC
68 #define MAGNETICROTARY3_REG_MAG 0x3FFD
69 #define MAGNETICROTARY3_REG_ANGLEUNC 0x3FFE
70 #define MAGNETICROTARY3_REG_ANGLECOM 0x3FFF
71 #define MAGNETICROTARY3_REG_ECC_CHECKSUM 0x00D1
72 
77 #define MAGNETICROTARY3_REG_DISABLE 0x0015
78 #define MAGNETICROTARY3_REG_ZPOSM 0x0016
79 #define MAGNETICROTARY3_REG_ZPOSL 0x0017
80 #define MAGNETICROTARY3_REG_SETTINGS1 0x0018
81 #define MAGNETICROTARY3_REG_SETTINGS2 0x0019
82 #define MAGNETICROTARY3_REG_SETTINGS3 0x001A
83 #define MAGNETICROTARY3_REG_ECC 0x001B
84  // magneticrotary3_reg
86 
101 #define MAGNETICROTARY3_DATA_RESOLUTION 0x3FFF
102 #define MAGNETICROTARY3_FULL_CIRCLE 360
103 
110 #define MAGNETICROTARY3_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
111 #define MAGNETICROTARY3_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
112  // magneticrotary3_set
114 
129 #define MAGNETICROTARY3_MAP_MIKROBUS( cfg, mikrobus ) \
130  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
131  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
132  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
133  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS );
134  // magneticrotary3_map // magneticrotary3
137 
142 typedef struct
143 {
144  // Modules
145  spi_master_t spi;
147  pin_name_t chip_select;
150 
155 typedef struct
156 {
157  // Communication gpio pins
158  pin_name_t miso;
159  pin_name_t mosi;
160  pin_name_t sck;
161  pin_name_t cs;
163  // static variable
164  uint32_t spi_speed;
165  spi_master_mode_t spi_mode;
166  spi_master_chip_select_polarity_t cs_polarity;
169 
174 typedef enum
175 {
178 
180 
197 
212 
225 err_t magneticrotary3_write_register ( magneticrotary3_t *ctx, uint16_t reg, uint16_t data_in );
226 
239 err_t magneticrotary3_read_register ( magneticrotary3_t *ctx, uint16_t reg, uint16_t *data_out );
240 
252 err_t magneticrotary3_get_angle ( magneticrotary3_t *ctx, float *angle );
253 
254 #ifdef __cplusplus
255 }
256 #endif
257 #endif // MAGNETICROTARY3_H
258  // magneticrotary3
260 
261 // ------------------------------------------------------------------------ END
magneticrotary3_write_register
err_t magneticrotary3_write_register(magneticrotary3_t *ctx, uint16_t reg, uint16_t data_in)
Magnetic Rotary 3 write register function.
spi_specifics.h
This file contains SPI specific macros, functions, etc.
magneticrotary3_t::chip_select
pin_name_t chip_select
Definition: magneticrotary3.h:147
magneticrotary3_cfg_t::mosi
pin_name_t mosi
Definition: magneticrotary3.h:159
magneticrotary3_cfg_t::spi_speed
uint32_t spi_speed
Definition: magneticrotary3.h:164
magneticrotary3_cfg_t
Magnetic Rotary 3 Click configuration object.
Definition: magneticrotary3.h:156
magneticrotary3_read_register
err_t magneticrotary3_read_register(magneticrotary3_t *ctx, uint16_t reg, uint16_t *data_out)
Magnetic Rotary 3 read register function.
magneticrotary3_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: magneticrotary3.h:165
magneticrotary3_cfg_t::sck
pin_name_t sck
Definition: magneticrotary3.h:160
magneticrotary3_cfg_setup
void magneticrotary3_cfg_setup(magneticrotary3_cfg_t *cfg)
Magnetic Rotary 3 configuration object setup function.
magneticrotary3_return_value_t
magneticrotary3_return_value_t
Magnetic Rotary 3 Click return value data.
Definition: magneticrotary3.h:175
magneticrotary3_t
Magnetic Rotary 3 Click context object.
Definition: magneticrotary3.h:143
magneticrotary3_t::spi
spi_master_t spi
Definition: magneticrotary3.h:145
magneticrotary3_cfg_t::miso
pin_name_t miso
Definition: magneticrotary3.h:158
MAGNETICROTARY3_ERROR
@ MAGNETICROTARY3_ERROR
Definition: magneticrotary3.h:177
magneticrotary3_init
err_t magneticrotary3_init(magneticrotary3_t *ctx, magneticrotary3_cfg_t *cfg)
Magnetic Rotary 3 initialization function.
magneticrotary3_get_angle
err_t magneticrotary3_get_angle(magneticrotary3_t *ctx, float *angle)
Magnetic Rotary 3 get angle function.
MAGNETICROTARY3_OK
@ MAGNETICROTARY3_OK
Definition: magneticrotary3.h:176
magneticrotary3_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: magneticrotary3.h:166
magneticrotary3_cfg_t::cs
pin_name_t cs
Definition: magneticrotary3.h:161