ismrx  2.0.0.0
Data Structures | Macros | Enumerations | Functions
ismrx.h File Reference

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

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

Go to the source code of this file.

Data Structures

struct  ismrx_t
 ISM RX Click context object. More...
 
struct  ismrx_cfg_t
 ISM RX Click configuration object. More...
 

Macros

#define ISMRX_REG_POWER_CFG   0x00
 ISM RX description register. More...
 
#define ISMRX_REG_CFG   0x01
 
#define ISMRX_REG_CTRL   0x02
 
#define ISMRX_REG_OSC_FREQ   0x03
 
#define ISMRX_REG_OFF_TIMER_MSB   0x04
 
#define ISMRX_REG_OFF_TIMER_LSB   0x05
 
#define ISMRX_REG_CPU_RECOVERY_TIME   0x06
 
#define ISMRX_REG_RF_SETTLE_TIMER_MSB   0x07
 
#define ISMRX_REG_RF_SETTLE_TIMER_LSB   0x08
 
#define ISMRX_REG_STATUS   0x09
 
#define ISMRX_REG_AGC_DWELL_TIMER   0x0A
 
#define ISMRX_MODULATION_NULL   0
 ISM RX description setting. More...
 
#define ISMRX_MODULATION_ASK   1
 
#define ISMRX_MODULATION_FSK   2
 
#define ISMRX_RECEIVE_MODE_NULL   0
 
#define ISMRX_RECEIVE_MODE_RX   3
 
#define ISMRX_RECEIVE_MODE_DRX   4
 
#define ISMRX_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping. More...
 

Enumerations

enum  ismtx_return_value_t { ISMRX_OK = 0, ISMRX_ERROR = -1, ISMRX_CONTEXT_MODULATION_ERROR = -2, ISMRX_CONTEXT_RECEIVE_MODE_ERROR = -3 }
 ISM RX Click return value data. More...
 

Functions

void ismrx_cfg_setup (ismrx_cfg_t *cfg)
 ISM RX configuration object setup function. More...
 
err_t ismrx_init (ismrx_t *ctx, ismrx_cfg_t *cfg)
 ISM RX initialization function. More...
 
err_t ismrx_task_init (ismrx_t *ctx, ismrx_cfg_t *cfg)
 ISM RX initialization function. More...
 
err_t ismrx_default_cfg (ismrx_t *ctx)
 ISM RX default configuration function. More...
 
err_t ismrx_generic_write (ismrx_t *ctx, uint8_t reg, uint8_t data_in)
 ISM RX data writing function. More...
 
err_t ismrx_generic_read (ismrx_t *ctx, uint8_t reg, uint8_t *data_out)
 ISM RX data reading function. More...
 
err_t ismrx_master_reset (ismrx_t *ctx)
 ISM RX software reset. More...
 
void ismrx_start_drx (ismrx_t *ctx)
 ISM RX start receiving signal. More...
 
void ismrx_stop_drx (ismrx_t *ctx)
 ISM RX stop receiving signal. More...
 
uint8_t ismrx_get_data (ismrx_t *ctx)
 ISM RX get miso pin state. More...
 

Detailed Description

This file contains API for ISM RX Click Driver.

Enumeration Type Documentation

◆ ismtx_return_value_t

ISM RX Click return value data.

Predefined enum values for driver return values.

Enumerator
ISMRX_OK 
ISMRX_ERROR 
ISMRX_CONTEXT_MODULATION_ERROR 
ISMRX_CONTEXT_RECEIVE_MODE_ERROR