Generic Level server behaviour

APP_TIMER_DEF(_name ## _timer); \
    static app_level_server_t _name =  \
    {  \
        .server.settings.force_segmented = _force_segmented,  \
        .server.settings.transmic_size = _mic_size,  \
        .state.transition.timer.p_timer_id = &_name ## _timer,  \
        .p_dtt_ms = _p_dtt, \
        .level_set_cb = _set_cb,  \
        .level_get_cb = _get_cb,  \
        .level_transition_cb = _transition_cb  \
    };

Macro to create application level app_level_server_t context.

Individual timer instances are created for each model instance.

Parameters

[in]	_name	Name of the app_level_server_t instance
[in]	_force_segmented	If the Generic Level server shall use force segmentation of messages
[in]	_mic_size	MIC size to be used by Generic Level server
[in]	_p_dtt	Pointer to the default transition time state if present
[in]	_set_cb	Callback for setting the application state to given value.
[in]	_get_cb	Callback for reading the state from the application.
[in]	_transition_cb	Callback for setting the application transition time and state value to given values.

Definition at line 113 of file app_level.h.

Application state set callback prototype.

This callback is called by the this module whenever application is required to be informed to reflect the desired Level value, as a result of the received SET/DELTA SET/MOVE SET message, depending on the received Target Level value and timing parameters.

Note: Since the behavioral module encapsulates functionality required for the compliance with timing behaviour, it is not possible to infer number of Level messages received by the node by counting the number of times this callback is triggered. If such counting is required, it should be done in the app_level.c module.

Parameters

[in]	p_app	Pointer to app_level_server_t context.
[in]	present_level	Instantaneous new level value to be used by the application

Definition at line 183 of file app_level.h.

Application state read callback prototype.

This callback is called by the app_level.c whenever application level state is required to be read.

Parameters

[in]	p_app	Pointer to app_level_server_t context.
[out]	p_present_level	User application fills this value with the value retrived from the hardware interface. See model_callback_pointer_note.

Definition at line 193 of file app_level.h.

Application transition time callback prototype.

This callback is called by the this module whenever application is required to be informed to reflect the desired transition time, depending on the received target level/type and timing parameters.

Parameters

[in]	p_app	Pointer to app_level_server_t context.
[in]	transition_time_ms	Transition time (in milliseconds) to be used by the application.
[in]	target_level	Target level value to be used by the application

Definition at line 206 of file app_level.h.

Initiates value fetch from the user application by calling a get callback, updates internal state, and publishes the Generic Level Status message.

This API must always be called by an application when user initiated action (e.g. button press) results in the local Level state change. This API should never be called from transition callback. Bluetooth Mesh Profile Specification (MshPRFv1.0.1) mandates that, every local state change must be published if model publication state is configured. If model publication is not configured this API call will not generate any assertion.

Parameters

[in]

p_app

Pointer to app_level_server_t context.

Return values

NRF_SUCCESS	If status message is successfully published.
NRF_ERROR_NULL	NULL pointer given to function.
NRF_ERROR_INVALID_PARAM	The model not bound to application key or publish address not set.
NRF_ERROR_INVALID_STATE	There's already a segmented packet that is being to sent to this destination. Wait for the transmission to finish before sending new segmented packets.
NRF_ERROR_NO_MEM	No memory available to send the message at this point.
NRF_ERROR_FORBIDDEN	Failed to allocate a sequence number from network.
NRF_ERROR_NOT_FOUND	The model is not initialized.

Initializes the behavioral module for the Generic Level model.

Parameters

[in]	p_app	Pointer to app_level_server_t context.
[in]	element_index	Element index on which this server will be instantiated.

Return values

NRF_SUCCESS	If initialization is successful
NRF_ERROR_NULL	NULL pointer is supplied to the function or to the required member variable pointers.
NRF_ERROR_NO_MEM	ACCESS_MODEL_COUNT number of models already allocated or no more subscription lists available in memory pool (see ACCESS_SUBSCRIPTION_LIST_COUNT).
NRF_ERROR_FORBIDDEN	Multiple model instances per element are not allowed or changes to device composition are not allowed. Adding a new model after device is provisioned is not allowed.
NRF_ERROR_NOT_FOUND	Invalid access element index.
NRF_ERROR_INVALID_PARAM	If the application timer module has not been initialized.
NRF_ERROR_INVALID_STATE	If the application timer is running.

Restores the level value from persistent storage.

This is called by main.c when the mesh is initialized and stable. Note that this function must be called from the same IRQ level that mesh_init() is set at.

Parameters

[in]

p_app

Pointer to app_level_server_t context.

Return values

NRF_SUCCESS	Value is restored successfully
NRF_ERROR_NULL	If NULL pointer is provided as input context

Sets the scene context.

This is needed for app level to inform app scene when the state change occurs.

Note

Available only if SCENE_SETUP_SERVER_INSTANCES_MAX is equal or larger than 1.

Parameters

[in]	p_app	Pointer to app_level_server_t context.
[in]	p_app_scene	Pointer to scene behavioral moduel context.

Return values

NRF_SUCCESS	Value is restored successfully
NRF_ERROR_NULL	If NULL pointer is provided as input context