ooktx 2.1.0.0
ooktx.h File Reference

This file contains API for OOK 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  ooktx_t
 OOK TX Click context object. More...
 
struct  ooktx_cfg_t
 OOK TX Click configuration object. More...
 

Macros

#define OOKTX_TRAINING_BYTES   { 0xAA, 0xAA, 0xAA, 0xAA }
 OOK TX default settings.
 
#define OOKTX_MAN_MSB   0x8000
 
#define OOKTX_MAN_BIT_LEN_US   2000
 
#define OOKTX_MAX_DATA_LEN   255
 
#define OOKTX_CALIB_ENABLE   0x01
 
#define OOKTX_CALIB_DISABLE   0x00
 
#define OOKTX_CFG_ENABLE   0x01
 
#define OOKTX_CFG_DISABLE   0x00
 
#define OOKTX_CFG_DEFAULT   0xF6F0
 
#define OOKTX_CFG_F_433MHZ   0xF000
 
#define OOKTX_CFG_CX_18PF   0x0600
 
#define OOKTX_CFG_P_13DB   0x00F0
 
#define OOKTX_CFG_P_10DB   0x00C0
 
#define OOKTX_CFG_P_7DB   0x0090
 
#define OOKTX_CFG_P_3DB   0x0050
 
#define OOKTX_CFG_P_0DB   0x0020
 
#define OOKTX_CFG_CT_0PF   0x0000
 
#define OOKTX_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.
 

Enumerations

enum  ooktx_return_value_t { OOKTX_OK = 0 , OOKTX_ERROR = -1 }
 OOK TX Click return value data. More...
 

Functions

void ooktx_cfg_setup (ooktx_cfg_t *cfg)
 OOK TX configuration object setup function.
 
err_t ooktx_init (ooktx_t *ctx, ooktx_cfg_t *cfg)
 OOK TX initialization function.
 
void ooktx_set_data_pin (ooktx_t *ctx)
 OOK TX set data pin function.
 
void ooktx_clear_data_pin (ooktx_t *ctx)
 OOK TX clear data pin function.
 
void ooktx_set_clock_pin (ooktx_t *ctx)
 OOK TX set clock pin function.
 
void ooktx_clear_clock_pin (ooktx_t *ctx)
 OOK TX clear clock pin function.
 
void ooktx_start (ooktx_t *ctx, uint8_t calib_en, uint8_t cfg_en, uint16_t cfg)
 OOK TX start function.
 
void ooktx_stop (ooktx_t *ctx)
 OOK TX stop function.
 

Detailed Description

This file contains API for OOK TX Click Driver.

Enumeration Type Documentation

◆ ooktx_return_value_t

OOK TX Click return value data.

Predefined enum values for driver return values.

Enumerator
OOKTX_OK 
OOKTX_ERROR