dcmotor9.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 DCMOTOR9_H
#define DCMOTOR9_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 DCMOTOR9_DEF_FREQ     20000
#define DCMOTOR9_DEF_VREF     3.3
 
#define DCMOTOR9_PWM_DUTY_PERCENT_0   0.0
#define DCMOTOR9_PWM_DUTY_PERCENT_10  0.1
#define DCMOTOR9_PWM_DUTY_PERCENT_20  0.2
#define DCMOTOR9_PWM_DUTY_PERCENT_30  0.3
#define DCMOTOR9_PWM_DUTY_PERCENT_40  0.4
#define DCMOTOR9_PWM_DUTY_PERCENT_50  0.5
#define DCMOTOR9_PWM_DUTY_PERCENT_60  0.6
#define DCMOTOR9_PWM_DUTY_PERCENT_70  0.7
#define DCMOTOR9_PWM_DUTY_PERCENT_80  0.8
#define DCMOTOR9_PWM_DUTY_PERCENT_90  0.9
#define DCMOTOR9_PWM_DUTY_PERCENT_100 1.0
 
 // dcmotor9_cfg
 
#define DCMOTOR9_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.shd = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.pw2 = MIKROBUS( mikrobus, MIKROBUS_CS )
 
 // dcmotor9_map
 // dcmotor9
 
typedef struct
{
    // Output pins
    digital_out_t shd;      
    digital_out_t pw2;      
    // Modules
    pwm_t pwm;              
    analog_in_t  adc;       
    // ctx variable
    uint32_t pwm_freq;      
} dcmotor9_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t pwm;         
    // Additional gpio pins
    pin_name_t an;         
    pin_name_t shd;        
    pin_name_t pw1;        
    pin_name_t pw2;        
    // Static variable
    uint32_t dev_pwm_freq;                 
    analog_in_resolution_t resolution;     
    float vref;                            
} dcmotor9_cfg_t;
 
typedef enum
{
    DCMOTOR9_OK = 0,
    DCMOTOR9_ERROR = -1
 
} dcmotor9_return_value_t;
 
void dcmotor9_cfg_setup ( dcmotor9_cfg_t *cfg );
 
err_t dcmotor9_init ( dcmotor9_t *ctx, dcmotor9_cfg_t *cfg );
 
err_t dcmotor9_default_cfg ( dcmotor9_t *ctx );
 
err_t dcmotor9_set_duty_cycle ( dcmotor9_t *ctx, float duty_cycle );
 
err_t dcmotor9_pwm_stop ( dcmotor9_t *ctx );
 
err_t dcmotor9_pwm_start ( dcmotor9_t *ctx );
 
void dcmotor9_enable ( dcmotor9_t *ctx );
 
void dcmotor9_standby ( dcmotor9_t *ctx );
 
void dcmotor9_counter_clockwise ( dcmotor9_t *ctx );
 
void dcmotor9_clockwise ( dcmotor9_t *ctx );
 
void dcmotor9_short_brake ( dcmotor9_t *ctx );
 
void dcmotor9_stop ( dcmotor9_t *ctx );
 
err_t dcmotor9_read_an_value ( dcmotor9_t *ctx, uint16_t *data_out );
 
err_t dcmotor9_read_an_voltage ( dcmotor9_t *ctx, float *data_out );
 
#ifdef __cplusplus
}
#endif
#endif // DCMOTOR9_H
 
 // dcmotor9
 
// ------------------------------------------------------------------------ END