dcmotor5.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 DCMOTOR5_H
#define DCMOTOR5_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"
#include "drv_pwm.h"
 
#define DCMOTOR5_DEF_FREQ     20000
 
 // dcmotor5_cfg
 
#define DCMOTOR5_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.snso = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.sleep = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.fault = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.in2 = MIKROBUS( mikrobus, MIKROBUS_INT );
 
 // dcmotor5_map
 // dcmotor5
 
typedef struct
{
    // Output pins
    digital_out_t sleep;            
    digital_out_t in2;              
    // Input pins
    digital_in_t snso;              
    digital_in_t fault;             
    // Modules
    pwm_t pwm;                      
    // ctx variable
    uint32_t pwm_freq;              
} dcmotor5_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t pwm;          
    // Additional gpio pins
    pin_name_t snso;         
    pin_name_t sleep;        
    pin_name_t fault;        
    pin_name_t in2;          
    // Static variable
    uint32_t dev_pwm_freq;   
} dcmotor5_cfg_t;
 
typedef enum
{
    DCMOTOR5_OK = 0,
    DCMOTOR5_ERROR = -1
 
} dcmotor5_return_value_t;
 
void dcmotor5_cfg_setup ( dcmotor5_cfg_t *cfg );
 
err_t dcmotor5_init ( dcmotor5_t *ctx, dcmotor5_cfg_t *cfg );
 
void dcmotor5_default_cfg ( dcmotor5_t *ctx );
 
void dcmotor5_set_duty_cycle ( dcmotor5_t *ctx, float duty_cycle );
 
void dcmotor5_pwm_stop ( dcmotor5_t *ctx );
 
void dcmotor5_pwm_start ( dcmotor5_t *ctx );
 
void dcmotor5_enable ( dcmotor5_t *ctx );
 
void dcmotor5_standby ( dcmotor5_t *ctx );
 
void dcmotor5_counter_clockwise ( dcmotor5_t *ctx );
 
void dcmotor5_clockwise ( dcmotor5_t *ctx );
 
void dcmotor5_short_brake ( dcmotor5_t *ctx );
 
void dcmotor5_stop ( dcmotor5_t *ctx );
 
uint8_t dcmotor5_get_fault_conditions ( dcmotor5_t *ctx );
 
uint8_t dcmotor5_get_sense_comparator ( dcmotor5_t *ctx );
 
 
#ifdef __cplusplus
}
#endif
#endif // DCMOTOR5_H
 
 // dcmotor5
 
// ------------------------------------------------------------------------ END