tr_level_control_server.h

Go to the documentation of this file.

#ifndef TR_LEVEL_CONTROL_SERVER_H
#define TR_LEVEL_CONTROL_SERVER_H
 
#include "tr_af.h"

#if defined(TR_LEVEL_CONTROL_SERVER_PLUGIN_PRINT_ENABLE) && (TR_LEVEL_CONTROL_SERVER_PLUGIN_PRINT_ENABLE == 1)
#define tr_level_control_server_printf(...)  tr_zcl_printf(__VA_ARGS__)
#define tr_level_control_server_println(...) tr_zcl_println(__VA_ARGS__)
#else
#define tr_level_control_server_printf(...)
#define tr_level_control_server_println(...)
#endif
 
// *****************************************************************************
// this section of defines allow for lighting transitions to happen over time.
// When a transition is in progress, a timer is used to trigger a tick function.
// The state variables are used by the tick function to determine what to do next.
// *****************************************************************************
// we keep the same number of timer slots as we have endpoints
#define TR_LEVEL_CONTROL_SERVER_MAX_LC_TIMERS_AT_ONCE TR_DEVICE_EP_COUNT
 
// special index to mean timer index not found
#define TR_LEVEL_CONTROL_SERVER_TIMER_INDEX_NOT_FOUND 0xFF
 
// the tick function called by the timer to adjust state
void level_control_server_timer_tick(zb_uint8_t endpoint);
 
// struct for keeping information on active transitions using timers
typedef struct
{
    // is this slot being used for an active timer
    zb_bool_t slot_in_use;
 
    // the mapping of endpoint to timer index
    zb_uint8_t endpoint;
 
    // the timer state so level_control_server_tick can decided what to do on the current tick
    zb_uint32_t current_level_32;
    zb_uint32_t target_level_32;
    zb_uint32_t move_rate_per_tenth_32;
    zb_uint16_t num_tenths_left;
    zb_uint8_t  move_direction;
    zb_bool_t   with_on_off;
 
} tr_lvl_ctrl_timer_t;


void tr_level_control_server_init_cb(zb_uint8_t endpoint);

zb_bool_t tr_level_control_server_command_received_cb(zb_zcl_parsed_hdr_t *cmd_info);

void tr_level_control_server_write_attr_cb(zb_uint8_t  endpoint,
                                           zb_uint16_t attr_id,
                                           zb_uint8_t  *new_value,
                                           zb_uint16_t manuf_code);

zb_bool_t tr_level_control_server_move_to_level_cb(zb_zcl_parsed_hdr_t *cmd_info,
                                                   zb_uint8_t          endpoint,
                                                   zb_uint8_t          level,
                                                   zb_uint16_t         transition_time,
                                                   zb_uint8_t          option_mask,
                                                   zb_uint8_t          option_override);

zb_bool_t tr_level_control_server_move_cb(zb_zcl_parsed_hdr_t *cmd_info,
                                          zb_uint8_t          endpoint,
                                          zb_uint8_t          move_mode,
                                          zb_uint8_t          rate,
                                          zb_uint8_t          option_mask,
                                          zb_uint8_t          option_override);

zb_bool_t tr_level_control_server_step_cb(zb_zcl_parsed_hdr_t *cmd_info,
                                          zb_uint8_t          endpoint,
                                          zb_uint8_t          step_mode,
                                          zb_uint8_t          step_size,
                                          zb_uint16_t         transition_time,
                                          zb_uint8_t          option_mask,
                                          zb_uint8_t          option_override);

zb_bool_t tr_level_control_server_stop_cb(zb_zcl_parsed_hdr_t *cmd_info,
                                          zb_uint8_t          endpoint,
                                          zb_uint8_t          option_mask,
                                          zb_uint8_t          option_override);

zb_bool_t tr_level_control_server_move_to_level_with_on_off_cb(zb_zcl_parsed_hdr_t *cmd_info,
                                                               zb_uint8_t          endpoint,
                                                               zb_uint8_t          level,
                                                               zb_uint16_t         transition_time,
                                                               zb_uint8_t          option_mask,
                                                               zb_uint8_t          option_override);

zb_bool_t tr_level_control_server_move_with_on_off_cb(zb_zcl_parsed_hdr_t *cmd_info,
                                                      zb_uint8_t          endpoint,
                                                      zb_uint8_t          move_mode,
                                                      zb_uint8_t          rate,
                                                      zb_uint8_t          option_mask,
                                                      zb_uint8_t          option_override);

zb_bool_t tr_level_control_server_step_with_on_off_cb(zb_zcl_parsed_hdr_t *cmd_info,
                                                      zb_uint8_t          endpoint,
                                                      zb_uint8_t          step_mode,
                                                      zb_uint8_t          step_size,
                                                      zb_uint16_t         transition_time,
                                                      zb_uint8_t          option_mask,
                                                      zb_uint8_t          option_override);

zb_bool_t tr_level_control_server_stop_with_on_off_cb(zb_zcl_parsed_hdr_t *cmd_info,
                                                      zb_uint8_t          endpoint,
                                                      zb_uint8_t          option_mask,
                                                      zb_uint8_t          option_override);
 

void tr_level_control_server_level_changed_cb(zb_uint8_t endpoint,
                                              zb_uint8_t new_level);


void tr_level_control_server_init(void);
 
void write_new_current_level(zb_uint8_t new_level,
                             zb_uint8_t endpoint,
                             zb_bool_t  with_on_off);
 
// command that prints the status of the level control timer for each endpoint
void level_control_server_check_timers(void);
 
// function that is called from ZCL common when attr are ready to be used
void tr_level_control_server_attributes_ready(void);
 
#endif // TR_LEVEL_CONTROL_SERVER_H