Skip to main content

Wifi Functions

dev.wireless.wifi - wire path w\w - generated from fwMenuWifi.

toggle_events​

Enable Wifi Events. Toggle Wifi Event Streaming

Requires power zone 5 (ESP32). See Errors.

Wire command: w\w\r

Returns: none (Ok/Err only)

dev.wireless.wifi.toggle_events() -> Result
ow_status ow_wireless_wifi_toggle_events(ow_device* dev);
dev.wireless().wifi().toggle_events() -> Result<(), OwError>

The C and Rust signatures above are also the WASM guest signatures - the device API surface is identical; only the transport differs (ow_open_wasm(&dev) in C, OneWili::open() in Rust).

dev.wireless.wifi.toggle_events() # check dev.ok

on_start_access_point​

Start Access Point. Starts up Access Point with provided SSID and Password

Requires power zone 5 (ESP32). See Errors.

Wire command: w\w\a

ArgWire type
ssidstring
passwordstring
authmodedecS32
hidessidbool

Returns: none (Ok/Err only)

dev.wireless.wifi.on_start_access_point(ssid: str, password: str, authmode: int, hidessid: bool) -> Result
ow_status ow_wireless_wifi_on_start_access_point(ow_device* dev, const char* ssid, const char* password, int32_t authmode, bool hidessid);
dev.wireless().wifi().on_start_access_point(ssid: &str, password: &str, authmode: i32, hidessid: bool) -> Result<(), OwError>

The C and Rust signatures above are also the WASM guest signatures - the device API surface is identical; only the transport differs (ow_open_wasm(&dev) in C, OneWili::open() in Rust).

dev.wireless.wifi.on_start_access_point(ssid, password, authmode, hidessid) # check dev.ok

on_discconect_from_station​

Stop Access Point. Turns off Access Point

Requires power zone 5 (ESP32). See Errors.

Wire command: w\w\t

Returns: none (Ok/Err only)

dev.wireless.wifi.on_discconect_from_station() -> Result
ow_status ow_wireless_wifi_on_discconect_from_station(ow_device* dev);
dev.wireless().wifi().on_discconect_from_station() -> Result<(), OwError>

The C and Rust signatures above are also the WASM guest signatures - the device API surface is identical; only the transport differs (ow_open_wasm(&dev) in C, OneWili::open() in Rust).

dev.wireless.wifi.on_discconect_from_station() # check dev.ok

get_connected_devices​

Get Stations connected to AP. Turns off Access Point

Requires power zone 5 (ESP32). See Errors.

Wire command: w\w\g

Returns: none (Ok/Err only)

dev.wireless.wifi.get_connected_devices() -> Result
ow_status ow_wireless_wifi_get_connected_devices(ow_device* dev);
dev.wireless().wifi().get_connected_devices() -> Result<(), OwError>

The C and Rust signatures above are also the WASM guest signatures - the device API surface is identical; only the transport differs (ow_open_wasm(&dev) in C, OneWili::open() in Rust).

dev.wireless.wifi.get_connected_devices() # check dev.ok

on_connect_to_station​

Connect to a Wifi Access Point. Connect to a WAP with provided SSID and Password

Requires power zone 5 (ESP32). See Errors.

Wire command: w\w\c

ArgWire type
ssidstring
passwordstring

Returns: none (Ok/Err only)

dev.wireless.wifi.on_connect_to_station(ssid: str, password: str) -> Result
ow_status ow_wireless_wifi_on_connect_to_station(ow_device* dev, const char* ssid, const char* password);
dev.wireless().wifi().on_connect_to_station(ssid: &str, password: &str) -> Result<(), OwError>

The C and Rust signatures above are also the WASM guest signatures - the device API surface is identical; only the transport differs (ow_open_wasm(&dev) in C, OneWili::open() in Rust).

dev.wireless.wifi.on_connect_to_station(ssid, password) # check dev.ok

on_discconect_from_station_2​

Disconnect From Wifi Access Point. Disconnect from Wifi Stations

Requires power zone 5 (ESP32). See Errors.

Wire command: w\w\f

Returns: none (Ok/Err only)

dev.wireless.wifi.on_discconect_from_station_2() -> Result
ow_status ow_wireless_wifi_on_discconect_from_station_2(ow_device* dev);
dev.wireless().wifi().on_discconect_from_station_2() -> Result<(), OwError>

The C and Rust signatures above are also the WASM guest signatures - the device API surface is identical; only the transport differs (ow_open_wasm(&dev) in C, OneWili::open() in Rust).

