mbusrf2  2.1.0.0
Data Structures | Macros | Enumerations | Functions
mbusrf2.h File Reference

This file contains API for M-BUS RF 2 Click Driver. More...

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

Go to the source code of this file.

Data Structures

struct  mbusrf2_t
 M-BUS RF 2 Click context object. More...
 
struct  mbusrf2_cfg_t
 M-BUS RF 2 Click configuration object. More...
 

Macros

#define MBUSRF2_CMD_SFD   0xFF
 M-BUS RF 2 control commands. More...
 
#define MBUSRF2_CMD_DATA_REQ   0x00
 
#define MBUSRF2_CMD_DATA_IND   0x03
 
#define MBUSRF2_CMD_SET_MODE_REQ   0x04
 
#define MBUSRF2_CMD_RESET_REQ   0x05
 
#define MBUSRF2_CMD_SET_REQ   0x09
 
#define MBUSRF2_CMD_SETUARTSPEED_REQ   0x10
 
#define MBUSRF2_CMD_FACTORYRESET_REQ   0x11
 
#define MBUSRF2_CMD_GET_REQ   0x0A
 
#define MBUSRF2_CMD_SERIALNO_REQ   0x0B
 
#define MBUSRF2_CMD_FWV_REQ   0x0C
 
#define MBUSRF2_CMD_RSSI_REQ   0x0D
 
#define MBUSRF2_CMD_SET_AES_KEY_REQ   0x50
 
#define MBUSRF2_CMD_CLR_AES_KEY_REQ   0x51
 
#define MBUSRF2_CMD_GET_AES_KEY_REQ   0x52
 
#define MBUSRF2_CMD_RESPONSE   0x80
 
#define MBUSRF2_TX_DRV_BUFFER_SIZE   100
 M-BUS RF 2 driver buffer size. More...
 
#define MBUSRF2_RX_DRV_BUFFER_SIZE   300
 
#define MBUSRF2_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping. More...
 

Enumerations

enum  mbusrf2_return_value_t { MBUSRF2_OK = 0, MBUSRF2_ERROR = -1, MBUSRF2_ERROR_TIMEOUT = -2 }
 M-BUS RF 2 Click return value data. More...
 

Functions

void mbusrf2_cfg_setup (mbusrf2_cfg_t *cfg)
 M-BUS RF 2 configuration object setup function. More...
 
err_t mbusrf2_init (mbusrf2_t *ctx, mbusrf2_cfg_t *cfg)
 M-BUS RF 2 initialization function. More...
 
err_t mbusrf2_generic_write (mbusrf2_t *ctx, uint8_t *data_in, uint16_t len)
 M-BUS RF 2 data writing function. More...
 
err_t mbusrf2_generic_read (mbusrf2_t *ctx, uint8_t *data_out, uint16_t len)
 M-BUS RF 2 data reading function. More...
 
void mbusrf2_set_rst_pin (mbusrf2_t *ctx, uint8_t pin_state)
 M-BUS RF 2 set reset pin function. More...
 
err_t mbusrf2_send_command (mbusrf2_t *ctx, uint8_t cmd, uint8_t *data_in, uint8_t len)
 M-BUS RF 2 send command function. More...
 
err_t mbusrf2_send_data (mbusrf2_t *ctx, uint8_t *data_in, uint8_t len)
 M-BUS RF 2 send data function. More...
 

Detailed Description

This file contains API for M-BUS RF 2 Click Driver.

Enumeration Type Documentation

◆ mbusrf2_return_value_t

M-BUS RF 2 Click return value data.

Predefined enum values for driver return values.

Enumerator
MBUSRF2_OK 
MBUSRF2_ERROR 
MBUSRF2_ERROR_TIMEOUT