From eb8f864d8781eb70bdaa685215122440e13f5b65 Mon Sep 17 00:00:00 2001 From: Maximilian Gerhardt Date: Tue, 19 Jul 2022 11:30:51 +0200 Subject: [PATCH] Add Pico W WiFi Scan example --- examples/arduino-wifi-scan/README.md | 25 ++++++++++++ examples/arduino-wifi-scan/include/README | 39 +++++++++++++++++++ examples/arduino-wifi-scan/lib/README | 46 +++++++++++++++++++++++ examples/arduino-wifi-scan/platformio.ini | 15 ++++++++ examples/arduino-wifi-scan/src/main.cpp | 43 +++++++++++++++++++++ examples/arduino-wifi-scan/test/README | 11 ++++++ 6 files changed, 179 insertions(+) create mode 100644 examples/arduino-wifi-scan/README.md create mode 100644 examples/arduino-wifi-scan/include/README create mode 100644 examples/arduino-wifi-scan/lib/README create mode 100644 examples/arduino-wifi-scan/platformio.ini create mode 100644 examples/arduino-wifi-scan/src/main.cpp create mode 100644 examples/arduino-wifi-scan/test/README diff --git a/examples/arduino-wifi-scan/README.md b/examples/arduino-wifi-scan/README.md new file mode 100644 index 0000000..6037265 --- /dev/null +++ b/examples/arduino-wifi-scan/README.md @@ -0,0 +1,25 @@ +How to build PlatformIO based project +===================================== + +1. [Install PlatformIO Core](https://docs.platformio.org/page/core.html) +2. Download [development platform with examples](https://github.com/platformio/platform-raspberrypi/archive/develop.zip) +3. Extract ZIP archive +4. Run these commands: + +```shell +# Change directory to example +$ cd platform-raspberrypi/examples/arduino-wifi-scan + +# Build project +$ pio run + +# Upload firmware +$ pio run --target upload + +# Clean build files +$ pio run --target clean +``` + +## Notes + +This example is only intended for the Raspberry Pi Pico W with the [Earle Philhower](https://github.com/earlephilhower/arduino-pico) core. diff --git a/examples/arduino-wifi-scan/include/README b/examples/arduino-wifi-scan/include/README new file mode 100644 index 0000000..194dcd4 --- /dev/null +++ b/examples/arduino-wifi-scan/include/README @@ -0,0 +1,39 @@ + +This directory is intended for project header files. + +A header file is a file containing C declarations and macro definitions +to be shared between several project source files. You request the use of a +header file in your project source file (C, C++, etc) located in `src` folder +by including it, with the C preprocessing directive `#include'. + +```src/main.c + +#include "header.h" + +int main (void) +{ + ... +} +``` + +Including a header file produces the same results as copying the header file +into each source file that needs it. Such copying would be time-consuming +and error-prone. With a header file, the related declarations appear +in only one place. If they need to be changed, they can be changed in one +place, and programs that include the header file will automatically use the +new version when next recompiled. The header file eliminates the labor of +finding and changing all the copies as well as the risk that a failure to +find one copy will result in inconsistencies within a program. + +In C, the usual convention is to give header files names that end with `.h'. +It is most portable to use only letters, digits, dashes, and underscores in +header file names, and at most one dot. + +Read more about using header files in official GCC documentation: + +* Include Syntax +* Include Operation +* Once-Only Headers +* Computed Includes + +https://gcc.gnu.org/onlinedocs/cpp/Header-Files.html diff --git a/examples/arduino-wifi-scan/lib/README b/examples/arduino-wifi-scan/lib/README new file mode 100644 index 0000000..6debab1 --- /dev/null +++ b/examples/arduino-wifi-scan/lib/README @@ -0,0 +1,46 @@ + +This directory is intended for project specific (private) libraries. +PlatformIO will compile them to static libraries and link into executable file. + +The source code of each library should be placed in a an own separate directory +("lib/your_library_name/[here are source files]"). + +For example, see a structure of the following two libraries `Foo` and `Bar`: + +|--lib +| | +| |--Bar +| | |--docs +| | |--examples +| | |--src +| | |- Bar.c +| | |- Bar.h +| | |- library.json (optional, custom build options, etc) https://docs.platformio.org/page/librarymanager/config.html +| | +| |--Foo +| | |- Foo.c +| | |- Foo.h +| | +| |- README --> THIS FILE +| +|- platformio.ini +|--src + |- main.c + +and a contents of `src/main.c`: +``` +#include +#include + +int main (void) +{ + ... +} + +``` + +PlatformIO Library Dependency Finder will find automatically dependent +libraries scanning project source files. + +More information about PlatformIO Library Dependency Finder +- https://docs.platformio.org/page/librarymanager/ldf.html diff --git a/examples/arduino-wifi-scan/platformio.ini b/examples/arduino-wifi-scan/platformio.ini new file mode 100644 index 0000000..edd3aa0 --- /dev/null +++ b/examples/arduino-wifi-scan/platformio.ini @@ -0,0 +1,15 @@ +; PlatformIO Project Configuration File +; +; Build options: build flags, source filter, extra scripting +; Upload options: custom port, speed and extra flags +; Library options: dependencies, extra library storages +; +; Please visit documentation for the other options and examples +; https://docs.platformio.org/page/projectconf.html + +[env] +platform = raspberrypi +framework = arduino + +[env:rpipicow] +board = rpipicow diff --git a/examples/arduino-wifi-scan/src/main.cpp b/examples/arduino-wifi-scan/src/main.cpp new file mode 100644 index 0000000..d93c5ca --- /dev/null +++ b/examples/arduino-wifi-scan/src/main.cpp @@ -0,0 +1,43 @@ +// Simple WiFi network scanner application +// Released to the public domain in 2022 by Earle F. Philhower, III +#include +#include + +void setup() { + Serial.begin(115200); +} + +const char *macToString(uint8_t mac[6]) { + static char s[20]; + sprintf(s, "%02X:%02X:%02X:%02X:%02X:%02X", mac[0], mac[1], mac[2], mac[3], mac[4], mac[5]); + return s; +} + +const char *encToString(uint8_t enc) { + switch (enc) { + case ENC_TYPE_NONE: return "NONE"; + case ENC_TYPE_TKIP: return "WPA"; + case ENC_TYPE_CCMP: return "WPA2"; + case ENC_TYPE_AUTO: return "AUTO"; + } + return "UNKN"; +} + +void loop() { + delay(5000); + Serial.printf("Beginning scan at %d\n", millis()); + auto cnt = WiFi.scanNetworks(); + if (!cnt) { + Serial.printf("No networks found\n"); + } else { + Serial.printf("Found %d networks\n\n", cnt); + Serial.printf("%32s %5s %17s %2s %4s\n", "SSID", "ENC", "BSSID ", "CH", "RSSI"); + for (auto i = 0; i < cnt; i++) { + uint8_t bssid[6]; + WiFi.BSSID(i, bssid); + Serial.printf("%32s %5s %17s %2d %4d\n", WiFi.SSID(i), encToString(WiFi.encryptionType(i)), macToString(bssid), WiFi.channel(i), WiFi.RSSI(i)); + } + } + Serial.printf("\n--- Sleeping ---\n\n\n"); + delay(5000); +} diff --git a/examples/arduino-wifi-scan/test/README b/examples/arduino-wifi-scan/test/README new file mode 100644 index 0000000..df5066e --- /dev/null +++ b/examples/arduino-wifi-scan/test/README @@ -0,0 +1,11 @@ + +This directory is intended for PIO Unit Testing and project tests. + +Unit Testing is a software testing method by which individual units of +source code, sets of one or more MCU program modules together with associated +control data, usage procedures, and operating procedures, are tested to +determine whether they are fit for use. Unit testing finds problems early +in the development cycle. + +More information about PIO Unit Testing: +- https://docs.platformio.org/page/plus/unit-testing.html