Go to the documentation of this file.
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
53 #define MBUSRF4_MAP_MIKROBUS( cfg, mikrobus ) \
54 cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
55 cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
56 cfg.ind = MIKROBUS( mikrobus, MIKROBUS_AN ); \
57 cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
58 cfg.sel = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
59 cfg.rts = MIKROBUS( mikrobus, MIKROBUS_INT )
66 #define MBUSRF4_RETVAL uint8_t
68 #define MBUSRF4_OK 0x00
69 #define MBUSRF4_INIT_ERROR 0xFF
76 #define MBUSRF4_ERROR_COMMAND_OR_ELEMENT 0xFF
77 #define MBUSRF4_ERROR_START_OR_END_COMMAND 0x8F
78 #define MBUSRF4_ERROR_NEXT_ELEMENT 0x4F
79 #define MBUSRF4_ERROR_CURRENT_ELEMENT 0x2F
80 #define MBUSRF4_NO_ERROR 0x00
87 #define DRV_RX_BUFFER_SIZE 256
94 #define MBUSRF4_CMD_RESET 0x30
95 #define MBUSRF4_CMD_FACTORY_RESET 0x31
96 #define MBUSRF4_CMD_SET_MODE 0x32
97 #define MBUSRF4_CMD_EEPROM_WRITE 0x33
98 #define MBUSRF4_CMD_EEPROM_READ 0x34
99 #define MBUSRF4_CMD_TX_MSG 0x35
100 #define MBUSRF4_CMD_RX_MSG_IND 0x36
101 #define MBUSRF4_CMD_GET_FW_VERSION 0x37
102 #define MBUSRF4_CMD_GET_SERIALNO 0x38
103 #define MBUSRF4_CMD_GET_RSSI 0x39
104 #define MBUSRF4_CMD_SET_C_FIELD 0x40
111 #define MBUSRF4_EEADDR_WM_BUS_MODE 0x00
112 #define MBUSRF4_EEADDR_RF_CHANNEL 0x01
113 #define MBUSRF4_EEADDR_RF_POWER 0x02
114 #define MBUSRF4_EEADDR_RF_AUTOSLEEP 0x03
115 #define MBUSRF4_EEADDR_RX_WINDOW 0x04
117 #define MBUSRF4_EEADDR_WMBUS_C_FIELD 0x10
118 #define MBUSRF4_EEADDR_WMBUS_MANUFACTER_ID0 0x11
119 #define MBUSRF4_EEADDR_WMBUS_MANUFACTER_ID1 0x12
120 #define MBUSRF4_EEADDR_WMBUS_DEVICE_ID0 0x13
121 #define MBUSRF4_EEADDR_WMBUS_DEVICE_ID1 0x14
122 #define MBUSRF4_EEADDR_WMBUS_DEVICE_ID2 0x15
123 #define MBUSRF4_EEADDR_WMBUS_DEVICE_ID3 0x16
124 #define MBUSRF4_EEADDR_WMBUS_VERSION 0x17
125 #define MBUSRF4_EEADDR_WMBUS_DEVICE_TYPE 0x18
127 #define MBUSRF4_EEADDR_WMBUS_BLOCK1_FROM_MODULE_ENABLE 0x20
128 #define MBUSRF4_EEADDR_WMBUS_RSSI_ENABLE 0x21
129 #define MBUSRF4_EEADDR_WMBUS_INDICATE_TIMEOUT_LSB 0x22
130 #define MBUSRF4_EEADDR_WMBUS_INDICATE_TIMEOUT_MSB 0x23
131 #define MBUSRF4_EEADDR_WMBUS_UART_BAUDREATE 0x24
138 #define MBUSRF4_EEPARAM_WMBUS_MODE_S2_SHORT_PREAMBLE 0x00
139 #define MBUSRF4_EEPARAM_WMBUS_MODE_S2_LONG_PREAMBLE 0x01
140 #define MBUSRF4_EEPARAM_WMBUS_MODE_S1 0x02
141 #define MBUSRF4_EEPARAM_WMBUS_MODE_S1_M 0x03
142 #define MBUSRF4_EEPARAM_WMBUS_MODE_T1_METER 0x04
143 #define MBUSRF4_EEPARAM_WMBUS_MODE_T2_METER 0x05
144 #define MBUSRF4_EEPARAM_WMBUS_MODE_T2_OTHER 0x06
145 #define MBUSRF4_EEPARAM_WMBUS_MODE_R2_METER 0x07
146 #define MBUSRF4_EEPARAM_WMBUS_MODE_R2_OTHER 0x08
147 #define MBUSRF4_EEPARAM_WMBUS_MODE_C1_METER_FRAME_A 0x09
148 #define MBUSRF4_EEPARAM_WMBUS_MODE_C1_METER_FRAME_B 0x0A
149 #define MBUSRF4_EEPARAM_WMBUS_MODE_C2_METER_FRAME_A 0x0B
150 #define MBUSRF4_EEPARAM_WMBUS_MODE_C2_METER_FRAME_B 0x0C
151 #define MBUSRF4_EEPARAM_WMBUS_MODE_C2_OTHER_FRAME_A 0x0D
152 #define MBUSRF4_EEPARAM_WMBUS_MODE_C2_OTHER_FRAME_B 0x0E
153 #define MBUSRF4_EEPARAM_WMBUS_MODE_T2_C2_OTHER 0x0F
160 #define MBUSRF4_EEPARAM_RFGH_868p03MHz 0x00
161 #define MBUSRF4_EEPARAM_RFGH_868p09MHz 0x01
162 #define MBUSRF4_EEPARAM_RFGH_868p15MHz 0x02
163 #define MBUSRF4_EEPARAM_RFGH_868p21MHz 0x03
164 #define MBUSRF4_EEPARAM_RFGH_868p27MHz 0x04
165 #define MBUSRF4_EEPARAM_RFGH_868p33MHz 0x05
166 #define MBUSRF4_EEPARAM_RFGH_868p39MHz 0x06
167 #define MBUSRF4_EEPARAM_RFGH_868p45MHz 0x07
168 #define MBUSRF4_EEPARAM_RFGH_868p51MHz 0x08
169 #define MBUSRF4_EEPARAM_RFGH_868p57MHz 0x09
176 #define MBUSRF4_EEPARAM_RFPWR_0dBm 0x00
177 #define MBUSRF4_EEPARAM_RFPWR_5dBm 0x01
178 #define MBUSRF4_EEPARAM_RFPWR_7dBm 0x02
179 #define MBUSRF4_EEPARAM_RFPWR_10dBm 0x03
180 #define MBUSRF4_EEPARAM_RFPWR_12dBm 0x04
187 #define MBUSRF4_EEPARAM_RFAS_SLEEP_DISABLE 0x00
188 #define MBUSRF4_EEPARAM_RFAS_SLEEP_ENABLE 0x01
195 #define MBUSRF4_WM_BUS_C_FIELD 0x44
196 #define MBUSRF4_HEADER 0xAA
203 #define MBUSRF4_EEPARAM_BLOCK1_FROM_MODULE_ENABLE 0x01
204 #define MBUSRF4_EEPARAM_BLOCK1_FROM_MODULE_DISABLE 0x00
211 #define MBUSRF4_EEPARAM_RSSI_ENABLE 0x01
212 #define MBUSRF4_EEPARAM_RSSI_DISABLE 0x00
219 #define MBUSRF4_EEPARAM_UART_BAUDRATE_9600 0x00
220 #define MBUSRF4_EEPARAM_UART_BAUDRATE_19200 0x01
221 #define MBUSRF4_EEPARAM_UART_BAUDRATE_38400 0x02
222 #define MBUSRF4_EEPARAM_UART_BAUDRATE_57600 0x03
223 #define MBUSRF4_EEPARAM_UART_BAUDRATE_115200 0x04
230 #define MBUSRF4_SET_VALUE_IN_RAM_MEMORY 0x00
231 #define MBUSRF4_SET_VALUE_IN_EEPROM_MEMORY 0xFF
238 #define MBUSRF4_USER_APP_RX_MODE 0x00
239 #define MBUSRF4_USER_APP_TX_MODE 0x01
246 #define MBUSRF4_COMMUNICATION_UART_MODE 0x01
247 #define MBUSRF4_COMMUNICATION_SPI_MODE 0x00
422 #endif // _MBUSRF4_H_
pin_name_t cs
Definition: mbusrf4.h:292
#define DRV_RX_BUFFER_SIZE
Definition: mbusrf4.h:87
int32_t mbusrf4_generic_read(mbusrf4_t *ctx, char *data_buf, uint16_t max_len)
Generic read function.
MBUSRF4_RETVAL mbusrf4_init(mbusrf4_t *ctx, mbusrf4_cfg_t *cfg)
Initialization function.
void mbusrf4_set_communication_mode(mbusrf4_t *ctx, uint8_t mode)
Set communication SPI/UART.
uart_parity_t parity_bit
Definition: mbusrf4.h:301
uart_data_bits_t data_bit
Definition: mbusrf4.h:300
uart_t uart
Definition: mbusrf4.h:272
uart_stop_bits_t stop_bit
Definition: mbusrf4.h:302
void mbusrf4_generic_write(mbusrf4_t *ctx, char *data_buf, uint16_t len)
Generic write function.
void mbusrf4_cfg_setup(mbusrf4_cfg_t *cfg)
Config Object Initialization function.
bool uart_blocking
Definition: mbusrf4.h:299
pin_name_t tx_pin
Definition: mbusrf4.h:287
uint32_t baud_rate
Definition: mbusrf4.h:298
uint8_t mbusrf4_get_state_ind(mbusrf4_t *ctx)
Get Interrupt state of the IND(AN) pin.
Click ctx object definition.
Definition: mbusrf4.h:259
digital_in_t ind
Definition: mbusrf4.h:267
void mbusrf4_send_command(mbusrf4_t *ctx, uint8_t command, uint8_t length, uint8_t *payload_buff)
Send command - UART communication.
digital_out_t sel
Definition: mbusrf4.h:263
pin_name_t ind
Definition: mbusrf4.h:291
digital_out_t cs
Definition: mbusrf4.h:262
pin_name_t rx_pin
Definition: mbusrf4.h:286
uint8_t mbusrf4_get_state_rts(mbusrf4_t *ctx)
Get Interrupt state of the RTS(INT) pin.
Click configuration structure definition.
Definition: mbusrf4.h:283
void mbusrf4_transmit_data(mbusrf4_t *ctx, uint8_t *tx_buf, uint8_t tx_len)
pin_name_t rts
Definition: mbusrf4.h:294
pin_name_t sel
Definition: mbusrf4.h:293
digital_in_t rts
Definition: mbusrf4.h:268
uint8_t mbusrf4_error_t
Error type.
Definition: mbusrf4.h:309
#define MBUSRF4_RETVAL
Definition: mbusrf4.h:66