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 
41 // -------------------------------------------------------------- PUBLIC MACROS
51 #define ANGLE3_RETVAL uint8_t
52 
53 #define ANGLE3_OK 0x00
54 #define ANGLE3_INIT_ERROR 0xFF
55 
61 #define ANGLE3_REG_ANG 0x00
62 #define ANGLE3_REG_MAG 0x01
63 #define ANGLE3_REG_CHMD 0x02
64 #define ANGLE3_REG_ERRMON 0x03
65 #define ANGLE3_REG_ZP 0x06
66 #define ANGLE3_REG_RDABZ 0x07
67 #define ANGLE3_REG_MLK 0x08
68 #define ANGLE3_REG_EBDIS 0x09
69 #define ANGLE3_REG_UVW 0x0A
70  // End group register
71 
76 #define ANGLE3_EEPROM_ID1 0x04
77 #define ANGLE3_EEPROM_ID2 0x05
78 #define ANGLE3_EEPROM_ZP 0x06
79 #define ANGLE3_EEPROM_RDABZ 0x07
80 #define ANGLE3_EEPROM_MLK 0x08
81 #define ANGLE3_EEPROM_EBDIS 0x09
82 #define ANGLE3_EEPROM_UVW 0x0A
83  // End group EEPROM_locations
84 
89 #define ANGLE3_OPCODE_LOCK_EEPROM 0x00
90 #define ANGLE3_OPCODE_WRITE_EEPROM 0x01
91 #define ANGLE3_OPCODE_READ_EEPROM 0x02
92 #define ANGLE3_OPCODE_WRITE_REG 0x03
93 #define ANGLE3_OPCODE_READ_REG 0x04
94 #define ANGLE3_OPCODE_CHANGE_MODE 0x05
95 #define ANGLE3_OPCODE_ANGLE_DATA_RENEW 0x08
96 #define ANGLE3_OPCODE_READ_ANGLE 0x09
97  // End group operation_code
98 
103 #define ANGLE3_NORMAL_MODE 0x0000
104 #define ANGLE3_USER_MODE 0x050F
105  // End group command
106 
112 #define ANGLE3_MAP_MIKROBUS( cfg, mikrobus ) \
113  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
114  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
115  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
116  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
117  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
118  // End group macro
120 // --------------------------------------------------------------- PUBLIC TYPES
129 typedef struct
130 {
131  // Input pins
132 
133  digital_in_t int_pin;
134 
135  // Modules
136 
137  spi_master_t spi;
138  pin_name_t chip_select;
139 
140 } angle3_t;
141 
145 typedef struct
146 {
147  // Communication gpio pins
148 
149  pin_name_t miso;
150  pin_name_t mosi;
151  pin_name_t sck;
152  pin_name_t cs;
153 
154  // Additional gpio pins
155 
156  pin_name_t int_pin;
157 
158  // static variable
159 
160  uint32_t spi_speed;
161  spi_master_mode_t spi_mode;
162  spi_master_chip_select_polarity_t cs_polarity;
163 
164 } angle3_cfg_t;
165  // End types group
167 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
168 
174 #ifdef __cplusplus
175 extern "C"{
176 #endif
177 
186 void angle3_cfg_setup ( angle3_cfg_t *cfg );
187 
198 void angle3_default_cfg ( angle3_t *ctx );
199 
209 
220 void angle3_write_data ( angle3_t* ctx, uint8_t opcode, uint8_t reg,
221  uint16_t write_data );
233 uint16_t angle3_read_data ( angle3_t* ctx, uint8_t opcode, uint8_t reg );
234 
246 void angle3_write_EEPROM ( angle3_t* ctx, uint8_t reg_addr, uint16_t write_data );
247 
258 uint16_t angle3_read_EEPROM ( angle3_t* ctx, uint8_t reg_addr );
259 
270 void angle3_lock_EEPROM ( angle3_t* ctx );
271 
282 void angle3_write_register ( angle3_t* ctx, uint8_t reg_addr, uint16_t write_data );
283 
295 uint16_t angle3_read_register ( angle3_t* ctx, uint8_t reg_addr );
296 
308 void angle3_set_mode( angle3_t* ctx, uint16_t set_mode );
309 
319 void angle3_set_normal_mode ( angle3_t* ctx );
320 
330 void angle3_set_user_mode ( angle3_t* ctx );
331 
341 uint16_t angle3_read_angle_data ( angle3_t* ctx );
342 
343 
356 float angle3_calculate_degrees ( angle3_t* ctx, uint16_t angle );
357 
368 uint8_t angle3_read_error ( angle3_t* ctx );
369 
370 #ifdef __cplusplus
371 }
372 #endif
373 #endif // ANGLE3_H
374  // End public_function group
377 
378 // ------------------------------------------------------------------------ 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:156
angle3_t::int_pin
digital_in_t int_pin
Definition: angle3.h:133
angle3_cfg_t::cs
pin_name_t cs
Definition: angle3.h:152
angle3_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: angle3.h:162
angle3_read_EEPROM
uint16_t angle3_read_EEPROM(angle3_t *ctx, uint8_t reg_addr)
Read EEPROM function.
angle3_set_user_mode
void angle3_set_user_mode(angle3_t *ctx)
Set user mode function.
angle3_init
ANGLE3_RETVAL angle3_init(angle3_t *ctx, angle3_cfg_t *cfg)
Initialization 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:129
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:145
angle3_cfg_t::sck
pin_name_t sck
Definition: angle3.h:151
angle3_t::chip_select
pin_name_t chip_select
Definition: angle3.h:138
ANGLE3_RETVAL
#define ANGLE3_RETVAL
Definition: angle3.h:51
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_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: angle3.h:161
angle3_t::spi
spi_master_t spi
Definition: angle3.h:137
angle3_cfg_t::miso
pin_name_t miso
Definition: angle3.h:149
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:160
angle3_cfg_t::mosi
pin_name_t mosi
Definition: angle3.h:150
angle3_lock_EEPROM
void angle3_lock_EEPROM(angle3_t *ctx)
EEPROM lock function.