leddriver10.h File Reference

This file contains API for LED Driver 10 Click Driver. More...

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

Go to the source code of this file.

Data Structures
struct	leddriver10_t
	LED Driver 10 Click context object. More...
struct	leddriver10_cfg_t
	LED Driver 10 Click configuration object. More...

Macros
#define	LEDDRIVER10_ENABLE_ALL_CH   0xFFFF
	LED Driver 10 output flags.
#define	LEDDRIVER10_DISABLE_ALL_CH   0x0000
#define	LEDDRIVER10_ENABLE_CH_0   0x0001
#define	LEDDRIVER10_ENABLE_CH_1   0x0002
#define	LEDDRIVER10_ENABLE_CH_2   0x0004
#define	LEDDRIVER10_ENABLE_CH_3   0x0008
#define	LEDDRIVER10_ENABLE_CH_4   0x0010
#define	LEDDRIVER10_ENABLE_CH_5   0x0020
#define	LEDDRIVER10_ENABLE_CH_6   0x0040
#define	LEDDRIVER10_ENABLE_CH_7   0x0080
#define	LEDDRIVER10_ENABLE_CH_8   0x0100
#define	LEDDRIVER10_ENABLE_CH_9   0x0200
#define	LEDDRIVER10_ENABLE_CH_10   0x0400
#define	LEDDRIVER10_ENABLE_CH_11   0x0800
#define	LEDDRIVER10_ENABLE_CH_12   0x1000
#define	LEDDRIVER10_ENABLE_CH_13   0x2000
#define	LEDDRIVER10_ENABLE_CH_14   0x4000
#define	LEDDRIVER10_ENABLE_CH_15   0x8000
#define	LEDDRIVER10_DEF_FREQ   10000
	LED Driver 10 default PWM frequency.
#define	LEDDRIVER10_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	leddriver10_return_value_t { LEDDRIVER10_OK = 0 , LEDDRIVER10_ERROR = -1 }
	LED Driver 10 Click return value data. More...

Functions
void	leddriver10_cfg_setup (leddriver10_cfg_t *cfg)
	LED Driver 10 configuration object setup function.
err_t	leddriver10_init (leddriver10_t *ctx, leddriver10_cfg_t *cfg)
	LED Driver 10 initialization function.
err_t	leddriver10_set_channels (leddriver10_t *ctx, uint16_t ch_mask)
	LED Driver 10 set channels function.
err_t	leddriver10_read_channels (leddriver10_t *ctx, uint16_t *ch_mask)
	LED Driver 10 read channels function.
err_t	leddriver10_set_duty_cycle (leddriver10_t *ctx, float duty_cycle)
	LED Driver 10 sets PWM duty cycle.
err_t	leddriver10_pwm_stop (leddriver10_t *ctx)
	LED Driver 10 stop PWM module.
err_t	leddriver10_pwm_start (leddriver10_t *ctx)
	LED Driver 10 start PWM module.

Detailed Description

This file contains API for LED Driver 10 Click Driver.

Enumeration Type Documentation

leddriver10_return_value_t

enum leddriver10_return_value_t

LED Driver 10 Click return value data.

Predefined enum values for driver return values.

Enumerator
LEDDRIVER10_OK
LEDDRIVER10_ERROR