stepper17  2.0.0.0
Data Structures | Macros | Enumerations | Functions
stepper17.h File Reference

This file contains API for Stepper 17 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"
#include "drv_pwm.h"

Go to the source code of this file.

Data Structures

struct  stepper17_t
 Stepper 17 Click context object. More...
 
struct  stepper17_cfg_t
 Stepper 17 Click configuration object. More...
 

Macros

#define STEPPER17_REG_INPUT_PORT0   0x00
 Stepper 17 description register. More...
 
#define STEPPER17_REG_INPUT_PORT1   0x01
 
#define STEPPER17_REG_OUTPUT_PORT0   0x02
 
#define STEPPER17_REG_OUTPUT_PORT1   0x03
 
#define STEPPER17_REG_POLARITY_INVERSION_PORT0   0x04
 
#define STEPPER17_REG_POLARITY_INVERSION_PORT1   0x05
 
#define STEPPER17_REG_CONFIGUARTION_PORT0   0x06
 
#define STEPPER17_REG_CONFIGUARTION_PORT1   0x07
 
#define STEPPER17_MODE_SLEEP   0x00
 Stepper 17 mode settings. More...
 
#define STEPPER17_MODE_NORMAL   0x80
 
#define STEPPER17_STEP_FULL   0x00
 Stepper 17 step resolution settings. More...
 
#define STEPPER17_STEP_HALF_A   0x04
 
#define STEPPER17_STEP_HALF_B   0x02
 
#define STEPPER17_STEP_QUARTER   0x06
 
#define STEPPER17_STEP_1DIV8   0x01
 
#define STEPPER17_STEP_1DIV16   0x05
 
#define STEPPER17_STEP_1DIV32   0x07
 
#define STEPPER17_DECAY_MIXED   0x00
 Stepper 17 decay settings. More...
 
#define STEPPER17_DECAY_SLOW   0x08
 
#define STEPPER17_DECAY_FAST   0x10
 
#define STEPPER17_DECAY_ADMD   0x18
 
#define STEPPER17_TORQUE_100PCT   0x00
 Stepper 17 torque settings. More...
 
#define STEPPER17_TORQUE_75PCT   0x20
 
#define STEPPER17_TORQUE_50PCT   0x40
 
#define STEPPER17_TORQUE_25PCT   0x60
 
#define STEPPER17_SET_DEV_ADDR   0x20
 Stepper 17 device address setting. More...
 
#define STEPPER17_DEF_FREQ   1500
 Stepper 17 default frequency value. More...
 
#define STEPPER17_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping. More...
 

Enumerations

enum  stepper17_return_value_t { STEPPER17_OK = 0, STEPPER17_ERROR = -1 }
 Stepper 17 Click return value data. More...
 

Functions

void stepper17_cfg_setup (stepper17_cfg_t *cfg)
 Stepper 17 configuration object setup function. More...
 
err_t stepper17_init (stepper17_t *ctx, stepper17_cfg_t *cfg)
 Stepper 17 initialization function. More...
 
err_t stepper17_default_cfg (stepper17_t *ctx)
 Stepper 17 default configuration function. More...
 
err_t stepper17_generic_write (stepper17_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len)
 Stepper 17 I2C writing function. More...
 
err_t stepper17_generic_read (stepper17_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len)
 Stepper 17 I2C reading function. More...
 
err_t stepper17_set_duty_cycle (stepper17_t *ctx, float duty_cycle)
 Stepper 17 sets PWM duty cycle. More...
 
err_t stepper17_pwm_stop (stepper17_t *ctx)
 Stepper 17 stop PWM module. More...
 
err_t stepper17_pwm_start (stepper17_t *ctx)
 Stepper 17 start PWM module. More...
 
void stepper17_set_dir_state (stepper17_t *ctx, uint8_t state)
 Direction control. More...
 
void stepper17_set_rst_state (stepper17_t *ctx, uint8_t state)
 Set reset pin state. More...
 
void stepper17_set_en_state (stepper17_t *ctx, uint8_t state)
 Enable stepping motor output. More...
 
uint8_t stepper17_get_int_state (stepper17_t *ctx)
 Gets interrupt state. More...
 
err_t stepper17_step_resolution (stepper17_t *ctx, uint8_t resolution)
 Step resolution setting. More...
 
err_t stepper17_torque_setting (stepper17_t *ctx, uint8_t torque)
 Torque setting. More...
 
err_t stepper17_decay_function (stepper17_t *ctx, uint8_t decay)
 Decay period setting. More...
 
err_t stepper17_mode (stepper17_t *ctx, uint8_t mode)
 Mode setting. More...
 
uint8_t stepper17_get_error (stepper17_t *ctx)
 Reads error output. More...
 
uint8_t stepper17_get_electrical_angle (stepper17_t *ctx)
 Reads MO pin state. More...
 
void stepper17_reset_electrical_angle (stepper17_t *ctx)
 Reset electrical angle to initial state. More...
 

Detailed Description

This file contains API for Stepper 17 Click Driver.

Enumeration Type Documentation

◆ stepper17_return_value_t

Stepper 17 Click return value data.

Predefined enum values for driver return values.

Enumerator
STEPPER17_OK 
STEPPER17_ERROR