wifi

Connect

Start a connect attempt and return immediately.

The AP-disconnection asymmetry (connecting to the home network tears down the setup AP the client is talking through) means the result can never come back on this response -- it is recorded via :class:~palmimo_portal.ports.StateStore and read back later through GET /api/v1/system/status.

The attempt is recorded before :meth:~palmimo_portal.ports.NetworkPort.connect is called, so a process death right after the call would not lose the record; if connect raises, the attempt is corrected to a durable "failed" result rather than left claiming "attempting" forever. Does not transition "attempting" to "success" asynchronously -- that belongs to the real network adapter, which observes the outcome.

If the device is currently CONNECTED, the real adapter forgets that network before connecting to the new one (see :meth:~palmimo_portal.adapters.comitup.ComitupNetworkPort.connect) -- comitup would otherwise short-circuit back to the old network. This handler reads :meth:~palmimo_portal.ports.NetworkPort.get_status first purely for operator visibility, logging a WARNING naming both networks.

Raises: PortalError: 400 wifi_invalid_ssid / wifi_invalid_psk if body fails :func:_validate_ssid / :func:_validate_psk -- checked first, before anything below touches state or the network adapter. 502 wifi_connect_failed if network.connect itself raises (e.g. the radio is busy).

post/api/v1/wifi/connect

Request

  • The document declares no server URL.
  • Auth: none declared

Request body

pskstring required
ssidstring required

Response

Successful Response

statusstring

Changes

No recorded changes to this operation across all 8 revisions of this API.