dcmotor6  2.0.0.0
dcmotor6.h
Go to the documentation of this file.
1 /*
2  * MikroSDK - MikroE Software Development Kit
3  * Copyright© 2020 MikroElektronika d.o.o.
4  *
5  * Permission is hereby granted, free of charge, to any person
6  * obtaining a copy of this software and associated documentation
7  * files (the "Software"), to deal in the Software without restriction,
8  * including without limitation the rights to use, copy, modify, merge,
9  * publish, distribute, sublicense, and/or sell copies of the Software,
10  * and to permit persons to whom the Software is furnished to do so,
11  * subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be
14  * included in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
22  * OR OTHER DEALINGS IN THE SOFTWARE.
23  */
24 
33 // ----------------------------------------------------------------------------
34 
35 #ifndef DCMOTOR6_H
36 #define DCMOTOR6_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 
41 // -------------------------------------------------------------- PUBLIC MACROS
51 #define DCMOTOR6_MAP_MIKROBUS( cfg, mikrobus ) \
52  cfg.in1= MIKROBUS( mikrobus, MIKROBUS_AN ); \
53  cfg.in2= MIKROBUS( mikrobus, MIKROBUS_RST );
54 
61 #define DCMOTOR6_RETVAL uint8_t
62 
63 #define DCMOTOR6_OK 0x00
64 #define DCMOTOR6_INIT_ERROR 0xFF
65 
71 #define DCMOTOR6_MOTOR_FORWARD 1
72 #define DCMOTOR6_MOTOR_REVERSE 2
73 #define DCMOTOR6_MOTOR_BRAKE 0
74 #define DCMOTOR6_MOTOR_STOP 0
75  // End group macro
78 // --------------------------------------------------------------- PUBLIC TYPES
87 typedef struct
88 {
89  // Output pins
90 
91  digital_out_t in1;
92  digital_out_t in2;
93 
94 
95 } dcmotor6_t;
96 
100 typedef struct
101 {
102  // Additional gpio pins
103 
104  pin_name_t in1;
105  pin_name_t in2;
106 
108  // End types group
110 
111 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
112 
118 #ifdef __cplusplus
119 extern "C"{
120 #endif
121 
130 void dcmotor6_cfg_setup ( dcmotor6_cfg_t *cfg );
131 
140 
147 void dcmotor6_set_in1_pin ( dcmotor6_t *ctx, uint8_t state );
148 
155 void dcmotor6_set_in2_pin ( dcmotor6_t *ctx, uint8_t state );
156 
163 void dcmotor6_set_direction( dcmotor6_t *ctx, uint8_t dir );
164 
165 #ifdef __cplusplus
166 }
167 #endif
168 #endif // _DCMOTOR6_H_
169  // End public_function group
172 
173 // ------------------------------------------------------------------------- END
dcmotor6_t::in2
digital_out_t in2
Definition: dcmotor6.h:92
dcmotor6_cfg_t::in1
pin_name_t in1
Definition: dcmotor6.h:104
DCMOTOR6_RETVAL
#define DCMOTOR6_RETVAL
Definition: dcmotor6.h:61
dcmotor6_init
DCMOTOR6_RETVAL dcmotor6_init(dcmotor6_t *ctx, dcmotor6_cfg_t *cfg)
Initialization function.
dcmotor6_set_in2_pin
void dcmotor6_set_in2_pin(dcmotor6_t *ctx, uint8_t state)
Set IN1 pin.
dcmotor6_set_in1_pin
void dcmotor6_set_in1_pin(dcmotor6_t *ctx, uint8_t state)
Set IN1 pin.
dcmotor6_t
Click ctx object definition.
Definition: dcmotor6.h:87
dcmotor6_set_direction
void dcmotor6_set_direction(dcmotor6_t *ctx, uint8_t dir)
Set motor Direction.
dcmotor6_cfg_setup
void dcmotor6_cfg_setup(dcmotor6_cfg_t *cfg)
Config Object Initialization function.
dcmotor6_t::in1
digital_out_t in1
Definition: dcmotor6.h:91
dcmotor6_cfg_t
Click configuration structure definition.
Definition: dcmotor6.h:100
dcmotor6_cfg_t::in2
pin_name_t in2
Definition: dcmotor6.h:105