brushless24 2.1.0.0
brushless24.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 BRUSHLESS24_H
29#define BRUSHLESS24_H
30
31#ifdef __cplusplus
32extern "C"{
33#endif
34
35#include "drv_digital_out.h"
36#include "drv_digital_in.h"
37#include "drv_pwm.h"
38
59#define BRUSHLESS24_DEF_FREQ 25000
60 // brushless24_cfg
62
77#define BRUSHLESS24_MAP_MIKROBUS( cfg, mikrobus ) \
78 cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
79 cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT );
80 // brushless24_map // brushless24
83
88typedef struct
89{
90 // Input pins
91 digital_in_t int_pin;
93 // Modules
94 pwm_t pwm;
96 // ctx variable
97 uint32_t pwm_freq;
100
105typedef struct
106{
107 // Communication gpio pins
108 pin_name_t pwm;
110 // Additional gpio pins
111 pin_name_t int_pin;
113 // Static variable
114 uint32_t dev_pwm_freq;
117
122typedef enum
123{
126
128
145
160
174
186err_t brushless24_set_duty_cycle ( brushless24_t *ctx, float duty_cycle );
187
199
211
221
222#ifdef __cplusplus
223}
224#endif
225#endif // BRUSHLESS24_H
226 // brushless24
228
229// ------------------------------------------------------------------------ END
brushless24_return_value_t
Brushless 24 Click return value data.
Definition: brushless24.h:123
@ BRUSHLESS24_ERROR
Definition: brushless24.h:125
@ BRUSHLESS24_OK
Definition: brushless24.h:124
err_t brushless24_pwm_stop(brushless24_t *ctx)
Brushless 24 stop PWM module.
err_t brushless24_set_duty_cycle(brushless24_t *ctx, float duty_cycle)
Brushless 24 sets PWM duty cycle.
err_t brushless24_init(brushless24_t *ctx, brushless24_cfg_t *cfg)
Brushless 24 initialization function.
err_t brushless24_pwm_start(brushless24_t *ctx)
Brushless 24 start PWM module.
void brushless24_cfg_setup(brushless24_cfg_t *cfg)
Brushless 24 configuration object setup function.
err_t brushless24_default_cfg(brushless24_t *ctx)
Brushless 24 default configuration function.
uint8_t brushless24_get_int_state(brushless24_t *ctx)
Brushless 24 get INT pin state.
Brushless 24 Click configuration object.
Definition: brushless24.h:106
uint32_t dev_pwm_freq
Definition: brushless24.h:114
pin_name_t int_pin
Definition: brushless24.h:111
pin_name_t pwm
Definition: brushless24.h:108
Brushless 24 Click context object.
Definition: brushless24.h:89
uint32_t pwm_freq
Definition: brushless24.h:97
digital_in_t int_pin
Definition: brushless24.h:91
pwm_t pwm
Definition: brushless24.h:94