Merge pull request #32 from SEPIA-Framework/dev

v0.24.0;

Author: fquirin

Cordova-Plugin-Versions.txt

@@ -1,35 +1,34 @@
-Android (tested April 2019)
+Android (tested October 2020)
 -----------------------------
-cordova version 7.1.0
-cordova platform version android@6.4.0
+cordova version 9.0.0
+cordova platform version android@8.1.0
 cordova-plugin-inappbrowser		      			custom version from plugin_mods folder
 org.apache.cordova.speech.speechrecognition		custom version from plugin_mods folder
 
 "dependencies": {
-	"com-darryncampbell-cordova-plugin-intent": "^1.1.6",
-    "cordova-android": "^6.4.0",
-    "cordova-android-support-gradle-release": "^3.0.0",
-    "cordova-custom-config": "^5.1.0",
-    "cordova-plugin-badge": "^0.8.8",
-    "cordova-plugin-ble": "^2.0.1",
-    "cordova-plugin-cache-clear": "^1.3.8",
-    "cordova-plugin-compat": "^1.2.0",
-    "cordova-plugin-device": "^2.0.2",
-    "cordova-plugin-eddystone": "^1.3.0",
-    "cordova-plugin-file": "^6.0.1",
-    "cordova-plugin-geolocation": "^4.0.1",
-    "cordova-plugin-inappbrowser": "^3.0.0",
-    "cordova-plugin-insomnia": "git+https://github.com/EddyVerbruggen/Insomnia-PhoneGap-Plugin.git",
-    "cordova-plugin-local-notification": "^0.9.0-beta.2",
-    "cordova-plugin-nativestorage": "^2.3.2",
-    "cordova-plugin-navigationbar-color": "0.0.8",
-    "cordova-plugin-splashscreen": "^5.0.2",
-    "cordova-plugin-statusbar": "^2.4.2",
-    "cordova-plugin-tts": "^0.2.3",
-    "cordova-plugin-whitelist": "^1.3.3",
-    "cordova-universal-links-plugin": "^1.2.1",
-    "es6-promise-plugin": "^4.2.2",
-    "phonegap-plugin-media-stream": "^1.2.1",
-    "speechrecognition": "file:plugin_mods\\speechrecognition\\org.apache.cordova.speech.speechrecognition",
-    "org.apache.cordova.speech.speechrecognition": "plugin_mods/speechrecognition/org.apache.cordova.speech.speechrecognition"
+	"com-darryncampbell-cordova-plugin-intent": "^2.0.0",
+	"cordova-android": "^8.1.0",
+	"cordova-android-support-gradle-release": "^3.0.1",
+	"cordova-custom-config": "^5.1.0",
+	"cordova-plugin-badge": "^0.8.8",
+	"cordova-plugin-ble": "^2.0.1",
+	"cordova-plugin-cache-clear": "^1.3.8",
+	"cordova-plugin-compat": "^1.2.0",
+	"cordova-plugin-device": "^2.0.3",
+	"cordova-plugin-eddystone": "^1.3.0",
+	"cordova-plugin-file": "^6.0.2",
+	"cordova-plugin-geolocation": "^4.0.2",
+	"cordova-plugin-inappbrowser": "^4.0.0",
+	"cordova-plugin-insomnia": "git+https://github.com/tombolaltd/cordova-plugin-insomnia.git",
+	"cordova-plugin-local-notification": "git+https://github.com/timkellypa/cordova-plugin-local-notifications.git",
+	"cordova-plugin-nativestorage": "^2.3.2",
+	"cordova-plugin-navigationbar-color": "0.0.9",
+	"cordova-plugin-splashscreen": "^5.0.4",
+	"cordova-plugin-statusbar": "^2.4.3",
+	"cordova-plugin-tts": "^0.2.3",
+	"cordova-plugin-whitelist": "^1.3.4",
+	"cordova-universal-links-plugin": "git+https://github.com/sepia-assistant/cordova-universal-links-plugin.git",
+	"es6-promise-plugin": "^4.2.2",
+	"phonegap-plugin-media-stream": "^1.2.1",
+	"speechrecognition": "file:plugin_mods/speechrecognition/org.apache.cordova.speech.speechrecognition"
 }

