ra8_net_credentials Struct Reference

Decoded runtime network configuration. More...

#include <ra8_net_provision.h>

Data Fields
char	ssid [k_ra8_net_provision_ssid_bytes_max+1U]
	NUL-terminated SSID storage.
char	psk [k_ra8_net_provision_psk_bytes_max+1U]
	NUL-terminated PSK storage.
char	url [k_ra8_net_provision_url_bytes_max+1U]
	NUL-terminated optional URL storage.
uint16_t	url_len
	Decoded URL bytes, excluding the NUL.
uint8_t	ssid_len
	Decoded SSID bytes, excluding the NUL.
uint8_t	psk_len
	Decoded PSK bytes, excluding the NUL.

Detailed Description

Decoded runtime network configuration.

Owns NUL-terminated SSID, PSK, and optional URL storage so no field points back into the UART line buffer. Lengths exclude the trailing NUL and permit callers to retain binary-safe bounds.

Invariant

ssid_len is in 1..32 after a successful parse.

psk_len is 8..63, or 64 with hexadecimal text.

Example:

ra8_net_credentials_t credentials = {};
ra8_net_provision_clear(&credentials);

See also

ra8_net_provision_clear

Since

0.1.0

Definition at line 69 of file ra8_net_provision.h.

Field Documentation

psk

char ra8_net_credentials::psk[k_ra8_net_provision_psk_bytes_max+1U]

NUL-terminated PSK storage.

Definition at line 73 of file ra8_net_provision.h.

Referenced by c6_join_phase_associate(), internal_c6_cam_associate(), internal_decode_line(), internal_open_and_join(), internal_run(), internal_validate_candidate(), and wifi_hal_run().

psk_len

uint8_t ra8_net_credentials::psk_len

Decoded PSK bytes, excluding the NUL.

Definition at line 81 of file ra8_net_provision.h.

Referenced by internal_decode_line(), internal_run(), and internal_validate_candidate().

ssid

char ra8_net_credentials::ssid[k_ra8_net_provision_ssid_bytes_max+1U]

NUL-terminated SSID storage.

Definition at line 71 of file ra8_net_provision.h.

Referenced by c6_join_phase_associate(), internal_c6_cam_associate(), internal_decode_line(), internal_open_and_join(), internal_run(), internal_validate_candidate(), and wifi_hal_run().

ssid_len

uint8_t ra8_net_credentials::ssid_len

Decoded SSID bytes, excluding the NUL.

Definition at line 79 of file ra8_net_provision.h.

Referenced by internal_decode_line(), internal_run(), and internal_validate_candidate().

url

char ra8_net_credentials::url[k_ra8_net_provision_url_bytes_max+1U]

NUL-terminated optional URL storage.

Definition at line 75 of file ra8_net_provision.h.

Referenced by internal_decode_line(), internal_run(), internal_transfer_and_consume(), and internal_validate_candidate().

url_len

uint16_t ra8_net_credentials::url_len

Decoded URL bytes, excluding the NUL.

Definition at line 77 of file ra8_net_provision.h.

Referenced by internal_decode_line(), and internal_validate_candidate().

---

The documentation for this struct was generated from the following file:

• examples/ek_ra8d2/common/network_provision/inc/ra8_net_provision.h