dcmotor18.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2021 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 DCMOTOR18_H
#define DCMOTOR18_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"
#include "drv_analog_in.h"
 
#define DCMOTOR18_DEF_FREQ     5000
 
 // dcmotor18_cfg
 
#define DCMOTOR18_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.pw2 = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.en = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT );
 
 // dcmotor18_map
 // dcmotor18
 
typedef struct
{
    // Output pins
    digital_out_t pw2;      
    digital_out_t en;       
    // Input pins
    digital_in_t int_pin;   
    // Modules
    pwm_t pwm;              
    analog_in_t  adc;       
    // ctx variable
    uint32_t pwm_freq;      
    uint8_t direction;      
} dcmotor18_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t pwm;     
    pin_name_t  an;     
    // Additional gpio pins
    pin_name_t pw2;     
    pin_name_t en;      
    pin_name_t int_pin; 
    // Static variable
    uint32_t dev_pwm_freq;              
    analog_in_resolution_t  resolution; 
    float                   vref;       
} dcmotor18_cfg_t;
 
typedef enum
{
   DCMOTOR18_OK = 0,
   DCMOTOR18_ERROR = -1
 
} dcmotor18_return_value_t;
 
void dcmotor18_cfg_setup ( dcmotor18_cfg_t *cfg );
 
err_t dcmotor18_init ( dcmotor18_t *ctx, dcmotor18_cfg_t *cfg );
 
err_t dcmotor18_default_cfg ( dcmotor18_t *ctx );
 
err_t dcmotor18_set_duty_cycle ( dcmotor18_t *ctx, float duty_cycle );
 
err_t dcmotor18_pwm_stop ( dcmotor18_t *ctx );
 
err_t dcmotor18_pwm_start ( dcmotor18_t *ctx );
 
err_t dcmotor18_read_an_pin_value ( dcmotor18_t *ctx, uint16_t *data_out );
 
err_t dcmotor18_read_an_pin_voltage ( dcmotor18_t *ctx, float *data_out );
 
err_t dcmotor18_read_an_pin_current ( dcmotor18_t *ctx, float *data_out );
 
void dcmotor18_set_direction ( dcmotor18_t *ctx, uint8_t state );
 
void dcmotor18_set_enable ( dcmotor18_t *ctx, uint8_t state );
 
uint8_t dcmotor18_get_interrupt ( dcmotor18_t *ctx );
 
err_t dcmotor18_set_speed_percentage ( dcmotor18_t *ctx, float speed_percentage );
 
#ifdef __cplusplus
}
#endif
#endif // DCMOTOR18_H
 
 // dcmotor18
 
// ------------------------------------------------------------------------ END