ooktx  2.0.0.0
Functions
Public function

Functions

void ooktx_cfg_setup (ooktx_cfg_t *cfg)
 Config Object Initialization function. More...
 
OOKTX_RETVAL ooktx_init (ooktx_t *ctx, ooktx_cfg_t *cfg)
 Initialization function. More...
 
void ooktx_communication_init (ooktx_t *ctx, uint8_t calibration, uint8_t configuration, uint16_t cfg_settings)
 Communication initiation function. More...
 
void ooktx_communication_stop (ooktx_t *ctx)
 Communication stop function. More...
 
void ooktx_communication_transmit (ooktx_t *ctx, uint8_t transmit_data)
 Communication transmit function. More...
 
void ooktx_transmit_byte (ooktx_t *ctx, uint16_t preable_word, uint8_t transmit_byte)
 Communication transmit function. More...
 
void ooktx_transmit_data (ooktx_t *ctx, uint16_t preable_word, uint8_t *transmit_data, uint8_t transmit_len)
 Communication transmit function. More...
 

Detailed Description

Function Documentation

◆ ooktx_cfg_setup()

void ooktx_cfg_setup ( ooktx_cfg_t cfg)

Config Object Initialization function.

Parameters
cfgClick configuration structure.

@description This function initializes click configuration structure to init state.

Note
All used pins will be set to unconnected state.

◆ ooktx_communication_init()

void ooktx_communication_init ( ooktx_t ctx,
uint8_t  calibration,
uint8_t  configuration,
uint16_t  cfg_settings 
)

Communication initiation function.

Parameters
ctxClick object.
calibrationCalibration byte.
configurationConfiguration byte.
cfg_settingsConfig settings byte.

@description This function initiates the OOK communication.

◆ ooktx_communication_stop()

void ooktx_communication_stop ( ooktx_t ctx)

Communication stop function.

Parameters
ctxClick object.

@description This function stops the OOK communication.

◆ ooktx_communication_transmit()

void ooktx_communication_transmit ( ooktx_t ctx,
uint8_t  transmit_data 
)

Communication transmit function.

Parameters
ctxClick object.
transmit_dataData package byte.

@description This function transmits data in the OOK communication.

◆ ooktx_init()

OOKTX_RETVAL ooktx_init ( ooktx_t ctx,
ooktx_cfg_t cfg 
)

Initialization function.

Parameters
ooktxClick object.
cfgClick configuration structure.

@description This function initializes all necessary pins and peripherals used for this click.

◆ ooktx_transmit_byte()

void ooktx_transmit_byte ( ooktx_t ctx,
uint16_t  preable_word,
uint8_t  transmit_byte 
)

Communication transmit function.

Parameters
ctxClick object.
preable_wordPreable word.
transmit_byteData package byte.

@description This function transmits data in the OOK communication.

◆ ooktx_transmit_data()

void ooktx_transmit_data ( ooktx_t ctx,
uint16_t  preable_word,
uint8_t *  transmit_data,
uint8_t  transmit_len 
)

Communication transmit function.

Parameters
ctxClick object.
preable_wordPreable word.
transmit_dataData package.
transmit_lenData package length.

@description This function transmits data in the OOK communication.