ra8_net_provision.h

Go to the documentation of this file.

 
#pragma once
 
#include <stddef.h>
#include <stdint.h>
 
#include "ra8_err.h"

typedef enum : uint16_t {
  k_ra8_net_provision_ssid_bytes_max = 32U,    
  k_ra8_net_provision_psk_bytes_max  = 64U,    
  k_ra8_net_provision_url_bytes_max  = 511U,   
  k_ra8_net_provision_prefix_bytes   = 8U,     
  k_ra8_net_provision_line_bytes_max = 1225U,  
  k_ra8_net_provision_timeout_ms     = 30000U, 
  k_ra8_net_provision_timeout_ms_max = 60000U, 
} ra8_net_provision_limit_t;

typedef struct ra8_net_credentials {
  char ssid[k_ra8_net_provision_ssid_bytes_max + 1U];
  char psk[k_ra8_net_provision_psk_bytes_max + 1U];
  char url[k_ra8_net_provision_url_bytes_max + 1U];
  uint16_t url_len;
  uint8_t ssid_len;
  uint8_t psk_len;
} ra8_net_credentials_t;

typedef ra8_err_t (*ra8_net_provision_uart_write_fn)(const uint8_t* data, size_t length);

typedef ra8_err_t (*ra8_net_provision_uart_read_fn)(uint8_t* data,
                                                    size_t   capacity,
                                                    size_t*  out_length);

typedef void (*ra8_net_provision_wait_fn)(uint32_t delay_ms);

typedef struct ra8_net_provision_uart {
  ra8_net_provision_uart_write_fn write;   
  ra8_net_provision_uart_read_fn  read;    
  ra8_net_provision_wait_fn       wait_ms; 
} ra8_net_provision_uart_t;

extern const char k_ra8_net_provision_ready_prompt[];

[[nodiscard]] ra8_err_t
ra8_net_provision_parse(const uint8_t* line, size_t line_length, ra8_net_credentials_t* out);

[[nodiscard]] ra8_err_t ra8_net_provision_receive(const ra8_net_provision_uart_t* uart,
                                                  uint32_t                        timeout_ms,
                                                  ra8_net_credentials_t*          out);

void ra8_net_provision_clear(ra8_net_credentials_t* credentials);