zwave_controller_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_CONTROLLER_UTILS_H
#define ZWAVE_CONTROLLER_UTILS_H
 
// includes from this component
#include "zwave_controller_connection_info.h"
 
// Includes from other components
#include "zwave_rx_definitions.h"
#include "zwave_tx.h"
 
// Interfaces
#include "zwave_command_class_version_types.h"
 
// Generic includes
#include <stddef.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define ZWAVE_CMD_CLASS_PROTOCOL    0x01  /* Z-Wave protocol class command */
#define ZWAVE_CMD_CLASS_PROTOCOL_LR 0x04  /* Z-Wave Long Range protocol class command */
 
sl_status_t zwave_send_nop_to_node(
  zwave_node_id_t node_id,
  uint32_t qos_priority,
  uint32_t discard_timeout_ms,
  const on_zwave_tx_send_data_complete_t on_send_complete,
  void *user);
 
void zwave_sl_log_frame_data(
  const zwave_controller_connection_info_t *connection_info,
  const zwave_rx_receive_options_t *rx_options,
  const uint8_t *frame_data,
  uint16_t frame_length);
 
void zwave_sl_log_nif_data(zwave_node_id_t node_id,
                           const zwave_node_info_t *node_info);
 
void zwave_sl_log_dsk(const char *tag, const zwave_dsk_t dsk);
 
void zwave_command_class_list_unpack(zwave_node_info_t *node_info,
                                     const uint8_t *nif,
                                     uint8_t nif_length);
 
void zwave_command_class_list_pack(const zwave_node_info_t *node_info,
                                   uint8_t *nif,
                                   uint8_t *nif_length);
 
bool is_command_class_in_supported_list(zwave_command_class_t command_class,
                                        const uint8_t *nif,
                                        uint8_t nif_length);
 
sl_status_t zwave_parse_nif(const uint8_t *nif,
                            size_t nif_length,
                            zwave_command_class_t *supported_command_classes,
                            size_t *supported_command_classes_length,
                            zwave_command_class_t *controlled_command_classes,
                            size_t *controlled_command_classes_length);
 
const char *
  zwave_network_scheme_str(zwave_controller_encapsulation_scheme_t scheme);
 
zwave_controller_encapsulation_scheme_t zpc_highest_security_class();
 
#ifdef __cplusplus
}
#endif
 
#endif  // ZWAVE_CONTROLLER_UTILS_H