brushless12.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 BRUSHLESS12_H
#define BRUSHLESS12_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"
 
#define BRUSHLESS12_ENABLE          1
#define BRUSHLESS12_DISABLE         0
#define BRUSHLESS12_START           1
#define BRUSHLESS12_BRAKE           0
#define BRUSHLESS12_DIR_FORWARD     1
#define BRUSHLESS12_DIR_REVERSE     0
 
 // brushless12_set
 
#define BRUSHLESS12_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.brk = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.en = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.dir = MIKROBUS( mikrobus, MIKROBUS_PWM );
 
 // brushless12_map
 // brushless12
 
typedef struct
{
    digital_out_t  brk;      
    digital_out_t  en;       
    digital_out_t  dir;      
} brushless12_t;
 
typedef struct
{
    pin_name_t  brk;         
    pin_name_t  en;          
    pin_name_t  dir;         
} brushless12_cfg_t;
 
typedef enum
{
    BRUSHLESS12_OK = 0,
    BRUSHLESS12_ERROR = -1
 
} brushless12_return_value_t;
 
void brushless12_cfg_setup ( brushless12_cfg_t *cfg );
 
err_t brushless12_init ( brushless12_t *ctx, brushless12_cfg_t *cfg );
 
err_t brushless12_default_cfg ( brushless12_t *ctx );
 
void brushless12_set_brake ( brushless12_t *ctx, uint8_t state );
 
void brushless12_set_direction ( brushless12_t *ctx, uint8_t state );
 
void brushless12_set_enable ( brushless12_t *ctx, uint8_t state );
 
#ifdef __cplusplus
}
#endif
#endif // BRUSHLESS12_H
 
 // brushless12
 
// ------------------------------------------------------------------------ END