zwave_command_handler.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_HANDLER_H
#define ZWAVE_COMMAND_HANDLER_H
 
// Includes from other components
#include "zwave_controller_connection_info.h"
#include "zwave_controller.h"
#include "zwave_rx.h"
#include "sl_status.h"
 
// Interface includes
#include "zwave_command_class_version_types.h"
 
// Generic includes
#include <stdbool.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef sl_status_t (*zwave_command_class_handler_t)(
  const zwave_controller_connection_info_t *connection,
  const uint8_t *frame_data,
  uint16_t frame_length);
 
typedef struct {
  zwave_command_class_handler_t support_handler;
 
  zwave_command_class_handler_t control_handler;
 
  zwave_controller_encapsulation_scheme_t minimal_scheme;
 
  zwave_command_class_t command_class;
 
  const char *command_class_name;
 
  const char *comments;
 
  zwave_cc_version_t version;
 
  bool manual_security_validation;
} zwave_command_handler_t;
 
sl_status_t zwave_command_handler_init(void);
 
int zwave_command_handler_teardown(void);
 
sl_status_t zwave_command_handler_register_handler(
  zwave_command_handler_t new_command_class_handler);
 
zwave_cc_version_t
  zwave_command_handler_get_version(zwave_command_class_t command_class);
 
// It is moved here to insert supervision decapsulated commands back to
// the command handler. This may be updated with TX/RX validation scheme
// component work.
sl_status_t zwave_command_handler_dispatch(
  const zwave_controller_connection_info_t *connection_info,
  const uint8_t *frame_data,
  uint16_t frame_length);
 
bool zwave_command_handler_controls(zwave_command_class_t command_class);
 
void zwave_command_handler_print_info(int fd);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZWAVE_COMMAND_HANDLER_H */