stspin820.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 STSPIN820_H
#define STSPIN820_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 STSPIN820_DIR_CW                        0
#define STSPIN820_DIR_CCW                       1
 
#define STSPIN820_PIN_LOW_LEVEL                 0
#define STSPIN820_PIN_HIGH_LEVEL                1
 
#define STSPIN820_SPEED_VERY_SLOW               0
#define STSPIN820_SPEED_SLOW                    1
#define STSPIN820_SPEED_MEDIUM                  2
#define STSPIN820_SPEED_FAST                    3
#define STSPIN820_SPEED_VERY_FAST               4 
 
 // stspin820_set
 
#define STSPIN820_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.dir = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.en = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.step = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.fault = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // stspin820_map
 // stspin820
 
typedef struct
{
    digital_out_t dir;      
    digital_out_t rst;      
    digital_out_t en;       
    digital_out_t step;     
    digital_in_t fault;     
} stspin820_t;
 
typedef struct
{
    pin_name_t dir;         
    pin_name_t rst;         
    pin_name_t en;          
    pin_name_t step;        
    pin_name_t fault;       
} stspin820_cfg_t;
 
typedef enum
{
    STSPIN820_OK = 0,
    STSPIN820_ERROR = -1
 
} stspin820_return_value_t;
 
void stspin820_cfg_setup ( stspin820_cfg_t *cfg );
 
err_t stspin820_init ( stspin820_t *ctx, stspin820_cfg_t *cfg );
 
void stspin820_default_cfg ( stspin820_t *ctx );
 
void stspin820_drive_motor ( stspin820_t *ctx, uint32_t steps, uint8_t speed );
 
void stspin820_enable_device ( stspin820_t *ctx );
 
void stspin820_disable_device ( stspin820_t *ctx );
 
void stspin820_set_direction ( stspin820_t *ctx, uint8_t dir );
 
void stspin820_switch_direction ( stspin820_t *ctx );
 
void stspin820_reset_device ( stspin820_t *ctx );
 
void stspin820_set_rst_pin ( stspin820_t *ctx, uint8_t state );
 
uint8_t stspin820_get_fault_pin ( stspin820_t *ctx );
 
void stspin820_set_step_pin ( stspin820_t *ctx, uint8_t state );
 
#ifdef __cplusplus
}
#endif
#endif // STSPIN820_H
 
 // stspin820
 
// ------------------------------------------------------------------------ END