Unify Framework Lib 1.6.0
attribute_transitions.h
Go to the documentation of this file.
1/******************************************************************************
2 * # License
3 * <b>Copyright 2021 Silicon Laboratories Inc. www.silabs.com</b>
4 ******************************************************************************
5 * The licensor of this software is Silicon Laboratories Inc. Your use of this
6 * software is governed by the terms of Silicon Labs Master Software License
7 * Agreement (MSLA) available at
8 * www.silabs.com/about-us/legal/master-software-license-agreement. This
9 * software is distributed to you in Source Code format and is governed by the
10 * sections of the MSLA applicable to Source Code.
11 *
12 *****************************************************************************/
13
26#ifndef ATTRIBUTE_TRANSITIONS_H
27#define ATTRIBUTE_TRANSITIONS_H
28
29// Includes from other Unify components
30#include "sl_status.h"
31#include "attribute_store.h"
32
33// Contiki
34#include "clock.h"
35
36#ifdef __cplusplus
37extern "C" {
38#endif
39
55 clock_time_t duration);
56
78 float target_value,
79 float step,
80 clock_time_t step_interval);
81
94
103
114
121
127
128#ifdef __cplusplus
129}
130#endif
131
132#endif //ATTRIBUTE_TRANSITIONS_H
uint32_t clock_time_t
Definition: contiki-conf.h:31
attribute_store_node_value_state_t
This is the value state of a value.
Definition: attribute_store.h:121
datastore_attribute_id_t attribute_store_node_t
Handle to identify attribute store nodes.
Definition: attribute_store.h:101
sl_status_t attribute_start_transition(attribute_store_node_t node, clock_time_t duration)
Starts a transition from the REPORTED to the DESIRED value of an attribute following the indicated du...
int attribute_transitions_teardown()
Teardown the Unify attribute transition component.
clock_time_t attribute_transition_get_remaining_duration(attribute_store_node_t node)
Retrieves the remaining time for a transition.
bool is_attribute_transition_ongoing(attribute_store_node_t node)
Verifies if a transition is ongoing for an attribute.
sl_status_t attribute_start_fixed_transition(attribute_store_node_t node, attribute_store_node_value_state_t value_type, float target_value, float step, clock_time_t step_interval)
Start attribute transition with a fixed step, target value and interval.
sl_status_t attribute_transitions_init()
Initializes the Unify attribute transition component.
sl_status_t attribute_stop_transition(attribute_store_node_t node)
Stops an ongoing transition for an attribute.
uint32_t sl_status_t
Definition: sl_status.h:139
SL Status Codes.