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

Reworded intro 

Per a comment from Kai, took out the "2" in openHAB 2 to set the
precedent that whenever we refer to openHAB we are referring to OH 2 and
we will use the 1.x when referring to OH 1.

Reworked some of the wording to tighten up the sentences and take out
some redundancies.

Edited the bullet points, per many writing style guides bullet points
are part of the previous sentence and not a sentence unto themselves so
I reworded accordingly.
pull/9/head
Richard Koshak 2016-05-30 18:31:27 -06:00
parent 56380e8361
commit 43c9840540
1 changed files with 11 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
index.md
View File

@ -4,21 +4,22 @@ layout: intro
{% include base.html %}
# Introduction to openHAB 2
# Introduction to openHAB
openHAB is 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 platform for integrating many different home automation systems and technologies into one seamless environment that enables over-arching automation rules and offers a uniform user interface.
openHAB 2 is the successor to [openHAB 1](https://github.com/openhab/openhab/wiki). It is an open-source solution based on the [Eclipse SmartHome](https://eclipse.org/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, hearafter referred to as openHAB, is the successor to [openHAB 1](https://github.com/openhab/openhab/wiki). It is a Free and Open Source software package released under the Eclipse Public License. openHAB is fully written in Java and is based on the [Eclipse SmartHome](https://eclipse.org/smarthome/) framework. In addition, openHAB uses [Apache Karaf](http://karaf.apache.org/) together with [Eclipse Equinox](https://www.eclipse.org/equinox/) as an OSGi runtime to support modular plugins, and bundles this with [Jetty](https://www.eclipse.org/jetty/) as an HTTP server to support a RESTful API and web based user interfaces.
openHAB is highly modular software, which means that the base installation (the "runtime") can be extended through "add-ons". The openHAB distribution includes add-ons from different sources and makes them all available.
openHAB is highly modular software and can be extended through "add-ons". The openHAB distribution includes many add-ons from different sources.
![distribution overview](images/distro.png)
Note that the openHAB distribution repository does not contain any source code, but it rather aggregates features from different repositories:
The source code and binaries for openHAB are located in a number of GitHub repositories including:
- [Eclipse SmartHome Framework](https://github.com/eclipse/smarthome): This repository holds the major parts of the core functionality.
- [openHAB 2 Core](https://github.com/kaikreuzer/openhab-core): This repository contains a few small bundles that are not part of Eclipse SmartHome, but are required for the openHAB runtime. This e.g. contains a compatibility layer for supporting openHAB 1 add-ons.
- [openHAB 2 Add-ons](https://github.com/openhab/openhab2): Add-ons of openHAB that use the Eclipse SmartHome APIs can be found within this repository. They cannot be used with an openHAB 1.x runtime, since they provide features that the old runtime does not support.
- [openHAB 1 Add-ons](https://github.com/openhab/openhab): Add-ons developed for openHAB 1.x. Most of them are working smoothly on the openHAB 2 runtime and thus they are packaged within the distribution.
- [Eclipse SmartHome Extensions](https://github.com/eclipse/smarthome/tree/master/extensions): Since openHAB uses the Eclipse SmartHome framework, it is automatically compatible with all extensions that are available for it and maintained within the Eclipse SmartHome repository. These are usually high-quality extensions that might be even used in commercial products.
- [openHAB Distro](https://github.com/openhab/openhab-distro): contains no source code but pulls and aggregates from the other listed repositories
- [Eclipse SmartHome Framework](https://github.com/eclipse/smarthome): holds the major parts of the core functionality
- [openHAB 2 Core](https://github.com/kaikreuzer/openhab-core): contains a few small bundles that are not part of Eclipse SmartHome, but are required for the openHAB runtime including a compatibility layer for supporting openHAB 1 add-ons
- [openHAB 2 Add-ons](https://github.com/openhab/openhab2): add-ons of openHAB that use the Eclipse SmartHome APIs and are incompatible with openHAB 1.x
- [openHAB 1 Add-ons](https://github.com/openhab/openhab): add-ons developed for openHAB 1.x that are tested and known to work smoothly with openHAB 2
- [Eclipse SmartHome Extensions](https://github.com/eclipse/smarthome/tree/master/extensions): add-ons developed for the Eclipse SmartHome framework which are also compatible with openHAB by default, many of which are used in commercial products.