API Reference

wifi

Wi-Fi native Berry module.

All modules Open Studio

Networking

`import wifi`

The wifi module manages station mode, access point mode, scans, mDNS, and connection event callbacks. It is the main networking surface for device scripts.

Quick example

import wifi
wifi.on_connect("connected")
wifi.connect("ssid", "password")
ip = wifi.get_ip()

import`wifi`

Wi-Fi native Berry module.

The wifi module manages station mode, access point mode, scans, mDNS, and connection event callbacks. It is the main networking surface for device scripts.

API 24 available

`wifi.scan() -> any`

Start a Wi-Fi network scan.

Returns

any Native scan start result.

`wifi.get_scan_results() -> list`

Return results from the latest Wi-Fi scan.

Returns

list List-like native value of discovered networks.

`wifi.connect(ssid: any, password: any) -> any`

Connect to a Wi-Fi network in station mode.

Parameters

Name	Type	Pass as	Required	Description
`ssid`	`any`	positional or keyword	Yes	Network SSID.
`password`	`any`	positional or keyword	Yes	Network password.

Returns

any Native connection start result.

`wifi.disconnect() -> any`

Disconnect from the current Wi-Fi network.

Returns

any Native disconnect result.

`wifi.is_connected() -> bool`

Return whether station mode is connected.

Returns

bool True when connected to Wi-Fi.

`wifi.get_ip() -> str`

Return the station IP address.

Returns

str IP address string when connected.

`wifi.ap(ssid: any, password: any = None, channel: int = None) -> any`

Start access point mode.

Parameters

Name	Type	Pass as	Required	Description
`ssid`	`any`	positional or keyword	Yes	Access point SSID.
`password`	`any`	positional or keyword	No	Optional access point password.
`channel`	`int`	positional or keyword	No	Optional Wi-Fi channel.

Returns

any Native AP start result.

`wifi.apsta(ap_ssid: any, ap_password: any = None, sta_ssid: any = None, sta_password: any = None) -> any`

Start combined access point and station mode.

Parameters

Name	Type	Pass as	Required	Description
`ap_ssid`	`any`	positional or keyword	Yes	Access point SSID.
`ap_password`	`any`	positional or keyword	No	Optional access point password.
`sta_ssid`	`any`	positional or keyword	No	Optional station SSID.
`sta_password`	`any`	positional or keyword	No	Optional station password.

Returns

any Native APSTA start result.

`wifi.get_ap_ip() -> str`

Return the access point IP address.

Returns

str AP IP address string.

`wifi.mdns(hostname: str) -> any`

Configure mDNS hostname.

Parameters

Name	Type	Pass as	Required	Description
`hostname`	`str`	positional or keyword	Yes	mDNS host name to advertise.

Returns

any Native mDNS result.

`wifi.on_scan_done(callback: callback) -> str`

Register a callback for scan completion.

Parameters

Name	Type	Pass as	Required	Description
`callback`	`callback`	positional or keyword	Yes	Function name or callable accepted by firmware.

Returns

str Native registration result.

`wifi.on_connect(callback: callback) -> str`

Register a callback for station connection.

Parameters

Name	Type	Pass as	Required	Description
`callback`	`callback`	positional or keyword	Yes	Function name or callable accepted by firmware.

Returns

str Native registration result.

`wifi.on_disconnect(callback: callback) -> str`

Register a callback for station disconnection.

Parameters

Name	Type	Pass as	Required	Description
`callback`	`callback`	positional or keyword	Yes	Function name or callable accepted by firmware.

Returns

str Native registration result.

`wifi.on_error(callback: callback) -> str`

Register a callback for generic Wi-Fi errors.

Parameters

Name	Type	Pass as	Required	Description
`callback`	`callback`	positional or keyword	Yes	Function name or callable accepted by firmware.

Returns

str Native registration result.

`wifi.on_status(callback: callback) -> str`

Register a callback for Wi-Fi status updates.

Parameters

Name	Type	Pass as	Required	Description
`callback`	`callback`	positional or keyword	Yes	Function name or callable accepted by firmware.

Returns

str Native registration result.

`wifi.on_network_not_found(callback: callback) -> str`

Register a callback when the requested SSID is not found.

Parameters

Name	Type	Pass as	Required	Description
`callback`	`callback`	positional or keyword	Yes	Function name or callable accepted by firmware.

Returns

str Native registration result.

`wifi.on_auth_failed(callback: callback) -> str`

Register a callback for authentication failures.

Parameters

Name	Type	Pass as	Required	Description
`callback`	`callback`	positional or keyword	Yes	Function name or callable accepted by firmware.

Returns

str Native registration result.

`wifi.on_connection_failed(callback: callback) -> str`

Register a callback when connection retries fail.

Parameters

Name	Type	Pass as	Required	Description
`callback`	`callback`	positional or keyword	Yes	Function name or callable accepted by firmware.

Returns

str Native registration result.

`wifi.on_ssid_incorrect(callback: callback) -> str`

Register a friendly alias callback for incorrect SSID events.

Parameters

Name	Type	Pass as	Required	Description
`callback`	`callback`	positional or keyword	Yes	Function name or callable accepted by firmware.

Returns

str Native registration result.

`wifi.on_password_incorrect(callback: callback) -> str`

Register a friendly alias callback for incorrect password events.

Parameters

Name	Type	Pass as	Required	Description
`callback`	`callback`	positional or keyword	Yes	Function name or callable accepted by firmware.

Returns

str Native registration result.

`wifi.on_ap_start(callback: callback) -> str`

Register a callback when access point mode starts.

Parameters

Name	Type	Pass as	Required	Description
`callback`	`callback`	positional or keyword	Yes	Function name or callable accepted by firmware.

Returns

str Native registration result.

`wifi.on_ap_stop(callback: callback) -> str`

Register a callback when access point mode stops.

Parameters

Name	Type	Pass as	Required	Description
`callback`	`callback`	positional or keyword	Yes	Function name or callable accepted by firmware.

Returns

str Native registration result.

`wifi.on_ap_client_connect(callback: callback) -> str`

Register a callback when a client joins the access point.

Parameters

Name	Type	Pass as	Required	Description
`callback`	`callback`	positional or keyword	Yes	Function name or callable accepted by firmware.

Returns

str Native registration result.

`wifi.on_ap_client_disconnect(callback: callback) -> str`

Register a callback when a client leaves the access point.

Parameters

Name	Type	Pass as	Required	Description
`callback`	`callback`	positional or keyword	Yes	Function name or callable accepted by firmware.

Returns

str Native registration result.