dcmotor25.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 DCMOTOR25_H
#define DCMOTOR25_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_i2c_master.h"
 
#define DCMOTOR25_WRITE_TO_RDAC                 0x00
#define DCMOTOR25_ONE_TIME_PROG                 0x80
 
 // dcmotor25_inst
 
#define DCMOTOR25_OTP_V_READY                   0x00
#define DCMOTOR25_OTP_V_TEST_OK                 0x40
#define DCMOTOR25_OTP_V_ERROR                   0x80
#define DCMOTOR25_OTP_V_PROG_SUCCESS            0xC0
 
#define DCMOTOR25_RESISTANCE_MIN                17000
#define DCMOTOR25_RES_DEFAULT_20_kOhm           20000
#define DCMOTOR25_FULL_SCALE_RES_50_kOhm        50000
#define DCMOTOR25_WIPER_POS_MAX                 0x3F
 
 
#define DCMOTOR25_DEVICE_ADDRESS                0x2C
 
 // dcmotor25_set
 
#define DCMOTOR25_MAP_MIKROBUS( cfg, mikrobus )   \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.in1 = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.in2 = MIKROBUS( mikrobus, MIKROBUS_PWM )
 
 // dcmotor25_map
 // dcmotor25
 
typedef struct
{
    // Output pins
    digital_out_t in1;        
    digital_out_t in2;        
    // Modules
    i2c_master_t i2c;         
    // I2C slave address
    uint8_t slave_address;    
} dcmotor25_t;
 
typedef struct
{
    pin_name_t scl;            
    pin_name_t sda;            
    pin_name_t in1;            
    pin_name_t in2;            
    uint32_t   i2c_speed;      
    uint8_t    i2c_address;    
} dcmotor25_cfg_t;
 
typedef enum
{
    DCMOTOR25_OK = 0,
    DCMOTOR25_ERROR = -1
 
} dcmotor25_return_value_t;
 
void dcmotor25_cfg_setup ( dcmotor25_cfg_t *cfg );
 
err_t dcmotor25_init ( dcmotor25_t *ctx, dcmotor25_cfg_t *cfg );
 
err_t dcmotor25_default_cfg ( dcmotor25_t *ctx );
 
err_t dcmotor25_write_byte ( dcmotor25_t *ctx, uint8_t inst, uint8_t data_in );
 
err_t dcmotor25_read_byte ( dcmotor25_t *ctx, uint8_t *data_out );
 
err_t dcmotor25_write_rdac ( dcmotor25_t *ctx, uint8_t rdac_data );
 
err_t dcmotor25_read_rdac ( dcmotor25_t *ctx, uint8_t *rdac_data );
 
err_t dcmotor25_set_digi_pot ( dcmotor25_t *ctx, uint8_t wiper_pos );
 
err_t dcmotor25_set_resistance ( dcmotor25_t *ctx, uint16_t res_ohm );
 
void dcmotor25_standby ( dcmotor25_t *ctx );
 
void dcmotor25_reverse ( dcmotor25_t *ctx );
 
void dcmotor25_forward ( dcmotor25_t *ctx );
 
void dcmotor25_brake ( dcmotor25_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // DCMOTOR25_H
 
 // dcmotor25
 
// ------------------------------------------------------------------------ END