dcmotor15.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 DCMOTOR15_H
#define DCMOTOR15_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_analog_in.h"
 
#define DCMOTOR15_RIPROP_OHM            1500
#define DCMOTOR15_AIPROP_AMP            0.000455
 
#define DCMOTOR15_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.ipr = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.slp = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.in2 = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.in1 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.flt = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // dcmotor15_map
 // dcmotor15
 
typedef struct
{
    digital_out_t  slp;     
    digital_out_t  in2;     
    digital_out_t  in1;     
    digital_in_t  flt;      
    analog_in_t  adc;       
} dcmotor15_t;
 
typedef struct
{
    pin_name_t  ipr;         
    pin_name_t  slp;        
    pin_name_t  in2;        
    pin_name_t  in1;        
    pin_name_t  flt;        
    analog_in_resolution_t  resolution;     
    float                   vref;           
} dcmotor15_cfg_t;
 
typedef enum
{
    DCMOTOR15_OK = 0,
    DCMOTOR15_ERROR = -1
 
} dcmotor15_return_value_t;
 
typedef enum
{
    DCMOTOR15_LOW = 0,
    DCMOTOR15_HIGH = 1
 
} dcmotor15_pin_state_value_t;
 
void dcmotor15_cfg_setup ( dcmotor15_cfg_t *cfg );
 
err_t dcmotor15_init ( dcmotor15_t *ctx, dcmotor15_cfg_t *cfg );
 
void dcmotor15_default_cfg ( dcmotor15_t *ctx );
 
err_t dcmotor15_read_an_pin_value ( dcmotor15_t *ctx, uint16_t *data_out );
 
err_t dcmotor15_read_an_pin_voltage ( dcmotor15_t *ctx, float *data_out );
 
void dcmotor15_set_slp_pin_state ( dcmotor15_t *ctx, uint8_t state );
 
void dcmotor15_set_in1_pin_state ( dcmotor15_t *ctx, uint8_t state );
 
void dcmotor15_set_in2_pin_state ( dcmotor15_t *ctx, uint8_t state );
 
uint8_t dcmotor15_fault_check ( dcmotor15_t *ctx );
 
void dcmotor15_forward ( dcmotor15_t *ctx );
 
void dcmotor15_reverse ( dcmotor15_t *ctx );
 
void dcmotor15_brake ( dcmotor15_t *ctx );
 
void dcmotor15_stop ( dcmotor15_t *ctx );
 
float dcmotor15_get_current ( dcmotor15_t *ctx, uint16_t num_of_conv );
 
#ifdef __cplusplus
}
#endif
#endif // DCMOTOR15_H
 
 // dcmotor15
 
// ------------------------------------------------------------------------ END