Shiny Client v6.3Easy Live Activities, Game Center, Geospatial Geofencing, App Store APIs, More Thermal Printer Support, & Call Directory

Wi-Fi

The Wi-Fi bridge gives the page the current network and its changes, scanning, connecting, known networks, the radio and the hotspot, backed by Shiny.Net.Wifi.

Install and register

dotnet add package Shiny.AppDeviceBridge.Wifi

builder.UseAppDeviceBridge(
    bridge => bridge.AddWifiBridge(hotspot: false),
    webApp => { /* … */ }
);

Client	C#	TypeScript
`IWifiBridge`	`AddWifiBridgeClient()`	`WifiBridge`

Details

What works depends on the platform. iOS can’t scan, and Android can’t toggle the radio. GET /_bridge/wifi lists the platform’s capabilities, and any call it lacks returns 501. Linux uses NetworkManager through Shiny.Net.Wifi.Linux, which the bridge picks automatically. wifi.changed and wifi.hotspot only run while a page listens to them. Permissions come from Shiny.Net.Wifi: location on Android; the Access Wi-Fi Information and Hotspot Configuration entitlements on iOS.

From the page

import { WifiBridge } from "@shinyorg/appdevicebridge";

const wifi = new WifiBridge();
await wifi.requestAccess();

const networks = await wifi.scan();
networks.sort((a, b) => b.signalStrengthPercent - a.signalStrengthPercent);

await wifi.onChanged(e => console.log("now on", e.current?.ssid ?? "nothing"));
await wifi.connect({ ssid: "Shop-Floor", passphrase, security: "Wpa2Psk", timeoutMs: 20_000 });

Requests

GET/_bridge/wifi#

What this platform can do, the current network, and whether a hotspot is available.

C#IWifiBridge.GetStatusAsyncTSWifiBridge.getStatus

Response

200 WifiStatus

WifiStatus · 3 fields

`capabilities`	`WifiCapability[]`	What this platform can do. Calls outside it fail with 501.
`current`	`WifiNetworkInfo \| null`	The network the device is on, where the platform can tell.
`hotspotSupported`	`boolean`	Whether the app registered the hotspot and the platform supports one.

POST/_bridge/wifi/access#

Requests the permission Wi-Fi needs here — location on Android.

C#IWifiBridge.RequestAccessAsyncTSWifiBridge.requestAccess

Response

200 WifiAccessResult

WifiAccessResult · 1 field

access AccessState

GET/_bridge/wifi/networks#

Scans for networks in range.

C#IWifiBridge.ScanAsyncTSWifiBridge.scan

Response

200 WifiScanResult[]

WifiScanResult · 10 fields

`ssid`	`string`
`bssid`	`string \| null`
`security`	`WifiSecurity`
`signalStrengthDbm`	`number \| null`
`signalStrengthPercent`	`number`
`frequencyMhz`	`number \| null`
`band`	`WifiBand`
`channel`	`number \| null`
`isHidden`	`boolean`
`isOpen`	`boolean`

GET/_bridge/wifi/current#

The network the device is on. Null when it is not on Wi-Fi.

C#IWifiBridge.GetCurrentNetworkAsyncTSWifiBridge.getCurrentNetwork

Response

200 WifiNetworkInfo · or 204 when there is none

WifiNetworkInfo · 13 fields

`interfaceName`	`string`
`ssid`	`string \| null`
`bssid`	`string \| null`
`security`	`WifiSecurity`
`ipAddresses`	`string[]`
`dnsAddresses`	`string[]`
`gateway`	`string \| null`
`subnetMask`	`string \| null`
`signalStrengthDbm`	`number \| null`
`signalStrengthPercent`	`number \| null`
`frequencyMhz`	`number \| null`
`band`	`WifiBand`
`channel`	`number \| null`

POST/_bridge/wifi/connection#

Joins a network by SSID, or a saved one by id. iOS asks the user first. Fails with 409 when the connection fails, 403 when permission is missing.

C#IWifiBridge.ConnectAsyncTSWifiBridge.connect

Body

application/json · WifiConnectRequest

WifiConnectRequest · 8 fields

`ssid`	`string \| null`
`passphrase`	`string \| null`
`security`	`WifiSecurity`
`bssid`	`string \| null`	Join this access point in particular.
`isHidden`	`boolean`
`remember`	`boolean`	Save the network on the device.
`timeoutMs`	`number \| null`	How long to wait for the connection, in milliseconds; the platform's default when null.
`knownNetworkId`	`string \| null`	A saved network's `id`, instead of an SSID.

