dcmotor19.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 DCMOTOR19_H
#define DCMOTOR19_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"
#include "drv_digital_in.h"
 
#define DCMOTOR19_CHANNEL_1             0x01
#define DCMOTOR19_CHANNEL_2             0x02
 
#define DCMOTOR19_MODE_STOP             0x00
#define DCMOTOR19_MODE_FORWARD          0x01
#define DCMOTOR19_MODE_REVERSE          0x02
#define DCMOTOR19_MODE_SHORT_BRAKE      0x03
 
#define DCMOTOR19_SPEED_MAX             100
#define DCMOTOR19_SPEED_DEFAULT         5
#define DCMOTOR19_SPEED_MIN             1
#define DCMOTOR19_MS_TIME_STEP          10
 
 // dcmotor19_set
 
#define DCMOTOR19_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.in1 = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.in2 = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.sby = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.in3 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.in4 = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // dcmotor19_map
 // dcmotor19
 
typedef struct
{
    digital_out_t  in1;         
    digital_out_t  in2;         
    digital_out_t  sby;         
    digital_out_t  in3;         
    digital_out_t  in4;         
    uint8_t        active_ch;   
    uint8_t        mode;        
} dcmotor19_t;
 
typedef struct
{
    pin_name_t  in1;            
    pin_name_t  in2;            
    pin_name_t  sby;            
    pin_name_t  in3;            
    pin_name_t  in4;            
} dcmotor19_cfg_t;
 
typedef enum
{
    DCMOTOR19_OK = 0,
    DCMOTOR19_ERROR = -1
 
} dcmotor19_return_value_t;
 
void dcmotor19_cfg_setup ( dcmotor19_cfg_t *cfg );
 
err_t dcmotor19_init ( dcmotor19_t *ctx, dcmotor19_cfg_t *cfg );
 
err_t dcmotor19_drive_motor ( dcmotor19_t *ctx, uint8_t speed, uint32_t time_ms );
 
err_t dcmotor19_set_channel_mode ( dcmotor19_t *ctx, uint8_t channel, uint8_t mode );
 
void dcmotor19_disable_standby_mode ( dcmotor19_t *ctx );
 
void dcmotor19_enable_standby_mode ( dcmotor19_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // DCMOTOR19_H
 
 // dcmotor19
 
// ------------------------------------------------------------------------ END