Z-Wave Protocol Controller Reference
zwave_command_class_supervision.h
Go to the documentation of this file.
1/******************************************************************************
2 * # License
3 * <b>Copyright 2021 Silicon Laboratories Inc. www.silabs.com</b>
4 ******************************************************************************
5 * The licensor of this software is Silicon Laboratories Inc. Your use of this
6 * software is governed by the terms of Silicon Labs Master Software License
7 * Agreement (MSLA) available at
8 * www.silabs.com/about-us/legal/master-software-license-agreement. This
9 * software is distributed to you in Source Code format and is governed by the
10 * sections of the MSLA applicable to Source Code.
11 *
12 *****************************************************************************/
13
52#ifndef ZWAVE_COMMAND_CLASS_SUPERVISION_H
53#define ZWAVE_COMMAND_CLASS_SUPERVISION_H
54
55#include "sl_status.h"
57#include "zwave_rx.h"
58#include "zwave_tx.h"
59
60#ifdef __cplusplus
61extern "C" {
62#endif
63
75
89 const zwave_controller_connection_info_t *connection_info,
90 const uint8_t *frame_data,
91 uint16_t frame_length);
92
123 const zwave_controller_connection_info_t *connection,
124 uint16_t data_length,
125 const uint8_t *data,
126 const zwave_tx_options_t *tx_options,
127 const on_zwave_tx_send_data_complete_t on_supervision_complete,
128 void *user,
129 zwave_tx_session_id_t *session);
130
142 zwave_tx_session_id_t session);
143
159
173
186 zwave_tx_session_id_t tx_session_id);
187
188#ifdef __cplusplus
189}
190#endif
191
192#endif //ZWAVE_COMMAND_CLASS_SUPERVISION_H
uint32_t sl_status_t
Definition: sl_status.h:139
sl_status_t zwave_command_class_supervision_stop_wake_on_demand(zwave_node_id_t node_id)
Cancel a request that a node is "Waked" Up on demand at the next communication.
Definition: zwave_command_class_supervision.c:577
sl_status_t zwave_command_class_supervision_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_supervision_complete, void *user, zwave_tx_session_id_t *session)
Take a frame and create a Supervision Session.
Definition: zwave_command_class_supervision.c:450
sl_status_t zwave_command_class_supervision_support_handler(const zwave_controller_connection_info_t *connection_info, const uint8_t *frame_data, uint16_t frame_length)
Handle incoming Supervision encapsulated commands.
Definition: zwave_command_class_supervision.c:426
sl_status_t zwave_command_class_supervision_wake_on_demand(zwave_node_id_t node_id)
Request that a node is "Waked" Up on demand at the next communication.
Definition: zwave_command_class_supervision.c:560
sl_status_t zwave_command_class_supervision_abort_send_data(zwave_tx_session_id_t session)
Abort a queued or ongoing transmission.
Definition: zwave_command_class_supervision.c:546
sl_status_t zwave_command_class_supervision_init(void)
Setup fixture for the Supervision Command Class.
Definition: zwave_command_class_supervision.c:398
sl_status_t zwave_command_class_supervision_close_session_by_tx_session(zwave_tx_session_id_t tx_session_id)
Close a supervision session based on the Z-Wave Tx session ID.
uint16_t zwave_node_id_t
Z-Wave NodeID type.
Definition: zwave_node_id_definitions.h:84
void * zwave_tx_session_id_t
Handle that can be used for aborting ongoing transmissions or identifying TX Queue elements.
Definition: zwave_tx_definitions.h:77
void(* on_zwave_tx_send_data_complete_t)(uint8_t status, const zwapi_tx_report_t *tx_info, void *user)
Function signature for callbacks invoked when send data has completed.
Definition: zwave_tx.h:168
SL Status Codes.
Structure holding information about the source and destination when transmitting and receiving Z-Wave...
Definition: zwave_controller_connection_info.h:87
Definition: zwave_tx_definitions.h:131
const zwave_node_id_t node_id