Update readme

chkr1011 · Apr 8, 2017 · a7753bc · a7753bc
1 parent a17bcac
commit a7753bc
Show file tree

Hide file tree

Showing 72 changed files with 17 additions and 26 deletions.
diff --git a/Documentation/Screens/1.0.0/App_Bedroom_1.PNG b/Documentation/Screens/1.0.0/App_Bedroom_1.PNG
diff --git a/Documentation/Screens/1.0.0/App_Bedroom_2.PNG b/Documentation/Screens/1.0.0/App_Bedroom_2.PNG
diff --git a/Documentation/Screens/1.0.0/App_Office.PNG b/Documentation/Screens/1.0.0/App_Office.PNG
diff --git a/Documentation/Screens/1.0.0/App_ReadingRoom.PNG b/Documentation/Screens/1.0.0/App_ReadingRoom.PNG
diff --git a/Documentation/Screens/1.0.0/App_Splash.PNG b/Documentation/Screens/1.0.0/App_Splash.PNG
diff --git a/Documentation/Screens/1.0.0/App_WindowsOverview.PNG b/Documentation/Screens/1.0.0/App_WindowsOverview.PNG
diff --git a/Documentation/Screens/1.11.0/MC_ActuatorConfiguration.png b/Documentation/Screens/1.11.0/MC_ActuatorConfiguration.png
diff --git a/Documentation/Screens/1.11.0/MC_AutomationConfiguration.png b/Documentation/Screens/1.11.0/MC_AutomationConfiguration.png
diff --git a/Documentation/Screens/1.11.0/MC_ControllerSelection.png b/Documentation/Screens/1.11.0/MC_ControllerSelection.png
diff --git a/Documentation/Screens/1.11.0/MC_HomeScreen.png b/Documentation/Screens/1.11.0/MC_HomeScreen.png
diff --git a/Documentation/Screens/1.11.0/MC_SplashScreen.png b/Documentation/Screens/1.11.0/MC_SplashScreen.png
diff --git a/Documentation/Screens/1.11.0/MC_TraceViewer.png b/Documentation/Screens/1.11.0/MC_TraceViewer.png
diff --git a/Documentation/Screens/1.11.0/WA_Areas.PNG b/Documentation/Screens/1.11.0/WA_Areas.PNG
diff --git a/Documentation/Screens/1.11.0/WA_Bathroom.PNG b/Documentation/Screens/1.11.0/WA_Bathroom.PNG
diff --git a/Documentation/Screens/1.11.0/WA_Bedroom-1.PNG b/Documentation/Screens/1.11.0/WA_Bedroom-1.PNG
diff --git a/Documentation/Screens/1.11.0/WA_Bedroom-2.PNG b/Documentation/Screens/1.11.0/WA_Bedroom-2.PNG
diff --git a/Documentation/Screens/1.11.0/WA_Info.PNG b/Documentation/Screens/1.11.0/WA_Info.PNG
diff --git a/Documentation/Screens/1.11.0/WA_SensorsOverview.PNG b/Documentation/Screens/1.11.0/WA_SensorsOverview.PNG
diff --git a/Documentation/Screens/1.11.0/WA_SplashScreen.PNG b/Documentation/Screens/1.11.0/WA_SplashScreen.PNG
diff --git a/Documentation/Screens/1.11.0/WA_Storeroom.PNG b/Documentation/Screens/1.11.0/WA_Storeroom.PNG
diff --git a/Documentation/Screens/1.11.0/WA_WeatherStation.PNG b/Documentation/Screens/1.11.0/WA_WeatherStation.PNG
diff --git a/Documentation/Screens/1.11.0/WA_WindowOverview.PNG b/Documentation/Screens/1.11.0/WA_WindowOverview.PNG
diff --git a/Documentation/Screens/1.12.0/MC_Automation.png b/Documentation/Screens/1.12.0/MC_Automation.png
diff --git a/Documentation/Screens/1.12.0/MC_Component.png b/Documentation/Screens/1.12.0/MC_Component.png
diff --git a/Documentation/Screens/1.12.0/MC_Controller.png b/Documentation/Screens/1.12.0/MC_Controller.png
diff --git a/Documentation/Screens/1.12.0/MC_Home.png b/Documentation/Screens/1.12.0/MC_Home.png
diff --git a/Documentation/Screens/1.12.0/MC_Log.png b/Documentation/Screens/1.12.0/MC_Log.png
diff --git a/Documentation/Screens/1.12.0/MC_WeatherStation.png b/Documentation/Screens/1.12.0/MC_WeatherStation.png
diff --git a/Documentation/Screens/1.12.0/PA_Debug.PNG b/Documentation/Screens/1.12.0/PA_Debug.PNG
diff --git a/Documentation/Screens/1.12.0/PA_RollerShutterAndTemperature.PNG b/Documentation/Screens/1.12.0/PA_RollerShutterAndTemperature.PNG
diff --git a/Documentation/Screens/1.12.0/PA_WeatherAndWindowsAndLight.PNG b/Documentation/Screens/1.12.0/PA_WeatherAndWindowsAndLight.PNG
diff --git a/Documentation/Screens/1.12.0/SplashScreen.png b/Documentation/Screens/1.12.0/SplashScreen.png
diff --git a/Documentation/Screens/1.13.0/SplashScreen.png b/Documentation/Screens/1.13.0/SplashScreen.png
diff --git a/Documentation/Screens/1.14.0B1/SplashScreen.png b/Documentation/Screens/1.14.0B1/SplashScreen.png
diff --git a/Documentation/Screens/Alpha/BoardStatus.png b/Documentation/Screens/Alpha/BoardStatus.png
diff --git a/Documentation/Screens/Alpha/Events.png b/Documentation/Screens/Alpha/Events.png
diff --git a/Documentation/Screens/Alpha/Main.png b/Documentation/Screens/Alpha/Main.png
diff --git a/Documentation/Screens/Alpha/Panda Memory.png b/Documentation/Screens/Alpha/Panda Memory.png
diff --git a/Documentation/Screens/Alpha/Screen 1.png b/Documentation/Screens/Alpha/Screen 1.png
diff --git a/Documentation/Screens/Alpha/TemperatureStatus.png b/Documentation/Screens/Alpha/TemperatureStatus.png
diff --git a/...tation/Images/AlternativeInstallation.jpg → Media/Images/AlternativeInstallation.jpg b/...tation/Images/AlternativeInstallation.jpg → Media/Images/AlternativeInstallation.jpg
diff --git a/Documentation/Images/Echo.jpg → Media/Images/Echo.jpg b/Documentation/Images/Echo.jpg → Media/Images/Echo.jpg
diff --git a/Documentation/Images/HSPE16.jpg → Media/Images/HSPE16.jpg b/Documentation/Images/HSPE16.jpg → Media/Images/HSPE16.jpg
diff --git a/Documentation/Images/HSRel5.jpg → Media/Images/HSRel5.jpg b/Documentation/Images/HSRel5.jpg → Media/Images/HSRel5.jpg
diff --git a/...mentation/Images/InstallationOverview.png → Media/Images/InstallationOverview.png b/...mentation/Images/InstallationOverview.png → Media/Images/InstallationOverview.png
diff --git a/Documentation/Images/LPD.jpg → Media/Images/LPD.jpg b/Documentation/Images/LPD.jpg → Media/Images/LPD.jpg
diff --git a/Documentation/Images/Live/Lamps1.JPG → Media/Images/Live/Lamps1.JPG b/Documentation/Images/Live/Lamps1.JPG → Media/Images/Live/Lamps1.JPG
diff --git a/Documentation/Images/Live/Lamps2.JPG → Media/Images/Live/Lamps2.JPG b/Documentation/Images/Live/Lamps2.JPG → Media/Images/Live/Lamps2.JPG
diff --git a/Documentation/Images/Live/MotionDetector.JPG → Media/Images/Live/MotionDetector.JPG b/Documentation/Images/Live/MotionDetector.JPG → Media/Images/Live/MotionDetector.JPG
diff --git a/Documentation/Images/Live/PD.jpg → Media/Images/Live/PD.jpg b/Documentation/Images/Live/PD.jpg → Media/Images/Live/PD.jpg
diff --git a/Documentation/Images/Live/RoomSensorCase.JPG → Media/Images/Live/RoomSensorCase.JPG b/Documentation/Images/Live/RoomSensorCase.JPG → Media/Images/Live/RoomSensorCase.JPG
diff --git a/Documentation/Images/Live/Terminal.jpg → Media/Images/Live/Terminal.jpg b/Documentation/Images/Live/Terminal.jpg → Media/Images/Live/Terminal.jpg
diff --git a/Documentation/Images/Logo_256.png → Media/Images/Logo_256.png b/Documentation/Images/Logo_256.png → Media/Images/Logo_256.png
diff --git a/Documentation/Images/Overview1.png → Media/Images/Overview1.png b/Documentation/Images/Overview1.png → Media/Images/Overview1.png
diff --git a/...tation/Images/Overview1_WithoutHeader.png → Media/Images/Overview1_WithoutHeader.png b/...tation/Images/Overview1_WithoutHeader.png → Media/Images/Overview1_WithoutHeader.png
diff --git a/Documentation/Images/Overview2.png → Media/Images/Overview2.png b/Documentation/Images/Overview2.png → Media/Images/Overview2.png
diff --git a/Documentation/Images/OverviewWithApp.png → Media/Images/OverviewWithApp.png b/Documentation/Images/OverviewWithApp.png → Media/Images/OverviewWithApp.png
diff --git a/Documentation/Images/Overview_4to3.png → Media/Images/Overview_4to3.png b/Documentation/Images/Overview_4to3.png → Media/Images/Overview_4to3.png
diff --git a/Documentation/Images/Pi2.JPG → Media/Images/Pi2.JPG b/Documentation/Images/Pi2.JPG → Media/Images/Pi2.JPG
diff --git a/Documentation/Images/Pi2WithShield.jpg → Media/Images/Pi2WithShield.jpg b/Documentation/Images/Pi2WithShield.jpg → Media/Images/Pi2WithShield.jpg
diff --git a/Documentation/Images/RoomSensor.jpg → Media/Images/RoomSensor.jpg b/Documentation/Images/RoomSensor.jpg → Media/Images/RoomSensor.jpg
diff --git a/Documentation/Images/Sonoff.jpg → Media/Images/Sonoff.jpg b/Documentation/Images/Sonoff.jpg → Media/Images/Sonoff.jpg
diff --git a/Media/Screens/App_1.png b/Media/Screens/App_1.png
diff --git a/Media/Screens/App_2.png b/Media/Screens/App_2.png
diff --git a/Documentation/Screens/1.14.0B1/MA_1.png → Media/Screens/MA_1.png b/Documentation/Screens/1.14.0B1/MA_1.png → Media/Screens/MA_1.png
diff --git a/Documentation/Screens/1.14.0B1/MA_2.png → Media/Screens/MA_2.png b/Documentation/Screens/1.14.0B1/MA_2.png → Media/Screens/MA_2.png
diff --git a/Documentation/Screens/1.14.0B1/MA_3.png → Media/Screens/MA_3.png b/Documentation/Screens/1.14.0B1/MA_3.png → Media/Screens/MA_3.png
diff --git a/Documentation/Screens/1.14.0B1/MA_4.png → Media/Screens/MA_4.png b/Documentation/Screens/1.14.0B1/MA_4.png → Media/Screens/MA_4.png
diff --git a/Documentation/Screens/1.14.0B1/MA_5.png → Media/Screens/MA_5.png b/Documentation/Screens/1.14.0B1/MA_5.png → Media/Screens/MA_5.png
diff --git a/Documentation/Screens/1.14.0B1/MA_6.png → Media/Screens/MA_6.png b/Documentation/Screens/1.14.0B1/MA_6.png → Media/Screens/MA_6.png
diff --git a/Documentation/Screens/PA_1.png → Media/Screens/PA_1.png b/Documentation/Screens/PA_1.png → Media/Screens/PA_1.png
diff --git a/README.md b/README.md
@@ -1,27 +1,27 @@
 <p align="center">
