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

Reworded to match changes to index.html 

Reworded to match the changes I made to index.html. Added a paragraph to
describe the drawing and explain the purpose of each part. This makes it
a little more obvious why the drawing is there, even though some of the
info is repeated from the first paragraph.

Signed-off-by: Rich Koshak <rlkoshak@gmail.com> (github: rkoshak)
pull/9/head
Richard Koshak 2016-05-30 19:08:31 -06:00
parent 43c9840540
commit cae87add29
1 changed files with 13 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
overview.md
View File

@ -6,40 +6,41 @@ layout: documentation
# What is 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.
But openHAB is also a __community__ of users, contributors and maintainers.
openHAB is also a __community__ of users, contributors and maintainers.
## openHAB Structure
openHAB 2 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 platform 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 different kinds of "add-ons", either to communicate with new home automation solution, or to offer a new kind of user interface.
openHAB is highly modular software and can be extended through "add-ons" which extend openHAB to communicate with a new home automation technology or solution, offer a new kind of user interface, or extend openHAB's caabilities.
The structure of openHAB can be summarized this way:
The structure of openHAB can be summarized using the following drawing.
![distribution overview](images/distro.png)
Add-ons can come from three different origins:
The openHAB distribution is written in Java and therefore runs where ever the [Java Runtime Environment](http://java.com/) runs. At the base of the openHAB architecture is the [Apache Karaf](http://karaf.apache.org/) and [Eclipse Equinox](http://www.eclipse.org/equinox/) OSGi platforms. These enable modularity for the rest of the openHAB framework and some core services. On top of this base there is [Jetty](http://www.eclipse.org/jetty/), an HTTP Server which serves openHAB's web based user interfaces and enables openHAB's RESTful API. Also on top of the OSGi platform is the [Eclipse SmartHome Framework](https://eclipse.org/smarthome/), a set of libraries and core functionality which openHAB builds upon. Next, the __openHAB 2 Core__ also resides on top of the OSGi framwork providing oepnHAB unique capabilities such as a compatibility layer to adapt openHAB 1.x add-ons to openHAB. Finally, add-ons which are built to the Eclipse SmartHome Framework and openHAB API enable openHAB to communicate with a myriad of home automation products, technologies, and standards as well as adding additional capabilities.
* add-ons coming from the Eclipse SmartHome project, as Eclipse SmartHome is the base of openHAB 2,
Add-ons can come from one of three different origins:
* add-ons coming from the openHAB version 1 package, as openHAB 2 includes a compatibility layer,
* the Eclipse SmartHome project which are fully compatible with openHAB,
* openHAB version 1.x which are compatible with openHAB through a compatibility layer,
* add-ons made for openHAB 2.
## The openHAB Community
openHAB is not only a solution but also a community.
openHAB is not just a software solution, it is also a community.
The center of this community is the [openHAB forum](https://community.openhab.org).
If you have questions about the use of openHAB, before reporting an issue, or for comments and contributions about the documentation, please check the [openHAB forum](https://community.openhab.org) for solutions and help. More people will see your issue when it is posted in the forum and community members may be able to help you find known solutions/workarounds for your issue.
Please post questions or comments to the [openHAB forum](https://community.openhab.org) first when encountering problems. The forum is populated with many helpful openHAB users and developers who can assist with almost any topic related to openHAB including installation, troubleshooting runtime problems, identifying bugs, explaining parts of the system, working with specific add-ons, working with rules and configurations, and potential solutions and workarounds for problems. There are also many excellent examples rules, configurations, and tutorials posted to the forum.
Rules about posting an issue and [contributions guidelines](appendix/contributing.html) are in the _Appendix_.
# Developer Documentation
The [_Developer Guide_](/developers) contains practical and technical information for people willing to contribute to the development of openHAB or of one of its add-ons.
The [_Developer Guide_](/developers) contains practical and technical information for people desiring to contribute to the development of openHAB or of one of its add-ons.