Decides what the WiFi glue should do next. Events that do not apply to the current state return Action{None} and change nothing. All time arithmetic is wrap-safe. More...

#include <wifi_plan.h>

Public Member Functions
Action	start (bool have_saved, uint32_t now_ms)
	Boot only: saved networks -> Scanning + StartScan; none -> Setup + StartHotspot.

Action	on_scan_done (const Candidates &c, uint32_t now_ms)
	Scan finished (Scanning, Setup or Lost). Candidates -> Joining; none -> Setup (Scanning only).

Action	on_joined (uint32_t now_ms)
	Joining, Lost or Setup -> Connected; StopHotspot if the hotspot is up.

Action	on_join_failed (JoinFail why, uint32_t now_ms)
	Joining only: next remembered candidate, else Setup (+ StartHotspot if not up). A Transient failure first retries the same candidate (same Join action, up to kTransientRetries, only before kJoinTimeoutMs since its first attempt). Entering Setup with the hotspot not yet up schedules the first rescan after kSetupFirstRescanMs; later ones keep kSetupRescanMs.

Action	on_disconnected (uint32_t now_ms)
	Connected -> Lost (auto-reconnect retries; nothing issued).

Action	on_network_added (uint32_t now_ms)
	Setup or Lost -> StartScan (and the last failure is cleared; a scan that then finds no candidate records NotFound); other states only store the network (None).

Action	tick (uint32_t now_ms)
	Timers: join timeout, Lost -> Setup, Setup rescan.

PlanState	state () const

bool	hotspot_up () const

JoinFail	last_failure () const

Static Public Attributes
static constexpr uint32_t	kJoinTimeoutMs = 15000

static constexpr uint32_t	kLostToSetupMs = 120000

static constexpr uint32_t	kSetupRescanMs = 30000

static constexpr uint32_t	kSetupFirstRescanMs = 5000
	First Setup rescan after the join attempts of a boot or lost-network cycle all failed.

static constexpr uint8_t	kTransientRetries = 2
	Same-candidate retries of a Transient failure within kJoinTimeoutMs.

Detailed Description

Decides what the WiFi glue should do next. Events that do not apply to the current state return Action{None} and change nothing. All time arithmetic is wrap-safe.

The documentation for this class was generated from the following files:

lib/provisioning/include/wifi_plan.h
lib/provisioning/src/wifi_plan.cpp

Public Member Functions

Static Public Attributes

Detailed Description