-<img src="https://github.com/chkr1011/HA4IoT/blob/master/Documentation/Images/Logo_256.png?raw=true" width="128">
+<img src="https://github.com/chkr1011/HA4IoT/blob/master/Media/Images/Logo_256.png?raw=true" width="128">
 </p>
 
 # HA4IoT
 HA4IoT (Home Automation for Internet of Things) is an Open Source Home Automation application running on Windows 10 IoT Core. It allows integration of different hardware actuators and sensors. It also provides a HTML/JavaScript based WebApp to control the system. But also other external services like Alexa, Twitter, Telegram etc. are supported.
 
 ## Raspberry Pi
 <p align="center">
-  <img src="https://github.com/chkr1011/HA4IoT/blob/master/Documentation/Images/Pi2.JPG?raw=true" width="375">
+  <img src="https://github.com/chkr1011/HA4IoT/blob/master/Media/Images/Pi2.JPG?raw=true" width="375">
 </p>
 The core application of this project is running under Windows 10 IoT Core which is available for free and runs on a Raspberry Pi 2/3 for example. But any other compatible board is supported.
 
 ## Amazon Alexa support
 <p align="center">
-  <img src="https://github.com/chkr1011/HA4IoT/blob/master/Documentation/Images/Echo.jpg?raw=true" width="256">
+  <img src="https://github.com/chkr1011/HA4IoT/blob/master/Media/Images/Echo.jpg?raw=true" width="256">
 </p>
 
 This project contains a _Custom Skill_ for Amazon Alexa (Echo and Echo Dot) which allows controlling actuators via speech commands and ask for sensor status like open windows etc. A demonstration is available here: https://www.youtube.com/watch?v=9089vAgu2pQ.
 
 ## CCTools support
 <p align="center">
