dcmotor15  2.0.0.0
dcmotor15.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 DCMOTOR15_H
29 #define DCMOTOR15_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_analog_in.h"
38 
49 #define DCMOTOR15_RIPROP_OHM 1500
50 #define DCMOTOR15_AIPROP_AMP 0.000455
51 
66 #define DCMOTOR15_MAP_MIKROBUS( cfg, mikrobus ) \
67  cfg.ipr = MIKROBUS( mikrobus, MIKROBUS_AN ); \
68  cfg.slp = MIKROBUS( mikrobus, MIKROBUS_RST ); \
69  cfg.in2 = MIKROBUS( mikrobus, MIKROBUS_CS ); \
70  cfg.in1 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
71  cfg.flt = MIKROBUS( mikrobus, MIKROBUS_INT )
72  // dcmotor15_map // dcmotor15
75 
80 typedef struct
81 {
82  digital_out_t slp;
83  digital_out_t in2;
84  digital_out_t in1;
86  digital_in_t flt;
88  analog_in_t adc;
90 } dcmotor15_t;
91 
96 typedef struct
97 {
98  pin_name_t ipr;
99  pin_name_t slp;
100  pin_name_t in2;
101  pin_name_t in1;
102  pin_name_t flt;
104  analog_in_resolution_t resolution;
105  float vref;
108 
113 typedef enum
114 {
116  DCMOTOR15_ERROR = -1
117 
119 
124 typedef enum
125 {
127  DCMOTOR15_HIGH = 1
128 
130 
147 
162 err_t dcmotor15_init ( dcmotor15_t *ctx, dcmotor15_cfg_t *cfg );
163 
174 void dcmotor15_default_cfg ( dcmotor15_t *ctx );
175 
188 err_t dcmotor15_read_an_pin_value ( dcmotor15_t *ctx, uint16_t *data_out );
189 
204 err_t dcmotor15_read_an_pin_voltage ( dcmotor15_t *ctx, float *data_out );
205 
215 void dcmotor15_set_slp_pin_state ( dcmotor15_t *ctx, uint8_t state );
216 
226 void dcmotor15_set_in1_pin_state ( dcmotor15_t *ctx, uint8_t state );
227 
237 void dcmotor15_set_in2_pin_state ( dcmotor15_t *ctx, uint8_t state );
238 
247 uint8_t dcmotor15_fault_check ( dcmotor15_t *ctx );
248 
257 void dcmotor15_forward ( dcmotor15_t *ctx );
258 
267 void dcmotor15_reverse ( dcmotor15_t *ctx );
268 
277 void dcmotor15_brake ( dcmotor15_t *ctx );
278 
287 void dcmotor15_stop ( dcmotor15_t *ctx );
288 
298 float dcmotor15_get_current ( dcmotor15_t *ctx, uint16_t num_of_conv );
299 
300 #ifdef __cplusplus
301 }
302 #endif
303 #endif // DCMOTOR15_H
304  // dcmotor15
306 
307 // ------------------------------------------------------------------------ END
dcmotor15_cfg_t
DC Motor 15 Click configuration object.
Definition: dcmotor15.h:95
DCMOTOR15_HIGH
Definition: dcmotor15.h:126
DCMOTOR15_ERROR
Definition: dcmotor15.h:115
dcmotor15_t
DC Motor 15 Click context object.
Definition: dcmotor15.h:79
dcmotor15_cfg_setup
void dcmotor15_cfg_setup(dcmotor15_cfg_t *cfg)
DC Motor 15 configuration object setup function.
dcmotor15_set_slp_pin_state
void dcmotor15_set_slp_pin_state(dcmotor15_t *ctx, uint8_t state)
DC Motor 15 set SLP pin state function.
dcmotor15_get_current
float dcmotor15_get_current(dcmotor15_t *ctx, uint16_t num_of_conv)
DC Motor 15 get current function.
DCMOTOR15_OK
Definition: dcmotor15.h:114
dcmotor15_read_an_pin_voltage
err_t dcmotor15_read_an_pin_voltage(dcmotor15_t *ctx, float *data_out)
DC Motor 15 read IPR pin voltage level function.
dcmotor15_set_in1_pin_state
void dcmotor15_set_in1_pin_state(dcmotor15_t *ctx, uint8_t state)
DC Motor 15 set IN1 pin state function.
dcmotor15_init
err_t dcmotor15_init(dcmotor15_t *ctx, dcmotor15_cfg_t *cfg)
DC Motor 15 initialization function.
dcmotor15_stop
void dcmotor15_stop(dcmotor15_t *ctx)
DC Motor 15 stop function.
dcmotor15_brake
void dcmotor15_brake(dcmotor15_t *ctx)
DC Motor 15 brake function.
dcmotor15_return_value_t
dcmotor15_return_value_t
DC Motor 15 Click return value data.
Definition: dcmotor15.h:112
dcmotor15_pin_state_value_t
dcmotor15_pin_state_value_t
DC Motor 15 Click pin state value data.
Definition: dcmotor15.h:123
dcmotor15_forward
void dcmotor15_forward(dcmotor15_t *ctx)
DC Motor 15 drive forward function.
dcmotor15_reverse
void dcmotor15_reverse(dcmotor15_t *ctx)
DC Motor 15 drive reverse function.
dcmotor15_read_an_pin_value
err_t dcmotor15_read_an_pin_value(dcmotor15_t *ctx, uint16_t *data_out)
DC Motor 15 read IPR pin value function.
DCMOTOR15_LOW
Definition: dcmotor15.h:125
dcmotor15_set_in2_pin_state
void dcmotor15_set_in2_pin_state(dcmotor15_t *ctx, uint8_t state)
DC Motor 15 set IN2 pin state function.
dcmotor15_default_cfg
void dcmotor15_default_cfg(dcmotor15_t *ctx)
DC Motor 15 default configuration function.
dcmotor15_fault_check
uint8_t dcmotor15_fault_check(dcmotor15_t *ctx)
DC Motor 15 get FLT pin state function.