stspin233.h

Go to the documentation of this file.

/*
 * MikroSDK - MikroE Software Development Kit
 * Copyright© 2020 MikroElektronika d.o.o.
 * 
 * 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 STSPIN233_H
#define STSPIN233_H
 
#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_uart.h"
 
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define DRV_RX_BUFFER_SIZE 500
#define STSPIN233_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.tx_pin  = MIKROBUS( mikrobus, MIKROBUS_TX ); \
  cfg.rx_pin  = MIKROBUS( mikrobus, MIKROBUS_RX ); \
  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
#define STSPIN233_RETVAL  uint8_t
 
#define STSPIN233_OK           0x00
#define STSPIN233_INIT_ERROR   0xFF
#define STSPIN233_CMD_START_MOTOR  "STARTM"
#define STSPIN233_CMD_STOP_MOTOR   "STOPMT"
#define STSPIN233_CMD_DIR_MOTOR    "DIRECT"
#define STSPIN233_CMD_SET_SPEED    "SETSPD"
#define STSPIN233_CMD_GET_SPEED    "GETSPD"
#define STSPIN233_CMD_STATUS       "STATUS"
#define STSPIN233_CMD_HELP         "HELP"
#define STSPIN233_CMD_SET_PWM      "INIREF"
#define STSPIN233_CMD_COM_DELAY    "COMDEL"
#define STSPIN233_CMD_MOTOR_POLE   "POLESP"
#define STSPIN233_CMD_KP_PRM       "KP-PRM"
#define STSPIN233_CMD_KI_PRM       "KI-PRM"
#define STSPIN233_CW_DIR   "1"
#define STSPIN233_CCW_DIR  "0"
#define STSPIN233_START_PWM_DUTY_10p    "409"
#define STSPIN233_START_PWM_DUTY_20p    "819"
#define STSPIN233_START_PWM_DUTY_DEF    "819"
#define STSPIN233_START_PWM_DUTY_30p    "1229"
#define STSPIN233_START_PWM_DUTY_40p    "1638"
#define STSPIN233_START_PWM_DUTY_50p    "2048"
#define STSPIN233_START_PWM_DUTY_60p    "2458"
#define STSPIN233_START_PWM_DUTY_70p    "2867"
#define STSPIN233_START_PWM_DUTY_80p    "3277"
#define STSPIN233_START_PWM_DUTY_90p    "3687"
#define STSPIN233_START_PWM_DUTY_100p   "4095"
#define STSPIN233_COMM_DELAY_7ms  "7"
#define STSPIN233_COMM_DELAY_DEF  "7"
#define  STSPIN233_M_POLE_2     "2"
#define  STSPIN233_M_POLE_3     "3"
#define  STSPIN233_M_POLE_4     "4"
#define  STSPIN233_M_POLE_5     "5"
#define  STSPIN233_M_POLE_6     "6"
#define  STSPIN233_M_POLE_DEF   "6"
#define  STSPIN233_M_POLE_7     "7"
#define  STSPIN233_M_POLE_8     "8"
#define  STSPIN233_KP_PRM_DEF  "500"
#define  STSPIN233_KI_PRM_DEF  "250"
#define  STSPIN233_SPEED_1000RPM   "1000"
#define  STSPIN233_SPEED_DEF       "1000"
#define  STSPIN233_SPEED_900RPM     "900"
#define  STSPIN233_SPEED_1100RPM   "1100"
#define  STSPIN233_SPEED_1200RPM   "1200"
#define  STSPIN233_SPEED_1300RPM   "1300"
#define  STSPIN233_SPEED_1400RPM   "1400"
#define  STSPIN233_SPEED_1500RPM   "1500"
#define  STSPIN233_SPEED_1600RPM   "1600"
#define  STSPIN233_SPEED_1700RPM   "1700"
#define  STSPIN233_SPEED_1800RPM   "1800"
#define  STSPIN233_SPEED_1900RPM   "1900"
#define  STSPIN233_SPEED_2000RPM   "2000"
#define  STSPIN233_SPEED_2100RPM   "2100"
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Output pins 
 
    digital_out_t rst;
 
    // Input pins 
 
    digital_in_t int_pin;
    
    // Modules 
 
    uart_t uart;
 
    char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
    char uart_tx_buffer[ DRV_RX_BUFFER_SIZE ];
 
} stspin233_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t rx_pin;
    pin_name_t tx_pin;
    
    // Additional gpio pins 
 
    pin_name_t rst;
    pin_name_t int_pin;
 
    // static variable 
 
    uint32_t          baud_rate;     // Clock speed.
    bool              uart_blocking;
    uart_data_bits_t  data_bit;      // Data bits.
    uart_parity_t     parity_bit;    // Parity bit.  
    uart_stop_bits_t  stop_bit;      // Stop bits. 
 
} stspin233_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void stspin233_cfg_setup ( stspin233_cfg_t *cfg );
 
STSPIN233_RETVAL stspin233_init ( stspin233_t *ctx, stspin233_cfg_t *cfg );
 
void stspin233_default_cfg ( stspin233_t *ctx );
 
void stspin233_generic_write ( stspin233_t *ctx, char *data_buf, uint16_t len );
 
int32_t stspin233_generic_read ( stspin233_t *ctx, char *data_buf, uint16_t max_len );
 
void stspin233_wakeup ( stspin233_t *ctx );
 
void stspin233_send_single_cmd ( stspin233_t *ctx, uint8_t *tx_buf );
 
void stspin233_send_double_cmd ( stspin233_t *ctx, uint8_t *cmd_buf, uint8_t *arg_buf );
 
void stspin233_set_reset_state ( stspin233_t *ctx, uint8_t state );
 
uint8_t stspin233_get_int_state ( stspin233_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif  // _STSPIN233_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END