wifi_userconfig.h File Reference

User configuration WiFi interface. More...

#include <stddef.h>
#include <stdint.h>
#include "../communication.h"
#include "../../user_config.h"

Go to the source code of this file.

Functions
UserConfigStatus	ControllerUserConfigRequest (void)
	Request user configuration from ESP32.
UserConfigStatus	ControllerUserConfigSend (void)
	Send user configuration to ESP32.
bool	ControllerUserConfigStart (void)
	Start the user configuration website.
bool	isConfigEmpty (const UserConfiguration *config)
	Check if configuration is empty/uninitialized.
void	printUserConfig (const UserConfiguration *config)
	Print user configuration details to log.

Detailed Description

User configuration WiFi interface.

Date

2026-04-08

Author

Ahmed Falah

John Madden jmadd.nosp@m.en17.nosp@m.3@pm..nosp@m.me

Definition in file wifi_userconfig.h.

Function Documentation

ControllerUserConfigRequest()

UserConfigStatus ControllerUserConfigRequest

(

void

)

Request user configuration from ESP32.

Returns

UserConfigStatus indicating success or failure

Definition at line 6 of file wifi_userconfig.c.

References CONTROLLER_SUCCESS, ControllerRx(), ControllerTransaction(), ControllerTx(), Buffer::data, DecodeEsp32Command(), EncodeUserConfigCommand(), isConfigEmpty(), Buffer::len, Buffer::size, USERCONFIG_COMM_ERROR, USERCONFIG_EMPTY_CONFIG, USERCONFIG_ENCODE_ERROR, USERCONFIG_FRAM_ERROR, USERCONFIG_INVALID_RESPONSE, USERCONFIG_NO_RESPONSE, USERCONFIG_OK, and UserConfigSave().

Referenced by UserConfigUpdateFromServer().

ControllerUserConfigSend()

UserConfigStatus ControllerUserConfigSend

(

void

)

Send user configuration to ESP32.

Returns

UserConfigStatus indicating success or failure

Definition at line 66 of file wifi_userconfig.c.

References CONTROLLER_SUCCESS, ControllerRx(), ControllerTransaction(), ControllerTx(), Buffer::data, EncodeUserConfigCommand(), Buffer::len, Buffer::size, USERCONFIG_COMM_ERROR, USERCONFIG_ENCODE_ERROR, USERCONFIG_NULL_CONFIG, USERCONFIG_OK, and UserConfigGet().

Referenced by UserConfigStart().

ControllerUserConfigStart()

bool ControllerUserConfigStart

(

void

)

Start the user configuration website.

This function must be called after the station has been setup.

Returns

true if command was sent sucessfully, false otherwise

Definition at line 114 of file wifi_userconfig.c.

References CONTROLLER_SUCCESS, ControllerRx(), ControllerTransaction(), ControllerTx(), Buffer::data, EncodeUserConfigCommand(), Buffer::len, and Buffer::size.

Referenced by test_ControllerUserConfigStart(), and UserConfigStart().

isConfigEmpty()

bool isConfigEmpty

(

const UserConfiguration *

config

)

Check if configuration is empty/uninitialized.

Parameters

config

Pointer to UserConfiguration structure

Returns

true if config is empty, false otherwise

Definition at line 144 of file wifi_userconfig.c.

Referenced by ControllerUserConfigRequest().

printUserConfig()

void printUserConfig

(

const UserConfiguration *

config

)

Print user configuration details to log.

Parameters

config

Pointer to UserConfiguration structure