From 2b667549976cf85cda67d34787382a0e6b44dd1c Mon Sep 17 00:00:00 2001 From: Calvin <56485508+CalvinSchwartz@users.noreply.github.com> Date: Tue, 23 Feb 2021 20:39:18 +0100 Subject: [PATCH] Update Documentation (#1162) * Add information on WLED to documentation Add information how to force max brightness in WLED. See Issue #1101 * Translated Installation.md to german Translation and added short instructions to WIN 10 installation. * Removed Typo * Added Windows 10 instructions * Update Installation.md --- docs/docs/de/user/Installation.md | 57 +++++++++++++++++++++++++++++++ docs/docs/en/user/Installation.md | 11 +++++- docs/docs/en/user/LedDevices.md | 5 ++- 3 files changed, 71 insertions(+), 2 deletions(-) create mode 100644 docs/docs/de/user/Installation.md diff --git a/docs/docs/de/user/Installation.md b/docs/docs/de/user/Installation.md new file mode 100644 index 00000000..fee10910 --- /dev/null +++ b/docs/docs/de/user/Installation.md @@ -0,0 +1,57 @@ +# Installiere Hyperion +Hyperion unterstützt zahlreiche Plattformen zur Installation und wird als Paket oder .zip bereitgestellt. + +## Voraussetzungen + +### Unterstützte Systeme + * Raspberry Pi (Siehe [HyperBian](/en/user/HyperBian), derzeit nur auf Englisch) + * Debian 9 | Ubuntu 16.04 oder neuer + * Mac OS + * Windows 10 + +**Einige arm Geräte haben eine reduzierte Untersützung der Funktion des mitschneidens des Bildschirms** + +### Unterstützte Browser +Hyperion wird durch ein Web Interface konfiguriert und gesteuert. + * Chrome 47+ + * Firefox 43+ + * Opera 34+ + * Safari 9.1+ + * Microsoft Edge 14+ + +::: warnung Internet Explorer +Internet Explorer ist nicht unterstützt. +::: + +## Installation von Hyperion + * Raspberry Pi man kann [HyperBian](/en/user/HyperBian.md) für ein neues System nutzen. Alternativ kann es auf einem bestehenden System installiert werden + * Wir stellen Installationspakete (.deb) bereit um Hyperion mit nur einem Klick auf Debian/Ubuntu basierten Systemen zu installieren. + * Mac OSX - derzeit nur eine Zip-Datei mit Binärdaten + * Windows 10 - Lade die Windows-AMD.64.exe von der [Release page](https://github.com/hyperion-project/hyperion.ng/releases) herunter und installiere es. + +### Debian/Ubuntu +Für Debian/Ubuntu stellen wir eine .deb Datei bereit. Damit geschieht die Installation automatisch. \ +Lade die Datei von der [Release page](https://github.com/hyperion-project/hyperion.ng/releases) herunter. \ +Installiere über die Kommandozeile indem du \ +`sudo apt install ./Hyperion-2.0.0-Linux-x86_64.deb` \ +eintippst. Hyperion kann jetzt über das Startmenü gestartet werden. + +### Fedora +Für Fedora stellen wir eine .rpm Datei bereit. Damit geschieht die Installation automatisch. \ +Lade die Datei von der [Release page](https://github.com/hyperion-project/hyperion.ng/releases) herunter. \ +Installiere über die Kommandozeile indem du \ +`sudo dnf install ./Hyperion-2.0.0-Linux-x86_64.rpm` \ +eintippst. Hyperion kann jetzt über das Startmenü gestartet werden. + +### Windows 10 +Für Windows 10 stellen wir eine .exe Datei bereit. Damit geschieht die Installation automatisch. \ +Lade die Datei von der [Release page](https://github.com/hyperion-project/hyperion.ng/releases) herunter. \ +Installiere über das ausführen der .exe Datei. Hyperion kann jetzt über das Startmenü gestartet werden. + +## Deinstallieren von Hyperion +In Debian/Ubuntu kann man Hyperion mit diesem Kommando deinstallieren \ +`sudo apt remove hyperion` \ +In Windows erfolgt die Deinstallation über die Systemsteuerung. + +### Hyperion lokale Daten +Hyperion speichert lokale Daten in dem "Home"-Ordner (Ordner `.hyperion`). diff --git a/docs/docs/en/user/Installation.md b/docs/docs/en/user/Installation.md index f09a45c0..2b3a5b57 100644 --- a/docs/docs/en/user/Installation.md +++ b/docs/docs/en/user/Installation.md @@ -7,6 +7,7 @@ Hyperion supports various platforms for installation, as package or portable .zi * Raspberry Pi (See also [HyperBian](/en/user/HyperBian)) * Debian 9 | Ubuntu 16.04 or higher * Mac OS + * Windows 10 **Please note that some arm devices have limited support in terms of screen capturing** @@ -26,6 +27,7 @@ Internet Explorer is not supported * Raspberry Pi you can use [HyperBian](/en/user/HyperBian.md) for a fresh start. Or use the install system * We provide installation packages (.deb) to install Hyperion with a single click on Debian/Ubuntu based systems. * Mac OSX - currently just a zip file with the binary + * Windows 10 you can use the .exe file from [Release page](https://github.com/hyperion-project/hyperion.ng/releases) for a single click installation. ### Debian/Ubuntu For Debian/Ubuntu we provide a .deb file. A one click installation package that does the job for you. \ @@ -41,9 +43,16 @@ Install from commandline by typing. \ `sudo dnf install ./Hyperion-2.0.0-Linux-x86_64.rpm` \ Hyperion can be now started from your start menu. +### Windows 10 +For Windows 10 we provide a .exe file. A one click installation package that does the job for you. \ +Download the file from the [Release page](https://github.com/hyperion-project/hyperion.ng/releases) \ +Install by executing the file. \ +After following the instructions Hyperion can be now started from your start menu. + ## Uninstall Hyperion On Debian/Ubuntu you can remove Hyperion with this command \ -`sudo apt remove hyperion` \ +`sudo apt remove hyperion`\ +On Windows 10 Hyperion can be removed using the Windows 10 "Programs and Features" settings. ### Hyperion user data Hyperion stores user data inside your home directory (folder `.hyperion`). diff --git a/docs/docs/en/user/LedDevices.md b/docs/docs/en/user/LedDevices.md index ddeb1139..2b782267 100644 --- a/docs/docs/en/user/LedDevices.md +++ b/docs/docs/en/user/LedDevices.md @@ -56,7 +56,7 @@ Most used because it's cheap and easy! An Arduino powered by an adalight sketch. #### tpm2 ### Network -Hue bridges, nodeMCU, AtmoOrbs everything that is reachable over network. +Hue bridges, nodeMCU, AtmoOrbs, [WLED](https://github.com/Aircoookie/WLED) everything that is reachable over network. #### philipshue The well known [Philips Hue Bridge + Bulbs](https://www.amazon.com/s/ref=nb_sb_noss?url=search-alias%3Daps&field-keywords=philips+hue+starter+set&rh=i%3Aaps%2Ck%3Aphilips+hue+starter+set&tag=hyperionpro05-20) is supported. How to configure them with Hyperion? Checkout: Web configuration @@ -147,6 +147,9 @@ Hyperion cannot be held liable for any foreseeable, or unforeseeable, negative o * Brightness compensation influences the brightness across different color (Adjust at the color section) * To enable/disable the bridge control from Hyperion, disable Hyperion or just the led hardware component. The previous lamp state will be recovered +#### WLED +WLED is connected to Hyperion by selecting the "Controller type" als WLED and entering the IP-Adress of your WLED instance in the Hyperion UI.\ +Hyperion uses the brightness setting set in WLED. E.g. if you set the brightness in WLED to 10% the LEDs will light up to a maximum of 10%. If you would like Hyperion to override the brightness setting of WLED and use the maximum brightness you can do so by going to the WLED configuration -> Sync. Settings and enabling "Force max brightness". #### atmoorb #### tpm2net #### udpe131