zwapi_connection.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_CONNECTION_H
#define ZWAPI_CONNECTION_H
 
#include "zwapi_internal.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
// Timeout values, in ms
#define RX_ACK_TIMEOUT_DEFAULT  1500
#define RX_BYTE_TIMEOUT_DEFAULT 1500
 
typedef enum {
  ZWAPI_CONNECTION_STATUS_IDLE,  
  ZWAPI_CONNECTION_STATUS_FRAME_RECEIVED,  
  ZWAPI_CONNECTION_STATUS_FRAME_SENT,  
  ZWAPI_CONNECTION_STATUS_CHECKSUM_ERROR,  
  ZWAPI_CONNECTION_STATUS_RX_TIMEOUT,      
  ZWAPI_CONNECTION_STATUS_TX_TIMEOUT,  
  ZWAPI_CONNECTION_STATUS_TX_NAK,  
  ZWAPI_CONNECTION_STATUS_TX_CAN,  
} zwapi_connection_status_t;
 
int zwapi_connection_init(const char *serial_port);
 
void zwapi_connection_shutdown();
 
int zwapi_connection_restart();
 
void zwapi_connection_tx(
  uint8_t cmd, uint8_t type, const uint8_t *Buf, uint8_t len, bool ack_needed);
 
zwapi_connection_status_t zwapi_connection_refresh();
 
int zwapi_connection_get_last_rx_frame(uint8_t *user_buffer,
                                       int user_buffer_length);
 
const char *zwapi_connection_status_to_string(zwapi_connection_status_t t);
 
#ifdef __cplusplus
}
#endif
 
#endif  // ZWAPI_CONNECTION_H