zwave_tx.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_TX_H
#define ZWAVE_TX_H
 
// Includes from other components
#include "sl_status.h"
#include "zwave_controller_connection_info.h"
#include "zwapi_protocol_transport.h"
#include "zwapi_protocol_basis.h"
#include "zwave_tx_definitions.h"
 
#ifndef ZWAVE_TX_QUEUE_BUFFER_SIZE
// max amount of frames that can be store int the internal zwave_tx_queue
#define ZWAVE_TX_QUEUE_BUFFER_SIZE 64
#endif
 
#ifndef ZWAVE_TX_INCOMING_FRAMES_BUFFER_SIZE
// Max amount of NodeID that can send us frames to track.
#define ZWAVE_TX_INCOMING_FRAMES_BUFFER_SIZE 10
#endif
 
#ifndef ZWAVE_TX_ROUTE_CACHE_BUFFER_SIZE
// Maximum amount of NodeIDs for which we cache the number of repeaters.
#define ZWAVE_TX_ROUTE_CACHE_BUFFER_SIZE 50
#endif
 
typedef void (*on_zwave_tx_send_data_complete_t)(
  uint8_t status, const zwapi_tx_report_t *tx_info, void *user);
 
#ifdef __cplusplus
extern "C" {
#endif
 
sl_status_t
  zwave_tx_send_data(const zwave_controller_connection_info_t *connection,
                     uint16_t data_length,
                     const uint8_t *data,
                     const zwave_tx_options_t *tx_options,
                     const on_zwave_tx_send_data_complete_t on_send_complete,
                     void *user,
                     zwave_tx_session_id_t *session);
 
sl_status_t zwave_tx_send_test_frame(
  zwave_node_id_t destination_node_id,
  rf_power_level_t power_level,
  const on_zwave_tx_send_data_complete_t on_send_complete,
  void *user,
  zwave_tx_session_id_t *session_id);
 
sl_status_t zwave_tx_abort_transmission(zwave_tx_session_id_t session_id);
 
uint8_t zwave_tx_get_number_of_responses(zwave_tx_session_id_t session_id);
 
void zwave_tx_set_expected_frames(zwave_node_id_t remote_node_id,
                                  uint8_t number_of_incoming_frames);
 
const uint8_t *zwave_tx_get_frame(zwave_tx_session_id_t session_id);
 
uint16_t zwave_tx_get_frame_length(zwave_tx_session_id_t session_id);
 
bool zwave_tx_has_frames_for_node(zwave_node_id_t node_id);
 
sl_status_t zwave_tx_init();
 
void zwave_tx_log_queue(bool with_contents);
 
void zwave_tx_log_element(zwave_tx_session_id_t session_id,
                          bool log_frame_payload);
 
int zwave_tx_get_queue_size();
 
#ifdef __cplusplus
}
#endif
#endif  //ZWAVE_TX_H