Update license and versions

mcspr · Jun 11, 2018 · fdf4804 · fdf4804
1 parent 7297d77
commit fdf4804
Showing 17 changed files with 260 additions and 769 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,9 +3,16 @@
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
-## [2.0.0] 2018-05-22
+## [2.0.0] 2018-06-11
+### Added
+- SmartConfig (a.k.a. ESP Touch) support
+- WPS Support
+- TravisCI build tests
+- Codacy code test
+
 ### Changed
-- Complete refactor
+- Complete refactor (check examples to adapt your code)
+- Changed license to LGPL-3.0
 
 ## [1.2.0] 2018-05-20
 ### Changed

diff --git a/LICENSE b/LICENSE
diff --git a/README.md b/README.md
@@ -10,34 +10,14 @@ JustWifi is a WIFI Manager library for the [Arduino Core for ESP8266][2]. The go
 [![donate](https://img.shields.io/badge/donate-PayPal-blue.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=xose%2eperez%40gmail%2ecom&lc=US&no_note=0&currency_code=EUR&bn=PP%2dDonationsBF%3abtn_donate_LG%2egif%3aNonHostedGuest)
 [![twitter](https://img.shields.io/twitter/follow/xoseperez.svg?style=social)](https://twitter.com/intent/follow?screen_name=xoseperez)
 
-There are other WIFI managers available. So how does JustWifi compare to them:
-
-* [WiFiManager][1] is a connection manager with fallback web configuration portal.
-* [WiFiMulti][2] is the default multi-network manager that comes with Arduino Core for ESP8266
-
-The table below summarizes the main differences between WiFiManager, WifiMulti and JustWifi:
-
-||WiFiManager|JustWifi|WifiMulti|
-|-|-|-|-|
-| AP fallback | YES | YES | NO |
-| AP+STA mode | NO | YES | NO |
-| Configuration portal | YES | NO | NO |
-| Configure networks from code | NO | YES | YES
-| Custom parameters | YES | NO | NO |
-| Persist confguration | YES | NO | NO |
-| Allow multiple networks | NO | YES | YES |
-| Check the signal strength  | YES* | YES | YES |
-| Support static IPs | YES | YES | NO |
-
-* WifiManager filters networks by RSSI, but does not try to connect in order of signal strength
-
-
 ## Features
 
 The main features of the JustWifi library are:
 
 * Configure multiple possible networks
 * Scan wifi networks so it can try to connect to only those available, in order of signal strength
+* Smart Config support (when built with -DJUSTWIFI_ENABLE_SMARTCONFIG, tested with ESP8266 SmartConfig or IoT SmartConfig apps)
+* WPS support (when built with -DJUSTWIFI_ENABLE_WPS)
 * Fallback to AP mode
 * Configurable timeout to try to reconnect after AP fallback
 * AP+STA mode
@@ -48,5 +28,19 @@ The main features of the JustWifi library are:
 
 See examples.
 
-[1]:https://github.com/tzapu/WiFiManager
-[2]:https://github.com/esp8266/Arduino
+## License
+
+Copyright (C) 2016-2018 by Xose Pérez <xose dot perez at gmail dot com>
+
+The JustWifi 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.
+
+The JustWifi 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 the JustWifi library.  If not, see <http://www.gnu.org/licenses/>.
diff --git a/examples/advanced/advanced.ino b/examples/advanced/advanced.ino
@@ -7,18 +7,18 @@ a captive portal (when in AP mode only)
 
 Copyright (C) 2016-2018 by Xose Pérez <xose dot perez at gmail dot com>
 
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
+The JustWifi 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 program is distributed in the hope that it will be useful,
+The JustWifi 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 General Public License for more details.
+GNU Lesser General Public License for more details.
 
-You should have received a copy of the GNU General Public License
-along with this program.  If not, see <http://www.gnu.org/licenses/>.
+You should have received a copy of the GNU Lesser General Public License
+along with the JustWifi library.  If not, see <http://www.gnu.org/licenses/>.
 
 */
 

diff --git a/examples/advanced/utils.ino b/examples/advanced/utils.ino
@@ -4,18 +4,18 @@ JustWifi - Basic debugging callback utils
 
 Copyright (C) 2016-2018 by Xose Pérez <xose dot perez at gmail dot com>
 
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
+The JustWifi 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 program is distributed in the hope that it will be useful,
+The JustWifi 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 General Public License for more details.
+GNU Lesser General Public License for more details.
 
-You should have received a copy of the GNU General Public License
-along with this program.  If not, see <http://www.gnu.org/licenses/>.
+You should have received a copy of the GNU Lesser General Public License
+along with the JustWifi library.  If not, see <http://www.gnu.org/licenses/>.
 
 */
 

diff --git a/examples/ap/ap.ino b/examples/ap/ap.ino
@@ -6,18 +6,18 @@ This example creates an access point.
 
 Copyright (C) 2016-2018 by Xose Pérez <xose dot perez at gmail dot com>
 
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
+The JustWifi 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 program is distributed in the hope that it will be useful,
+The JustWifi 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 General Public License for more details.
+GNU Lesser General Public License for more details.
 
-You should have received a copy of the GNU General Public License
-along with this program.  If not, see <http://www.gnu.org/licenses/>.
+You should have received a copy of the GNU Lesser General Public License
+along with the JustWifi library.  If not, see <http://www.gnu.org/licenses/>.
 
 */
 

diff --git a/examples/ap/utils.ino b/examples/ap/utils.ino
@@ -4,18 +4,18 @@ JustWifi - Basic debugging callback utils
 
 Copyright (C) 2016-2018 by Xose Pérez <xose dot perez at gmail dot com>
 
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
+The JustWifi 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 program is distributed in the hope that it will be useful,
+The JustWifi 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 General Public License for more details.
+GNU Lesser General Public License for more details.
 
-You should have received a copy of the GNU General Public License
-along with this program.  If not, see <http://www.gnu.org/licenses/>.
+You should have received a copy of the GNU Lesser General Public License
+along with the JustWifi library.  If not, see <http://www.gnu.org/licenses/>.
 
 */
 

diff --git a/examples/basic/basic.ino b/examples/basic/basic.ino
@@ -6,18 +6,18 @@ This example shows how to define different networks and enable network scanning
 
 Copyright (C) 2016-2018 by Xose Pérez <xose dot perez at gmail dot com>
 
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
+The JustWifi 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 program is distributed in the hope that it will be useful,
+The JustWifi 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 General Public License for more details.
+GNU Lesser General Public License for more details.
 
-You should have received a copy of the GNU General Public License
-along with this program.  If not, see <http://www.gnu.org/licenses/>.
+You should have received a copy of the GNU Lesser General Public License
+along with the JustWifi library.  If not, see <http://www.gnu.org/licenses/>.
 
 */
 

diff --git a/examples/basic/utils.ino b/examples/basic/utils.ino
@@ -4,18 +4,18 @@ JustWifi - Basic debugging callback utils
 
 Copyright (C) 2016-2018 by Xose Pérez <xose dot perez at gmail dot com>
 
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
+The JustWifi 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 program is distributed in the hope that it will be useful,
+The JustWifi 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 General Public License for more details.
+GNU Lesser General Public License for more details.
 
-You should have received a copy of the GNU General Public License
-along with this program.  If not, see <http://www.gnu.org/licenses/>.
+You should have received a copy of the GNU Lesser General Public License
+along with the JustWifi library.  If not, see <http://www.gnu.org/licenses/>.
 
 */
 

diff --git a/examples/smartconfig/smartconfig.ino b/examples/smartconfig/smartconfig.ino
@@ -12,18 +12,18 @@ Compatible apps:
 
 Copyright (C) 2016-2018 by Xose Pérez <xose dot perez at gmail dot com>
 
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
+The JustWifi 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 program is distributed in the hope that it will be useful,
+The JustWifi 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 General Public License for more details.
+GNU Lesser General Public License for more details.
 
-You should have received a copy of the GNU General Public License
-along with this program.  If not, see <http://www.gnu.org/licenses/>.
+You should have received a copy of the GNU Lesser General Public License
+along with the JustWifi library.  If not, see <http://www.gnu.org/licenses/>.
 
 */
 

diff --git a/examples/smartconfig/utils.ino b/examples/smartconfig/utils.ino
@@ -4,18 +4,18 @@ JustWifi - Basic debugging callback utils
 
 Copyright (C) 2016-2018 by Xose Pérez <xose dot perez at gmail dot com>
 
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
+The JustWifi 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 program is distributed in the hope that it will be useful,
+The JustWifi 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 General Public License for more details.
+GNU Lesser General Public License for more details.
 
-You should have received a copy of the GNU General Public License
-along with this program.  If not, see <http://www.gnu.org/licenses/>.
+You should have received a copy of the GNU Lesser General Public License
+along with the JustWifi library.  If not, see <http://www.gnu.org/licenses/>.
 
 */
 

diff --git a/examples/wps/utils.ino b/examples/wps/utils.ino
@@ -4,18 +4,18 @@ JustWifi - Basic debugging callback utils
 
 Copyright (C) 2016-2018 by Xose Pérez <xose dot perez at gmail dot com>
 
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
+The JustWifi 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 program is distributed in the hope that it will be useful,
+The JustWifi 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 General Public License for more details.
+GNU Lesser General Public License for more details.
 
-You should have received a copy of the GNU General Public License
-along with this program.  If not, see <http://www.gnu.org/licenses/>.
+You should have received a copy of the GNU Lesser General Public License
+along with the JustWifi library.  If not, see <http://www.gnu.org/licenses/>.
 
 */
 

diff --git a/examples/wps/wps.ino b/examples/wps/wps.ino
@@ -6,18 +6,18 @@ This example shows how to use connect to a WiFi using WPS.
 
 Copyright (C) 2016-2018 by Xose Pérez <xose dot perez at gmail dot com>
 
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
+The JustWifi 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 program is distributed in the hope that it will be useful,
+The JustWifi 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 General Public License for more details.
+GNU Lesser General Public License for more details.
 
-You should have received a copy of the GNU General Public License
-along with this program.  If not, see <http://www.gnu.org/licenses/>.
+You should have received a copy of the GNU Lesser General Public License
+along with the JustWifi library.  If not, see <http://www.gnu.org/licenses/>.
 
 */
 #include <JustWifi.h>

diff --git a/library.json b/library.json
@@ -7,7 +7,7 @@
         "url": "https://github.com/xoseperez/justwifi.git"
     },
     "version": "2.0.0",
-    "license": "GPL-3.0",
+    "license": "LGPL-3.0",
     "exclude": "tests",
     "frameworks": "arduino",
     "platforms": "espressif8266",

diff --git a/library.properties b/library.properties
@@ -3,7 +3,7 @@ version=2.0.0
 author=Xose Pérez <xose.perez@gmail.com>
 maintainer=Xose Pérez <xose.perez@gmail.com>
 sentence=Wifi Manager for ESP8266
-paragraph=Wifi Manager for ESP8266
+paragraph=
 category=Other
 url=https://github.com/xoseperez/justwifi.git
 architectures=*
diff --git a/src/JustWifi.cpp b/src/JustWifi.cpp
@@ -6,18 +6,18 @@ Wifi Manager for ESP8266
 
 Copyright (C) 2016-2018 by Xose Pérez <xose dot perez at gmail dot com>
 
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
+The JustWifi 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 program is distributed in the hope that it will be useful,
+The JustWifi 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 General Public License for more details.
+GNU Lesser General Public License for more details.
 
-You should have received a copy of the GNU General Public License
-along with this program.  If not, see <http://www.gnu.org/licenses/>.
+You should have received a copy of the GNU Lesser General Public License
+along with the JustWifi library.  If not, see <http://www.gnu.org/licenses/>.
 
 */
 

diff --git a/src/JustWifi.h b/src/JustWifi.h
@@ -6,18 +6,18 @@ Wifi Manager for ESP8266
 
 Copyright (C) 2016-2018 by Xose Pérez <xose dot perez at gmail dot com>
 
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
+The JustWifi 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 program is distributed in the hope that it will be useful,
+The JustWifi 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 General Public License for more details.
+GNU Lesser General Public License for more details.
 
-You should have received a copy of the GNU General Public License
-along with this program.  If not, see <http://www.gnu.org/licenses/>.
+You should have received a copy of the GNU Lesser General Public License
+along with the JustWifi library.  If not, see <http://www.gnu.org/licenses/>.
 
 */