ookrx  2.0.0.0
Functions
Public function

Functions

void ookrx_cfg_setup (ookrx_cfg_t *cfg)
 Config Object Initialization function. More...
 
OOKRX_RETVAL ookrx_init (ookrx_t *ctx, ookrx_cfg_t *cfg)
 Initialization function. More...
 
uint8_t ookrx_receive_data (ookrx_t *ctx, uint16_t start_package, uint8_t *receive_buffer, uint8_t bytes_num)
 Receive data function. More...
 
uint8_t ookrx_read_do_pin (ookrx_t *ctx)
 Read DO pin function. More...
 
uint8_t ookrx_read_rsi_pin (ookrx_t *ctx)
 Read RSI pin function. More...
 

Detailed Description

Function Documentation

◆ ookrx_cfg_setup()

void ookrx_cfg_setup ( ookrx_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.

◆ ookrx_init()

OOKRX_RETVAL ookrx_init ( ookrx_t ctx,
ookrx_cfg_t cfg 
)

Initialization function.

Parameters
ookrxClick object.
cfgClick configuration structure.

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

◆ ookrx_read_do_pin()

uint8_t ookrx_read_do_pin ( ookrx_t ctx)

Read DO pin function.

Parameters
ctxClick object.

@description This function reads the od pin digital input.

◆ ookrx_read_rsi_pin()

uint8_t ookrx_read_rsi_pin ( ookrx_t ctx)

Read RSI pin function.

Parameters
ctxClick object.

@description This function reads the rsi pin digital input.

◆ ookrx_receive_data()

uint8_t ookrx_receive_data ( ookrx_t ctx,
uint16_t  start_package,
uint8_t *  receive_buffer,
uint8_t  bytes_num 
)

Receive data function.

Parameters
ctxClick object.
start_packageStart package byte.
receive_bufferBuffer to which data is written.
bytes_numNumber of data packages to read.

@description This function receives data in the OOK communication.