-  <img src="https://github.com/chkr1011/HA4IoT/blob/master/Documentation/Images/HSRel5.jpg?raw=true" width="256">
-  <img src="https://github.com/chkr1011/HA4IoT/blob/master/Documentation/Images/HSPE16.jpg?raw=true" width="256">
+  <img src="https://github.com/chkr1011/HA4IoT/blob/master/Media/Images/HSRel5.jpg?raw=true" width="256">
+  <img src="https://github.com/chkr1011/HA4IoT/blob/master/Media/Images/HSPE16.jpg?raw=true" width="256">
 </p>
 
 This project has build in support for many devices from _CCTools_ (www.CCTools.eu) like I2C based relay boards and I2C port expanders. Support boards from _CCTools_ are:
@@ -34,14 +34,14 @@ But also other compatible I2C boards based on _PCF8574_, _PCA9555_ or _MAX7311_
 
 ## 433 MHz support
 <p align="center">
-  <img src="https://github.com/chkr1011/HA4IoT/blob/master/Documentation/Images/LPD.jpg?raw=true" height="256">
+  <img src="https://github.com/chkr1011/HA4IoT/blob/master/Media/Images/LPD.jpg?raw=true" height="256">
 </p>
 
 Controlling old 433 MHz devices is supported via using a I2C or WiFi -> 433 MHz sender bridge. The bridge is based on Arduino/ESP8266. Also recording 433 MHz signals like from a TV remote is supported.
 
 ## Itead Studio Sonoff supported
 <p align="center">