Response

200 WifiNetworkInfo

WifiNetworkInfo · 13 fields

`interfaceName`	`string`
`ssid`	`string \| null`
`bssid`	`string \| null`
`security`	`WifiSecurity`
`ipAddresses`	`string[]`
`dnsAddresses`	`string[]`
`gateway`	`string \| null`
`subnetMask`	`string \| null`
`signalStrengthDbm`	`number \| null`
`signalStrengthPercent`	`number \| null`
`frequencyMhz`	`number \| null`
`band`	`WifiBand`
`channel`	`number \| null`

Errors

403Forbidden409Conflict

DELETE/_bridge/wifi/connection#

Disconnects from the current network.

C#IWifiBridge.DisconnectAsyncTSWifiBridge.disconnect

Response: 204 No content

GET/_bridge/wifi/known#

The networks saved on the device that this app can see.

C#IWifiBridge.GetKnownNetworksAsyncTSWifiBridge.getKnownNetworks

Response

200 KnownWifiNetwork[]

KnownWifiNetwork · 5 fields

`id`	`string`	An int on Android, a UUID on Linux, the SSID itself on Apple platforms.
`ssid`	`string`
`security`	`WifiSecurity`
`isHidden`	`boolean`
`addedByThisApp`	`boolean`

DELETE/_bridge/wifi/known#

Forgets a saved network.

C#IWifiBridge.ForgetAsyncTSWifiBridge.forget

Parameter	In	Type
`id`	query	`string`	required

Response: 204 No content

GET/_bridge/wifi/radio#

Whether the Wi-Fi radio is on.

C#IWifiBridge.GetRadioAsyncTSWifiBridge.getRadio

Response

200 WifiRadioState

WifiRadioState · 1 field

enabled boolean

PUT/_bridge/wifi/radio#

Turns the Wi-Fi radio on or off.

C#IWifiBridge.SetRadioAsyncTSWifiBridge.setRadio

Body

application/json · WifiRadioState

WifiRadioState · 1 field

enabled boolean

Response

204 No content

GET/_bridge/wifi/hotspot#

Whether a hotspot is supported and running.

C#IWifiBridge.GetHotspotAsyncTSWifiBridge.getHotspot

Response

200 HotspotStatus

HotspotStatus · 3 fields

`supported`	`boolean`	Whether the platform supports a hotspot and the app registered it.
`running`	`boolean`	Whether one this app started is running.
`current`	`HotspotInfo \| null`	The hotspot, when one is running.

POST/_bridge/wifi/hotspot#

Starts a hotspot. Every field of the request is optional; the platform picks what is not given.

C#IWifiBridge.StartHotspotAsyncTSWifiBridge.startHotspot

Body

application/json · HotspotStartRequest

HotspotStartRequest · 4 fields

`ssid`	`string \| null`
`passphrase`	`string \| null`
`band`	`WifiBand`
`isHidden`	`boolean`

Response

200 HotspotInfo

HotspotInfo · 5 fields

`ssid`	`string`
`passphrase`	`string \| null`
`security`	`WifiSecurity`
`band`	`WifiBand`
`address`	`string \| null`

DELETE/_bridge/wifi/hotspot#

Stops the hotspot.

C#IWifiBridge.StopHotspotAsyncTSWifiBridge.stopHotspot

Response: 204 No content

GET/_bridge/wifi/hotspot/clients#

The devices connected to a hotspot this app started. Fails with 409 when it is not running.

C#IWifiBridge.GetHotspotClientsAsyncTSWifiBridge.getHotspotClients

Response

200 HotspotClient[]

HotspotClient · 3 fields

`macAddress`	`string`
`ipAddress`	`string \| null`
`hostName`	`string \| null`

Errors

409Conflict

Events

EVENTwifi.changed#

The device joined, left or changed networks.

C#IWifiBridge.OnChangedAsyncTSWifiBridge.onChanged

Payload: WifiChangedEvent

current WifiNetworkInfo | null The network now; null when the device left Wi-Fi.

EVENTwifi.hotspot#

The hotspot started, stopped or changed.

C#IWifiBridge.OnHotspotChangedAsyncTSWifiBridge.onHotspotChanged

