Wireless M-Bus Virtual Water Meter Sensor#

The Wireless M-Bus Virtual Water Meter Sensor component is a software-based solution designed to monitor and measure water usage in a given environment. This component provides the necessary tools to integrate water meter data into Wireless M-Bus packets, ensuring that the data is correctly formatted and transmitted.

Key Features:

  • Water Usage Measurement: Functions to measure water usage using a virtual water meter sensor.

  • Data Handling: Functions to retrieve and format water meter data for inclusion in Wireless M-Bus packets.

  • Packet Assembly: Tools to assemble packets with water meter data, ensuring that the data is correctly formatted and transmitted.

Modules#

Configurations

Functions#

sl_status_t
sl_rail_sdk_wmbus_sensor_virtual_water_meter_init(void)

Wireless M-Bus Virtual Water Meter initialization function.

sl_status_t
sl_rail_sdk_wmbus_sensor_virtual_water_meter_deinit(void)

Wireless M-Bus Virtual Water Meter deinitialization function.

sl_status_t
sl_rail_sdk_wmbus_sensor_virtual_water_meter_measure(void)

Wireless M-Bus Virtual Water Meter measure function.

sl_rail_sdk_wmbus_sensor_data_t *
sl_rail_sdk_wmbus_sensor_virtual_water_meter_get_data(void)

Retrieves the sensor data for the Wireless M-Bus virtual water meter sensor.

sl_status_t
sl_rail_sdk_wmbus_sensor_virtual_water_meter_print(void)

Wireless M-Bus Virtual Water Meter 7 segment LCD print function.

sl_status_t
sl_rail_sdk_wmbus_sensor_virtual_water_meter_button_pressed(void)

Wireless M-Bus Virtual Water Meter button pressed function.

Function Documentation#

sl_rail_sdk_wmbus_sensor_virtual_water_meter_init#

sl_status_t sl_rail_sdk_wmbus_sensor_virtual_water_meter_init (void )

Wireless M-Bus Virtual Water Meter initialization function.

Parameters
N/A

Returns

  • sl_status_t: SL_STATUS_OK if init was successful SL_STATUS_FAIL if init failed


Definition at line 67 of file /mnt/raid/workspaces/ws.bVpTDXqvc/overlay/gsdk/app/rail/component/sl_rail_sdk_wmbus_sensor_virtual_water_meter/sl_rail_sdk_wmbus_sensor_virtual_water_meter.h

sl_rail_sdk_wmbus_sensor_virtual_water_meter_deinit#

sl_status_t sl_rail_sdk_wmbus_sensor_virtual_water_meter_deinit (void )

Wireless M-Bus Virtual Water Meter deinitialization function.

Parameters
N/A

Returns

  • sl_status_t: SL_STATUS_OK if init was successful SL_STATUS_FAIL if init failed


Definition at line 75 of file /mnt/raid/workspaces/ws.bVpTDXqvc/overlay/gsdk/app/rail/component/sl_rail_sdk_wmbus_sensor_virtual_water_meter/sl_rail_sdk_wmbus_sensor_virtual_water_meter.h

sl_rail_sdk_wmbus_sensor_virtual_water_meter_measure#

sl_status_t sl_rail_sdk_wmbus_sensor_virtual_water_meter_measure (void )

Wireless M-Bus Virtual Water Meter measure function.

Parameters
N/A

Returns

  • sl_status_t: SL_STATUS_OK if measure was successful SL_STATUS_FAIL if measure failed


Definition at line 83 of file /mnt/raid/workspaces/ws.bVpTDXqvc/overlay/gsdk/app/rail/component/sl_rail_sdk_wmbus_sensor_virtual_water_meter/sl_rail_sdk_wmbus_sensor_virtual_water_meter.h

sl_rail_sdk_wmbus_sensor_virtual_water_meter_get_data#

sl_rail_sdk_wmbus_sensor_data_t * sl_rail_sdk_wmbus_sensor_virtual_water_meter_get_data (void )

Retrieves the sensor data for the Wireless M-Bus virtual water meter sensor.

Parameters
N/A

Returns a pointer to the sl_rail_sdk_wmbus_sensor_data_t structure that contains the sensor data for the Wireless M-Bus virtual water meter sensor.

Returns


Definition at line 94 of file /mnt/raid/workspaces/ws.bVpTDXqvc/overlay/gsdk/app/rail/component/sl_rail_sdk_wmbus_sensor_virtual_water_meter/sl_rail_sdk_wmbus_sensor_virtual_water_meter.h

sl_rail_sdk_wmbus_sensor_virtual_water_meter_print#

sl_status_t sl_rail_sdk_wmbus_sensor_virtual_water_meter_print (void )

Wireless M-Bus Virtual Water Meter 7 segment LCD print function.

Parameters
N/A

Returns

  • sl_status_t: SL_STATUS_OK if 7 segment LCD print was successfully SL_STATUS_FAIL if 7 segment LCD print failed


Definition at line 102 of file /mnt/raid/workspaces/ws.bVpTDXqvc/overlay/gsdk/app/rail/component/sl_rail_sdk_wmbus_sensor_virtual_water_meter/sl_rail_sdk_wmbus_sensor_virtual_water_meter.h

sl_rail_sdk_wmbus_sensor_virtual_water_meter_button_pressed#

sl_status_t sl_rail_sdk_wmbus_sensor_virtual_water_meter_button_pressed (void )

Wireless M-Bus Virtual Water Meter button pressed function.

Parameters
N/A

This function handles the button press event for the Wireless M-Bus virtual water meter sensor, in this case, it resets the total water consumption.

Returns

  • sl_status_t: SL_STATUS_OK if button press was successful SL_STATUS_FAIL if button pressed failed


Definition at line 112 of file /mnt/raid/workspaces/ws.bVpTDXqvc/overlay/gsdk/app/rail/component/sl_rail_sdk_wmbus_sensor_virtual_water_meter/sl_rail_sdk_wmbus_sensor_virtual_water_meter.h