angle3  2.0.0.0
angle3.h
Go to the documentation of this file.
1 /*
2  * MikroSDK - MikroE Software Development Kit
3  * Copyright (c) 2019, MikroElektronika - www.mikroe.com
4  * All rights reserved.
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to deal
8  * in the Software without restriction, including without limitation the rights
9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10  * copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in
14  * all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22  * SOFTWARE.
23  */
24 
33 // ----------------------------------------------------------------------------
34 
35 #ifndef ANGLE3_H
36 #define ANGLE3_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_spi_master.h"
41 
42 
43 // -------------------------------------------------------------- PUBLIC MACROS
53 #define ANGLE3_RETVAL uint8_t
54 
55 #define ANGLE3_OK 0x00
56 #define ANGLE3_INIT_ERROR 0xFF
57 
63 #define ANGLE3_REG_ANG 0x00
64 #define ANGLE3_REG_MAG 0x01
65 #define ANGLE3_REG_CHMD 0x02
66 #define ANGLE3_REG_ERRMON 0x03
67 #define ANGLE3_REG_ZP 0x06
68 #define ANGLE3_REG_RDABZ 0x07
69 #define ANGLE3_REG_MLK 0x08
70 #define ANGLE3_REG_EBDIS 0x09
71 #define ANGLE3_REG_UVW 0x0A
72  // End group register
73 
78 #define ANGLE3_EEPROM_ID1 0x04
79 #define ANGLE3_EEPROM_ID2 0x05
80 #define ANGLE3_EEPROM_ZP 0x06
81 #define ANGLE3_EEPROM_RDABZ 0x07
82 #define ANGLE3_EEPROM_MLK 0x08
83 #define ANGLE3_EEPROM_EBDIS 0x09
84 #define ANGLE3_EEPROM_UVW 0x0A
85  // End group EEPROM_locations
86 
91 #define ANGLE3_OPCODE_LOCK_EEPROM 0x00
92 #define ANGLE3_OPCODE_WRITE_EEPROM 0x01
93 #define ANGLE3_OPCODE_READ_EEPROM 0x02
94 #define ANGLE3_OPCODE_WRITE_REG 0x03
95 #define ANGLE3_OPCODE_READ_REG 0x04
96 #define ANGLE3_OPCODE_CHANGE_MODE 0x05
97 #define ANGLE3_OPCODE_ANGLE_DATA_RENEW 0x08
98 #define ANGLE3_OPCODE_READ_ANGLE 0x09
99  // End group operation_code
100 
105 #define ANGLE3_NORMAL_MODE 0x0000
106 #define ANGLE3_USER_MODE 0x050F
107  // End group command
108 
114 #define ANGLE3_MAP_MIKROBUS( cfg, mikrobus ) \
115  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
116  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
117  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
118  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
119  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
120  // End group macro
122 // --------------------------------------------------------------- PUBLIC TYPES
131 typedef struct
132 {
133 
134  // Input pins
135 
136  digital_in_t int_pin;
137 
138  // Modules
139 
140  spi_master_t spi;
141 
142 } angle3_t;
143 
147 typedef struct
148 {
149  // Communication gpio pins
150 
151  pin_name_t miso;
152  pin_name_t mosi;
153  pin_name_t sck;
154  pin_name_t cs;
155 
156  // Additional gpio pins
157 
158  pin_name_t int_pin;
159 
160  // static variable
161 
162  hal_spi_speed_t spi_speed;
163  hal_spi_mode_t spi_mode;
164 
165 } angle3_cfg_t;
166  // End types group
168 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
169 
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 
208 
219 void angle3_write_data ( angle3_t* ctx, uint8_t opcode, uint8_t reg,
220  uint16_t write_data );
232 uint16_t angle3_read_data ( angle3_t* ctx, uint8_t opcode, uint8_t reg );
233 
245 void angle3_write_EEPROM ( angle3_t* ctx, uint8_t reg_addr, uint16_t write_data );
246 
257 uint16_t angle3_read_EEPROM ( angle3_t* ctx, uint8_t reg_addr );
258 
269 void angle3_lock_EEPROM ( angle3_t* ctx );
270 
281 void angle3_write_register ( angle3_t* ctx, uint8_t reg_addr, uint16_t write_data );
282 
294 uint16_t angle3_read_register ( angle3_t* ctx, uint8_t reg_addr );
295 
307 void angle3_set_mode( angle3_t* ctx, uint16_t set_mode );
308 
318 void angle3_set_normal_mode ( angle3_t* ctx );
319 
329 void angle3_set_user_mode ( angle3_t* ctx );
330 
340 uint16_t angle3_read_angle_data ( angle3_t* ctx );
341 
342 
355 float angle3_calculate_degrees ( angle3_t* ctx, uint16_t angle );
356 
367 uint8_t angle3_read_error ( angle3_t* ctx );
368 
369 #ifdef __cplusplus
370 }
371 #endif
372 #endif // _ANGLE3_H_
373  // End public_function group
376 
377 // ------------------------------------------------------------------------- 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:158
angle3_t::int_pin
digital_in_t int_pin
Definition: angle3.h:136
angle3_cfg_t::cs
pin_name_t cs
Definition: angle3.h:154
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:131
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:147
angle3_cfg_t::sck
pin_name_t sck
Definition: angle3.h:153
ANGLE3_RETVAL
#define ANGLE3_RETVAL
Definition: angle3.h:53
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_speed
hal_spi_speed_t spi_speed
Definition: angle3.h:162
angle3_t::spi
spi_master_t spi
Definition: angle3.h:140
angle3_cfg_t::miso
pin_name_t miso
Definition: angle3.h:151
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_mode
hal_spi_mode_t spi_mode
Definition: angle3.h:163
angle3_cfg_t::mosi
pin_name_t mosi
Definition: angle3.h:152
angle3_lock_EEPROM
void angle3_lock_EEPROM(angle3_t *ctx)
EEPROM lock function.