Multiple minor fixes to documentation and samples (#2239)

* Fixed WebcamServer to use spiffs. * Remove potential memory leak. A Wifi station can get disconnected and connected multiple times. * Renamed sample to what it actually is: Telnet_Server. * Minor typos. * Fixed broken links. * Fix the documents installation on travis. * Removed obsolete setting. * Demonstrate WIFI disabling. * Removed empty component.mk. * Renamed sample output to the standard example.output.txt. * Removed example output that is not matching the sample application. * Minor code reorganization and text changes. * Spiffs are not required for the instapush and thingspeak samples. * Removed dump.bat file. Not related to the sample. * Removed spaces around value. * Minor cleanup to HttpServer Bootstrap sample. * Moved user0.bin to files/. * Fixed URL path.
SmingHub · Mar 5, 2021 · 52f0ea3 · 52f0ea3
1 parent a450eb6
commit 52f0ea3
Show file tree

Hide file tree

Showing 68 changed files with 94 additions and 108 deletions.
diff --git a/README.md b/README.md
@@ -67,17 +67,17 @@ Please note Version 4 documentation is at [sming.readthedocs.io](https://sming.r
     * Async TCP and UDP stack based on [LWIP](http://savannah.nongnu.org/projects/lwip/).
     * With clients supporting: HTTP, MQTT, WebSockets and SMTP.
     * And servers for: DNS, FTP, HTTP(+ WebSockets), Telnet.
-    * With [SSL support](https://sming.readthedocs.io/en/latest/framework/core/network/ssl.html) for all network clients and servers. Based on [axTLS](http://axtls.sourceforge.net/) and [BearSSL](https://www.bearssl.org/).
+    * With [SSL support](https://sming.readthedocs.io/en/latest/_inc/Sming/Components/ssl/index.html) for all network clients and servers. Based on [axTLS](http://axtls.sourceforge.net/) and [BearSSL](https://www.bearssl.org/).
     * Out of the box support for OTA over HTTPS.
 * ESP8266 specific features.
     * Integrated boot loader [rboot](https://sming.readthedocs.io/en/latest/_inc/Sming/Components/rboot/index.html) with support for 1MB ROMs, OTA firmware updating and ROM switching.
-    * [Crash handlers](https://sming.readthedocs.io/en/latest/information/debugging/index.html) for analyzing/handling system restarts due to fatal errors or WDT resets.
+    * [Crash handlers](https://sming.readthedocs.io/en/latest/information/debugging.html) for analyzing/handling system restarts due to fatal errors or WDT resets.
     * [PWM support](https://sming.readthedocs.io/en/latest/_inc/Sming/Arch/Esp8266/Components/driver/index.html) based on [Stefan Bruens PWM](https://github.com/StefanBruens/ESP8266_new_pwm.git).
     * Optional [custom heap allocation](https://sming.readthedocs.io/en/latest/_inc/Sming/Arch/Esp8266/Components/heap/index.html) based on [Umm Malloc](https://github.com/rhempel/umm_malloc.git).
     * Based on Espressif NONOS SDK. Officially suppored NON SDK version is >= 3.0.1.
     * Support for a [thin No-Wifi-SDK](https://sming.readthedocs.io/en/latest/_inc/Sming/Arch/Esp8266/Components/esp_no_wifi/index.html). Helpful when a project does not require WiFi (or networking) and reduces code size and memory usage signficantly.
 * Linux/Windows features
-    * Sming has a [host emulator](https://sming.readthedocs.io/en/latest/arch/host/host-emulator.html) that allows libraries and sample applications to be compiled on a Linux/Windows host system and be tested before uploading them to an actual microcontroller.
+    * Sming has a [host emulator](https://sming.readthedocs.io/en/latest/arch/host/index.html) that allows libraries and sample applications to be compiled on a Linux/Windows host system and be tested before uploading them to an actual microcontroller.
 
 ## Compatibility
 
@@ -136,7 +136,7 @@ git clone https://github.com/SmingHub/Sming.git
 
 ## Getting Started
 
-Sming supports multiple architectures. Choose the architecture of your choice to [install the needed development software](https://sming.readthedocs.io/en/latest/getting-started.html) and toolchain(s).
+Sming supports multiple architectures. Choose the architecture of your choice to [install the needed development software](https://sming.readthedocs.io/en/latest/getting-started) and toolchain(s).
 
 You can also try Sming without installing anything locally. We have an [interactive tutorial](https://www.katacoda.com/slaff/scenarios/sming-host-emulator) that can be run directly from your browser.
 
@@ -196,7 +196,7 @@ Serial.println("Hello Sming! Let's do smart things.");
 ### Connect to WiFi
 ```c++
 WifiStation.enable(true);
-WifiStation.config("LOCAL-NETWORK", "123456789087"); // Put you SSID and Password here
+WifiStation.config("LOCAL-NETWORK", "123456789087"); // Put your SSID and password here
 ```
 
 ### Read DHT22 sensor

diff --git a/Sming/Arch/Host/Tools/travis/build.run.sh b/Sming/Arch/Host/Tools/travis/build.run.sh
@@ -23,4 +23,5 @@ $MAKE_PARALLEL tests
 mv $SMING_PROJECTS_DIR/samples ..
 mv $SMING_PROJECTS_DIR/tests ..
 unset SMING_PROJECTS_DIR
+$SMING_HOME/../Tools/install.sh doc
 make docs V=1
diff --git a/docs/source/getting-started/index.rst b/docs/source/getting-started/index.rst
@@ -94,7 +94,7 @@ Connect to WiFi
 ::
 
    WifiStation.enable(true);
-   WifiStation.config("LOCAL-NETWORK", "123456789087"); // Put you SSID and Password here
+   WifiStation.config("LOCAL-NETWORK", "123456789087"); // Put your SSID and password here
 
 Read DHT22 sensor
 ~~~~~~~~~~~~~~~~~

diff --git a/docs/source/getting-started/macos/index.rst b/docs/source/getting-started/macos/index.rst
@@ -77,7 +77,7 @@ Clone from the `Sming <https://github.com/SmingHub/Sming>`__ repository::
    Do NOT use the --recursive option for the command above.
    Our build mechanism will take care to get the third-party sources and patch them, if needed.
 
-You will get a copy of our `develop` branch which intended for developers.
+You will get a copy of our `develop` branch which is intended for developers.
 It is the one where all new cool (unstable) features are landing.
 
 If you want to use our stable branch then use the master branch::

diff --git a/samples/Arducam/app/application.cpp b/samples/Arducam/app/application.cpp
@@ -15,7 +15,7 @@
 
 // If you want, you can define WiFi settings globally in Eclipse Environment Variables
 #ifndef WIFI_SSID
-#define WIFI_SSID "PleaseEnterSSID" // Put you SSID and Password here
+#define WIFI_SSID "PleaseEnterSSID" // Put your SSID and password here
 #define WIFI_PWD "PleaseEnterPass"
 #endif
 

diff --git a/samples/Basic_APA102/app/application.cpp b/samples/Basic_APA102/app/application.cpp
@@ -1,14 +1,14 @@
 /*
  * File: APA102 LED class demo for Sming framework
- * 
+ *
  * Original Author: https://github.com/HappyCodingRobot
  *
- * This library support the APA102 LED with integrated controller chip.
- * 
+ * This library supports the APA102 LED with integrated controller chip.
+ *
  *
  * hardware SPI: clk=GPIO14 , mosi=GPIO13
  * software SPI: user defined
- * 
+ *
  */
 #include <SmingCore.h>
 

diff --git a/samples/Basic_AWS/app/application.cpp b/samples/Basic_AWS/app/application.cpp
@@ -3,7 +3,7 @@
 
 // If you want, you can define WiFi settings globally in Eclipse Environment Variables
 #ifndef WIFI_SSID
-#define WIFI_SSID "PleaseEnterSSID" // Put you SSID and Password here
+#define WIFI_SSID "PleaseEnterSSID" // Put your SSID and password here
 #define WIFI_PWD "PleaseEnterPass"
 #endif
 

diff --git a/samples/Basic_Capsense/README.rst b/samples/Basic_Capsense/README.rst
@@ -1,4 +1,4 @@
 Basic Capsense
 ==============
 
-Simple demonstration showing Displays raw output from a capacitive sensor.
+Simple demonstration showing raw output from a capacitive sensor.
diff --git a/samples/Basic_Capsense/app/application.cpp b/samples/Basic_Capsense/app/application.cpp
@@ -3,8 +3,8 @@
 #include <Libraries/CapacitiveSensor/CapacitiveSensor.h>
 
 // http://playground.arduino.cc/Main/CapacitiveSensor?from=Main.CapSense
-// Im using a 250K resistor currently. Using 500K seems to timeout. Im guessing that the higher
-// Clock speed on the ESP means we need a higher charge current than arduino ??
+// I'm using a 250K resistor currently. Using 500K seems to timeout. I'm guessing that the higher
+// clock speed on the ESP means we need a higher charge current than arduino ??
 // Further investigation required.
 
 CapacitiveSensor cs_0_2 = CapacitiveSensor(0, 2); //Send pin 0, Receive Pin 2.

diff --git a/samples/Basic_IFS/app/application.cpp b/samples/Basic_IFS/app/application.cpp
@@ -12,7 +12,7 @@
 
 // If you want, you can define WiFi settings globally in Eclipse Environment Variables
 #ifndef WIFI_SSID
-#define WIFI_SSID "PleaseEnterSSID" // Put you SSID and Password here
+#define WIFI_SSID "PleaseEnterSSID" // Put your SSID and password here
 #define WIFI_PWD "PleaseEnterPass"
 #endif
 

diff --git a/samples/Basic_Neopixel/app/application.cpp b/samples/Basic_Neopixel/app/application.cpp
@@ -3,7 +3,7 @@
 #include <Libraries/Adafruit_NeoPixel/Adafruit_NeoPixel.h>
 
 #ifndef WIFI_SSID
-#define WIFI_SSID "XXX" // Put you SSID and Password here
+#define WIFI_SSID "XXX" // Put your SSID and password here
 #define WIFI_PWD "XXX"
 #endif
 
@@ -160,14 +160,16 @@ void init()
 
 	Serial.print("NeoPixel demo .. start");
 
-	// Wifi could be used eg. for switching Neopixel from internet
-	// could be also dissabled if no needed
+#ifndef DISABLE_WIFI
+	// Wifi could be used eg. for switching Neopixel from internet.
+	// If not needed compile this sample with `make DISABLE_WIFI=1`
 
 	WifiStation.config(WIFI_SSID, WIFI_PWD);
 	WifiStation.enable(true);
 	WifiAccessPoint.enable(false);
 	WifiEvents.onStationDisconnect(connect_Fail);
 	WifiEvents.onStationGotIP(got_IP);
+#endif
 
 	StripDemoType = 0; //demo index to be displayed
 

diff --git a/samples/Basic_ScannerI2C/component.mk b/samples/Basic_ScannerI2C/component.mk
diff --git a/samples/Basic_Serial/printf_test_output.txt → samples/Basic_Serial/example.output.txt b/samples/Basic_Serial/printf_test_output.txt → samples/Basic_Serial/example.output.txt
diff --git a/samples/Basic_SmartConfig/README.rst b/samples/Basic_SmartConfig/README.rst
@@ -11,8 +11,8 @@ a special signature. It then tries to extract data like SSID and password from i
 The App on your smart phone sends out that information.
 
 The example here shows how to use ESP_TOUCH method to do smart
-configuration on the device. It ported from the C code that
-Espressif provides in the SDK examples.
+configuration on the device. It is ported from the C code that
+Espressif provides in their SDK examples.
 
 You will need an App for your Smart Phone, such as:
 

diff --git a/samples/Basic_Ssl/README.rst b/samples/Basic_Ssl/README.rst
@@ -42,4 +42,4 @@ Memory usage
 SSL uses a significant amount of RAM. You can build this sample to track heap usage
 and output statistics every 5 seconds::
 
-   make ENABLE_MALLOC_COUNT = 1
+   make ENABLE_MALLOC_COUNT=1
diff --git a/samples/Basic_Ssl/app/application.cpp b/samples/Basic_Ssl/app/application.cpp
@@ -8,7 +8,7 @@
 
 // If you want, you can define WiFi settings globally in Eclipse Environment Variables
 #ifndef WIFI_SSID
-#define WIFI_SSID "PleaseEnterSSID" // Put you SSID and Password here
+#define WIFI_SSID "PleaseEnterSSID" // Put your SSID and password here
 #define WIFI_PWD "PleaseEnterPass"
 #endif
 
@@ -141,7 +141,7 @@ void init()
 
 	// Setup the WIFI connection
 	WifiStation.enable(true);
-	WifiStation.config(WIFI_SSID, WIFI_PWD); // Put you SSID and Password here
+	WifiStation.config(WIFI_SSID, WIFI_PWD); // Put your SSID and password here
 
 	WifiEvents.onStationGotIP(gotIP);
 	WifiEvents.onStationDisconnect(connectFail);

diff --git a/samples/Basic_Storage/basic_storage.hw b/samples/Basic_Storage/basic_storage.hw
@@ -15,7 +15,7 @@
 			"size": "16K",
 			"type": "user",
 			"subtype": 0,
-			"filename": "user0.bin"
+			"filename": "files/user0.bin"
 		},
 		"user1": {
 			"address": "0x1F4000",

diff --git a/samples/Basic_Storage/user0.bin → samples/Basic_Storage/files/user0.bin b/samples/Basic_Storage/user0.bin → samples/Basic_Storage/files/user0.bin
diff --git a/samples/Basic_WebSkeletonApp/app/configuration.cpp b/samples/Basic_WebSkeletonApp/app/configuration.cpp
@@ -3,7 +3,7 @@
 
 // If you want, you can define WiFi settings globally in Eclipse Environment Variables
 #ifndef WIFI_SSID
-#define WIFI_SSID "PleaseEnterSSID" // Put you SSID and Password here
+#define WIFI_SSID "PleaseEnterSSID" // Put your SSID and password here
 #define WIFI_PWD "PleaseEnterPass"
 #endif
 

diff --git a/samples/Basic_WebSkeletonApp_LTS/app/configuration.cpp b/samples/Basic_WebSkeletonApp_LTS/app/configuration.cpp
@@ -2,7 +2,7 @@
 
 // If you want, you can define WiFi settings globally in Eclipse Environment Variables
 #ifndef WIFI_SSID
-#define WIFI_SSID "PleaseEnterSSID" // Put you SSID and Password here
+#define WIFI_SSID "PleaseEnterSSID" // Put your SSID and password here
 #define WIFI_PWD "PleaseEnterPass"
 #endif
 

diff --git a/samples/Basic_WiFi/app/application.cpp b/samples/Basic_WiFi/app/application.cpp
@@ -2,7 +2,7 @@
 
 // If you want, you can define WiFi settings globally in Eclipse Environment Variables
 #ifndef WIFI_SSID
-#define WIFI_SSID "PleaseEnterSSID" // Put you SSID and Password here
+#define WIFI_SSID "PleaseEnterSSID" // Put your SSID and password here
 #define WIFI_PWD "PleaseEnterPass"
 #endif
 

diff --git a/samples/Basic_rBoot/app/application.cpp b/samples/Basic_rBoot/app/application.cpp
@@ -8,7 +8,7 @@
 
 // If you want, you can define WiFi settings globally in Eclipse Environment Variables
 #ifndef WIFI_SSID
-#define WIFI_SSID "PleaseEnterSSID" // Put you SSID and Password here
+#define WIFI_SSID "PleaseEnterSSID" // Put your SSID and password here
 #define WIFI_PWD "PleaseEnterPass"
 #endif
 

diff --git a/samples/CommandProcessing_Debug/app/application.cpp b/samples/CommandProcessing_Debug/app/application.cpp
@@ -6,7 +6,7 @@
 
 // If you want, you can define WiFi settings globally in Eclipse Environment Variables
 #ifndef WIFI_SSID
-#define WIFI_SSID "PleaseEnterSSID" // Put you SSID and Password here
+#define WIFI_SSID "PleaseEnterSSID" // Put your SSID and password here
 #define WIFI_PWD "PleaseEnterPass"
 #endif
 

diff --git a/samples/CommandProcessing_Debug/files/index.html b/samples/CommandProcessing_Debug/files/index.html
@@ -6,7 +6,7 @@
 
 <script language="javascript" type="text/javascript">
 
-  var wsUri = "ws://" + location.host + "/index.html?command=true";
+  var wsUri = "ws://" + location.host + "/ws";
   var output;
 
   function init()
@@ -53,7 +53,7 @@
 
   function doSend(message)
   {
-    addCommandReply("SENT: " + message); 
+    addCommandReply("SENT: " + message);
     websocket.send(message);
   }
 
@@ -118,5 +118,5 @@ <h2>WebSocket Command Test</h2>
 
 <div id="commandReply"style="width:500px; height:500px; overflow-y: scroll;border:1px solid black;font-size:15px" >
 </div>
- 
+
 <div id="output"></div>
diff --git a/samples/Compass_HMC5883L/README.rst b/samples/Compass_HMC5883L/README.rst
@@ -1,7 +1,7 @@
 HMC5883L Compass
 ================
 
-ESP8266 HMC5883L sensor reader.
+HMC5883L sensor reader.
 
 .. image:: hmc5883l.jpg
    :height: 192px
diff --git a/samples/Compass_HMC5883L/example.output.txt b/samples/Compass_HMC5883L/example.output.txt
diff --git a/samples/DFPlayerMini/README.rst b/samples/DFPlayerMini/README.rst
@@ -4,10 +4,10 @@ DFPlayer Mini
 Introduction
 ------------
 
-The DFPlayer Mini MP3 Player is a small and low price MP3 module with an
+The DFPlayer Mini MP3 Player is a small and low-cost MP3 module with a
 simplified output directly to the speaker. The module can be used as a
 stand alone module with attached battery, speaker and push buttons or
-used in combination with an ESP8266 via RX/TX.
+used in combination with an ESP8266/ESP32 via RX/TX.
 
 For more details see this link:
 https://www.dfrobot.com/wiki/index.php/DFPlayer_Mini_SKU:DFR0299
@@ -16,7 +16,7 @@ Building
 --------
 
 Steps to test this sample: \* Connect DFPlayer Mini using RX/TX pins to
-TX/RX pins respectively of ESP8266. \* Copy one or more mp3 file to an
-SD card. The example playes one file for some time and moves to next
-one. \* Insert that SD card in the slot of the DF Player module. \*
+TX/RX pins respectively of ESP8266. \* Copy one or more mp3 files to your
+SD card. The example playes one file for some time and moves to the next
+one. \* Insert your SD card in the slot of the DF Player module. \*
 Flash and run the sample code.
diff --git a/samples/DFPlayerMini/app/application.cpp b/samples/DFPlayerMini/app/application.cpp
@@ -5,20 +5,21 @@
 #define GPIO_LED 2
 
 Timer timerDFPlayer;
-DFRobotDFPlayerMini player;
-void nextSong()
-{
-	player.next();
-}
-
 Timer timerLedBlink;
+DFRobotDFPlayerMini player;
 bool ledState = true;
+
 void blink()
 {
 	digitalWrite(GPIO_LED, ledState);
 	ledState = !ledState;
 }
 
+void nextSong()
+{
+	player.next();
+}
+
 void init()
 {
 	Serial.begin(9600);

diff --git a/samples/DS3232RTC_NTP_Setter/app/application.cpp b/samples/DS3232RTC_NTP_Setter/app/application.cpp
@@ -5,7 +5,7 @@
 
 // If you want, you can define WiFi settings globally in Eclipse Environment Variables
 #ifndef WIFI_SSID
-#define WIFI_SSID "ENTER_YOUR_SSID" // Put you SSID and Password here
+#define WIFI_SSID "ENTER_YOUR_SSID" // Put your SSID and password here
 #define WIFI_PWD "ENTER_YOUR_PASSWORD"
 #endif
 

diff --git a/samples/Echo_Ssl/app/application.cpp b/samples/Echo_Ssl/app/application.cpp
@@ -10,7 +10,7 @@
 
 // If you want, you can define WiFi settings globally in Eclipse Environment Variables
 #ifndef WIFI_SSID
-#define WIFI_SSID "PleaseEnterSSID" // Put you SSID and Password here
+#define WIFI_SSID "PleaseEnterSSID" // Put your SSID and password here
 #define WIFI_PWD "PleaseEnterPass"
 #endif
 
@@ -66,7 +66,7 @@ void init()
 
 	// Setup the WIFI connection
 	WifiStation.enable(true);
-	WifiStation.config(WIFI_SSID, WIFI_PWD); // Put you SSID and Password here
+	WifiStation.config(WIFI_SSID, WIFI_PWD); // Put your SSID and password here
 
 	// Run our method when station was connected to AP (or not connected)
 	WifiEvents.onStationDisconnect(connectFail);

diff --git a/samples/FtpServer_Files/app/application.cpp b/samples/FtpServer_Files/app/application.cpp
@@ -2,7 +2,7 @@
 
 // If you want, you can define WiFi settings globally in Eclipse Environment Variables
 #ifndef WIFI_SSID
-#define WIFI_SSID "PleaseEnterSSID" // Put you SSID and Password here
+#define WIFI_SSID "PleaseEnterSSID" // Put your SSID and password here
 #define WIFI_PWD "PleaseEnterPass"
 #endif
 

diff --git a/samples/HttpClient_Instapush/app/application.cpp b/samples/HttpClient_Instapush/app/application.cpp
@@ -19,7 +19,7 @@
 
 // If you want, you can define WiFi settings globally in Eclipse Environment Variables
 #ifndef WIFI_SSID
-#define WIFI_SSID "PleaseEnterSSID" // Put you SSID and Password here
+#define WIFI_SSID "PleaseEnterSSID" // Put your SSID and password here
 #define WIFI_PWD "PleaseEnterPass"
 #endif
 
@@ -100,8 +100,6 @@ void gotIP(IpAddress ip, IpAddress netmask, IpAddress gateway)
 
 void init()
 {
-	spiffs_mount(); // Mount file system, in order to work with files
-
 	Serial.begin(SERIAL_BAUD_RATE); // 115200 by default
 	Serial.systemDebugOutput(true); // Debug output to serial
 

diff --git a/samples/HttpClient_Instapush/component.mk b/samples/HttpClient_Instapush/component.mk
@@ -1,3 +1 @@
-HWCONFIG := spiffs
-SPIFF_FILES :=
 ARDUINO_LIBRARIES := ArduinoJson6