angle9  2.1.0.0
angle9.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 ANGLE9_H
29 #define ANGLE9_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "mikrosdk_version.h"
36 
37 #ifdef __GNUC__
38 #if mikroSDK_GET_VERSION < 20800ul
39 #include "rcu_delays.h"
40 #else
41 #include "delays.h"
42 #endif
43 #endif
44 
45 #include "drv_digital_out.h"
46 #include "drv_digital_in.h"
47 #include "drv_spi_master.h"
48 #include "spi_specifics.h"
49 
70 #define ANGLE9_REG_EWA 0x02
71 #define ANGLE9_REG_EWDH 0x04
72 #define ANGLE9_REG_EWDL 0x06
73 #define ANGLE9_REG_EWCS 0x08
74 #define ANGLE9_REG_ERA 0x0A
75 #define ANGLE9_REG_ERCS 0x0C
76 #define ANGLE9_REG_ERDH 0x0E
77 #define ANGLE9_REG_ERDL 0x10
78 #define ANGLE9_REG_CTRL 0x1E
79 #define ANGLE9_REG_ANG 0x20
80 #define ANGLE9_REG_STA 0x22
81 #define ANGLE9_REG_ERR 0x24
82 #define ANGLE9_REG_WARN 0x26
83 #define ANGLE9_REG_TSEN 0x28
84 #define ANGLE9_REG_FIELD 0x2A
85 #define ANGLE9_REG_HANG 0x30
86 #define ANGLE9_REG_ANG15 0x32
87 #define ANGLE9_REG_ZANG 0x34
88 #define ANGLE9_REG_KEY 0x3C
89  // angle9_reg
91 
106 #define ANGLE9_WRITE_BIT 0x40
107 
112 #define ANGLE9_DATA_RESOLUTION 0x0FFFu
113 #define ANGLE9_FULL_CIRCLE 360.0f
114 #define ANGLE9_TEMP_RESOLUTION 8.0f
115 #define ANGLE9_TEMP_OFFSET 25.0f
116 
121 #define ANGLE9_ODD_PARITY 0x01
122 
131 #define ANGLE9_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
132 #define ANGLE9_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
133  // angle9_set
135 
150 #define ANGLE9_MAP_MIKROBUS( cfg, mikrobus ) \
151  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
152  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
153  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
154  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
155  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM );
156  // angle9_map // angle9
159 
164 typedef struct
165 {
166  // Input pins
167  digital_in_t pwm;
169  // Modules
170  spi_master_t spi;
172  pin_name_t chip_select;
174 } angle9_t;
175 
180 typedef struct
181 {
182  // Communication gpio pins
183  pin_name_t miso;
184  pin_name_t mosi;
185  pin_name_t sck;
186  pin_name_t cs;
188  // Additional gpio pins
189  pin_name_t pwm;
191  // static variable
192  uint32_t spi_speed;
193  spi_master_mode_t spi_mode;
194  spi_master_chip_select_polarity_t cs_polarity;
196 } angle9_cfg_t;
197 
202 typedef enum
203 {
205  ANGLE9_ERROR = -1
206 
208 
225 
239 err_t angle9_init ( angle9_t *ctx, angle9_cfg_t *cfg );
240 
254 err_t angle9_write_register ( angle9_t *ctx, uint8_t reg, uint16_t data_in );
255 
269 err_t angle9_read_register ( angle9_t *ctx, uint8_t reg, uint16_t *data_out );
270 
279 uint8_t angle9_get_pwm_pin ( angle9_t *ctx );
280 
292 err_t angle9_read_angle ( angle9_t *ctx, float *angle );
293 
305 err_t angle9_read_temperature ( angle9_t *ctx, float *temperature );
306 
318 err_t angle9_read_field_strength ( angle9_t *ctx, uint16_t *field_str );
319 
320 #ifdef __cplusplus
321 }
322 #endif
323 #endif // ANGLE9_H
324  // angle9
326 
327 // ------------------------------------------------------------------------ END
angle9_cfg_setup
void angle9_cfg_setup(angle9_cfg_t *cfg)
Angle 9 configuration object setup function.
angle9_get_pwm_pin
uint8_t angle9_get_pwm_pin(angle9_t *ctx)
Angle 9 get pwm pin function.
angle9_t::pwm
digital_in_t pwm
Definition: angle9.h:167
spi_specifics.h
This file contains SPI specific macros, functions, etc.
angle9_cfg_t::spi_speed
uint32_t spi_speed
Definition: angle9.h:192
angle9_t::spi
spi_master_t spi
Definition: angle9.h:170
angle9_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: angle9.h:194
ANGLE9_ERROR
@ ANGLE9_ERROR
Definition: angle9.h:205
angle9_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: angle9.h:193
angle9_read_temperature
err_t angle9_read_temperature(angle9_t *ctx, float *temperature)
Angle 9 read temperature function.
angle9_read_field_strength
err_t angle9_read_field_strength(angle9_t *ctx, uint16_t *field_str)
Angle 9 read field strength function.
angle9_cfg_t
Angle 9 Click configuration object.
Definition: angle9.h:181
angle9_t
Angle 9 Click context object.
Definition: angle9.h:165
angle9_return_value_t
angle9_return_value_t
Angle 9 Click return value data.
Definition: angle9.h:203
angle9_read_register
err_t angle9_read_register(angle9_t *ctx, uint8_t reg, uint16_t *data_out)
Angle 9 read register function.
ANGLE9_OK
@ ANGLE9_OK
Definition: angle9.h:204
angle9_cfg_t::cs
pin_name_t cs
Definition: angle9.h:186
angle9_write_register
err_t angle9_write_register(angle9_t *ctx, uint8_t reg, uint16_t data_in)
Angle 9 write register function.
angle9_cfg_t::pwm
pin_name_t pwm
Definition: angle9.h:189
angle9_init
err_t angle9_init(angle9_t *ctx, angle9_cfg_t *cfg)
Angle 9 initialization function.
angle9_t::chip_select
pin_name_t chip_select
Definition: angle9.h:172
angle9_cfg_t::miso
pin_name_t miso
Definition: angle9.h:183
angle9_read_angle
err_t angle9_read_angle(angle9_t *ctx, float *angle)
Angle 9 read angle function.
angle9_cfg_t::mosi
pin_name_t mosi
Definition: angle9.h:184
angle9_cfg_t::sck
pin_name_t sck
Definition: angle9.h:185