official release

Author: beegee-tokyo

.gitignore

@@ -1,2 +1,3 @@
 **/.vscode
+**/build
 examples/RUI3-AT-P2P-ESP32-SLEEP-PIO

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Release Notes
 
+## V1.0.1 official release
+- Feeling confident it will work
+- Updated examples
+- Serial for debug output in class initiation is optional, defaults to Serial
+
 ## V0.0.5 update examples
 - Remove references to RAKwireless WisBlock modules from the examples
 - add Adafruit ESP32 Feather to PIO examples

README.md

@@ -63,17 +63,18 @@ The library provides a RUI3 class, which allows communication with RUI3 based Wi
 ## Construct a new RUI3 object     
 A simplified constructor taking only a Stream ({Software/Hardware}Serial) object.     
 The serial port should already be initialised when initialising this library.
-    
+Serial is used for debug output: host MCU <==> debug console
+
 ```cpp     
-RUI3(Stream &serial1, Stream &serial);     
+RUI3(Stream &serial1, Stream &serial = Serial);     
 ```     
 ### Parameters:
 @param serial1 Serial for communication with RUI3 module: WisDuo <==> host MCU     
-@param serial Serial for debug: host MCU <==> debug console
+@param serial Serial for debug: host MCU <==> debug console -- Defaults to Serial
     
 ### Usage:     
 ```cpp     
-RUI3 wisduo(Serial1, Serial);     
+RUI3 wisduo(Serial1);     
 ```
 	 
      

examples/RUI3-AT-ABP-PIO/platformio.ini

@@ -8,23 +8,28 @@
 ; Please visit documentation for the other options and examples
 ; https://docs.platformio.org/page/projectconf.html
 
-; [env:wiscore_rak11200]
-; platform = espressif32
-; board = wiscore_rak11200
-; framework = arduino
-; lib_deps = 
-; 	beegee-tokyo/RUI3-Arduino-Library
+[env:wiscore_rak11200]
+platform = espressif32
+board = wiscore_rak11200
+framework = arduino
+lib_deps = 
+	beegee-tokyo/RUI3-Arduino-Library
+build_flags = 
+	-DUSE_WB_IO2=1 ; Required for WisBlock Base Board
+	-DDEBUG_MODE=1 ; Set to 1 to enable library debug output
 
 ; [env:wiscore_rak4631]
 ; platform = nordicnrf52
 ; board = wiscore_rak4631
 ; framework = arduino
 ; lib_deps = 
 ; 	beegee-tokyo/RUI3-Arduino-Library
+; build_flags = 
+;	-DUSE_WB_IO2=1 ; Required for WisBlock Base Board
 
-[env:featheresp32]
-platform = espressif32
-board = featheresp32
-framework = arduino
-lib_deps =
-	beegee-tokyo/RUI3-Arduino-Library
+; [env:featheresp32]
+; platform = espressif32
+; board = featheresp32
+; framework = arduino
+; lib_deps =
+; 	beegee-tokyo/RUI3-Arduino-Library