CC_MultilevelSwitch_Support.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2018 Silicon Laboratories Inc. <https://www.silabs.com/>
 *
 * SPDX-License-Identifier: BSD-3-Clause
 *
 */

 
#ifndef _CC_MULTILEVEL_SWITCH_SUPPORT_H_
#define _CC_MULTILEVEL_SWITCH_SUPPORT_H_
 
/****************************************************************************/
/*                              INCLUDE FILES                               */
/****************************************************************************/
#include <ZW_classcmd.h>
#include <CC_Common.h>
#include <ZAF_types.h>
#include <ZW_TransportEndpoint.h>
#include <ZAF_Actuator.h>
#include "ZAF_CC_Invoker.h"

 
typedef struct cc_multilevel_switch_t {
  RECEIVE_OPTIONS_TYPE_EX rxOpt;            // Contains information required for Supervision and
                                            // True Status. Must be the first element in this
                                            // struct because TSE assumes this location.
  uint8_t endpoint;                         // The switch must be tied to an endpoint. (0 if no endpoints)
  s_Actuator actuator;                      // Defined in ZAF_Actuator.h
} cc_multilevel_switch_t;
 
typedef void (*cc_multilevel_switch_callback_t)(struct cc_multilevel_switch_t * p_switch);

void cc_multilevel_switch_set(cc_multilevel_switch_t * p_switch, uint8_t value, uint8_t duration);

void cc_multilevel_switch_start_level_change(cc_multilevel_switch_t * p_switch,
                                             bool up,
                                             bool ignore_start_level,
                                             uint8_t start_level,
                                             uint8_t duration);

void cc_multilevel_switch_stop_level_change(cc_multilevel_switch_t * p_switch);

uint8_t cc_multilevel_switch_get_current_value(cc_multilevel_switch_t * p_switch);

uint8_t cc_multilevel_switch_get_last_on_value(cc_multilevel_switch_t * p_switch);

uint8_t cc_multilevel_switch_get_min_value(void);

uint8_t cc_multilevel_switch_get_max_value(void);
 
void cc_multilevel_switch_support_cb(struct cc_multilevel_switch_t * p_switch);
 
cc_multilevel_switch_t *cc_multilevel_switch_support_config_get_switches(void);
uint8_t cc_multilevel_switch_support_config_get_length_switches(void);
uint8_t cc_multilevel_switch_support_config_get_default_duration(void);

 
#endif