zwave_command_classes_utils.h

Go to the documentation of this file.

/******************************************************************************
 * # License
 * <b>Copyright 2021 Silicon Laboratories Inc. www.silabs.com</b>
 ******************************************************************************
 * The licensor of this software is Silicon Laboratories Inc. Your use of this
 * software is governed by the terms of Silicon Labs Master Software License
 * Agreement (MSLA) available at
 * www.silabs.com/about-us/legal/master-software-license-agreement. This
 * software is distributed to you in Source Code format and is governed by the
 * sections of the MSLA applicable to Source Code.
 *
 *****************************************************************************/
 
#ifndef ZWAVE_COMMAND_CLASSES_UTILS_H
#define ZWAVE_COMMAND_CLASSES_UTILS_H
 
// Generic includes
#include <stdbool.h>
#include <string.h>
 
// Unify includes
#include "sl_status.h"
#include "zwave_controller_connection_info.h"
#include "zwave_generic_types.h"
#include "attribute_store.h"
#include "zwave_utils.h"
 
// ZPC includes
#include "zwave_controller_connection_info.h"
#include "zwave_command_class_generic_types.h"
 
// Interfaces
#include "zwave_generic_types.h"
 
// Contiki timing includes
#include "clock.h"
 
// Value to set in a 8-bits reserved field
#define RESERVED_BYTE 0x00
 
typedef struct zwave_minimum_frame {
  uint8_t command_class;
  uint8_t command;
} zwave_minimum_frame_t;
 
// Helper macros
#define FAHRENHEIT_TO_DEGREES(value) ((value - 32.0) * 5 / 9);
#define DEGREES_TO_FAHRENHEIT(value) (value * 9 / 5.0) + 32;
 
// Constants
#define PROBE_BACK_OFF 500
 
#ifdef __cplusplus
extern "C" {
#endif
 
attribute_store_node_t zwave_command_class_get_endpoint_node(
  const zwave_controller_connection_info_t *connection_info);
 
attribute_store_node_t zwave_command_class_get_node_id_node(
  const zwave_controller_connection_info_t *connection_info);
 
zwave_cc_version_t zwave_command_class_get_version_from_node(
  attribute_store_node_t node, zwave_command_class_t command_class);
 
bool has_reports_to_follow(attribute_store_node_t node);
 
reports_to_follow_t get_reports_to_follow(attribute_store_node_t node);
 
sl_status_t set_reports_to_follow(attribute_store_node_t node,
                                  reports_to_follow_t reports_to_follow);
 
void set_command_status_value(attribute_store_node_t command_status_node,
                              command_status_values_t reported,
                              command_status_values_t desired);
 
sl_status_t zwave_command_class_send_report(
  const zwave_controller_connection_info_t *connection_info,
  const uint16_t report_size,
  const uint8_t *const report_data);
 
bool is_zwave_command_class_filtered_for_root_device(
  zwave_command_class_t command_class, attribute_store_node_t updated_node);
 
bool is_using_zpc_highest_security_class(
  const zwave_controller_connection_info_t *connection);
 
int32_t command_class_get_int32_value(uint8_t size,
                                      uint8_t precision,
                                      const uint8_t *value);
 
int32_t get_signed_value_from_frame_and_size(const uint8_t *frame,
                                             uint8_t size);
 
uint32_t get_unsigned_value_from_frame_and_size(const uint8_t *frame,
                                                uint8_t size);
 
int16_t zwave_temperature_to_ucl_temperature(int32_t zwave_value,
                                             uint8_t zwave_precision,
                                             uint8_t zwave_scale);
 
int32_t ucl_temperature_to_zwave_temperature(int16_t ucl_value,
                                             uint8_t zwave_precision,
                                             uint8_t zwave_scale);
  uint8_t time_to_zwave_duration(clock_time_t time);
 
clock_time_t zwave_duration_to_time(uint8_t zwave_duration);
 
bool is_actuator_command_class(zwave_command_class_t command_class);
 
zwave_role_type_t get_zwave_node_role_type(zwave_node_id_t node_id);
 
bool is_portable_end_node(attribute_store_node_t node);
 
#ifdef __cplusplus
}
#endif
 
#endif  // ZWAVE_COMMAND_CLASSES_UTILS_H