servo2 2.1.0.0
Loading...
Searching...
No Matches
servo2.h File Reference

This file contains API for Servo 2 Click Driver. More...

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

Go to the source code of this file.

Data Structures

struct  servo2_t
 Servo 2 Click context object. More...
struct  servo2_cfg_t
 Servo 2 Click configuration object. More...

Macros

#define SERVO2_PWM_MAX   4095
 Servo 2 PWM output setting.
#define SERVO2_PWM_MIN   0
#define SERVO2_PWM_ZERO_DEGREE_PULSE   3980
#define SERVO2_PWM_180_DEGREE_PULSE   3468
#define SERVO2_ANGLE_MIN   0
 Servo 2 angle and channel setting.
#define SERVO2_ANGLE_MAX   180
#define SERVO2_CHANNEL_0   0
#define SERVO2_CHANNEL_1   1
#define SERVO2_CHANNEL_2   2
#define SERVO2_CHANNEL_3   3
#define SERVO2_CHANNEL_4   4
#define SERVO2_CHANNEL_5   5
#define SERVO2_CHANNEL_6   6
#define SERVO2_CHANNEL_7   7
#define SERVO2_CHANNEL_8   8
#define SERVO2_CHANNEL_9   9
#define SERVO2_CHANNEL_10   10
#define SERVO2_CHANNEL_11   11
#define SERVO2_CHANNEL_12   12
#define SERVO2_CHANNEL_13   13
#define SERVO2_CHANNEL_14   14
#define SERVO2_CHANNEL_15   15
#define SERVO2_CHANNEL_ALL   16
#define SERVO2_NUM_CHANNELS   16
#define SERVO2_DEF_FREQ   256000ul
 Servo 2 default PWM frequency.
#define SERVO2_DEF_DC   0.5
#define SERVO2_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.

Enumerations

enum  servo2_return_value_t { SERVO2_OK = 0 , SERVO2_ERROR = -1 }
 Servo 2 Click return value data. More...

Functions

void servo2_cfg_setup (servo2_cfg_t *cfg)
 Servo 2 configuration object setup function.
err_t servo2_init (servo2_t *ctx, servo2_cfg_t *cfg)
 Servo 2 initialization function.
err_t servo2_set_duty_cycle (servo2_t *ctx, float duty_cycle)
 Servo 2 sets PWM duty cycle.
err_t servo2_pwm_stop (servo2_t *ctx)
 Servo 2 stop PWM module.
err_t servo2_pwm_start (servo2_t *ctx)
 Servo 2 start PWM module.
void servo2_write_data (servo2_t *ctx, uint8_t *data_in, uint8_t len)
 Servo 2 write data function.
void servo2_set_sclk_pin (servo2_t *ctx, uint8_t state)
 Servo 2 set SCLK pin function.
void servo2_set_sin_pin (servo2_t *ctx, uint8_t state)
 Servo 2 set SIN pin function.
void servo2_set_xlat_pin (servo2_t *ctx, uint8_t state)
 Servo 2 set XLAT pin function.
void servo2_set_blank_pin (servo2_t *ctx, uint8_t state)
 Servo 2 set BLANK pin function.
uint8_t servo2_get_sout_pin (servo2_t *ctx)
 Servo 2 get SOUT pin state function.
uint8_t servo2_get_xerr_pin (servo2_t *ctx)
 Servo 2 get XERR pin state function.
err_t servo2_set_channel_pwm (servo2_t *ctx, uint8_t ch_num, uint16_t pwm_out)
 Servo 2 set channel PWM function.
err_t servo2_set_angle (servo2_t *ctx, uint8_t ch_num, uint8_t angle)
 Servo 2 set angle function.
void servo2_update_output (servo2_t *ctx)
 Servo 2 update output function.

Detailed Description

This file contains API for Servo 2 Click Driver.

Enumeration Type Documentation

◆ servo2_return_value_t

Servo 2 Click return value data.

Predefined enum values for driver return values.

Enumerator
SERVO2_OK 
SERVO2_ERROR