Skip to content

MiP_Wifi

github-actions[bot] edited this page Aug 10, 2026 · 7 revisions

Class MiP_Wifi

Manages WiFi network connections, mDNS hostname broadcasting, Over-The-Air (OTA) updates, and telnet debug streaming for MiP.

Table of Contents


Public Functions

begin

Signature: void begin(const char *ssid, const char *password, const char *hostname="MiP")

Summary: Initializes WiFi network connection and starts network background services.

Details:

Connects to the specified Access Point using ssid and password, configures mDNS host broadcasting using hostname, initializes ArduinoOTA handlers for wireless firmware flashing, and starts the telnet debug server.

Parameters:

Parameter Description
ssid Name of the target WiFi Access Point network.
password Password for the target WiFi network.
hostname Hostname broadcast on the network via mDNS and telnet (default: "MiP").

end

Signature: void end()

Summary: Disconnects from the WiFi network and shuts down network services.

Details:

Stops the telnet debug server, terminates active connections, and shuts down the ESP8266 WiFi radio hardware.


handle

Signature: void handle()

Summary: Processes pending network events, OTA updates, and telnet communications.

Details:

Must be called periodically inside the sketch loop() function to maintain network background tasks, process incoming OTA flash requests, and handle telnet client input.


isConnected

Signature: bool isConnected() const

Summary: Checks whether MiP's network controller is currently connected to a WiFi Access Point.

Returns: true if connected and assigned an IP address, false otherwise.


localIP

Signature: IPAddress localIP() const

Summary: Returns the local IP address assigned to MiP's network controller.

Returns: IPAddress Local network IP address.


Clone this wiki locally