README.md

@@ -27,11 +27,11 @@ Features of the app are:
 
 ### Quick-start
 
-The latest release version is always **online** at: `https://sepia-framework.github.io/app/index.html` (requires server with SSL)  
+The latest release version is **online** at: https://sepia-framework.github.io/app/index.html  
 When you've installed **SEPIA-Home** the default link is: `http://[sepia-home-IP]:20721/app/index.html`  
 The Android app can be installed via the **Google Play Store**: [Play Store link](https://play.google.com/store/apps/details?id=de.bytemind.sepia.app.web)  
 
-Note: If you don't operate your own SEPIA server you can still open the app in "demo-mode" (simply skip the log-in) and look around a bit though most of the features will not be active in this mode.  
+Note: If you don't operate your own SEPIA server you can still open the public app in **demo-mode** (simply skip the log-in) and look around a bit though many of the features will not be available in this mode.  
 More languages for Android and an iOS app are in beta-test phase and will be release "when they are done" :-p  
 
 For experts only: Use the build-scripts in this repository to build your own version of the app (Android and iOS are available).
@@ -42,6 +42,8 @@ You can modify the client configuration via several URL parameters:
 * `host` - SEPIA server host, e.g. IP address or domain + path
 * `lang` - Default language code for client (ISO code)
 * `isApp` - 'true' will change client to behave as if it was an app (not a website), e.g. login tokens will be valid for much longer etc.
+* `pwa` - 'true' will put the app in a PWA (progressive web app) compatible state by enabling the service-worker.
+* `noSW` - 'true' will force disable the service-worker of the page. This might be useful to find issues related to blocked cookies etc.
 * `isTiny` - 'true' will optimize the UI and controls to support small displays (e.g. Apple Watch or 240x240px screens)
 * `isHeadless` or `autoSetup` - Load client settings from file (settings.js) and trigger setup mode if no user is logged in. 'isHeadless' will set some supported client features as well (e.g. don't open browser tabs etc.).
 * `env` - 'environment' setting for client

config.xml

@@ -1,16 +1,16 @@
 <?xml version='1.0' encoding='utf-8'?>
-<widget id="org.example.sepia.app.web" version="0.23.0" xmlns="http://www.w3.org/ns/widgets" xmlns:cdv="http://cordova.apache.org/ns/1.0">
+<widget id="org.example.sepia.app.web" version="0.24.0" xmlns="http://www.w3.org/ns/widgets" xmlns:cdv="http://cordova.apache.org/ns/1.0">
     <name>S.E.P.I.A.</name>
     <description>
-        Prototype of S.E.P.I.A. framework client
+        S.E.P.I.A. framework client app
     </description>
     <author email="[email protected]" href="https://sepia.example.org">
         Name - Organisation
     </author>
 
 	<content src="start.html" />
 
-	<preference name="orientation" value="portrait" />
+	<preference name="orientation" value="default" />
 	<!--<preference name="BackgroundColor" value="0xff000000"/>-->
 
 	<!--plugins-->

create-android-project.sh

@@ -20,6 +20,7 @@ cd $APP_NAME
 sleep 2
 echo "#Adding plugins ..."
 cordova plugin add cordova-plugin-device
+cordova plugin add cordova-plugin-screen-orientation
 cordova plugin add cordova-plugin-geolocation
 cordova plugin add cordova-plugin-inappbrowser
 cordova plugin add cordova-plugin-tts
@@ -76,4 +77,6 @@ mkdir -p "platforms/android/app/src/main/res/values-v21"
 cp -r "resources/themes/android/values-v21/" "platforms/android/app/src/main/res/values-v21/"
 cp -r "resources/config/android/xml/" "platforms/android/app/src/main/res/xml/"
 echo "#DONE"
-echo "If everything worked out fine the next step would be to build the app from the %APP_NAME% folder: cordova build android"
+echo "If everything worked out fine the next step would be to build the app from the %APP_NAME% folder: cordova build android."
+echo "Alternatively just open the project in Android Studio and let Gradle build it."
+echo "If you get Gradle errors try setting 'distributionUrl' version in gradle-wrapper.properties to '4.10.1-all'."

create-ios-project-uiwebview.sh

@@ -19,35 +19,40 @@ cd $APP_NAME
 sleep 2
 echo "#Adding plugins ..."
 cordova plugin add cordova-plugin-device
+cordova plugin add cordova-plugin-screen-orientation
 cordova plugin add cordova-plugin-geolocation
-#cordova plugin add cordova-plugin-inappbrowser
-cordova plugin add cordova-plugin-inappbrowser-wkwebview
-cordova plugin add cordova-plugin-wkwebview-engine
+cordova plugin add cordova-plugin-inappbrowser
+#cordova plugin add cordova-plugin-inappbrowser-wkwebview
+#cordova plugin add cordova-plugin-wkwebview-engine
 cordova plugin add cordova-plugin-tts
 cordova plugin add cordova-plugin-whitelist
 cordova plugin add cordova-universal-links-plugin
 cordova plugin add cordova-plugin-statusbar
-cordova plugin add cordova-plugin-splashscreen
+#cordova plugin add cordova-plugin-splashscreen		#is now part of platform
 #cordova plugin add https://github.com/apache/cordova-plugin-splashscreen.git -- NOTE: use this in case releases are too old
 cordova plugin add cordova-plugin-cache-clear
-cordova plugin add plugin_mods/speechrecognition/org.apache.cordova.speech.speechrecognition
+#TODO: needs complete remake
+#cordova plugin add plugin_mods/speechrecognition/org.apache.cordova.speech.speechrecognition
 #cordova plugin add de.appplant.cordova.plugin.local-notification
 #cordova plugin add plugin_mods/localnotifications/de.appplant.cordova.plugin.local-notification
-cordova plugin add cordova-plugin-local-notification
+#cordova plugin add cordova-plugin-local-notification
+cordova plugin add https://github.com/timkellypa/cordova-plugin-local-notifications
 cordova plugin add cordova-plugin-file
 cordova plugin add cordova-plugin-nativestorage
 cordova plugin add cordova-plugin-audioinput
 cordova plugin add plugin_mods/iosbackgroundaudio/nl.kingsquare.cordova.background-audio
-cordova plugin add https://github.com/EddyVerbruggen/Insomnia-PhoneGap-Plugin.git
+#cordova plugin add https://github.com/EddyVerbruggen/Insomnia-PhoneGap-Plugin.git
+cordova plugin add https://github.com/tombolaltd/cordova-plugin-insomnia.git
 cordova plugin add phonegap-plugin-battery-status
 cordova plugin add cordova-plugin-eddystone
 #
 # overwrite plugin mods
 sleep 2
 echo "#Updating plugins ..."
 cp "plugin_mods/universallinks/xcodePreferences.js" "plugins/cordova-universal-links-plugin/hooks/lib/ios/xcodePreferences.js"
-cp "plugin_mods/inappbrowser/ios/CDVInAppBrowser_wkwv.m" "plugins/cordova-plugin-inappbrowser-wkwebview/src/ios/CDVInAppBrowser.m"
-cp "plugin_mods/inappbrowser/ios/CDVInAppBrowser_wkwv.h" "plugins/cordova-plugin-inappbrowser-wkwebview/src/ios/CDVInAppBrowser.h"
+#TODO: Update WkWebView version
+#cp "plugin_mods/inappbrowser/ios/CDVInAppBrowser_wkwv.m" "plugins/cordova-plugin-inappbrowser-wkwebview/src/ios/CDVInAppBrowser.m"
+#cp "plugin_mods/inappbrowser/ios/CDVInAppBrowser_wkwv.h" "plugins/cordova-plugin-inappbrowser-wkwebview/src/ios/CDVInAppBrowser.h"
 cp "plugin_mods/cacheclear/ios/CacheClear.m" "plugins/cordova-plugin-cache-clear/src/ios/CacheClear.m"
 cp "plugin_mods/tts/ios/CDVTTS.m" "plugins/cordova-plugin-tts/src/ios/CDVTTS.m"
 #
@@ -59,7 +64,7 @@ npm install xcode
 # add ios platform
 sleep 2
 echo "#Adding platform ..."
-cordova platform add ios@5.0.1
+cordova platform add ios@6.1.1
 #
 # prepare build
 echo "#Preparing build ..."

create-ios-project-wkwebview.sh create-ios-project.shcreate-ios-project-wkwebview.sh renamed to create-ios-project.sh

@@ -0,0 +1,7 @@
+## ADD NEW ICON
+
+* Open Android Studio
+* Right click 'app' -> new -> image asset
+* Choose 512x512px icon from 'www/img' folder
+* Choose background color
+* Confirm

plugin_mods/manual_fix_for_android_icon.md

@@ -1,5 +1,9 @@
 ## ADD THE CODE FROM BELOW TO 'SplashScreen.java'
 
+* Open: `src\main\java\org\apache\cordova\splashscreen`
+* Go to approx. line 315
+* Do code change described below
+
 ```
 // Create and show the dialog
 splashDialog = new Dialog(context, android.R.style.Theme_Translucent_NoTitleBar);

plugin_mods/manual_fix_for_splashscreen.md

@@ -67,7 +67,7 @@ public void onRequestPermissionResult(int requestCode, String[] permissions,
         {
             if(r == PackageManager.PERMISSION_DENIED)
             {
-                fireErrorEvent();
+                fireErrorEvent(SpeechRecognizer.ERROR_INSUFFICIENT_PERMISSIONS);
                 fireEvent("end");
                 return;
             }
@@ -250,10 +250,22 @@ private void fireEvent(String type) {
         this.speechRecognizerCallbackContext.sendPluginResult(pr); 
     }
 
-    private void fireErrorEvent() {
+    private void fireErrorEvent(int code) {
         JSONObject event = new JSONObject();
         try {
             event.put("type","error");
+            event.put("code", code);
+            if (code == SpeechRecognizer.ERROR_NO_MATCH || code == SpeechRecognizer.ERROR_SPEECH_TIMEOUT){
+                event.put("error", "no-speech");
+            }else if (code == SpeechRecognizer.ERROR_INSUFFICIENT_PERMISSIONS){
+                event.put("error", "not-allowed");
+            }else if (code == SpeechRecognizer.ERROR_SERVER){
+                event.put("error", "speech server");
+            }else if (code == SpeechRecognizer.ERROR_NETWORK || code == SpeechRecognizer.ERROR_NETWORK_TIMEOUT){
+                event.put("error", "network");
+            }else{
+                event.put("error", "code: " + code);
+            }
         } catch (JSONException e) {
             // this will never happen
         }
@@ -295,7 +307,7 @@ public void onEndOfSpeech() {
         public void onError(int error) {
             Log.d(LOG_TAG, "error speech "+error);
             if (listening || error == 9) {
-                fireErrorEvent();
+                fireErrorEvent(error);
                 fireEvent("end");
             }
             listening = false;

plugin_mods/speechrecognition/org.apache.cordova.speech.speechrecognition/src/android/SpeechRecognition.java

@@ -19,6 +19,7 @@ REM add plugins
 sleep 2
 echo "#Adding plugins ..."
 cordova plugin add cordova-plugin-device |more
+cordova plugin add cordova-plugin-screen-orientation |more
 cordova plugin add cordova-plugin-geolocation |more
 cordova plugin add cordova-plugin-inappbrowser |more
 cordova plugin add cordova-plugin-tts |more
@@ -72,5 +73,7 @@ xcopy "resources\themes\android\values" "platforms\android\app\src\main\res\valu
 xcopy "resources\themes\android\values-v21" "platforms\android\app\src\main\res\values-v21" /i |more
 xcopy "resources\config\android\xml" "platforms\android\app\src\main\res\xml" /i |more
 echo "#DONE"
-echo "If everything worked out fine the next step would be to build the app from the %APP_NAME% folder: cordova build android"
+echo "If everything worked out fine the next step would be to build the app from the %APP_NAME% folder: cordova build android."
+echo "Alternatively just open the project in Android Studio and let Gradle build it."
+echo "If you get Gradle errors try setting 'distributionUrl' version in gradle-wrapper.properties to '4.10.1-all'."
 pause