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

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

Data Structures
struct	ismrx3_t
	ISM RX 3 Click context object. More...

struct	ismrx3_cfg_t
	ISM RX 3 Click configuration object. More...

Macros
#define	ISMRX3_DEMOD 0x00
	ISM RX 3 description register.

#define	ISMRX3_AGC 0x01

#define	ISMRX3_IF_CHF_SEL 0x02

#define	ISMRX3_PDF_CFG 0x03

#define	ISMRX3_ATH_CFG_1 0x04

#define	ISMRX3_ATH_CFG_2 0x05

#define	ISMRX3_ATH_CFG_3 0x06

#define	ISMRX3_AFC_CFG_1 0x07

#define	ISMRX3_AFC_CFG_2 0x08

#define	ISMRX3_LO_CTR_FREQ_3 0x09

#define	ISMRX3_LO_CTR_FREQ_2 0x0A

#define	ISMRX3_LO_CTR_FREQ_1 0x0B

#define	ISMRX3_PREAMBLE_CFG_1 0x0C

#define	ISMRX3_PREAMBLE_WORD_1 0x0D

#define	ISMRX3_PREAMBLE_WROD_2 0x0E

#define	ISMRX3_RSS 0x10

#define	ISMRX3_FEI 0x11

#define	ISMRX3_PDF_OUT 0x12

#define	ISMRX3_ISR 0x13

#define	ISMRX3_CDR_CFG 0x35

#define	ISMRX3_STATE_CTRL_1 0x14

#define	ISMRX3_STATE_CTRL_2 0x15

#define	ISMRX3_STATE_CTRL_3 0x16

#define	ISMRX3_WUT_1 0x17

#define	ISMRX3_WUT_2 0x18

#define	ISMRX3_AFE_CTL_1 0x19

#define	ISMRX3_IR_ADJUST 0x1A

#define	ISMRX3_PART_NUM 0x1E

#define	ISMRX3_REV_NUM 0x1F

#define	ISMRX3_STATUS 0x27

#define	ISMRX3_MODULATION_ASK 0x01
	ISM RX 3 data modulation setting.

#define	ISMRX3_MODULATION_FSK 0x02

#define	ISMRX3_FREQUENCY_MHZ_315 0x01
	ISM RX 3 frequency setting.

#define	ISMRX3_FREQUENCY_MHZ_433p92 0x02

#define	ISMRX3_FREQUENCY_MHZ_868p3 0x03

#define	ISMRX3_DEVIATION_KHZ_5 0x01
	ISM RX 3 frequency deviation setting.

#define	ISMRX3_DEVIATION_KHZ_10 0x02

#define	ISMRX3_DEVIATION_KHZ_40 0x03

#define	ISMRX3_DEVIATION_KHZ_80 0x04

#define	ISMRX3_DATA_RATE_KBPS_1 0x01
	ISM RX 3 data rate setting.

#define	ISMRX3_DATA_RATE_KBPS_2 0x02

#define	ISMRX3_DATA_RATE_KBPS_5 0x03

#define	ISMRX3_DATA_RATE_KBPS_10 0x04

#define	ISMRX3_DATA_RATE_KBPS_50 0x05

#define	ISMRX3_DATA_RATE_KBPS_100 0x06

#define	ISMRX3_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	ismrx3_return_value_t { ISMRX3_OK = 0 , ISMRX3_ERROR = -1 , ISMRX3_ERROR_BUF_LEN = -2 }
	ISM RX 3 Click return value data. More...

Functions
void	ismrx3_cfg_setup (ismrx3_cfg_t *cfg)
	ISM RX 3 configuration object setup function.

err_t	ismrx3_init (ismrx3_t ctx, ismrx3_cfg_t cfg)
	ISM RX 3 initialization function.

err_t	ismrx3_default_cfg (ismrx3_t *ctx)
	ISM RX 3 default configuration function.

err_t	ismrx3_generic_write (ismrx3_t *ctx, uint8_t reg, uint8_t data_in)
	ISM RX 3 data writing function.

err_t	ismrx3_generic_read (ismrx3_t ctx, uint8_t reg, uint8_t data_out)
	ISM RX 3 data reading function.

void	ismrx3_reset (ismrx3_t *ctx)
	Reset function.

uint8_t	ismrx3_get_clk (ismrx3_t *ctx)
	Read clock output.

uint8_t	ismrx3_get_data (ismrx3_t *ctx)
	Read data output.

Detailed Description

This file contains API for ISM RX 3 Click Driver.

Enumeration Type Documentation

◆ ismrx3_return_value_t

enum ismrx3_return_value_t

ISM RX 3 Click return value data.

Predefined enum values for driver return values.

Enumerator
ISMRX3_OK
ISMRX3_ERROR
ISMRX3_ERROR_BUF_LEN

Data Structures

Macros

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ ismrx3_return_value_t