ismrx2 2.1.0.0
ismrx2.h File Reference

This file contains API for ISM RX 2 Click Driver. More...

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

Go to the source code of this file.

Data Structures

struct  ismrx2_t
 ISM RX 2 Click context object. More...
 
struct  ismrx2_cfg_t
 ISM RX 2 Click configuration object. More...
 

Macros

#define ISMRX2_PIN_STATE_HIGH   1
 ISM RX 2 description setting.
 
#define ISMRX2_PIN_STATE_LOW   0
 
#define ISMRX2_DEFAULT_SYNC_BYTE   0xCE35
 
#define ISMRX2_FSK_DEFAULT_SYNC_BYTE   0xFF
 
#define ISMRX2_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.
 

Enumerations

enum  ismrx2_return_value_t { ISMRX2_OK = 0 , ISMRX2_ERROR = -1 }
 ISM RX 2 Click return value data. More...
 

Functions

void ismrx2_cfg_setup (ismrx2_cfg_t *cfg)
 ISM RX 2 configuration object setup function.
 
err_t ismrx2_init (ismrx2_t *ctx, ismrx2_cfg_t *cfg)
 ISM RX 2 initialization function.
 
err_t ismrx2_default_cfg (ismrx2_t *ctx)
 ISM RX 2 default configuration function.
 
void ismrx2_set_rst_pin_state (ismrx2_t *ctx, uint8_t state)
 ISM RX 2 set state of RST pin function.
 
void ismrx2_set_stb_pin_state (ismrx2_t *ctx, uint8_t state)
 ISM RX 2 set state of STB pin function.
 
uint8_t ismrx2_get_mst_pin_state (ismrx2_t *ctx)
 ISM RX 2 get state of MST pin function.
 
uint8_t ismrx2_get_data_pin_state (ismrx2_t *ctx)
 ISM RX 2 get state of DATA pin function.
 
err_t ismrx2_read_manchester_data (ismrx2_t *ctx, uint8_t *data_out)
 ISM RX 2 read manchester encoded data function.
 
err_t ismrx2_read_rf_data (ismrx2_t *ctx, uint8_t *data_out)
 ISM RX 2 read data function.
 

Detailed Description

This file contains API for ISM RX 2 Click Driver.

Enumeration Type Documentation

◆ ismrx2_return_value_t

ISM RX 2 Click return value data.

Predefined enum values for driver return values.

Enumerator
ISMRX2_OK 
ISMRX2_ERROR