dcmotor20  2.0.0.0
dcmotor20.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 DCMOTOR20_H
29 #define DCMOTOR20_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "mikrosdk_version.h"
36 
37 #ifdef __GNUC__
38 #if mikroSDK_GET_VERSION < 20800ul
39 #include "rcu_delays.h"
40 #else
41 #include "delays.h"
42 #endif
43 #endif
44 
45 #include "drv_digital_out.h"
46 #include "drv_digital_in.h"
47 #include "drv_pwm.h"
48 
69 #define DCMOTOR20_CHANNEL_1 0x01
70 #define DCMOTOR20_CHANNEL_2 0x02
71 
76 #define DCMOTOR20_MODE_STOP 0x00
77 #define DCMOTOR20_MODE_FORWARD 0x01
78 #define DCMOTOR20_MODE_REVERSE 0x02
79 
84 #define DCMOTOR20_SPEED_MAX 100
85 #define DCMOTOR20_SPEED_DEFAULT 10
86 #define DCMOTOR20_SPEED_MIN 1
87 #define DCMOTOR20_MS_TIME_STEP 10
88  // dcmotor20_set
90 
105 #define DCMOTOR20_MAP_MIKROBUS( cfg, mikrobus ) \
106  cfg.in1 = MIKROBUS( mikrobus, MIKROBUS_AN ); \
107  cfg.in2 = MIKROBUS( mikrobus, MIKROBUS_RST ); \
108  cfg.in3 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
109  cfg.in4 = MIKROBUS( mikrobus, MIKROBUS_INT )
110  // dcmotor20_map // dcmotor20
113 
118 typedef struct
119 {
120  digital_out_t in1;
121  digital_out_t in2;
122  digital_out_t in3;
123  digital_out_t in4;
125  uint8_t active_ch;
126  uint8_t mode;
128 } dcmotor20_t;
129 
134 typedef struct
135 {
136  pin_name_t in1;
137  pin_name_t in2;
138  pin_name_t in3;
139  pin_name_t in4;
142 
147 typedef enum
148 {
150  DCMOTOR20_ERROR = -1
151 
153 
170 
186 
202 err_t dcmotor20_drive_motor ( dcmotor20_t *ctx, uint8_t speed, uint32_t time_ms );
203 
218 err_t dcmotor20_set_channel_mode ( dcmotor20_t *ctx, uint8_t channel, uint8_t mode );
219 
229 
230 #ifdef __cplusplus
231 }
232 #endif
233 #endif // DCMOTOR20_H
234  // dcmotor20
236 
237 // ------------------------------------------------------------------------ END
dcmotor20_t::active_ch
uint8_t active_ch
Definition: dcmotor20.h:125
dcmotor20_cfg_t::in4
pin_name_t in4
Definition: dcmotor20.h:139
dcmotor20_return_value_t
dcmotor20_return_value_t
DC Motor 20 Click return value data.
Definition: dcmotor20.h:148
dcmotor20_t::in2
digital_out_t in2
Definition: dcmotor20.h:121
dcmotor20_drive_motor
err_t dcmotor20_drive_motor(dcmotor20_t *ctx, uint8_t speed, uint32_t time_ms)
DC Motor 20 drive motor function.
dcmotor20_t::in1
digital_out_t in1
Definition: dcmotor20.h:120
dcmotor20_cfg_t::in2
pin_name_t in2
Definition: dcmotor20.h:137
dcmotor20_t
DC Motor 20 Click context object.
Definition: dcmotor20.h:119
dcmotor20_init
err_t dcmotor20_init(dcmotor20_t *ctx, dcmotor20_cfg_t *cfg)
DC Motor 20 initialization function.
DCMOTOR20_ERROR
@ DCMOTOR20_ERROR
Definition: dcmotor20.h:150
dcmotor20_t::in4
digital_out_t in4
Definition: dcmotor20.h:123
DCMOTOR20_OK
@ DCMOTOR20_OK
Definition: dcmotor20.h:149
dcmotor20_set_channel_mode
err_t dcmotor20_set_channel_mode(dcmotor20_t *ctx, uint8_t channel, uint8_t mode)
DC Motor 20 set channel mode function.
dcmotor20_cfg_t::in1
pin_name_t in1
Definition: dcmotor20.h:136
dcmotor20_cfg_t::in3
pin_name_t in3
Definition: dcmotor20.h:138
dcmotor20_set_standby_mode
void dcmotor20_set_standby_mode(dcmotor20_t *ctx)
DC Motor 20 set standby mode function.
dcmotor20_t::mode
uint8_t mode
Definition: dcmotor20.h:126
dcmotor20_t::in3
digital_out_t in3
Definition: dcmotor20.h:122
dcmotor20_cfg_t
DC Motor 20 Click configuration object.
Definition: dcmotor20.h:135
dcmotor20_cfg_setup
void dcmotor20_cfg_setup(dcmotor20_cfg_t *cfg)
DC Motor 20 configuration object setup function.