Merge pull request #26 from SEPIA-Framework/dev

SEPIA-Home v2.6.1 and DIY client release packages

Author: fquirin

CHANGELOG.md

@@ -1,5 +1,69 @@
 ## Release history and changelog
 
+### v2.6.1 - 2022.01.30
+
+Updated client to v0.24.1:
+* Added support for new 'shared-access' permissions and new settings page to allow other users limited access to specific devices and remote-actions
+* Added new 'remote media player' buttons to quickly control media on other clients (start, stop, skip)
+* Added support for Porcupine 2.0 and custom wake-words. Create wake-words via Porcupine console and use with free-tier access key + updated wake-word settings page
+* Updated web-audio lib and speech module to respond a bit more snappy and better handle timeouts, connection issues and no-speech events
+* Updated CLEXI client to v0.9.0 and introduced GPIO interface to control for example LED arrays or read hardware buttons + added "clexiGpioInterface" section to settings.js
+* Added remote terminal functions (CLEXI) to set/get/test microphone (gain, mictest) + added new debug page to STT settings
+* Implemented 'Config.appRegionCode' to enable region specific service actions for same languages
+* Improved avatar and app styles for example to better indicate wake-word activate state
+* Updated input-controls view and improved Bluetooth BLE beacon security with "known addresses" check 
+* New skins: 'Funky Sunrise' and 'The Vectors'
+* Improved landscape, big-screen and tiny mode + better handling of screen-size changes
+* Send optional 'info.data' to frame functions 'onOpen' and 'onFinishSetup'
+* Android: Updated app to meet the new Play Store requirements and adapt to Android 11 intent restrictions. NOTE: Some custom intents might not be allowed anymore :-/.
+* Fixed a bug that made expired timers disappear and return in UI unwantedly
+* Added new 'hasTouch' URL parameter to force touch-UI tweaks
+* Smaller bug fixes and tweaks
+
+Updated Control-HUB (admin-tools) to v1.4.2:
+* Improved look, added skin support + new "light" skin and choose dark/light skin according to browser settings
+* Added support for new 'raw' field to custom 'set-cmds' in smart-home page (device cards)
+* Updated CLEXI client to v0.9.0 and added support for GPIO interface (read hardware buttons, control LEDs)
+* Updated CLEXI help pop-up (remote terminal commands) to include new microphone settings and test functions
+
+Updated Assist-server to v2.6.0:
+* Introduced new 'shared-access' permission settings for accounts
+* Allow 'receiver' field for remote-actions + check shared permissions when sending action to other user
+* Created 'GeneralValue' parameter ("set AB to value XY") and implemented it to improve smart-home service (this will allow more general support for device-specific input)
+* Introduced new 'Xtensions/TTS/settings.json' to configure TTS voices, improved setup and added MBROLA voices support
+* Improved TTS pre-processing (e.g. better output for times)
+* Reorganized and optimized geo-coder code and implemented Graphhopper API for geo-coding, location and directions search in addition to Google Maps
+* Improved location parameter and points-of-interest (POI) search
+* Make Youtube API url configurable (e.g. to use custom search)
+* Updated smart-home Test-HUB to include more devices
+* Added new 'setCustomTriggerExcludeRegX' method for services to better handle sentences that should NOT match your service
+* Added Porcupine 2.0 files (WASM and keywords)
+* Updated core tools to v2.2.10
+* Bug fixes and smaller tweaks
+
+Updated WebSocket Chat-Server to v1.3.3:
+* Added support for new 'sharedAccess' feature to manage and allow remote-actions between users
+* Added endpoint 'refreshClientConnections' to trigger automatic client connection refresh (disconnect -> reconnect)
+* Updated core tools to v2.2.10
+* Smaller improvements
+
+Updated Teach-Server to v2.2.3:
+* Improved 'common.json' Teach-UI texts and configuration and added 'general_value' to smart-home command
+* Updated core tools to v2.2.10
+* Smaller fixes
+
+Updated Core-tools to v2.2.10:
+* Added support for 'sharedAccess' field in user account
+* Improved 'Connectors.apacheHttpGET' to be a bit more strict with timeouts and reconnects and to allow more custom settings
+* Updated 'PARAMETERS' class to include new 'GENERAL_VALUE' parameter
+
+Other servers, tools and common changes:
+* Improved most of the SEPIA-Home install, setup and run scripts (including self-signed SSL certificate generation and handling)
+* Improved DIY client (installation, logging, features like LED controls etc.)
+* Added SEPIA offline STT-Server install scripts (Linux) to SEPIA-Home and DIY client folders to get started more easily
+* Adjusted server and DIY client for better compatability with Debian 11/Raspberry Pi OS Bullseye
+* In preparation: Updated SDK and Docker demo containers
+
 ### v2.6.0 - 2021.10.10
 
 Updated client to v0.24.0:

