dcmotor17.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/
 
#ifndef DCMOTOR17_H
#define DCMOTOR17_H
 
#ifdef __cplusplus
extern "C"{
#endif
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
 
#define dcmotor17_retval_t  uint8_t
 
#define DCMOTOR17_OK                     0x00
#define DCMOTOR17_ERROR                  0xFF
 
 // retval_flag
 
#define DCMOTOR17_SEL_OUT_A              0
#define DCMOTOR17_SEL_OUT_B              1
 
 // sel_out
 
#define DCMOTOR17_SEL_MODE_STANDBY       0
#define DCMOTOR17_SEL_MODE_NORMAL        1
 
 // mode
 
#define DCMOTOR17_MAP_MIKROBUS( cfg, mikrobus )   \
    cfg.i1a = MIKROBUS( mikrobus, MIKROBUS_AN );  \
    cfg.i2a = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.stby = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.i1b = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.i2b = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // dcmotor17_map
 // dcmotor17
 
typedef struct
{
    digital_out_t  i1a;     
    digital_out_t  i2a;     
    digital_out_t  stby;    
    digital_out_t  i1b;     
    digital_out_t  i2b;     
} dcmotor17_t;
 
typedef struct
{
    pin_name_t  i1a;    
    pin_name_t  i2a;    
    pin_name_t  stby;   
    pin_name_t  i1b;    
    pin_name_t  i2b;    
} dcmotor17_cfg_t;
 
void dcmotor17_cfg_setup ( dcmotor17_cfg_t *cfg );
 
err_t dcmotor17_init ( dcmotor17_t *ctx, dcmotor17_cfg_t *cfg );
 
void dcmotor17_default_cfg ( dcmotor17_t *ctx );
 
void dcmotor17_standby_mode ( dcmotor17_t *ctx );
 
void dcmotor17_normal_mode ( dcmotor17_t *ctx );
 
dcmotor17_retval_t dcmotor17_set_mode ( dcmotor17_t *ctx, uint8_t op_mode );
 
dcmotor17_retval_t dcmotor17_stop ( dcmotor17_t *ctx, uint8_t sel_out );
 
dcmotor17_retval_t dcmotor17_forward ( dcmotor17_t *ctx, uint8_t sel_out );
 
dcmotor17_retval_t dcmotor17_reverse ( dcmotor17_t *ctx, uint8_t sel_out );
 
#ifdef __cplusplus
}
#endif
#endif // DCMOTOR17_H
 
 // dcmotor17
 
// ------------------------------------------------------------------------ END