zwave_frame_generator.hpp

Go to the documentation of this file.

/******************************************************************************
 * # License
 * <b>Copyright 2024 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_FRAME_GENERATOR_HPP
#define ZWAVE_FRAME_GENERATOR_HPP
 
#ifdef __cplusplus
 
// Unify includes
#include "attribute_store.h"
#include "sl_status.h"
 
// Cpp includes
#include <vector>
 
class zwave_frame_generator
{
  public:
  struct shifted_value {
    uint8_t left_shift = 0;
    attribute_store_node_t node = ATTRIBUTE_STORE_INVALID_NODE;
    attribute_store_node_value_state_t node_value_state = REPORTED_ATTRIBUTE;
    uint8_t raw_value = 0;
  };
 
  explicit zwave_frame_generator(uint8_t zwave_command_class);
  ~zwave_frame_generator() = default;
 
  void initialize_frame(uint8_t zwave_command_id,
                        uint8_t *raw_data,
                        uint16_t data_size);
 
  void add_raw_byte(uint8_t byte);
 
  void add_value(attribute_store_node_t node,
                 attribute_store_node_value_state_t node_value_state
                 = REPORTED_ATTRIBUTE);
  void add_shifted_values(const std::vector<shifted_value> &shifted_values);
  void add_shifted_values(const shifted_value &shifted_values);
 
  void validate_frame(uint16_t *frame_length) const;
 
  sl_status_t generate_no_args_frame(uint8_t zwave_command_id,
                                     uint8_t *raw_data,
                                     uint16_t *frame_length);
 
  private:
  std::vector<uint8_t> helper_get_raw_data(
    attribute_store_node_t node,
    attribute_store_node_value_state_t node_value_state) const;
 
  // Current Z-Wave command class used in the header of all generated commands
  const uint8_t current_command_class;
  // Vector wrapper around raw frame data. See initialize_frame()
  uint8_t *current_zwave_frame;
  // Current Z-Wave frame size
  uint16_t current_zwave_frame_size = 0;
  // Current Z-Wave frame index (we use uint16_t to match Unify API)
  uint16_t current_zwave_frame_index = 0;
};
 
#endif  // __cplusplus
#endif  // ZWAVE_FRAME_GENERATOR_HPP