wifi_plan.h

Go to the documentation of this file.

 
#pragma once
 
#include "prov_types.h"
 
namespace prov
{
enum class PlanState { Boot, Scanning, Joining, Connected, Lost, Setup };
enum class ActionKind { None, StartScan, Join, StartHotspot, StopHotspot };
enum class JoinFail { None, Timeout, WrongPassword, NotFound, Other, Transient };
 
struct Action {
    ActionKind kind = ActionKind::None;
    uint8_t network = 0; // Join: index into NetworkList
};
 
class WifiPlan
{
public:
    static constexpr uint32_t kJoinTimeoutMs = 15000;
    static constexpr uint32_t kLostToSetupMs = 120000;
    static constexpr uint32_t kSetupRescanMs = 30000;
    static constexpr uint32_t kSetupFirstRescanMs = 5000;
    static constexpr uint8_t kTransientRetries = 2;
 
    Action start(bool have_saved, uint32_t now_ms);
    Action on_scan_done(const Candidates& c, uint32_t now_ms);
    Action on_joined(uint32_t now_ms);
    Action on_join_failed(JoinFail why, uint32_t now_ms);
    Action on_disconnected(uint32_t now_ms);
    Action on_network_added(uint32_t now_ms);
    Action tick(uint32_t now_ms);
 
    PlanState state() const;
    bool hotspot_up() const;
    JoinFail last_failure() const;
 
private:
    Action fail_over(uint32_t now_ms);
    Action join_next(uint32_t now_ms);
 
    PlanState _state = PlanState::Boot;
    bool _hotspot = false;
    JoinFail _last_fail = JoinFail::None;
    bool _added_scan = false; // the pending scan was triggered by an added network
    Candidates _cand;
    size_t _next = 0;
    uint32_t _join_ms = 0;
    uint8_t _retries = 0; // Transient retries used on the current candidate
    uint32_t _lost_ms = 0;
    uint32_t _scan_ms = 0;
};
} // namespace prov