-  <img src="https://github.com/chkr1011/HA4IoT/blob/master/Documentation/Images/Sonoff.jpg?raw=true" height="256">
+  <img src="https://github.com/chkr1011/HA4IoT/blob/master/Media/Images/Sonoff.jpg?raw=true" height="256">
 </p>
 
 This project has build in  support for several _Sonoff_ devices from Itead Studio (www.itead.cc). But it is necessary to replace the firmware with a different one. More information can be found here: https://github.com/arendst/Sonoff-Tasmota
@@ -54,7 +54,7 @@ The HA4IoT WebApp is able to communicate with the controller (Raspberry Pi i.e.)
 
 ## Build in actuators and sensors
 <p align="center">
-  <img src="https://github.com/chkr1011/HA4IoT/blob/master/Documentation/Images/Overview2.png?raw=true" width="796">
+  <img src="https://github.com/chkr1011/HA4IoT/blob/master/Media/Images/Overview2.png?raw=true" width="796">
 </p>
 Lots of actuators and sensors are already implemented in this project and can be reused. It is also possible to add custom actuators and sensors.
 
@@ -96,29 +96,20 @@ If you are interested in supporting this project in any way feel free to contact
 ## Personal Agent
 Register a free bot for the messenger "Telegram" and let the bot control the home. Just tell him what he should do. The bot also supports giving status information like Weather information (Temperature, Humidity etc.), Window states (Open, Closed), Sensor values (Temperature, Humidity) etc. The bot will also send errors and warnings from the log to administrative users (which are defined in the configuration file). Every user who want's to interact with the bot must be added to a whitelist to ensure a high level of privacy.
 
-<img src="https://github.com/chkr1011/CK.HomeAutomation/blob/master/Documentation/Screens/PA_1.png?raw=true" width="100%">
+<img src="https://github.com/chkr1011/CK.HomeAutomation/blob/master/Media/Screens/PA_1.png?raw=true" width="100%">
 
 ## App
 Every actuator can be controlled using the web app which is hosted at the Raspberry Pi 2 using the build in webserver. The language for the examples is German but translation of each UI element is supported. The app shows every rooms/areas and provides several overviews like the overview of all temperature sensor. The app is based on Bootstrap and AngularJS and runs on Smartphones, Tables, PCs etc.
 
