timerrelay.h File Reference

This file contains API for Timer Relay Click Driver. More...

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

Go to the source code of this file.

Data Structures
struct	timerrelay_t
	Timer Relay Click context object. More...
struct	timerrelay_cfg_t
	Timer Relay Click configuration object. More...

Macros
#define	TIMERRELAY_PIN_STATE_HIGH   0x01
	Timer Relay description setting.
#define	TIMERRELAY_PIN_STATE_LOW   0x00
#define	TIMERRELAY_5V_MAX_DELAY   60
	Timer Relay calculation setting.
#define	TIMERRELAY_3V3_MAX_DELAY   160
#define	TIMERRELAY_5V_CALCULATION_MULTIPLIER   0.2353f
#define	TIMERRELAY_3V3_CALCULATION_MULTIPLIER   0.6275f
#define	TIMERRELAY_VCC_5V   0x01
	Timer Relay Vcc select setting.
#define	TIMERRELAY_VCC_3V3   0x00
#define	TIMERRELAY_SET_DATA_SAMPLE_EDGE   SET_SPI_DATA_SAMPLE_EDGE
	Data sample selection.
#define	TIMERRELAY_SET_DATA_SAMPLE_MIDDLE   SET_SPI_DATA_SAMPLE_MIDDLE
#define	TIMERRELAY_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	timerrelay_return_value_t { TIMERRELAY_OK = 0 , TIMERRELAY_ERROR = -1 }
	Timer Relay Click return value data. More...

Functions
void	timerrelay_cfg_setup (timerrelay_cfg_t *cfg)
	Timer Relay configuration object setup function.
err_t	timerrelay_init (timerrelay_t *ctx, timerrelay_cfg_t *cfg)
	Timer Relay initialization function.
err_t	timerrelay_default_cfg (timerrelay_t *ctx)
	Timer Relay default configuration function.
err_t	timerrelay_generic_write (timerrelay_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
	Timer Relay data writing function.
void	timerrelay_set_vcc_sel (timerrelay_t *ctx, uint8_t vcc_sel)
	Timer Relay set Vcc select settings function.
err_t	timerrelay_set_wiper_pos (timerrelay_t *ctx, uint8_t wiper_pos)
	Timer Relay set wiper position function.
err_t	timerrelay_set_delay (timerrelay_t *ctx, uint8_t delay)
	Timer Relay set delay function.
void	timerrelay_set_rst_pin (timerrelay_t *ctx, uint8_t pin_state)
	Timer Relay set RST pin state function.
void	timerrelay_set_trg_pin (timerrelay_t *ctx, uint8_t pin_state)
	Timer Relay set TRG pin state function.
void	timerrelay_activate_reset (timerrelay_t *ctx)
	Timer Relay reset timer function.
void	timerrelay_activate_trigger (timerrelay_t *ctx)
	Timer Relay activate trigger function.

Detailed Description

This file contains API for Timer Relay Click Driver.

Enumeration Type Documentation

timerrelay_return_value_t

enum timerrelay_return_value_t

Timer Relay Click return value data.

Predefined enum values for driver return values.

Enumerator
TIMERRELAY_OK
TIMERRELAY_ERROR