Wireless M-Bus Virtual Water Meter Sensor (Wireless M-Bus Meter Only)
License#
Copyright 2024 Silicon Laboratories Inc. www.silabs.com
SPDX-License-Identifier: Zlib
The licensor of this software is Silicon Laboratories Inc.
This software is provided 'as-is', without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this software.
Permission is granted to anyone to use this software for any purpose, including commercial applications, and to alter it and redistribute it freely, subject to the following restrictions:
The origin of this software must not be misrepresented; you must not claim that you wrote the original software. If you use this software in a product, an acknowledgment in the product documentation would be appreciated but is not required.
Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software.
This notice may not be removed or altered from any source distribution.
Functions#
Wireless M-Bus Virtual Water Meter initialization function.
Wireless M-Bus Virtual Water Meter deinitialization function.
Wireless M-Bus Virtual Water Meter measure function.
Retrieves the sensor data for the Wireless M-Bus virtual water meter sensor.
Wireless M-Bus Virtual Water Meter 7 segment LCD print function.
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.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
Returns
sl_status_t: SL_STATUS_OK if init was successful SL_STATUS_FAIL if init failed
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.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
Returns
sl_status_t: SL_STATUS_OK if init was successful SL_STATUS_FAIL if init failed
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.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
Returns
sl_status_t: SL_STATUS_OK if measure was successful SL_STATUS_FAIL if measure failed
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.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | 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
Pointer of a sl_rail_sdk_wmbus_sensor_data_t, to the sensor data for the Wireless M-Bus virtual water meter sensor
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.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | 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
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.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | 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