Payload: HotspotChangedEvent

current HotspotInfo | null The hotspot now; null when it stopped.

Types

JSON property names are camelCase and enums travel as their names. A ? marks a property the payload may omit;| null one that may be null.

WifiStatusobject#

Wi-Fi on this device.

`capabilities`	`WifiCapability[]`	What this platform can do. Calls outside it fail with 501.
`current`	`WifiNetworkInfo \| null`	The network the device is on, where the platform can tell.
`hotspotSupported`	`boolean`	Whether the app registered the hotspot and the platform supports one.

WifiCapabilityenum#

Something a platform's Wi-Fi can do.

"Scan""Connect""Disconnect""CurrentNetwork""RadioState""RadioToggle""Hotspot""HotspotCustomConfiguration""HotspotClients""KnownNetworks""ForgetNetwork""ConnectKnownNetwork"

WifiNetworkInfoobject#

The network the device is on.

`interfaceName`	`string`
`ssid`	`string \| null`
`bssid`	`string \| null`
`security`	`WifiSecurity`
`ipAddresses`	`string[]`
`dnsAddresses`	`string[]`
`gateway`	`string \| null`
`subnetMask`	`string \| null`
`signalStrengthDbm`	`number \| null`
`signalStrengthPercent`	`number \| null`
`frequencyMhz`	`number \| null`
`band`	`WifiBand`
`channel`	`number \| null`

WifiSecurityenum#

"Unknown""Open""Wep""WpaPsk""Wpa2Psk""Wpa3Psk""Enterprise""Owe""Psk"

WifiBandenum#

"Unknown""TwoPointFourGhz""FiveGhz""SixGhz"

WifiAccessResultobject#

access AccessState

AccessStateenum#

Where a permission stands. Reported by every bridge that needs one; the names match Shiny's own.

"Unknown""NotSupported""NotSetup""Disabled""Restricted""Denied""Available"

WifiScanResultobject#

A network in range.

`ssid`	`string`
`bssid`	`string \| null`
`security`	`WifiSecurity`
`signalStrengthDbm`	`number \| null`
`signalStrengthPercent`	`number`
`frequencyMhz`	`number \| null`
`band`	`WifiBand`
`channel`	`number \| null`
`isHidden`	`boolean`
`isOpen`	`boolean`

WifiConnectRequestobject#

A network to join: by ssid, or a saved one by knownNetworkId.

`ssid?`	`string \| null`
`passphrase?`	`string \| null`
`security?`	`WifiSecurity`
`bssid?`	`string \| null`	Join this access point in particular.
`isHidden?`	`boolean`
`remember?`	`boolean`	Save the network on the device.
`timeoutMs?`	`number \| null`	How long to wait for the connection, in milliseconds; the platform's default when null.
`knownNetworkId?`	`string \| null`	A saved network's `id`, instead of an SSID.

KnownWifiNetworkobject#

A network saved on the device.

`id`	`string`	An int on Android, a UUID on Linux, the SSID itself on Apple platforms.
`ssid`	`string`
`security`	`WifiSecurity`
`isHidden`	`boolean`
`addedByThisApp`	`boolean`

WifiRadioStateobject#

enabled boolean

HotspotStatusobject#

`supported`	`boolean`	Whether the platform supports a hotspot and the app registered it.
`running`	`boolean`	Whether one this app started is running.
`current`	`HotspotInfo \| null`	The hotspot, when one is running.

HotspotInfoobject#

A running hotspot.

`ssid`	`string`
`passphrase`	`string \| null`
`security`	`WifiSecurity`
`band`	`WifiBand`
`address`	`string \| null`

HotspotStartRequestobject#

A hotspot to start. Every field is optional.

`ssid?`	`string \| null`
`passphrase?`	`string \| null`
`band?`	`WifiBand`
`isHidden?`	`boolean`

HotspotClientobject#

A device connected to the hotspot.

`macAddress`	`string`
`ipAddress`	`string \| null`
`hostName`	`string \| null`

WifiChangedEventobject#

current WifiNetworkInfo | null The network now; null when the device left Wi-Fi.

HotspotChangedEventobject#

current HotspotInfo | null The hotspot now; null when it stopped.

Security

These routes sit under AppDeviceBridgePolicies.Bridges like every other bridge: callers on this device by default. See Security.