👁 Image
nanoFramework.System.Device.Wifi 1.5.144

👁 Quality Gate Status
👁 Reliability Rating
👁 NuGet
👁 #yourfirstpr
👁 Discord

👁 nanoFramework logo

Document Language: |

Welcome to the .NET nanoFramework System.Device.Wifi Library repository

This repository contains the nanoFramework System.Device.Wifi class library.

Build status

WifiNetworkHelper usage

The WifiNetworkHelper is mainly dedicated to help you connect automatically to Wifi networks. That said, it can be used as well to check if you have a valid IP address and a valid date on any interface including on ethernet.

Preferred usage

The following code will allow you to connect automatically, wait for a valid IP address and a valid date with specific credentials:

const string Ssid = "YourSSID";
const string Password = "YourWifiPassword";
// Give 60 seconds to the wifi join to happen
CancellationTokenSource cs = new(60000);
var success = WifiNetworkHelper.ConnectDhcp(Ssid, Password, requiresDateTime: true, token: cs.Token);
if (!success)
{
 // Something went wrong, you can get details with the ConnectionError property:
 Debug.WriteLine($"Can't connect to the network, error: {WifiNetworkHelper.Status}");
 if (WifiNetworkHelper.HelperException != null)
 {
 Debug.WriteLine($"ex: {WifiNetworkHelper.HelperException}");
 }
}
// Otherwise, you are connected and have a valid IP and date

Note that this function will store the network credentials on the device.

Using stored credentials

You can as well connect to a network with pre stored credentials on the device depending on the type of device you have. Please check for proper support with your device.

// The wifi credentials are already stored on the device
 // Give 60 seconds to the wifi join to happen
CancellationTokenSource cs = new(60000);
var success = WifiNetworkHelper.Reconnect(requiresDateTime: true, token: cs.Token);
if (!success)
{
 // Something went wrong, you can get details with the ConnectionError property:
 Debug.WriteLine($"Can't connect to the network, error: {WifiNetworkHelper.Status}");
 if (WifiNetworkHelper.HelperException != null)
 {
 Debug.WriteLine($"ex: {WifiNetworkHelper.HelperException}");
 }
}
// Otherwise, you are connected and have a valid IP and date

Scan and join

You can force to scan the network and then join the network. This case can be useful in specific conditions. Be aware, that you may have to use this method with one of the previous method depending the support of rescanning while you are already connected.

const string Ssid = "YourSSID";
const string Password = "YourWifiPassword";
// Give 60 seconds to the wifi join to happen
CancellationTokenSource cs = new(60000);
var success = WifiNetworkHelper.ScanAndConnectDhcp(Ssid, Password, requiresDateTime: true, token: cs.Token);
if (!success)
{
 // Something went wrong, you can get details with the ConnectionError property:
 Debug.WriteLine($"Can't connect to the network, error: {WifiNetworkHelper.Status}");
 if (WifiNetworkHelper.HelperException != null)
 {
 Debug.WriteLine($"ex: {WifiNetworkHelper.HelperException}");
 }
}
// Otherwise, you are connected and have a valid IP and date

Note that this function will store the network credentials on the device.

Joining with a static IP address

You join a Wifi network with a static IP address:

const string Ssid = "YourSSID";
const string Password = "YourWifiPassword";
// Give 60 seconds to the wifi join to happen
CancellationTokenSource cs = new(60000);
var success = WifiNetworkHelper.ConnectFixAddress(Ssid, Password, new IPConfiguration("192.168.1.7", "255.255.255.0", "192.168.1.1"), requiresDateTime: true, token: cs.Token);

Checking valid IP address and date

The WifiNetworkHelper offers couple of functions to check validity of your IP address, the DateTime and helping setting them up:

var success = IsValidDateTime();
// if success is true, you have a valid DateTime
success = IsValidIpAddress(NetworkInterfaceType.Wireless80211);
// if success is true, you have a valid IP address on the Wireless adapter
// Be aware that a local address like 127.0.0.1 is considered as a valid address for ethernet

You can as well wait for a valid IP address and date time:

// Give 60 seconds to check if we have a valid IP and a valid DateTime
CancellationTokenSource cs = new(60000);
var success = WaitForValidIPAndDate(true, NetworkInterfaceType.Ethernet, cs.Token);
// if success is true then you are connected

Retry and reconfiguration

Retry after timeout

Token-based methods (ConnectDhcp, ScanAndConnectDhcp, ConnectFixAddress) are retryable. If a connection attempt times out, call the method again:

bool connected = false;
while (!connected)
{
 CancellationTokenSource cs = new(30000);
 connected = WifiNetworkHelper.ConnectDhcp(Ssid, Password, requiresDateTime: true, token: cs.Token);
 if (!connected)
 {
 Debug.WriteLine($"Not ready, status: {WifiNetworkHelper.Status}");
 Thread.Sleep(5000);
 }
}

Switching networks or restarting

To switch to a different SSID or restart the event-based helper, call Reset() first:

// Disconnect from current network if needed
WifiNetworkHelper.Disconnect();

// Reset the helper so it can be reconfigured
WifiNetworkHelper.Reset();

// Connect to a different SSID
CancellationTokenSource cs = new(30000);
WifiNetworkHelper.ConnectDhcp("NewSSID", "NewPassword", token: cs.Token);

The same applies to the event-based SetupNetworkHelper:

WifiNetworkHelper.Reset();
WifiNetworkHelper.SetupNetworkHelper("NewSSID", "NewPassword");

Reconnect() vs. ConnectDhcp()

Reconnect() does not actively send join credentials. It only waits for the platform's automatic reconnection (configured via WifiReconnectionKind.Automatic) to produce a valid IP address. Use it only when credentials are already stored on the device and the platform is expected to reconnect automatically.

If you need an explicit reconnect with credentials, use ConnectDhcp() instead.

NetworkReady behaviour

When using SetupNetworkHelper(), NetworkReady is reset when the connection is lost and re-signaled when it is restored, accurately reflecting live network state. Code that previously assumed NetworkReady would remain set permanently after first connect should be updated to handle transient disconnects.

Feedback and documentation

For documentation, providing feedback, issues and finding out how to contribute please refer to the Home repo.

Join our Discord community here.

Credits

The list of contributors to this project can be found at CONTRIBUTORS.

License

The nanoFramework Class Libraries are licensed under the .

Code of Conduct

This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behaviour in our community. For more information see the .NET Foundation Code of Conduct.

.NET Foundation

This project is supported by the .NET Foundation.