OpenHAB
/
openhab-docs
mirror of https://github.com/openhab/openhab-docs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Change small details in tutorials/demo.md (#105) 

* Small changes: Added one line intro, rewrote/shortened a sentence that was a bit confusing to a beginner like myself, moved a note up to the section of the document to which it referred (although arguably it could have stayed).

* Fixed link to installation prerequisites

* Fixed Link: 404 on Karaf command reference
pull/106/head
Brian 2016-09-27 15:04:03 -07:00 committed by Thomas Dietrich
parent fc4cfff572
commit a75c294a9e
1 changed files with 14 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
tutorials/demo.md
View File

@ -6,9 +6,11 @@ layout: intro
# Quick Start with a Demo Setup
The 'Demo' is a quick and easy way to see the user interface for a virtual home and examples of the different widget types that exist.
## Prerequisites
Make sure that you have a [JDK 8](/installation/prereqs.html) installed.
Make sure that you have a [JDK 8](/installation/index.html#prerequisites) installed.
## Installation
@ -19,12 +21,12 @@ You will find the following folders:
- `conf`: This contains all your user specific configuration files.
- `runtime`: This contains the openHAB binaries, there should normally be no need to touch anything in here - the whole folder can be considered to be read-only.
- `userdata`: Here you will find all the data that is generated during runtime: log files, database files, etc. In theory this should be the only folder where openHAB needs write permission on.
- `addons`: Here you can drop add-ons (or any other OSGi bundles) that you want to be deployed in your instance. These can be add-ons for openHAB 1.x and 2.x likewise. Note that all "normal" add-ons are already included in the openHAB distribution and all you need is to name them in your 'addons.cfg' file (see below). Hence the `addons` folder is mainly useful if you have received jars from other sources and want to install and test them.
## Choosing Demo as a Base Package and further add-ons to be Installed
- `addons`: Here you can drop add-ons (or any other OSGi bundles) that you want to be deployed in your instance. These can be add-ons for openHAB 1.x and 2.x likewise. Note that all "normal" add-ons are already included in the openHAB distribution and all you need is to name them in your 'addons.cfg' file (see below). Hence the `addons` folder is mainly useful if you have received jars from other sources and want to install and test them.
The demo package consists out of demo configuration files (for items, sitemaps, etc.) and a selection of add-ons and UIs. In order to install it, you should directly edit the file 'conf/services/addons.cfg'.
You need to uncomment the line `package=` and set it to `demo` as shown below:
## Choosing Demo as a Base Package and further add-ons to be Installed
The demo package consists of example configuration files and samples of add-ons and UIs. In order to install the demo, you must edit the file 'conf/services/addons.cfg'.
Uncomment the line `package=` and set it to `demo` as shown below:
```
# The base installation package of this openHAB instance (default is "standard")
@ -37,9 +39,12 @@ package = demo
...
```
_NOTE:_ As long as you have selected the `demo` package in `addons.cfg`, you are not able to uninstall any of the installed addons.
So once you are ready to build your personal setup, don't forget to switch the base package back to `standard`.
## Starting the Runtime
Once you have configured your runtime, you can simply start openHAB by calling `start.sh` resp. `start.bat` on Windows and the runtime will start up:
Once you have configured your runtime as above, start the openHAB runtime from the terminal by calling `./start.sh` (`start.bat` on Windows):
![console](images/demo_console.png)
@ -54,17 +59,14 @@ Selecting the _Basic UI_ will give you a virtual home and examples of the differ
The files that are used by these demo setup are available in the `conf` folder.
To understand their meaning and how you can tweak them all, please refer to our [beginner tutorial](beginner).
_NOTE:_ As long as you have selected the `demo` package in `addons.cfg`, you are not able to uninstall any of the installed addons.
So once you are ready to build your personal setup, don't forget to switch the base package back to `standard`.
## Using the Shell
openHAB uses Apache Karaf and thus comes with a very powerful shell for managing the installation. Please check the [Karaf command reference](http://karaf.apache.org/manual/latest/commands/commands.html) for details. Useful commands e.g. include:
openHAB uses Apache Karaf and thus comes with a very powerful shell for managing the installation. Please check the [Karaf command reference](https://karaf.apache.org/manual/latest/#_commands) for details. Useful commands e.g. include:
- `log:tail`: Show the live logging output, end it by pressing ctrl+c.
- `log:exception-display`: Show the last exception of the log file.
- `log:set DEBUG org.openhab.binding.sonos`: Enables debug logging for a certain binding.
- `feature:list`: Lists all features available and shows there status. openHAB add-ons are made available as such Karaf features.
- `feature:install openhab-binding-knx`: Installs a certain add-on (here KNX).
- `feature:install openhab-binding-knx`: Installs a certain add-on (here KNX).
- `bundle:list -s`: Lists all installed bundles with their symbolic name.
- `logout`: Shuts down openHAB.