Dockerfile

@@ -35,6 +35,9 @@ RUN echo 'Installing SEPIA-Home...' && \
 #
 # ENV JAVA_HOME="/usr/lib/jvm/java-11-openjdk-amd64"
 # ENV PATH="${JAVA_HOME}:${PATH}"
+#
+# Set a Docker ENV to identify container in scripts
+ENV ISDOCKER="true"
 
 # Download SEPIA-Home (custom-bundle, single-server, SBC version)
 

README.md

@@ -13,13 +13,19 @@ NOTE: Setup and scripts included in this bundle assume you are using the framewo
 
 ## Quick start
 
-If you are using Raspian for Raspberry Pi check out the more detailed [guide](https://github.com/SEPIA-Framework/sepia-docs/wiki/Installation) including an installation script.  
+If you are using a **Raspberry Pi** check out the more detailed [guide](https://github.com/SEPIA-Framework/sepia-docs/wiki/Installation).  
+The easiest way to get started is to use the setup script and follow the instructions (optimized for Raspberry Pi OS but any Debian based Linux might work):  
+```
+wget https://sepia-framework.github.io/install/sepia-home-rpi.sh
+bash sepia-home-rpi.sh
+```
 
-* Make sure you have Java JDK 11 installed (recommended: OpenJDK 11). [Oracle Java JDK 8](https://www.oracle.com/java/technologies/downloads/#java8-windows) will work as well.
-* Optional (Linux): Update your local clock for precise timers, e.g. (Debian): `sudo timedatectl set-ntp true`
+Installation without script (any platform):
+* Make sure you have **Java JDK 11** installed (Java 8 will work as well, for now). For Debian Linux use `sudo apt-get install openjdk-11-jdk-headless`, for other platforms check [Eclipse's Adoptium Project](https://adoptium.net/index.html?variant=openjdk11).
 * Place the content of the [SEPIA-Home bundle](https://github.com/SEPIA-Framework/sepia-installation-and-setup/releases) in any folder you like. On Linux "~/SEPIA/" (no root!) is highly recommended if you want to use the boot and SSL scripts later: `unzip SEPIA-Home.zip -d ~/SEPIA`.
 * Run `setup.bat` (Windows) or `bash setup.sh` (Mac, Linux) to setup your SEPIA servers
 * Inside the setup choose 4 to start Elasticsearch and then 1 to setup the SEPIA-Framework. Remember the passwords you set! Optionally install the TTS engine (recommended for Linux). You can skip the other options for now.
+* Optional (Linux): Update your local clock for precise timers, e.g. (Debian): `sudo timedatectl set-ntp true`
 * If everything worked out (check console for errors) you can use "run-sepia" (.bat for Windows, .sh for Linux/Mac) to start all servers.
 * The run-script will ping the servers to see if everything started as planned. You can repeat this test with test-cluster.bat/test-cluster.sh to make sure. If you see errors check sepia-*/log.out.
 * You should be able to reach the web-app of SEPIA via one of the URLs suggested at the end of the run-script, e.g.: http://localhost:20721/app/index.html (replace 'localhost' with the server IP if you are on a different machine).
@@ -32,7 +38,7 @@ to your browser as well :-) see [this guide](https://github.com/SEPIA-Framework/
 
 ## Next steps
 
-If your local tests worked well it is time to create your own (non-admin) account:
+If your local tests worked well it is time to **create your own (non-admin) account**:
 
 * To create new users ([detailed tutorial](https://github.com/SEPIA-Framework/sepia-docs/wiki/Create-and-Edit-Users)) use the SEPIA Control-HUB (aka tools page or admin-tools): http://localhost:20721/tools/index.html (registration via 'real' e-mail is possible in theory but not fully implemented in the clients right now).
 * Login to the Control-HUB using your admin account. By extending the login-box you can check if the right server for authentication is selected (very similar to the hostname above) it should look like this 'http://localhost:20721' or this 'http://192.168.0.10:20721' for example.
@@ -41,9 +47,23 @@ If your local tests worked well it is time to create your own (non-admin) accoun
 
 ## Secure server
 
-Creating your own web-server with SSL encryption will make sure that you can use all features of the app without problems and will also make your server reachable from outside your network (e.g. when you're using the mobile app and want to check your shopping-list inside a supermarket).
-To upgrade you local server to a full-blown web-server with SSL it is recommended to use [Nginx](https://de.wikipedia.org/wiki/Nginx) and [Letsencrypt](https://letsencrypt.org/). There are some scripts included in the SEPIA-Home release to make your life easier.
-To get started check the Wiki entry about [how to secure your server, use all features and open it to the world](https://github.com/SEPIA-Framework/sepia-docs/wiki/SSL-for-your-Server).  
+Creating your own web-server with **SSL encryption** will make sure that you can use all features of the app without problems via **HTTPS**. There are 2 major options supported via SEPIA setup scripts:
+* Self-signed SSL with non-SSL fallback to secure your private network. **Recommended** if you're planning to use SEPIA inside your home.
+* [Letsencrypt](https://letsencrypt.org/) SSL with a dynamic DNS provider (e.g. Duck-DNS). This will make your server reachable from outside your network (e.g. when you're using the mobile app and want to check your shopping-list inside a supermarket) and give you "official" SSL certificates.
+
+To get started you can use the [Nginx](https://de.wikipedia.org/wiki/Nginx) setups script in your SEPIA folder: `bash setup-nginx.sh`.  
+To learn more about SSL setup check the SEPIA-Wiki entry: [how to secure your server, use all features and open it to the world](https://github.com/SEPIA-Framework/sepia-docs/wiki/SSL-for-your-Server).  
+
+# SEPIA DIY Client - Raspberry Pi Smart-Speaker, Smart-Display etc.
+
+When you've successfully installed SEPIA-Home you can use the web-based SEPIA-Client right away from your [web browser or via the official app](https://github.com/SEPIA-Framework/sepia-html-client-app#quick-start), but there is more ^^.  
+Check out the [DIY section](sepia-client-installation) to find out about custom clients.
+
+# Other SEPIA Projects
+
+* [SEPIA STT Server](https://github.com/SEPIA-Framework/sepia-stt-server) - Offline speech-recognition server with customizable language models
+* [micro:bit Bluetooth remote](sepia-microbit-projects) - BLE beacon based remote for SEPIA client to trigger microphone and other controls
+* There is much more to discover, just browse the project pages ;-)
 
 ## Build-your-own release (for experts)
 

scripts/install-environment-raspbian.sh

@@ -1,117 +1,8 @@
 #!/bin/sh
-set -e
-get_latest_release() {
-	curl --silent "https://api.github.com/repos/$1/releases/latest" | # Get latest release from GitHub api
-		grep '"tag_name":' |                                          # Get tag line
-		sed -E 's/.*"([^"]+)".*/\1/'                                  # Pluck JSON value
-}
-echo "Welcome! Checking version number of latest SEPIA release, just a second ..."
-SEPIA_VERSION=$(get_latest_release "SEPIA-Framework/sepia-installation-and-setup")
-echo "Latest SEPIA-Home version is: $SEPIA_VERSION"
-echo ""
-echo "Welcome to the SEPIA-Framework!"
-echo ""
-echo "This little script will help you to setup your environment and download SEPIA-Home (the server stack of SEPIA)."
-echo "If you are using a fresh Raspbian installation please follow steps 1 to 4 and make sure they complete successfully."
-echo "If you know what you are doing feel free to skip some steps as needed ;-)"
-echo "More help can be found here: https://github.com/SEPIA-Framework/sepia-docs/wiki"
-echo ""
-echo "Tested with: Raspian Buster (30-01-2020)"
-while true; do
-	echo ""
-	echo "Please choose next step:"
-	echo "1: Install Java OpenJDK 11 globally (alternative: download SEPIA-Home first and use local Java installation)"
-	echo "2: Install required packages and update server-clock for precise timers"
-	echo "3: Download SEPIA-Home bundle version: $SEPIA_VERSION"
-	echo "4: Extract SEPIA-Home to '~/SEPIA' (currently required home folder for SEPIA)"
-	echo "5: Optional: Install NGINX reverse-proxy (recommended alternative to SEPIA Reverse-Proxy)"
-	echo "6: Optional: Download and deploy NGINX proxy config for SEPIA"
-	echo ""
-	read -p "Enter a number plz (0 to exit): " option
-	echo ""
-	if [ $option = "0" ]
-	then
-		break
-	elif [ $option = "1" ]
-	then
-		# INSTALL JAVA OPENJDK 11
-		sudo apt-get update
-		sudo apt-get install -y openjdk-11-jdk-headless ca-certificates-java
-		echo "------------------------"
-		echo "DONE."
-		java -version
-		echo "------------------------"
-	
-	elif [ $option = "2" ] 
-	then
-		# INSTALL zip, unzip, curl, procps, etc.
-		sudo apt-get install -y zip unzip curl procps ca-certificates espeak-ng espeak-ng-espeak
-		
-		# UPDATE TIME SYNC
-		echo 'Installing ntpdate to sync time ...'
-		sudo apt-get install -y ntpdate
-		sudo ntpdate -u ntp.ubuntu.com
-		echo "------------------------"
-		echo "DONE."
-		echo "------------------------"
+#
+# TODO: redirect to new script and show info message 'moved and improved'
+#
+echo "This script has been moved and improved! Please use:"
+echo "wget https://sepia-framework.github.io/install/sepia-home-rpi.sh"
+echo "bash sepia-home-rpi.sh"
 
-	elif [ $option = "3" ] 
-	then
-		# DOWNLOAD SEPIA Custom-Bundle
-
-		#create tmp folder (usually done before getting this file)
-		mkdir -p ~/SEPIA/tmp
-		cd ~/SEPIA/tmp
-		#curl --silent "https://api.github.com/repos/SEPIA-Framework/sepia-installation-and-setup/releases/latest" | jq -r '.assets[] | select(.name == "SEPIA-Home.zip").browser_download_url'
-		#wget "https://github.com/SEPIA-Framework/sepia-installation-and-setup/releases/download/${SEPIA_VERSION}/SEPIA-Home.zip"
-		wget "https://github.com/SEPIA-Framework/sepia-installation-and-setup/releases/latest/download/SEPIA-Home.zip"
-		echo "------------------------"
-		echo "DONE."
-		echo "------------------------"
-
-	elif [ $option = "4" ] 
-	then
-		# EXTRACT SEPIA-Home bundle
-		
-		cd ~/SEPIA/tmp
-		unzip SEPIA-Home.zip -d ~/SEPIA
-		
-		# SET SCRIPT ACCESS AND DONE
-		
-		#set scripts access
-		cd ~/SEPIA
-		find . -name "*.sh" -exec chmod +x {} \;
-		chmod +x elasticsearch/bin/elasticsearch
-		
-		#done
-		echo ""
-		echo "------------------------"
-		echo "DONE :-) If you saw no errors you can exit now and continue with 'cd ~/SEPIA' and 'bash setup.sh'".
-		echo "------------------------"
-
-	elif [ $option = "5" ] 
-	then
-		# INSTALL NGINX
-
-		echo 'Installing nginx reverse-proxy ...'
-		sudo apt-get install software-properties-common
-		sudo apt-get install nginx
-		echo "------------------------"
-		echo "DONE."
-		echo "------------------------"
-
-	elif [ $option = "6" ] 
-	then
-		# INSTALL NGINX HTTP CONFIG FOR SEPIA
-
-		#echo 'Downloading nginx reverse-proxy HTTP config for SEPIA ...'
-		echo "------------------------"
-		echo "UNDER CONSTRUCTION - For now please run 'bash setup-nginx.sh' inside your SEPIA-Home folder"
-		echo "------------------------"
-
-	else
-		echo "------------------------"
-		echo "Not an option, please try again."
-		echo "------------------------"
-	fi
-done