This is a fork of WiFiNINA library that attempts to improve it and fix longstanding issues to make it usable for more serious network communication needs.
Currently it does not require any custom NINA firmware. Regular NINA firmware 1.5 or above will work. This may or may not change in the future.
In the spirit of open source all notable changes in this library will be submitted for inclusion to WiFiNINA. Whether or not that will happen (and when) is up to WiFiNINA maintainers.
For more information about original WiFiNINA library please visit WiFiNINA Reference page
WiFiNINA exposes a "simplified" interface for network communications via its WiFiClient/WiFiServer classes
that tries to hide the underlying socket operations complexity and manage them for you. Unfortunately this interface
is riddled with issues and longstanding problems (e.g. see this and this) that
seem to be very hard or impossible to fix.
Fortunately, since version 1.5 NINA firmware exposes direct access to BSD sockets which makes it possible to expose them
to client code. This is precisely what this library does. It exposes a new class WiFiSocket that provides type-safe
access to normal BSD socket functionality: socket/bind/listen/accept/connect/recv/send etc.
Notably non-blocking sockets are supported, enabling your code to easily handle multiple connections and multiple servers and clients.
If you are familiar with a regular BSD socket API this interface should provide a far better and easier experience than
using WiFiClient/WiFiServer.
WiFiNINA lets you create SSL clients (but not servers!) via WiFiClient/WiFiSSLClient classes. This is convenient since you do not need any additional libraries but comes at a price of the aforementioned clunky interface and clunky process to set up certificate trust. On the other hand, using WiFiSSLClient makes SSL happen on Nina chip saving you significant amount of main board memory.
This library provides WiFiBearSSLSocket class that connects WiFiSocket with Bear SSL library and allows you to create either SSL clients or servers. You can most easily obtain Bear SSL via ArduinoBearSSL library but other methods are also possible such as building it directly.
Note that running SSL (especially servers!) is RAM hungry. If your chip has only 32kB of RAM or less you might need to take extra precautions to avoid running out of memory. If your own code is already large then using WiFiClient for SSL and not having a server might be your only option.
The WiFiBearSSLServer example demonstrates how to create an SSL server using WiFiBearSSLSocket.
If your Arduino board software is Mbed OS based it is also possible to use WiFiSocket with Mbed TLS which is the same library NINA firmware uses to provide SSL functionality.
An older and slower version of it is included with your board library but you can also obtain latest and much faster one via MbedNanoTLS library.
BetterWiFiNINA provides WiFiMbedTLSSocket class that connects WiFiSocket with Mbed TLS and allows you to create either SSL clients or servers.
The WiFiMbedTLSServer example demonstrates how to create an SSL server using WiFiMbedTLSSocket.
Documentation for this library reflects the new APIs and is available at https://gershnik.github.io/BetterWiFiNINA/index.html.
All relevant examples in this repository have been changed to use WiFiSocket instead of WiFiClient/WiFiServer/WiFiUdp.
#include <BetterWiFiNINA.h>BetterWiFiNINA library is available from the Library Manager.
Alternatively you can download BetterWiFiNINA-x.y.z.tar.gz from the desired release of this library on
Releases page and unpack it into your Arduino libraries folder.
Use either:
lib_deps =
gershnik/BetterWiFiNINA@X.Y.Zor
lib_deps =
https://github.com/gershnik/BetterWiFiNINA#vX.Y.Zto your platformio.ini file where X.Y.Z is the desired version.
Note that the second form allows you to reference unreleased code at specific branches or commits, if desired.
Copyright (c) 2024 Eugene Gershnik. All rights reserved.
Copyright (c) 2018 Arduino SA. All rights reserved.
Copyright (c) 2011-2014 Arduino LLC. All right reserved.
This library is free software; you can redistribute it and/or modify it under
the terms of the GNU Lesser General Public License as published by the Free
Software Foundation; either version 3 of the License, or (at your option)
any later version.
This library is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
for more details.
You should have received a copy of the GNU Lesser General Public License along
with this library; if not, see https://www.gnu.org/licenses/.