micrftx  2.1.0.0
Data Structures | Macros | Enumerations | Functions
micrftx.h File Reference

This file contains API for MICRF TX Click Driver. More...

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

Go to the source code of this file.

Data Structures

struct  micrftx_t
 MICRF TX Click context object. More...
 
struct  micrftx_cfg_t
 MICRF TX Click configuration object. More...
 

Macros

#define MICRFTX_TRAINING_BYTES   { 0xAA, 0xAA, 0xAA, 0xAA }
 MICRF TX default training bytes, manchester settings, and data length. More...
 
#define MICRFTX_MAN_MSB   0x8000
 
#define MICRFTX_MAN_BIT_LEN_US   2000
 
#define MICRFTX_MAX_DATA_LEN   255
 
#define MICRFTX_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping. More...
 

Enumerations

enum  micrftx_return_value_t { MICRFTX_OK = 0, MICRFTX_ERROR = -1 }
 MICRF TX Click return value data. More...
 

Functions

void micrftx_cfg_setup (micrftx_cfg_t *cfg)
 MICRF TX configuration object setup function. More...
 
err_t micrftx_init (micrftx_t *ctx, micrftx_cfg_t *cfg)
 MICRF TX initialization function. More...
 
void micrftx_set_data_pin (micrftx_t *ctx)
 MICRF TX set data pin function. More...
 
void micrftx_clear_data_pin (micrftx_t *ctx)
 MICRF TX clear data pin function. More...
 
void micrftx_enable_device (micrftx_t *ctx)
 MICRF TX enable device function. More...
 
void micrftx_disable_device (micrftx_t *ctx)
 MICRF TX disable device function. More...
 
uint8_t micrftx_get_clock_pin (micrftx_t *ctx)
 MICRF TX get clock pin function. More...
 

Detailed Description

This file contains API for MICRF TX Click Driver.

Enumeration Type Documentation

◆ micrftx_return_value_t

MICRF TX Click return value data.

Predefined enum values for driver return values.

Enumerator
MICRFTX_OK 
MICRFTX_ERROR