angle3  2.0.0.0
angle3.h
Go to the documentation of this file.
1 /*
2  * MikroSDK - MikroE Software Development Kit
3  * Copyright© 2020 MikroElektronika d.o.o.
4  *
5  * Permission is hereby granted, free of charge, to any person
6  * obtaining a copy of this software and associated documentation
7  * files (the "Software"), to deal in the Software without restriction,
8  * including without limitation the rights to use, copy, modify, merge,
9  * publish, distribute, sublicense, and/or sell copies of the Software,
10  * and to permit persons to whom the Software is furnished to do so,
11  * subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be
14  * included in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
22  * OR OTHER DEALINGS IN THE SOFTWARE.
23  */
32 // ----------------------------------------------------------------------------
33 
34 #ifndef ANGLE3_H
35 #define ANGLE3_H
36 
37 #include "drv_digital_out.h"
38 #include "drv_digital_in.h"
39 #include "drv_spi_master.h"
40 #include "spi_specifics.h"
41 
42 // -------------------------------------------------------------- PUBLIC MACROS
52 #define ANGLE3_OK 0
53 #define ANGLE3_ERROR -1
54 
60 #define ANGLE3_REG_ANG 0x00
61 #define ANGLE3_REG_MAG 0x01
62 #define ANGLE3_REG_CHMD 0x02
63 #define ANGLE3_REG_ERRMON 0x03
64 #define ANGLE3_REG_ZP 0x06
65 #define ANGLE3_REG_RDABZ 0x07
66 #define ANGLE3_REG_MLK 0x08
67 #define ANGLE3_REG_EBDIS 0x09
68 #define ANGLE3_REG_UVW 0x0A
69  // End group register
70 
75 #define ANGLE3_EEPROM_ID1 0x04
76 #define ANGLE3_EEPROM_ID2 0x05
77 #define ANGLE3_EEPROM_ZP 0x06
78 #define ANGLE3_EEPROM_RDABZ 0x07
79 #define ANGLE3_EEPROM_MLK 0x08
80 #define ANGLE3_EEPROM_EBDIS 0x09
81 #define ANGLE3_EEPROM_UVW 0x0A
82  // End group EEPROM_locations
83 
88 #define ANGLE3_OPCODE_LOCK_EEPROM 0x00
89 #define ANGLE3_OPCODE_WRITE_EEPROM 0x01
90 #define ANGLE3_OPCODE_READ_EEPROM 0x02
91 #define ANGLE3_OPCODE_WRITE_REG 0x03
92 #define ANGLE3_OPCODE_READ_REG 0x04
93 #define ANGLE3_OPCODE_CHANGE_MODE 0x05
94 #define ANGLE3_OPCODE_ANGLE_DATA_RENEW 0x08
95 #define ANGLE3_OPCODE_READ_ANGLE 0x09
96  // End group operation_code
97 
102 #define ANGLE3_NORMAL_MODE 0x0000
103 #define ANGLE3_USER_MODE 0x050F
104  // End group command
105 
114 #define ANGLE3_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
115 #define ANGLE3_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
116 
122 #define ANGLE3_MAP_MIKROBUS( cfg, mikrobus ) \
123  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
124  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
125  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
126  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
127  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
128  // End group macro
130 // --------------------------------------------------------------- PUBLIC TYPES
139 typedef struct
140 {
141  // Input pins
142  digital_in_t int_pin;
143 
144  // Modules
145  spi_master_t spi;
146  pin_name_t chip_select;
147 
148 } angle3_t;
149 
153 typedef struct
154 {
155  // Communication gpio pins
156  pin_name_t miso;
157  pin_name_t mosi;
158  pin_name_t sck;
159  pin_name_t cs;
160 
161  // Additional gpio pins
162  pin_name_t int_pin;
163 
164  // static variable
165  uint32_t spi_speed;
166  spi_master_mode_t spi_mode;
167  spi_master_chip_select_polarity_t cs_polarity;
168 
169 } angle3_cfg_t;
170  // End types group
172 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
173 
179 #ifdef __cplusplus
180 extern "C"{
181 #endif
182 
192 
204 
213 err_t angle3_init ( angle3_t *ctx, angle3_cfg_t *cfg );
214 
225 void angle3_write_data ( angle3_t* ctx, uint8_t opcode, uint8_t reg, uint16_t write_data );
237 uint16_t angle3_read_data ( angle3_t* ctx, uint8_t opcode, uint8_t reg );
238 
250 void angle3_write_eeprom ( angle3_t* ctx, uint8_t reg_addr, uint16_t write_data );
251 
262 uint16_t angle3_read_eeprom ( angle3_t* ctx, uint8_t reg_addr );
263 
275 
286 void angle3_write_register ( angle3_t* ctx, uint8_t reg_addr, uint16_t write_data );
287 
299 uint16_t angle3_read_register ( angle3_t* ctx, uint8_t reg_addr );
300 
312 void angle3_set_mode( angle3_t* ctx, uint16_t set_mode );
313 
324 
335 
346 
347 
359 float angle3_calculate_degrees ( angle3_t* ctx, uint16_t angle );
360 
370 uint8_t angle3_read_error ( angle3_t* ctx );
371 
372 #ifdef __cplusplus
373 }
374 #endif
375 #endif // ANGLE3_H
376  // End public_function group
379 
380 // ------------------------------------------------------------------------ END
angle3_read_angle_data
uint16_t angle3_read_angle_data(angle3_t *ctx)
Read angle data function.
angle3_cfg_t::int_pin
pin_name_t int_pin
Definition: angle3.h:162
angle3_t::int_pin
digital_in_t int_pin
Definition: angle3.h:142
angle3_cfg_t::cs
pin_name_t cs
Definition: angle3.h:159
angle3_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: angle3.h:167
spi_specifics.h
This file contains SPI specific macros, functions, etc.
angle3_set_user_mode
void angle3_set_user_mode(angle3_t *ctx)
Set user mode function.
angle3_set_normal_mode
void angle3_set_normal_mode(angle3_t *ctx)
Set normal mode function.
angle3_write_data
void angle3_write_data(angle3_t *ctx, uint8_t opcode, uint8_t reg, uint16_t write_data)
Generic write function.
angle3_t
Click ctx object definition.
Definition: angle3.h:140
angle3_read_register
uint16_t angle3_read_register(angle3_t *ctx, uint8_t reg_addr)
Read register function.
angle3_write_eeprom
void angle3_write_eeprom(angle3_t *ctx, uint8_t reg_addr, uint16_t write_data)
Write EEPROM function.
angle3_cfg_t
Click configuration structure definition.
Definition: angle3.h:154
angle3_cfg_t::sck
pin_name_t sck
Definition: angle3.h:158
angle3_read_eeprom
uint16_t angle3_read_eeprom(angle3_t *ctx, uint8_t reg_addr)
Read EEPROM function.
angle3_t::chip_select
pin_name_t chip_select
Definition: angle3.h:146
angle3_cfg_setup
void angle3_cfg_setup(angle3_cfg_t *cfg)
Config Object Initialization function.
angle3_calculate_degrees
float angle3_calculate_degrees(angle3_t *ctx, uint16_t angle)
Degrees Calculation function.
angle3_init
err_t angle3_init(angle3_t *ctx, angle3_cfg_t *cfg)
Initialization function.
angle3_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: angle3.h:166
angle3_lock_eeprom
void angle3_lock_eeprom(angle3_t *ctx)
EEPROM lock function.
angle3_t::spi
spi_master_t spi
Definition: angle3.h:145
angle3_cfg_t::miso
pin_name_t miso
Definition: angle3.h:156
angle3_read_error
uint8_t angle3_read_error(angle3_t *ctx)
Read state of Error INT Pin.
angle3_read_data
uint16_t angle3_read_data(angle3_t *ctx, uint8_t opcode, uint8_t reg)
Generic read function.
angle3_write_register
void angle3_write_register(angle3_t *ctx, uint8_t reg_addr, uint16_t write_data)
Write register function.
angle3_default_cfg
void angle3_default_cfg(angle3_t *ctx)
Default Config Object Initialization function.
angle3_set_mode
void angle3_set_mode(angle3_t *ctx, uint16_t set_mode)
Set mode function.
angle3_cfg_t::spi_speed
uint32_t spi_speed
Definition: angle3.h:165
angle3_cfg_t::mosi
pin_name_t mosi
Definition: angle3.h:157