dev.wireless.wifi.on_discconect_from_station_2() # check dev.ok

on_scan_for_access_points​

Scan for Access Points. Scans for available WIFI networks

Requires power zone 5 (ESP32). See Errors.

Wire command: w\w\s

Returns: none (Ok/Err only)

dev.wireless.wifi.on_scan_for_access_points() -> Result
ow_status ow_wireless_wifi_on_scan_for_access_points(ow_device* dev);
dev.wireless().wifi().on_scan_for_access_points() -> Result<(), OwError>

The C and Rust signatures above are also the WASM guest signatures - the device API surface is identical; only the transport differs (ow_open_wasm(&dev) in C, OneWili::open() in Rust).

dev.wireless.wifi.on_scan_for_access_points() # check dev.ok

on_get_wif_info​

Print out Wifi Info. Scans for available Wifi networks

Requires power zone 5 (ESP32). See Errors.

Wire command: w\w\p

Returns: none (Ok/Err only)

dev.wireless.wifi.on_get_wif_info() -> Result
ow_status ow_wireless_wifi_on_get_wif_info(ow_device* dev);
dev.wireless().wifi().on_get_wif_info() -> Result<(), OwError>

The C and Rust signatures above are also the WASM guest signatures - the device API surface is identical; only the transport differs (ow_open_wasm(&dev) in C, OneWili::open() in Rust).

dev.wireless.wifi.on_get_wif_info() # check dev.ok

on_http_get_to_sd​

Download To SDCard. HTTP GET a URL and write it to a file on the SD card

Requires power zone 5 (ESP32). See Errors.

Wire command: w\w\l

ArgWire type
urlstring
pathstring

Returns: none (Ok/Err only)

dev.wireless.wifi.on_http_get_to_sd(url: str, path: str) -> Result
ow_status ow_wireless_wifi_on_http_get_to_sd(ow_device* dev, const char* url, const char* path);
dev.wireless().wifi().on_http_get_to_sd(url: &str, path: &str) -> Result<(), OwError>

The C and Rust signatures above are also the WASM guest signatures - the device API surface is identical; only the transport differs (ow_open_wasm(&dev) in C, OneWili::open() in Rust).

dev.wireless.wifi.on_http_get_to_sd(url, path) # check dev.ok

on_http_get_abort​

Cancel Download. Stops a download started with Download To SDCard

Requires power zone 5 (ESP32). See Errors.

Wire command: w\w\x

Returns: none (Ok/Err only)

dev.wireless.wifi.on_http_get_abort() -> Result
ow_status ow_wireless_wifi_on_http_get_abort(ow_device* dev);
dev.wireless().wifi().on_http_get_abort() -> Result<(), OwError>

The C and Rust signatures above are also the WASM guest signatures - the device API surface is identical; only the transport differs (ow_open_wasm(&dev) in C, OneWili::open() in Rust).

dev.wireless.wifi.on_http_get_abort() # check dev.ok

Events​

Spontaneous frames this menu emits (not command responses). Text events arrive as [*<id> ...] frames (Python: Transport.events; C: ow_poll_text_event; Rust: poll_event -> Event::Text); binary events use the binary API below. The on-device rthon and WASM bindings do not receive event streams; menus that expose a polled receive command (for example receive_canfd) are the on-device path.

wifistaInfo (text)​

Station IP configuration (got IP)

Payload fieldWire type
ipstring
gatewaystring
maskstring

wifiapInfo (text)​

Access point IP configuration

Payload fieldWire type
ipstring
gatewaystring
maskstring

wifiscan (text)​

Wifi scan record (SSID last so consumers can bounded-split)

Payload fieldWire type
bssidstring
rssidecS32
channeldecU32
banddecU32
authmodedecU32
ssidstring

wifiapdevcon (text)​

Device connected to the access point

Payload fieldWire type
ipstring
macstring

wifiapdevdc (text)​

Device disconnected from the access point

Payload fieldWire type
macstring

wsclientcon (text)​

Websocket client connected

Payload fieldWire type
ipstring

wsclientdc (text)​

Websocket client disconnected

Payload fieldWire type
ipstring

wifistations (text)​

Connected access-point station record (one event per device)

Payload fieldWire type
ipstring
macstring

httpget (text)​

Download progress; total is 0 when the server sent no length

Payload fieldWire type
writtendecU32
totaldecU32

httpgetdone (text)​

Download finished; result 0 is success, otherwise a bnose_http_result_t

Payload fieldWire type
resultdecU32
statusdecU32
writtendecU32