-<img src="https://github.com/chkr1011/CK.HomeAutomation/blob/master/Documentation/Screens/1.11.0/WA_SplashScreen.PNG?raw=true" width="256">
-<img src="https://github.com/chkr1011/CK.HomeAutomation/blob/master/Documentation/Screens/1.11.0/WA_Areas.PNG?raw=true" width="256">
-<img src="https://github.com/chkr1011/CK.HomeAutomation/blob/master/Documentation/Screens/1.11.0/WA_Bathroom.PNG?raw=true" width="256">
-<img src="https://github.com/chkr1011/CK.HomeAutomation/blob/master/Documentation/Screens/1.11.0/WA_Bedroom-1.PNG?raw=true" width="256">
-<img src="https://github.com/chkr1011/CK.HomeAutomation/blob/master/Documentation/Screens/1.11.0/WA_Bedroom-2.PNG?raw=true" width="256">
-<img src="https://github.com/chkr1011/CK.HomeAutomation/blob/master/Documentation/Screens/1.11.0/WA_Bedroom-2.PNG?raw=true" width="256">
-<img src="https://github.com/chkr1011/CK.HomeAutomation/blob/master/Documentation/Screens/1.11.0/WA_Storeroom.PNG?raw=true" width="256">
-<img src="https://github.com/chkr1011/CK.HomeAutomation/blob/master/Documentation/Screens/1.11.0/WA_SensorsOverview.PNG?raw=true" width="256">
-<img src="https://github.com/chkr1011/CK.HomeAutomation/blob/master/Documentation/Screens/1.11.0/WA_WindowOverview.PNG?raw=true" width="256">
-<img src="https://github.com/chkr1011/CK.HomeAutomation/blob/master/Documentation/Screens/1.11.0/WA_WeatherStation.PNG?raw=true" width="256">
-<img src="https://github.com/chkr1011/CK.HomeAutomation/blob/master/Documentation/Screens/1.11.0/WA_Info.PNG?raw=true" width="256">
+<img src="https://github.com/chkr1011/CK.HomeAutomation/blob/master/Media/Screens/App_1.png?raw=true" width="100%">
+<img src="https://github.com/chkr1011/CK.HomeAutomation/blob/master/Media/Screens/App_2.png?raw=true" width="100%">
 
 ## Management App
 The management app is an HTML/JavaScript application based on AngularJS and Bootstrap which is used the configure all areas, components, automations etc. It is deployed to the controller (Raspberry Pi 2 i.e.) and can be also used to create backups from the configuration.
 
-<img src="https://github.com/chkr1011/CK.HomeAutomation/blob/master/Documentation/Screens/1.14.0B1/MA_1.png?raw=true" width="100%">
-<img src="https://github.com/chkr1011/CK.HomeAutomation/blob/master/Documentation/Screens/1.14.0B1/MA_2.png?raw=true" width="100%">
-<img src="https://github.com/chkr1011/CK.HomeAutomation/blob/master/Documentation/Screens/1.14.0B1/MA_3.png?raw=true" width="100%">
-<img src="https://github.com/chkr1011/CK.HomeAutomation/blob/master/Documentation/Screens/1.14.0B1/MA_4.png?raw=true" width="100%">
-<img src="https://github.com/chkr1011/CK.HomeAutomation/blob/master/Documentation/Screens/1.14.0B1/MA_5.png?raw=true" width="100%">
-<img src="https://github.com/chkr1011/CK.HomeAutomation/blob/master/Documentation/Screens/1.14.0B1/MA_6.png?raw=true" width="100%">
+<img src="https://github.com/chkr1011/CK.HomeAutomation/blob/master/Media/Screens/MA_1.png?raw=true" width="100%">
+<img src="https://github.com/chkr1011/CK.HomeAutomation/blob/master/Media/Screens/MA_2.png?raw=true" width="100%">
+<img src="https://github.com/chkr1011/CK.HomeAutomation/blob/master/Media/Screens/MA_3.png?raw=true" width="100%">
+<img src="https://github.com/chkr1011/CK.HomeAutomation/blob/master/Media/Screens/MA_4.png?raw=true" width="100%">
+<img src="https://github.com/chkr1011/CK.HomeAutomation/blob/master/Media/Screens/MA_5.png?raw=true" width="100%">
+<img src="https://github.com/chkr1011/CK.HomeAutomation/blob/master/Media/Screens/MA_6.png?raw=true" width="100%">