Final check of links and titles
Final check of TOC links and related titles. Minor changes in page title levelpull/2/head
parent
33289440f9
commit
6a69c2996e
|
@ -4,7 +4,9 @@ layout: usersmanual
|
||||||
|
|
||||||
{% include base.html %}
|
{% include base.html %}
|
||||||
|
|
||||||
# What is openHAB
|
# Overview
|
||||||
|
|
||||||
|
## What is openHAB ?
|
||||||
|
|
||||||
openHAB is a software for integrating different home automation systems and technologies into one single solution that allows over-arching automation rules and that offers uniform user interfaces.
|
openHAB is a software for integrating different home automation systems and technologies into one single solution that allows over-arching automation rules and that offers uniform user interfaces.
|
||||||
|
|
||||||
|
@ -12,7 +14,7 @@ openHAB 2 is the successor of [openHAB 1](https://github.com/openhab/openhab/wik
|
||||||
|
|
||||||
openHAB is a highly modular software, which means that the base installation (the "runtime") can be extended through different kinds of "add-ons".
|
openHAB is a highly modular software, which means that the base installation (the "runtime") can be extended through different kinds of "add-ons".
|
||||||
|
|
||||||
# The documentation
|
## The documentation
|
||||||
|
|
||||||
The _user’s manual_ has been built in order to guide you for your first contact with OpenHAB. It guides you step by step in your discovery of OpenHAB mechanisms.
|
The _user’s manual_ has been built in order to guide you for your first contact with OpenHAB. It guides you step by step in your discovery of OpenHAB mechanisms.
|
||||||
|
|
||||||
|
|
|
@ -12,7 +12,7 @@ But openHAB is also a __community__ of users, contributors and maintainers.
|
||||||
|
|
||||||
In this chapter, we are going to see a little bit more of these two aspects.
|
In this chapter, we are going to see a little bit more of these two aspects.
|
||||||
|
|
||||||
# OpenHAB structure
|
## OpenHAB structure
|
||||||
|
|
||||||
OpenHAB 2 is an open-source solution based on the [Eclipse SmartHome]() framework. It is fully written in Java and uses [Apache Karaf](http://karaf.apache.org/) together with [Eclipse Equinox](https://www.eclipse.org/equinox/) as an OSGi runtime and bundles this with [Jetty](https://www.eclipse.org/jetty/) as an HTTP server.
|
OpenHAB 2 is an open-source solution based on the [Eclipse SmartHome]() framework. It is fully written in Java and uses [Apache Karaf](http://karaf.apache.org/) together with [Eclipse Equinox](https://www.eclipse.org/equinox/) as an OSGi runtime and bundles this with [Jetty](https://www.eclipse.org/jetty/) as an HTTP server.
|
||||||
|
|
||||||
|
@ -32,7 +32,7 @@ Add-ons can come from three different origins :
|
||||||
|
|
||||||
We will learn more about add-ons in the following chapters.
|
We will learn more about add-ons in the following chapters.
|
||||||
|
|
||||||
# The OpenHAB community
|
## The OpenHAB community
|
||||||
|
|
||||||
OpenHAB is not only a solution but also a community.
|
OpenHAB is not only a solution but also a community.
|
||||||
|
|
||||||
|
|
|
@ -10,11 +10,11 @@ This parts covers the different steps needed to have a working install of openHA
|
||||||
|
|
||||||
This is done thru 3 steps:
|
This is done thru 3 steps:
|
||||||
|
|
||||||
* checking Java version
|
* checking Java version,
|
||||||
|
|
||||||
* installing openHAB 2 itself
|
* installing openHAB 2 itself,
|
||||||
|
|
||||||
* using the logs.
|
* installing the designer.
|
||||||
|
|
||||||
The last chapter discusses about the migration from openHAB 1.x.
|
The last chapter discusses about the migration from openHAB 1.x.
|
||||||
|
|
||||||
|
|
|
@ -8,7 +8,7 @@ layout: usersmanual
|
||||||
|
|
||||||
OpenHAB 2 offers different UIs in its standard configuration: the _Paper UI_, the _Basic UI_ and the _Classic UI_.
|
OpenHAB 2 offers different UIs in its standard configuration: the _Paper UI_, the _Basic UI_ and the _Classic UI_.
|
||||||
|
|
||||||
# The Paper UI
|
## The Paper UI
|
||||||
|
|
||||||
The Paper UI is a new interface that helps setting up and configuring your openHAB instance.
|
The Paper UI is a new interface that helps setting up and configuring your openHAB instance.
|
||||||
It does not (yet) cover all aspects, so you still need to resort to textual configuration files, but it already offers the following:
|
It does not (yet) cover all aspects, so you still need to resort to textual configuration files, but it already offers the following:
|
||||||
|
@ -30,7 +30,7 @@ Here you can find a small screencast about the Paper UI:
|
||||||
|
|
||||||
[](http://www.youtube.com/watch?v=MV2a5qwtmRE)
|
[](http://www.youtube.com/watch?v=MV2a5qwtmRE)
|
||||||
|
|
||||||
# The Basic UI
|
## The Basic UI
|
||||||
|
|
||||||
The Basic UI is a web interface based on Material Design Lite from Google. This interface is used to present the different sitemaps.
|
The Basic UI is a web interface based on Material Design Lite from Google. This interface is used to present the different sitemaps.
|
||||||
|
|
||||||
|
@ -46,7 +46,7 @@ The UIs features are:
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
# The Classic UI
|
## The Classic UI
|
||||||
|
|
||||||
The Classic UI offers the same services that the Basic UI but with a different look and feel, close to an old iOS one.
|
The Classic UI offers the same services that the Basic UI but with a different look and feel, close to an old iOS one.
|
||||||
|
|
||||||
|
|
|
@ -10,3 +10,10 @@ There are a few technical changes in openHAB 2 that are not compatible with open
|
||||||
|
|
||||||
- the REST API does NOT support XML nor JSON-P anymore. It is now fully realized using JSON.
|
- the REST API does NOT support XML nor JSON-P anymore. It is now fully realized using JSON.
|
||||||
- the REST API does not support websocket access anymore - it actually completely drops "push" support and only has a simple long-polling implementation to provide a basic backward-compatibility for clients.
|
- the REST API does not support websocket access anymore - it actually completely drops "push" support and only has a simple long-polling implementation to provide a basic backward-compatibility for clients.
|
||||||
|
|
||||||
|
|
||||||
|
# Compatibility layer
|
||||||
|
|
||||||
|
There is a special bundle in openHAB 2, which serves as a compatibility layer. It effectively exposes and consumes all relevant classes and services from the `org.openhab` namespace and internally delegates or proxies them to the according `org.eclipse.smarthome` classes and services.
|
||||||
|
|
||||||
|
It is described next page.
|
|
@ -3,11 +3,15 @@
|
||||||
<ul class="nav">
|
<ul class="nav">
|
||||||
<li><a href="{{docu}}/50_developers_guide/00_introduction/introduction">Overview</a></li>
|
<li><a href="{{docu}}/50_developers_guide/00_introduction/introduction">Overview</a></li>
|
||||||
<li><a href="{{docu}}/50_developers_guide/05_contributing/contributing">Contributing as a developer</a></li>
|
<li><a href="{{docu}}/50_developers_guide/05_contributing/contributing">Contributing as a developer</a></li>
|
||||||
<li><a href="{{docu}}/50_developers_guide/10_development/ide.html">Development</a>
|
<li><a href="{{docu}}/50_developers_guide/10_development/ide.html">Development basics</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="{{docu}}/50_developers_guide/10_development/ide.html">IDE Setup</a></li>
|
<li><a href="{{docu}}/50_developers_guide/10_development/ide.html">IDE Setup</a></li>
|
||||||
<li><a href="{{docu}}/esh/guidelines.html">Guidelines</a></li>
|
<li><a href="{{docu}}/esh/guidelines.html">Guidelines</a></li>
|
||||||
<li><a href="{{docu}}/50_developers_guide/10_development/bindings.html">Bindings</a></li>
|
<li><a href="{{docu}}/50_developers_guide/10_development/bindings.html">Bindings</a></li>
|
||||||
|
</ul></li>
|
||||||
|
<li><a href="{{docu}}/50_developers_guide/10_development/evolution.html">Technical Difference to openHAB 1</a>
|
||||||
|
<ul>
|
||||||
<li><a href="{{docu}}/50_developers_guide/10_development/evolution.html">Technical Difference to openHAB 1</a></li>
|
<li><a href="{{docu}}/50_developers_guide/10_development/evolution.html">Technical Difference to openHAB 1</a></li>
|
||||||
|
<li><a href="{{docu}}/features/compatibilitylayer.html">openHAB 1 compatibility layer</a></li>
|
||||||
</ul></li>
|
</ul></li>
|
||||||
</ul>
|
</ul>
|
|
@ -24,7 +24,7 @@
|
||||||
<li><a href="{{docu}}/10_users_manual/30_working_with_openhab/00_working_with_openhab/working_with_openhab.html">Working with openHAB (I)</a>
|
<li><a href="{{docu}}/10_users_manual/30_working_with_openhab/00_working_with_openhab/working_with_openhab.html">Working with openHAB (I)</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="{{docu}}/10_users_manual/30_working_with_openhab/00_working_with_openhab/working_with_openhab.html">About of this part</a></li>
|
<li><a href="{{docu}}/10_users_manual/30_working_with_openhab/00_working_with_openhab/working_with_openhab.html">About of this part</a></li>
|
||||||
<li><a href="{{docu}}/10_users_manual/30_working_with_openhab/10_the_different_uis/the_different_uis.html">The different UIs</a></li>
|
<li><a href="{{docu}}/10_users_manual/30_working_with_openhab/10_the_different_uis/the_different_uis.html">OpenHAB 2 UIs</a></li>
|
||||||
<li><a href="{{docu}}/10_users_manual/30_working_with_openhab/20_installing_an_extension/installing_an_extension.html">Installing an extension</a></li>
|
<li><a href="{{docu}}/10_users_manual/30_working_with_openhab/20_installing_an_extension/installing_an_extension.html">Installing an extension</a></li>
|
||||||
<li><a href="{{docu}}//10_users_manual/30_working_with_openhab/50_working_with_persistence/working_with_persistence.html">Working with persistence</a></li>
|
<li><a href="{{docu}}//10_users_manual/30_working_with_openhab/50_working_with_persistence/working_with_persistence.html">Working with persistence</a></li>
|
||||||
<li><a href="{{docu}}/10_users_manual/30_working_with_openhab/60_working_with_rules_and_scripts/working_with_rules_and_scripts.html">Working with rules and script</a></li>
|
<li><a href="{{docu}}/10_users_manual/30_working_with_openhab/60_working_with_rules_and_scripts/working_with_rules_and_scripts.html">Working with rules and script</a></li>
|
||||||
|
|
|
@ -4,7 +4,9 @@ layout: usersmanual
|
||||||
|
|
||||||
{% include base.html %}
|
{% include base.html %}
|
||||||
|
|
||||||
# Available Add-ons
|
# Add-on list
|
||||||
|
|
||||||
|
## Available Add-ons
|
||||||
|
|
||||||
All optional add-ons for openHAB 2 are part of the distribution. This includes all new 2.0 bindings as well as all 1.x add-ons that were reported to be compatible.
|
All optional add-ons for openHAB 2 are part of the distribution. This includes all new 2.0 bindings as well as all 1.x add-ons that were reported to be compatible.
|
||||||
_Note_: If you are successfully using a 1.x add-on with the 2.0 runtime, which is not yet on this list, please create a PR for adding it!
|
_Note_: If you are successfully using a 1.x add-on with the 2.0 runtime, which is not yet on this list, please create a PR for adding it!
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
---
|
---
|
||||||
layout: documentation
|
layout: usersmanual
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
{% include base.html %}
|
||||||
|
|
|
@ -1,3 +1,9 @@
|
||||||
|
---
|
||||||
|
layout: developersguide
|
||||||
|
---
|
||||||
|
|
||||||
|
{% include base.html %}
|
||||||
|
|
||||||
# Compatibility Layer for openHAB 1.x Add-ons
|
# Compatibility Layer for openHAB 1.x Add-ons
|
||||||
|
|
||||||
openHAB 2 used [Eclipse SmartHome](https://www.eclipse.org/smarthome/) as its core framework. Although many classes are similar, all of them have at least a different namespace (`org.eclipse.smarthome` instead of `org.openhab`) - as a result, none the existing 1.x add-ons would work on openHAB 2.
|
openHAB 2 used [Eclipse SmartHome](https://www.eclipse.org/smarthome/) as its core framework. Although many classes are similar, all of them have at least a different namespace (`org.eclipse.smarthome` instead of `org.openhab`) - as a result, none the existing 1.x add-ons would work on openHAB 2.
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
---
|
---
|
||||||
layout: documentation
|
layout: usersmanual
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
{% include base.html %}
|
||||||
|
|
Loading…
Reference in New Issue