dcmotor19  2.0.0.0
dcmotor19.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 DCMOTOR19_H
29 #define DCMOTOR19_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 
58 #define DCMOTOR19_CHANNEL_1 0x01
59 #define DCMOTOR19_CHANNEL_2 0x02
60 
65 #define DCMOTOR19_MODE_STOP 0x00
66 #define DCMOTOR19_MODE_FORWARD 0x01
67 #define DCMOTOR19_MODE_REVERSE 0x02
68 #define DCMOTOR19_MODE_SHORT_BRAKE 0x03
69 
74 #define DCMOTOR19_SPEED_MAX 100
75 #define DCMOTOR19_SPEED_DEFAULT 5
76 #define DCMOTOR19_SPEED_MIN 1
77 #define DCMOTOR19_MS_TIME_STEP 10
78  // dcmotor19_set
80 
95 #define DCMOTOR19_MAP_MIKROBUS( cfg, mikrobus ) \
96  cfg.in1 = MIKROBUS( mikrobus, MIKROBUS_AN ); \
97  cfg.in2 = MIKROBUS( mikrobus, MIKROBUS_RST ); \
98  cfg.sby = MIKROBUS( mikrobus, MIKROBUS_CS ); \
99  cfg.in3 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
100  cfg.in4 = MIKROBUS( mikrobus, MIKROBUS_INT )
101  // dcmotor19_map // dcmotor19
104 
109 typedef struct
110 {
111  digital_out_t in1;
112  digital_out_t in2;
113  digital_out_t sby;
114  digital_out_t in3;
115  digital_out_t in4;
117  uint8_t active_ch;
118  uint8_t mode;
120 } dcmotor19_t;
121 
126 typedef struct
127 {
128  pin_name_t in1;
129  pin_name_t in2;
130  pin_name_t sby;
131  pin_name_t in3;
132  pin_name_t in4;
135 
140 typedef enum
141 {
143  DCMOTOR19_ERROR = -1
144 
146 
163 
179 
195 err_t dcmotor19_drive_motor ( dcmotor19_t *ctx, uint8_t speed, uint32_t time_ms );
196 
211 err_t dcmotor19_set_channel_mode ( dcmotor19_t *ctx, uint8_t channel, uint8_t mode );
212 
222 
232 
233 #ifdef __cplusplus
234 }
235 #endif
236 #endif // DCMOTOR19_H
237  // dcmotor19
239 
240 // ------------------------------------------------------------------------ END
dcmotor19_cfg_t
DC Motor 19 Click configuration object.
Definition: dcmotor19.h:127
dcmotor19_init
err_t dcmotor19_init(dcmotor19_t *ctx, dcmotor19_cfg_t *cfg)
DC Motor 19 initialization function.
dcmotor19_t::sby
digital_out_t sby
Definition: dcmotor19.h:113
dcmotor19_t::in2
digital_out_t in2
Definition: dcmotor19.h:112
dcmotor19_drive_motor
err_t dcmotor19_drive_motor(dcmotor19_t *ctx, uint8_t speed, uint32_t time_ms)
DC Motor 19 drive motor function.
dcmotor19_t::in3
digital_out_t in3
Definition: dcmotor19.h:114
dcmotor19_t
DC Motor 19 Click context object.
Definition: dcmotor19.h:110
dcmotor19_t::active_ch
uint8_t active_ch
Definition: dcmotor19.h:117
dcmotor19_t::in4
digital_out_t in4
Definition: dcmotor19.h:115
dcmotor19_cfg_t::in1
pin_name_t in1
Definition: dcmotor19.h:128
dcmotor19_enable_standby_mode
void dcmotor19_enable_standby_mode(dcmotor19_t *ctx)
DC Motor 19 enable standby mode function.
dcmotor19_cfg_t::in2
pin_name_t in2
Definition: dcmotor19.h:129
dcmotor19_return_value_t
dcmotor19_return_value_t
DC Motor 19 Click return value data.
Definition: dcmotor19.h:141
dcmotor19_cfg_t::in4
pin_name_t in4
Definition: dcmotor19.h:132
dcmotor19_cfg_setup
void dcmotor19_cfg_setup(dcmotor19_cfg_t *cfg)
DC Motor 19 configuration object setup function.
dcmotor19_t::in1
digital_out_t in1
Definition: dcmotor19.h:111
dcmotor19_cfg_t::sby
pin_name_t sby
Definition: dcmotor19.h:130
dcmotor19_cfg_t::in3
pin_name_t in3
Definition: dcmotor19.h:131
DCMOTOR19_OK
@ DCMOTOR19_OK
Definition: dcmotor19.h:142
dcmotor19_disable_standby_mode
void dcmotor19_disable_standby_mode(dcmotor19_t *ctx)
DC Motor 19 disable standby mode function.
DCMOTOR19_ERROR
@ DCMOTOR19_ERROR
Definition: dcmotor19.h:143
dcmotor19_set_channel_mode
err_t dcmotor19_set_channel_mode(dcmotor19_t *ctx, uint8_t channel, uint8_t mode)
DC Motor 19 set channel mode function.
dcmotor19_t::mode
uint8_t mode
Definition: dcmotor19.h:118