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

This file contains API for M-BUS RF 3 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  mbusrf3_t
 M-BUS RF 3 Click context object. More...
 
struct  mbusrf3_cfg_t
 M-BUS RF 3 Click configuration object. More...
 

Macros

#define MBUSRF3_CMD_SFD   0xFF
 M-BUS RF 3 control commands. More...
 
#define MBUSRF3_CMD_DATA_REQ   0x00
 
#define MBUSRF3_CMD_DATA_IND   0x03
 
#define MBUSRF3_CMD_SET_MODE_REQ   0x04
 
#define MBUSRF3_CMD_RESET_REQ   0x05
 
#define MBUSRF3_CMD_SET_REQ   0x09
 
#define MBUSRF3_CMD_SETUARTSPEED_REQ   0x10
 
#define MBUSRF3_CMD_FACTORYRESET_REQ   0x11
 
#define MBUSRF3_CMD_GET_REQ   0x0A
 
#define MBUSRF3_CMD_SERIALNO_REQ   0x0B
 
#define MBUSRF3_CMD_FWV_REQ   0x0C
 
#define MBUSRF3_CMD_RSSI_REQ   0x0D
 
#define MBUSRF3_CMD_SET_AES_KEY_REQ   0x50
 
#define MBUSRF3_CMD_CLR_AES_KEY_REQ   0x51
 
#define MBUSRF3_CMD_GET_AES_KEY_REQ   0x52
 
#define MBUSRF3_CMD_RESPONSE   0x80
 
#define MBUSRF3_TX_DRV_BUFFER_SIZE   100
 M-BUS RF 3 driver buffer size. More...
 
#define MBUSRF3_RX_DRV_BUFFER_SIZE   300
 
#define MBUSRF3_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping. More...
 

Enumerations

enum  mbusrf3_return_value_t { MBUSRF3_OK = 0, MBUSRF3_ERROR = -1, MBUSRF3_ERROR_TIMEOUT = -2 }
 M-BUS RF 3 Click return value data. More...
 

Functions

void mbusrf3_cfg_setup (mbusrf3_cfg_t *cfg)
 M-BUS RF 3 configuration object setup function. More...
 
err_t mbusrf3_init (mbusrf3_t *ctx, mbusrf3_cfg_t *cfg)
 M-BUS RF 3 initialization function. More...
 
err_t mbusrf3_generic_write (mbusrf3_t *ctx, uint8_t *data_in, uint16_t len)
 M-BUS RF 3 data writing function. More...
 
err_t mbusrf3_generic_read (mbusrf3_t *ctx, uint8_t *data_out, uint16_t len)
 M-BUS RF 3 data reading function. More...
 
void mbusrf3_set_rst_pin (mbusrf3_t *ctx, uint8_t pin_state)
 M-BUS RF 3 set reset pin function. More...
 
err_t mbusrf3_send_command (mbusrf3_t *ctx, uint8_t cmd, uint8_t *data_in, uint8_t len)
 M-BUS RF 3 send command function. More...
 
err_t mbusrf3_send_data (mbusrf3_t *ctx, uint8_t *data_in, uint8_t len)
 M-BUS RF 3 send data function. More...
 

Detailed Description

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

Enumeration Type Documentation

◆ mbusrf3_return_value_t

M-BUS RF 3 Click return value data.

Predefined enum values for driver return values.

Enumerator
MBUSRF3_OK 
MBUSRF3_ERROR 
MBUSRF3_ERROR_TIMEOUT