Radiocraft Wireless M-Bus extension module  2.18
mbus_open Struct Reference

FUNCTION mbusOpen
Defines the data structure of the VPL function mbusOpen. More...

Data Fields

int16 retval
 return value from call, set by VPL More...
 
int16 error
 error value from call, set by VPL More...
 
int8 mode
 The M-Bus mode to use. More...
 
int8 rssi
 Set to true to include the signal strength (RSSI) for each valid packet. More...
 
int16 max_frames
 Amount of elements the buffer will accept. Maximum value 1000. More...
 
int8 overwrite
 If 1 (true), use overwrite policy, if 0 (false), discard newly received frame. More...
 

Detailed Description

FUNCTION mbusOpen
Defines the data structure of the VPL function mbusOpen.

This function opens the connection to the M-Bus module.

Definition at line 54 of file mod_mbus.c.

Field Documentation

◆ error

int16 mbus_open::error

error value from call, set by VPL

Definition at line 58 of file mod_mbus.c.

◆ max_frames

int16 mbus_open::max_frames

Amount of elements the buffer will accept. Maximum value 1000.

Definition at line 71 of file mod_mbus.c.

Referenced by mbusCallOpen().

◆ mode

int8 mbus_open::mode

The M-Bus mode to use.

  • 0 = S2
  • 1 = T1 (default)
  • 2 = T2
  • 3 = S1
  • 4 = R
  • 10 = T1+C
  • 11 = T2+C

Definition at line 61 of file mod_mbus.c.

Referenced by mbusCallOpen().

◆ overwrite

int8 mbus_open::overwrite

If 1 (true), use overwrite policy, if 0 (false), discard newly received frame.

Definition at line 72 of file mod_mbus.c.

Referenced by mbusCallOpen().

◆ retval

int16 mbus_open::retval

return value from call, set by VPL

Definition at line 57 of file mod_mbus.c.

◆ rssi

int8 mbus_open::rssi

Set to true to include the signal strength (RSSI) for each valid packet.

It can be read from mbusReceive() and is available in the mbusFrame struct block (mbus_frame).

Definition at line 69 of file mod_mbus.c.

Referenced by mbusCallOpen().


The documentation for this struct was generated from the following file: