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 
39 #ifdef PREINIT_SUPPORTED
40 #include "preinit.h"
41 #endif
42 
43 #ifdef MikroCCoreVersion
44  #if MikroCCoreVersion >= 1
45  #include "delays.h"
46  #endif
47 #endif
48 
49 #include "drv_digital_out.h"
50 #include "drv_digital_in.h"
51 #include "drv_analog_in.h"
52 
63 #define DCMOTOR15_RIPROP_OHM 1500
64 #define DCMOTOR15_AIPROP_AMP 0.000455
65 
80 #define DCMOTOR15_MAP_MIKROBUS( cfg, mikrobus ) \
81  cfg.ipr = MIKROBUS( mikrobus, MIKROBUS_AN ); \
82  cfg.slp = MIKROBUS( mikrobus, MIKROBUS_RST ); \
83  cfg.in2 = MIKROBUS( mikrobus, MIKROBUS_CS ); \
84  cfg.in1 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
85  cfg.flt = MIKROBUS( mikrobus, MIKROBUS_INT )
86  // dcmotor15_map // dcmotor15
89 
94 typedef struct
95 {
96  digital_out_t slp;
97  digital_out_t in2;
98  digital_out_t in1;
100  digital_in_t flt;
102  analog_in_t adc;
104 } dcmotor15_t;
105 
110 typedef struct
111 {
112  pin_name_t ipr;
113  pin_name_t slp;
114  pin_name_t in2;
115  pin_name_t in1;
116  pin_name_t flt;
118  analog_in_resolution_t resolution;
119  float vref;
122 
127 typedef enum
128 {
130  DCMOTOR15_ERROR = -1
131 
133 
138 typedef enum
139 {
141  DCMOTOR15_HIGH = 1
142 
144 
161 
177 
189 
202 err_t dcmotor15_read_an_pin_value ( dcmotor15_t *ctx, uint16_t *data_out );
203 
218 err_t dcmotor15_read_an_pin_voltage ( dcmotor15_t *ctx, float *data_out );
219 
229 void dcmotor15_set_slp_pin_state ( dcmotor15_t *ctx, uint8_t state );
230 
240 void dcmotor15_set_in1_pin_state ( dcmotor15_t *ctx, uint8_t state );
241 
251 void dcmotor15_set_in2_pin_state ( dcmotor15_t *ctx, uint8_t state );
252 
262 
272 
282 
292 
302 
312 float dcmotor15_get_current ( dcmotor15_t *ctx, uint16_t num_of_conv );
313 
314 #ifdef __cplusplus
315 }
316 #endif
317 #endif // DCMOTOR15_H
318  // dcmotor15
320 
321 // ------------------------------------------------------------------------ END
dcmotor15_cfg_t
DC Motor 15 Click configuration object.
Definition: dcmotor15.h:111
dcmotor15_cfg_t::flt
pin_name_t flt
Definition: dcmotor15.h:116
DCMOTOR15_HIGH
@ DCMOTOR15_HIGH
Definition: dcmotor15.h:141
DCMOTOR15_ERROR
@ DCMOTOR15_ERROR
Definition: dcmotor15.h:130
dcmotor15_t::adc
analog_in_t adc
Definition: dcmotor15.h:102
dcmotor15_t
DC Motor 15 Click context object.
Definition: dcmotor15.h:95
dcmotor15_cfg_t::in1
pin_name_t in1
Definition: dcmotor15.h:115
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_cfg_t::in2
pin_name_t in2
Definition: dcmotor15.h:114
dcmotor15_t::flt
digital_in_t flt
Definition: dcmotor15.h:100
dcmotor15_cfg_t::ipr
pin_name_t ipr
Definition: dcmotor15.h:112
dcmotor15_t::in2
digital_out_t in2
Definition: dcmotor15.h:97
DCMOTOR15_OK
@ DCMOTOR15_OK
Definition: dcmotor15.h:129
dcmotor15_t::in1
digital_out_t in1
Definition: dcmotor15.h:98
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:128
dcmotor15_t::slp
digital_out_t slp
Definition: dcmotor15.h:96
dcmotor15_pin_state_value_t
dcmotor15_pin_state_value_t
DC Motor 15 Click pin state value data.
Definition: dcmotor15.h:139
dcmotor15_cfg_t::slp
pin_name_t slp
Definition: dcmotor15.h:113
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
@ DCMOTOR15_LOW
Definition: dcmotor15.h:140
dcmotor15_cfg_t::vref
float vref
Definition: dcmotor15.h:119
dcmotor15_cfg_t::resolution
analog_in_resolution_t resolution
Definition: dcmotor15.h:118
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.