app_level.h

/* Copyright (c) 2010 - 2020, Nordic Semiconductor ASA
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form, except as embedded into a Nordic
 * Semiconductor ASA integrated circuit in a product or a software update for
 * such product, must reproduce the above copyright notice, this list of
 * conditions and the following disclaimer in the documentation and/or other
 * materials provided with the distribution.
 *
 * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
 * contributors may be used to endorse or promote products derived from this
 * software without specific prior written permission.
 *
 * 4. This software, with or without modification, must only be used with a
 * Nordic Semiconductor ASA integrated circuit.
 *
 * 5. Any software provided in binary form under this license must not be reverse
 * engineered, decompiled, modified and/or disassembled.
 *
 * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
 * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef APP_LEVEL_H__
#define APP_LEVEL_H__

#include <stdint.h>

#include "generic_level_server.h"
#include "app_timer.h"
#include "app_transition.h"
#if (SCENE_SETUP_SERVER_INSTANCES_MAX > 0) || (DOXYGEN)
#include "app_scene.h"
#endif

#define APP_LEVEL_SERVER_DEF(_name, _force_segmented, _mic_size, _p_dtt, _set_cb, _get_cb, _transition_cb) \
 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 \
 };

typedef struct
{
 int32_t required_delta;
 int16_t initial_present_level;
} set_transition_t;

typedef struct
{
 int16_t required_move;
 int16_t initial_present_level;
} move_transition_t;

typedef struct
{
 int16_t present_level;
 int16_t target_level;

 int32_t delta;
 int16_t initial_present_level;

 int16_t init_present_snapshot;
 int16_t target_snapshot;

 app_transition_t transition;
} app_level_state_t;

/* Forward declaration */
typedef struct __app_level_server_t app_level_server_t;

typedef void (*app_level_set_cb_t)(const app_level_server_t * p_app, int16_t present_level);

typedef void (*app_level_get_cb_t)(const app_level_server_t * p_app, int16_t * p_present_level);

typedef void (*app_level_transition_cb_t)(const app_level_server_t * p_app,
 uint32_t transition_time_ms,
 uint16_t target_level,
 app_transition_type_t transition_type);

struct __app_level_server_t
{
 generic_level_server_t server;
 app_level_set_cb_t level_set_cb;
 app_level_get_cb_t level_get_cb;
 app_level_transition_cb_t level_transition_cb;

 const uint32_t * p_dtt_ms;
 app_level_state_t state;
#if (SCENE_SETUP_SERVER_INSTANCES_MAX > 0) || (DOXYGEN)

 app_scene_model_interface_t scene_if;
 app_scene_setup_server_t * p_app_scene;
#endif
};

uint32_t app_level_current_value_publish(app_level_server_t * p_app);

uint32_t app_level_init(app_level_server_t * p_app, uint8_t element_index);

uint32_t app_level_value_restore(app_level_server_t * p_app);

#if (SCENE_SETUP_SERVER_INSTANCES_MAX > 0) || (DOXYGEN)

uint32_t app_level_scene_context_set(app_level_server_t * p_app, 
 app_scene_setup_server_t * p_app_scene);
#endif

#endif /* APP_LEVEL_H__ */