zwapi_session.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 ZWAPI_SESSION_H
#define ZWAPI_SESSION_H
 
#include <stdbool.h>
#include "sl_status.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define IDX_LEN  0
#define IDX_TYPE 1
#define IDX_CMD  2
#define IDX_DATA 3
 
#define FRAME_TYPE_REQUEST  0x00
#define FRAME_TYPE_RESPONSE 0x01
 
int zwapi_session_init(const char *serial_port);
 
void zwapi_session_shutdown();
 
int zwapi_session_restart();
 
// Previously named SendFrame in the legacy SerialAPI module
sl_status_t zwapi_session_send_frame(uint8_t command,
                                     const uint8_t *payload_buffer,
                                     uint8_t payload_buffer_length);
 
sl_status_t
  zwapi_session_send_frame_with_response(uint8_t command,
                                         const uint8_t *payload_buffer,
                                         uint8_t payload_buffer_length,
                                         uint8_t *response_buf,
                                         uint8_t *response_len);
 
sl_status_t zwapi_session_send_frame_no_ack(uint8_t command,
                                            const uint8_t *payload_buffer,
                                            uint8_t payload_buffer_length);
 
void zwapi_session_enqueue_rx_frames(void);
 
bool zwapi_session_dequeue_frame(uint8_t **frame_ptr, uint8_t *frame_len);
 
void zwapi_session_flush_queue(void);
 
#ifdef __cplusplus
}
#endif
 
#endif  // ZWAPI_SESSION_H