brushless16  2.0.0.0
brushless16.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 BRUSHLESS16_H
29 #define BRUSHLESS16_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 
52 #define BRUSHLESS16_MAP_MIKROBUS( cfg, mikrobus ) \
53  cfg.en = MIKROBUS( mikrobus, MIKROBUS_CS ); \
54  cfg.fg = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
55  cfg.rd = MIKROBUS( mikrobus, MIKROBUS_INT )
56  // brushless16_map // brushless16
59 
64 typedef struct
65 {
66  digital_out_t en;
68  digital_in_t fg;
69  digital_in_t rd;
72 
77 typedef struct
78 {
79  pin_name_t en;
80  pin_name_t fg;
81  pin_name_t rd;
84 
89 typedef enum
90 {
93 
95 
112 
128 
138 void brushless16_set_en ( brushless16_t *ctx, uint8_t state );
139 
149 
150 
160 
161 #ifdef __cplusplus
162 }
163 #endif
164 #endif // BRUSHLESS16_H
165  // brushless16
167 
168 // ------------------------------------------------------------------------ END
brushless16_cfg_setup
void brushless16_cfg_setup(brushless16_cfg_t *cfg)
Brushless 16 configuration object setup function.
brushless16_cfg_t
Brushless 16 Click configuration object.
Definition: brushless16.h:78
brushless16_get_rd
uint8_t brushless16_get_rd(brushless16_t *ctx)
Get rd pin state.
brushless16_init
err_t brushless16_init(brushless16_t *ctx, brushless16_cfg_t *cfg)
Brushless 16 initialization function.
brushless16_cfg_t::en
pin_name_t en
Definition: brushless16.h:79
BRUSHLESS16_OK
@ BRUSHLESS16_OK
Definition: brushless16.h:91
BRUSHLESS16_ERROR
@ BRUSHLESS16_ERROR
Definition: brushless16.h:92
brushless16_t::en
digital_out_t en
Definition: brushless16.h:66
brushless16_cfg_t::rd
pin_name_t rd
Definition: brushless16.h:81
brushless16_t
Brushless 16 Click context object.
Definition: brushless16.h:65
brushless16_get_fg
uint8_t brushless16_get_fg(brushless16_t *ctx)
Get fg pin state.
brushless16_return_value_t
brushless16_return_value_t
Brushless 16 Click return value data.
Definition: brushless16.h:90
brushless16_set_en
void brushless16_set_en(brushless16_t *ctx, uint8_t state)
Set en pin state.
brushless16_t::fg
digital_in_t fg
Definition: brushless16.h:68
brushless16_cfg_t::fg
pin_name_t fg
Definition: brushless16.h:80
brushless16_t::rd
digital_in_t rd
Definition: brushless16.h:69