Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nanoframework/system.device.wifi
:package: nanoFramework System.Device.Wifi Class Library
https://github.com/nanoframework/system.device.wifi
csharp dotnet hacktoberfest nanoframework wifi
Last synced: 11 days ago
JSON representation
:package: nanoFramework System.Device.Wifi Class Library
- Host: GitHub
- URL: https://github.com/nanoframework/system.device.wifi
- Owner: nanoframework
- License: mit
- Created: 2018-08-21T02:41:04.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-10-21T00:40:29.000Z (about 1 month ago)
- Last Synced: 2024-10-29T21:06:18.121Z (22 days ago)
- Topics: csharp, dotnet, hacktoberfest, nanoframework, wifi
- Language: C#
- Homepage: https://www.nanoframework.net
- Size: 539 KB
- Stars: 22
- Watchers: 8
- Forks: 18
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
[](https://sonarcloud.io/dashboard?id=nanoframework_System.Device.WiFi) [](https://sonarcloud.io/dashboard?id=nanoframework_System.Device.WiFi) [](https://www.nuget.org/packages/nanoFramework.System.Device.Wifi/) [](https://github.com/nanoframework/Home/blob/main/CONTRIBUTING.md) [](https://discord.gg/gCyBu8T)
-----
Document Language: [English](README.md) | [简体中文](README.zh-cn.md)
### Welcome to the .NET **nanoFramework** System.Device.Wifi Library repository
This repository contains the nanoFramework System.Device.Wifi class library.
## Build status
| Component | Build Status | NuGet Package |
|:-|---|---|
| System.Device.Wifi | [](https://dev.azure.com/nanoframework/System.Device.Wifi/_build/latest?definitionId=13&repoName=nanoframework%2FSystem.Device.Wifi&branchName=main) | [](https://www.nuget.org/packages/nanoFramework.System.Device.Wifi/) |
## 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:
```csharp
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.
```csharp
// 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.
```csharp
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:
```csharp
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:
```csharp
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:
```csharp
// 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
```
## Feedback and documentation
For documentation, providing feedback, issues and finding out how to contribute please refer to the [Home repo](https://github.com/nanoframework/Home).
Join our Discord community [here](https://discord.gg/gCyBu8T).
## Credits
The list of contributors to this project can be found at [CONTRIBUTORS](https://github.com/nanoframework/Home/blob/main/CONTRIBUTORS.md).
## License
The **nanoFramework** Class Libraries are licensed under the [MIT license](LICENSE.md).
## 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](https://dotnetfoundation.org/code-of-conduct).
### .NET Foundation
This project is supported by the [.NET Foundation](https://dotnetfoundation.org).