ra8_wifi.h

Go to the documentation of this file.

 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
 
#include "ra8_err.h"

typedef enum : uint8_t {
  k_ra8_wifi_mac_bytes = 6U,  
  k_ra8_wifi_ssid_max  = 32U, 
} ra8_wifi_limits_t;

typedef enum : uint16_t {
  k_ra8_wifi_join_polls  = 200U, 
  k_ra8_wifi_poll_gap_ms = 50U,  
} ra8_wifi_budget_t;

typedef enum : uint8_t {
  k_ra8_wifi_state_down        = 0U, 
  k_ra8_wifi_state_associating = 1U, 
  k_ra8_wifi_state_associated  = 2U, 
  k_ra8_wifi_state_ip_bound    = 3U, 
} ra8_wifi_state_t;

typedef enum : uint8_t {
  k_ra8_wifi_link_down = 0U, 
  k_ra8_wifi_link_up   = 1U, 
} ra8_wifi_link_t;

typedef struct ra8_wifi_mac {
  uint8_t octet[k_ra8_wifi_mac_bytes]; 
} ra8_wifi_mac_t;

typedef struct ra8_wifi_lease {
  uint32_t ip;          
  uint32_t mask;        
  uint32_t gateway;     
  uint32_t dhcp_server; 
  bool     bound;       
} ra8_wifi_lease_t;

typedef struct ra8_wifi_ap {
  ra8_wifi_mac_t bssid;                          
  char           ssid[k_ra8_wifi_ssid_max + 1U]; 
  uint8_t        ssid_len;                       
  uint8_t        channel;                        
  int8_t         rssi;                           
  int32_t        authmode;                       
} ra8_wifi_ap_t;

typedef struct ra8_wifi_status {
  ra8_wifi_state_t state;      
  bool             associated; 
  bool             ip_bound;   
  int8_t           rssi;       
  ra8_wifi_lease_t ip;         
} ra8_wifi_status_t;

typedef ra8_err_t (*ra8_wifi_ip_bind_fn)(void*                 ip_ctx,
                                         const ra8_wifi_mac_t* mac,
                                         ra8_wifi_lease_t*     out);

typedef struct ra8_wifi_backend ra8_wifi_backend_t;

typedef struct ra8_wifi_cfg {
  const ra8_wifi_backend_t* backend;     
  void*                     backend_ctx; 
  ra8_wifi_ip_bind_fn       ip_bind;     
  void*                     ip_ctx;      
} ra8_wifi_cfg_t;

typedef struct ra8_wifi {
  const ra8_wifi_backend_t* backend;     
  void*                     backend_ctx; 
  ra8_wifi_ip_bind_fn       ip_bind;     
  void*                     ip_ctx;      
  ra8_wifi_mac_t            mac;         
  ra8_wifi_lease_t          lease;       
  ra8_wifi_state_t          state;       
  int8_t                    rssi;        
  bool                      open;        
  bool                      radio_on;    
  bool                      mac_valid;   
} ra8_wifi_t;

[[nodiscard]] ra8_err_t ra8_wifi_init(ra8_wifi_t* wifi, const ra8_wifi_cfg_t* cfg);

[[nodiscard]] ra8_err_t ra8_wifi_deinit(ra8_wifi_t* wifi);

[[nodiscard]] ra8_err_t ra8_wifi_connect(ra8_wifi_t* wifi, const char* ssid, const char* psk);

[[nodiscard]] ra8_err_t ra8_wifi_disconnect(ra8_wifi_t* wifi);

[[nodiscard]] ra8_err_t ra8_wifi_wait_ip(ra8_wifi_t* wifi, ra8_wifi_lease_t* out);

[[nodiscard]] ra8_err_t ra8_wifi_get_ip(const ra8_wifi_t* wifi, ra8_wifi_lease_t* out);

[[nodiscard]] ra8_err_t ra8_wifi_status(const ra8_wifi_t* wifi, ra8_wifi_status_t* out);

[[nodiscard]] ra8_err_t ra8_wifi_poll(ra8_wifi_t* wifi, ra8_wifi_link_t* out);

[[nodiscard]] ra8_err_t ra8_wifi_get_mac(ra8_wifi_t* wifi, ra8_wifi_mac_t* out);

[[nodiscard]] ra8_err_t ra8_wifi_get_ap(ra8_wifi_t* wifi, ra8_wifi_ap_t* out);
 
#ifdef __cplusplus
}
#endif