RA Flexible Software Package Documentation  Release v5.2.0

 
BLE Mesh Network Generic Battery Server (rm_mesh_generic_battery_srv)

Functions

fsp_err_t RM_MESH_GENERIC_BATTERY_SRV_Open (rm_ble_mesh_model_server_ctrl_t *const p_ctrl, rm_ble_mesh_model_server_cfg_t const *const p_cfg)
 
fsp_err_t RM_MESH_GENERIC_BATTERY_SRV_Close (rm_ble_mesh_model_server_ctrl_t *const p_ctrl)
 
fsp_err_t RM_MESH_GENERIC_BATTERY_SRV_StateUpdate (rm_ble_mesh_model_server_ctrl_t *const p_ctrl, rm_ble_mesh_access_server_state_t const *const p_state)
 

Detailed Description

Overview

Target Devices

The BLE Mesh Network Generic Battery Server module supports the following devices.

Configuration

Build Time Configurations for rm_mesh_generic_battery_srv

The following build time configurations are defined in fsp_cfg/rm_mesh_generic_battery_srv_cfg.h:

ConfigurationOptionsDefaultDescription

Configurations for Networking > BLE Mesh Network modules > BLE Mesh Model Generic Battery Server (rm_mesh_generic_battery_srv)

This module can be added to the Stacks tab via New Stack > Networking > BLE Mesh Network modules > BLE Mesh Model Generic Battery Server (rm_mesh_generic_battery_srv).

ConfigurationOptionsDefaultDescription
Interrupts
Callback Provided When Timeout OccursName Must Be a Valid C SymbolNULL Callback provided when mesh generic battery server ISR occurs
Callback Provided When an Timeout ISR OccursName Must Be a Valid C SymbolNULL Callback provided when mesh generic battery server timeout ISR occurs
NameName Must Be a Valid C Symbolg_rm_mesh_generic_battery_srv0 Module name.

Data Structures

struct  rm_mesh_generic_battery_srv_info_t
 
struct  rm_mesh_generic_battery_srv_instance_ctrl_t
 

Data Structure Documentation

◆ rm_mesh_generic_battery_srv_info_t

struct rm_mesh_generic_battery_srv_info_t

Generic Battery state is a set of four values representing the state of a battery

Data Fields
uint8_t generic_battery_level

Generic Battery Level state is a value ranging from 0 percent through 100 percent

uint32_t generic_battery_time_to_discharge

Generic Battery Time to Discharge state is a 24-bit unsigned value ranging from 0 through 0xFFFFFF

uint32_t generic_battery_time_to_charge

Generic Battery Time to Charge state is a 24-bit unsigned value ranging from 0 through 0xFFFFFF

uint8_t generic_battery_flags

Generic Battery Flags state is a concatenation of four 2-bit bit fields: Presence, Indicator, Charging, and Serviceability

◆ rm_mesh_generic_battery_srv_instance_ctrl_t

struct rm_mesh_generic_battery_srv_instance_ctrl_t

BLE mesh generic_battery instance control block. DO NOT INITIALIZE. Initialization occurs when RM_MESH_GENERIC_BATTERY_SRV_Open() is called.

Function Documentation

◆ RM_MESH_GENERIC_BATTERY_SRV_Open()

fsp_err_t RM_MESH_GENERIC_BATTERY_SRV_Open ( rm_ble_mesh_model_server_ctrl_t *const  p_ctrl,
rm_ble_mesh_model_server_cfg_t const *const  p_cfg 
)

API to initialize Generic_Battery Server model. This is to initialize Generic_Battery Server model and to register with Access layer.

Implements rm_ble_mesh_model_server_api_t::open.

Example:

/* Open the module. */
err = RM_MESH_GENERIC_BATTERY_SRV_Open(&g_mesh_generic_battery_srv0_ctrl, &g_mesh_generic_battery_srv0_cfg);
Return values
FSP_SUCCESSModel opened successfully.
FSP_ERR_ASSERTIONPointer to control block or configuration structure is NULL.
FSP_ERR_ALREADY_OPENModel is already open.
FSP_ERR_NOT_FOUNDThe number of models has exceeded the limit.
FSP_ERR_ABORTEDModel initialization is failed.

◆ RM_MESH_GENERIC_BATTERY_SRV_Close()

fsp_err_t RM_MESH_GENERIC_BATTERY_SRV_Close ( rm_ble_mesh_model_server_ctrl_t *const  p_ctrl)

API to terminate Generic_Battery Server model. This is to terminate Generic_Battery Server model and to register with Access layer.

Implements rm_ble_mesh_model_server_api_t::close.

Example:

/* Close the module. */
err = RM_MESH_GENERIC_BATTERY_SRV_Close(&g_mesh_generic_battery_srv0_ctrl);
Return values
FSP_SUCCESSModel successfully closed.
FSP_ERR_ASSERTIONThe parameter p_ctrl is NULL.
FSP_ERR_NOT_OPENModel is not open.

◆ RM_MESH_GENERIC_BATTERY_SRV_StateUpdate()

fsp_err_t RM_MESH_GENERIC_BATTERY_SRV_StateUpdate ( rm_ble_mesh_model_server_ctrl_t *const  p_ctrl,
rm_ble_mesh_access_server_state_t const *const  p_state 
)

API to send reply or to update state change. This is to send reply for a request or to inform change in state.

Implements rm_ble_mesh_model_server_api_t::stateUpdate.

Example:

/* Update server status. */
err = RM_MESH_GENERIC_BATTERY_SRV_StateUpdate(&g_mesh_generic_battery_srv0_ctrl, &state);
Return values
FSP_SUCCESSUpdated server status successfully.
FSP_ERR_ASSERTIONThe parameter p_ctrl is NULL.
FSP_ERR_INVALID_POINTERThe parameter p_state is NULL.
FSP_ERR_NOT_OPENModel is not open.
FSP_ERR_INVALID_ARGUMENTInput parameter is invalid.
FSP_ERR_APPROXIMATIONLower layer is invalid state.
FSP_ERR_NOT_FOUNDInput parameter is not found.
FSP_ERR_INVALID_ADDRESSInvalid source address.
FSP_ERR_OUT_OF_MEMORYMemory allocation is failed.
FSP_ERR_OVERFLOWTX queue is full.
FSP_ERR_UNDERFLOWTX queue is empty.
FSP_ERR_ABORTEDOperation is failed.