Fix Markdown. Remove Jenkins base tags. (#1497)
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>pull/1498/head
parent
beac270987
commit
ae9bdd76ec
|
@ -3,8 +3,6 @@ layout: documentation
|
||||||
title: Actions
|
title: Actions
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# Actions
|
# Actions
|
||||||
|
|
||||||
Actions are predefined methods that are called from openHAB rules and scripts.
|
Actions are predefined methods that are called from openHAB rules and scripts.
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: documentation
|
||||||
title: Bindings
|
title: Bindings
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# Bindings
|
# Bindings
|
||||||
|
|
||||||
Bindings connect your smart home's devices and technologies to openHAB.
|
Bindings connect your smart home's devices and technologies to openHAB.
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: documentation
|
||||||
title: System Integrations
|
title: System Integrations
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# System Integrations
|
# System Integrations
|
||||||
|
|
||||||
openHAB supports services that enable integration with various technologies that don't fall into other add-on categories.
|
openHAB supports services that enable integration with various technologies that don't fall into other add-on categories.
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: documentation
|
||||||
title: Persistence Services
|
title: Persistence Services
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# Persistence Services
|
# Persistence Services
|
||||||
|
|
||||||
Persistence services enable the storage of item states over time.
|
Persistence services enable the storage of item states over time.
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: documentation
|
||||||
title: Transformations
|
title: Transformations
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# Transformations
|
# Transformations
|
||||||
|
|
||||||
Transformations are used to translate data from a cluttered or technical raw value to a processed or human-readable representation.
|
Transformations are used to translate data from a cluttered or technical raw value to a processed or human-readable representation.
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: documentation
|
||||||
title: iOS App
|
title: iOS App
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# iOS App
|
# iOS App
|
||||||
|
|
||||||
<!-- https://developer.apple.com/app-store/marketing/guidelines/de/#downloadOnAppstore -->
|
<!-- https://developer.apple.com/app-store/marketing/guidelines/de/#downloadOnAppstore -->
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: documentation
|
||||||
title: Windows 10 App
|
title: Windows 10 App
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# Windows 10 App
|
# Windows 10 App
|
||||||
|
|
||||||
We provide a native Windows 10 app for openHAB, compatible with Windows laptops, desktops, tablets and phones (Xbox, Raspberry Pi and Holographic coming soon).
|
We provide a native Windows 10 app for openHAB, compatible with Windows laptops, desktops, tablets and phones (Xbox, Raspberry Pi and Holographic coming soon).
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: documentation
|
||||||
title: Voice Services
|
title: Voice Services
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# Available Voice Services
|
# Available Voice Services
|
||||||
|
|
||||||
| Voice Service | Description |
|
| Voice Service | Description |
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: documentation
|
||||||
title: Bundle Management
|
title: Bundle Management
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# Bundle Management
|
# Bundle Management
|
||||||
|
|
||||||
The [console](console.html) offers various commands to manage bundles, among other things.
|
The [console](console.html) offers various commands to manage bundles, among other things.
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: documentation
|
||||||
title: The Console
|
title: The Console
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# The Console
|
# The Console
|
||||||
|
|
||||||
The console offers the ability to:
|
The console offers the ability to:
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: documentation
|
||||||
title: Advanced Functionality and Administrative Tasks
|
title: Advanced Functionality and Administrative Tasks
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# Advanced Functionality and Administrative Tasks
|
# Advanced Functionality and Administrative Tasks
|
||||||
|
|
||||||
As a runtime environment openHAB uses [Apache Karaf](https://karaf.apache.org), a modern and polymorphic container for hosting Java applications.
|
As a runtime environment openHAB uses [Apache Karaf](https://karaf.apache.org), a modern and polymorphic container for hosting Java applications.
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: documentation
|
||||||
title: JsonDB Storage
|
title: JsonDB Storage
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# JsonDB Storage
|
# JsonDB Storage
|
||||||
|
|
||||||
JsonDB provides a system database for storage of configuration data.
|
JsonDB provides a system database for storage of configuration data.
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: documentation
|
||||||
title: Logging
|
title: Logging
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# Logging in openHAB
|
# Logging in openHAB
|
||||||
|
|
||||||
This article describes the logging functionality in openHAB.
|
This article describes the logging functionality in openHAB.
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: documentation
|
||||||
title: Runtime Commands
|
title: Runtime Commands
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# Runtime Commands
|
# Runtime Commands
|
||||||
|
|
||||||
It is possible to query and even change the state of entities like items or things. Therefore the console offers commands in various areas:
|
It is possible to query and even change the state of entities like items or things. Therefore the console offers commands in various areas:
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: documentation
|
||||||
title: Serial Port Configuration
|
title: Serial Port Configuration
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# Serial Port Configuration
|
# Serial Port Configuration
|
||||||
|
|
||||||
Without correct configuration, bindings using serial devices might not be able to open the serial port for communication, and you will see an error message in the logs.
|
Without correct configuration, bindings using serial devices might not be able to open the serial port for communication, and you will see an error message in the logs.
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: documentation
|
||||||
title: Contributing to openHAB
|
title: Contributing to openHAB
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# Contributing to openHAB
|
# Contributing to openHAB
|
||||||
|
|
||||||
openHAB is a community effort and everyone can take part in that.
|
openHAB is a community effort and everyone can take part in that.
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: documentation
|
||||||
title: Finding Help and FAQs
|
title: Finding Help and FAQs
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# Finding Help
|
# Finding Help
|
||||||
|
|
||||||
openHAB is surrounding by an amazing community helping new users, discussing problems and providing tutorials and examples.
|
openHAB is surrounding by an amazing community helping new users, discussing problems and providing tutorials and examples.
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: documentation
|
||||||
title: Audio & Voice
|
title: Audio & Voice
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# Audio & Voice
|
# Audio & Voice
|
||||||
|
|
||||||
Audio and voice features are an important aspect of any smart home solution as it is a very natural way to interact with the user.
|
Audio and voice features are an important aspect of any smart home solution as it is a very natural way to interact with the user.
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: documentation
|
||||||
title: Categories
|
title: Categories
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# Categories
|
# Categories
|
||||||
|
|
||||||
Categories in openHAB are used to provide meta information about Things, Channels, etc. UIs can use this information to render specific icons or provide a search functionality to for example filter all Things for a certain category.
|
Categories in openHAB are used to provide meta information about Things, Channels, etc. UIs can use this information to render specific icons or provide a search functionality to for example filter all Things for a certain category.
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: documentation
|
||||||
title: Thing Discovery
|
title: Thing Discovery
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# Thing Discovery
|
# Thing Discovery
|
||||||
|
|
||||||
Many devices, technologies and systems can be automatically discovered on the network or browsed through some API. It therefore makes a lot of sense to use these features for a smart home solution.
|
Many devices, technologies and systems can be automatically discovered on the network or browsed through some API. It therefore makes a lot of sense to use these features for a smart home solution.
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: documentation
|
||||||
title: Concepts
|
title: Concepts
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# Concepts
|
# Concepts
|
||||||
|
|
||||||
When first thinking about your home automation system, it may be helpful to bear in mind that there are two ways of thinking about or viewing your system: the physical view and the functional view.
|
When first thinking about your home automation system, it may be helpful to bear in mind that there are two ways of thinking about or viewing your system: the physical view and the functional view.
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: documentation
|
||||||
title: Items
|
title: Items
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# Items
|
# Items
|
||||||
|
|
||||||
openHAB has a strict separation between the physical world (the "Things", see below) and the application, which is built around the notion of "Items" (also called the virtual layer).
|
openHAB has a strict separation between the physical world (the "Things", see below) and the application, which is built around the notion of "Items" (also called the virtual layer).
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: documentation
|
||||||
title: Units Of Measurement
|
title: Units Of Measurement
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# Units Of Measurement
|
# Units Of Measurement
|
||||||
|
|
||||||
To express measured values in a scientific correct unit the framework supports units of measurement.
|
To express measured values in a scientific correct unit the framework supports units of measurement.
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: documentation
|
||||||
title: Editors
|
title: Editors
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# Editors - Different Ways to Simplify Your Textual Configuration
|
# Editors - Different Ways to Simplify Your Textual Configuration
|
||||||
|
|
||||||
Currently there are several existing solutions, that can help you configuring your openHAB instance in a textual way.
|
Currently there are several existing solutions, that can help you configuring your openHAB instance in a textual way.
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: documentation
|
||||||
title: Items
|
title: Items
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# Items
|
# Items
|
||||||
|
|
||||||
In openHAB Items represent all properties and capabilities of the user’s home automation.
|
In openHAB Items represent all properties and capabilities of the user’s home automation.
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: documentation
|
||||||
title: JSR223 Scripting
|
title: JSR223 Scripting
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# JSR223 Scripting
|
# JSR223 Scripting
|
||||||
|
|
||||||
::: tip Note
|
::: tip Note
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: documentation
|
||||||
title: Multimedia
|
title: Multimedia
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# Multimedia
|
# Multimedia
|
||||||
|
|
||||||
## Volume
|
## Volume
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: documentation
|
||||||
title: Persistence
|
title: Persistence
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# Persistence
|
# Persistence
|
||||||
|
|
||||||
openHAB can store data over time; this is known as persistence.
|
openHAB can store data over time; this is known as persistence.
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: documentation
|
||||||
title: openHAB REST API
|
title: openHAB REST API
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# openHAB REST API
|
# openHAB REST API
|
||||||
|
|
||||||
Through the openHAB [REST API](https://en.wikipedia.org/wiki/REST_API) most aspects of the openHAB system can be readily accessed by other programs.
|
Through the openHAB [REST API](https://en.wikipedia.org/wiki/REST_API) most aspects of the openHAB system can be readily accessed by other programs.
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: documentation
|
||||||
title: Rules
|
title: Rules
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# Textual Rules
|
# Textual Rules
|
||||||
|
|
||||||
"Rules" are used for automating processes: Each rule can be triggered, which invokes a script that performs any kinds of tasks, e.g. turn on lights by modifying your items, do mathematical calculations, start timers etcetera.
|
"Rules" are used for automating processes: Each rule can be triggered, which invokes a script that performs any kinds of tasks, e.g. turn on lights by modifying your items, do mathematical calculations, start timers etcetera.
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: documentation
|
||||||
title: Services
|
title: Services
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# Services
|
# Services
|
||||||
|
|
||||||
{% include contribution-wanted.html %}
|
{% include contribution-wanted.html %}
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: documentation
|
||||||
title: Things
|
title: Things
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# Things
|
# Things
|
||||||
|
|
||||||
[Things]({{base}}/concepts/things.html) represent the physical layer of an openHAB system.
|
[Things]({{base}}/concepts/things.html) represent the physical layer of an openHAB system.
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: documentation
|
||||||
title: Transformations Configuration
|
title: Transformations Configuration
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# Transformations Configuration
|
# Transformations Configuration
|
||||||
|
|
||||||
Transformations are used to translate data from a cluttered or technical raw value to a processed or human-readable representation.
|
Transformations are used to translate data from a cluttered or technical raw value to a processed or human-readable representation.
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: developersguide
|
||||||
title: Audio & Voice
|
title: Audio & Voice
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# Audio & Voice
|
# Audio & Voice
|
||||||
|
|
||||||
openHAB provides a modular architecture that enables all kinds of different use cases.
|
openHAB provides a modular architecture that enables all kinds of different use cases.
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: developersguide
|
||||||
title: Configuration Descriptions
|
title: Configuration Descriptions
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# Configuration Descriptions
|
# Configuration Descriptions
|
||||||
|
|
||||||
Specific services or bindings usually require a configuration to be operational in a meaningful way.
|
Specific services or bindings usually require a configuration to be operational in a meaningful way.
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: developersguide
|
||||||
title: FAQ
|
title: FAQ
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# Frequently Asked Questions (FAQs)
|
# Frequently Asked Questions (FAQs)
|
||||||
|
|
||||||
Here is a list of frequently asked questions around the development of bindings.
|
Here is a list of frequently asked questions around the development of bindings.
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: developersguide
|
||||||
title: Bindings
|
title: Bindings
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# Developing a Binding
|
# Developing a Binding
|
||||||
|
|
||||||
{:.no_toc}
|
{:.no_toc}
|
||||||
|
@ -969,7 +967,7 @@ Binding additional services to a handler can be achieved by implementing the ser
|
||||||
Instead of using the Component annotation your discovery service implements the `ThingHandlerService`.
|
Instead of using the Component annotation your discovery service implements the `ThingHandlerService`.
|
||||||
It should extend the `AbstractDiscoveryService` (which implements `DiscoveryService`) just like a normal service:
|
It should extend the `AbstractDiscoveryService` (which implements `DiscoveryService`) just like a normal service:
|
||||||
|
|
||||||
```
|
```java
|
||||||
public class <your binding bridge DiscoveryService> extends AbstractDiscoveryService
|
public class <your binding bridge DiscoveryService> extends AbstractDiscoveryService
|
||||||
implements ThingHandlerService {
|
implements ThingHandlerService {
|
||||||
```
|
```
|
||||||
|
@ -977,7 +975,7 @@ public class <your binding bridge DiscoveryService> extends AbstractDiscoverySer
|
||||||
The interface `ThingHandlerService` has 2 methods to pass the handler of the bridge.
|
The interface `ThingHandlerService` has 2 methods to pass the handler of the bridge.
|
||||||
A typical implementation is:
|
A typical implementation is:
|
||||||
|
|
||||||
```
|
```java
|
||||||
@Override
|
@Override
|
||||||
public void setThingHandler(@Nullable ThingHandler handler) {
|
public void setThingHandler(@Nullable ThingHandler handler) {
|
||||||
if (handler instanceof <your binding handler>) {
|
if (handler instanceof <your binding handler>) {
|
||||||
|
@ -997,7 +995,7 @@ The handler can be used to get the bridge UID or to get access to the configured
|
||||||
In the bridge handler you need to activate the thing handler service.
|
In the bridge handler you need to activate the thing handler service.
|
||||||
This is done by implementing the `getServices` method in your bridge handler:
|
This is done by implementing the `getServices` method in your bridge handler:
|
||||||
|
|
||||||
```
|
```java
|
||||||
@Override
|
@Override
|
||||||
public Collection<Class<? extends ThingHandlerService>> getServices() {
|
public Collection<Class<? extends ThingHandlerService>> getServices() {
|
||||||
return Collections.singleton(<your binding bridge DiscoveryService>.class);
|
return Collections.singleton(<your binding bridge DiscoveryService>.class);
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: developersguide
|
||||||
title: Thing Descriptions
|
title: Thing Descriptions
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# Binding Definitions
|
# Binding Definitions
|
||||||
|
|
||||||
{:.no_toc}
|
{:.no_toc}
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: developersguide
|
||||||
title: Build System
|
title: Build System
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# Build System
|
# Build System
|
||||||
|
|
||||||
The buildsystem is based on maven.
|
The buildsystem is based on maven.
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: developersguide
|
||||||
title: Contribution
|
title: Contribution
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# Contributing to the Development of openHAB
|
# Contributing to the Development of openHAB
|
||||||
|
|
||||||
## The Repositories
|
## The Repositories
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: developersguide
|
||||||
title: Extension service
|
title: Extension service
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# Extension service
|
# Extension service
|
||||||
|
|
||||||
openHAB comes with an API that allows implementing a service that manages the installed extensions within a solution.
|
openHAB comes with an API that allows implementing a service that manages the installed extensions within a solution.
|
||||||
|
|
|
@ -4,8 +4,6 @@ title: Governance
|
||||||
license: Parts of this page have been derived from the EPLv2 licensed https://www.eclipse.org/projects/handbook
|
license: Parts of this page have been derived from the EPLv2 licensed https://www.eclipse.org/projects/handbook
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# Governance of the openHAB Project
|
# Governance of the openHAB Project
|
||||||
|
|
||||||
## Principles
|
## Principles
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: developersguide
|
||||||
title: Coding Guidelines
|
title: Coding Guidelines
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# Coding Guidelines
|
# Coding Guidelines
|
||||||
|
|
||||||
{:.no_toc}
|
{:.no_toc}
|
||||||
|
@ -89,9 +87,9 @@ The rules are defined at <https://github.com/openhab/static-code-analysis/tree/m
|
||||||
### Java Coding Style
|
### Java Coding Style
|
||||||
|
|
||||||
- The [Java naming conventions](https://java.about.com/od/javasyntax/a/nameconventions.htm) should always be used and are descibed in detail at the link, a quick summary is:
|
- The [Java naming conventions](https://java.about.com/od/javasyntax/a/nameconventions.htm) should always be used and are descibed in detail at the link, a quick summary is:
|
||||||
* Channel IDs: `lowerCamelCase`
|
- Channel IDs: `lowerCamelCase`
|
||||||
* Variables: `lowerCamelCase`
|
- Variables: `lowerCamelCase`
|
||||||
* Constants: `ALL_UPPER_CASE`
|
- Constants: `ALL_UPPER_CASE`
|
||||||
- Generics must be used where applicable. See example below:
|
- Generics must be used where applicable. See example below:
|
||||||
|
|
||||||
```java
|
```java
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: developersguide
|
||||||
title: IO Services
|
title: IO Services
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# Developing an IO Service
|
# Developing an IO Service
|
||||||
|
|
||||||
TODO
|
TODO
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: developersguide
|
||||||
title: Automation Modules
|
title: Automation Modules
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# Developing Automation Modules
|
# Developing Automation Modules
|
||||||
|
|
||||||
{:.no_toc}
|
{:.no_toc}
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: developersguide
|
||||||
title: Configuration Admin
|
title: Configuration Admin
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# Configuration Admin Service
|
# Configuration Admin Service
|
||||||
|
|
||||||
As defined in the [OSGi Compendium Release 7][OSGi-cmpn] *configuration is the process of defining the configuration data of bundles and assuring that those bundles receive that data when they are active in the OSGi Service Platform.*
|
As defined in the [OSGi Compendium Release 7][OSGi-cmpn] *configuration is the process of defining the configuration data of bundles and assuring that those bundles receive that data when they are active in the OSGi Service Platform.*
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: developersguide
|
||||||
title: Equinox
|
title: Equinox
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# Equinox
|
# Equinox
|
||||||
|
|
||||||
{:.no_toc}
|
{:.no_toc}
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: developersguide
|
||||||
title: Event Admin
|
title: Event Admin
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# Introduction
|
# Introduction
|
||||||
|
|
||||||
In a dynamic environment like OSGi, communication with events has a wide variety of use cases.
|
In a dynamic environment like OSGi, communication with events has a wide variety of use cases.
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: developersguide
|
||||||
title: OSGi
|
title: OSGi
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# OSGi Overview
|
# OSGi Overview
|
||||||
|
|
||||||
{:.no_toc}
|
{:.no_toc}
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: developersguide
|
||||||
title: OSGi Declarative Services
|
title: OSGi Declarative Services
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# Declarative Services
|
# Declarative Services
|
||||||
|
|
||||||
{:.no_toc}
|
{:.no_toc}
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: developersguide
|
||||||
title: Persistence Service
|
title: Persistence Service
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# Developing a Persistence Service
|
# Developing a Persistence Service
|
||||||
|
|
||||||
TODO
|
TODO
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: developersguide
|
||||||
title: Writing tests
|
title: Writing tests
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# Tests
|
# Tests
|
||||||
|
|
||||||
There are two approaches for testing:
|
There are two approaches for testing:
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: developersguide
|
||||||
title: Transformations / Profiles
|
title: Transformations / Profiles
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# Developing a Transformation Service
|
# Developing a Transformation Service
|
||||||
|
|
||||||
Transformations and Profiles (see next section) are very similar in their nature. Usually
|
Transformations and Profiles (see next section) are very similar in their nature. Usually
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: developersguide
|
||||||
title: Event Bus
|
title: Event Bus
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# Event Bus
|
# Event Bus
|
||||||
|
|
||||||
{:.no_toc}
|
{:.no_toc}
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: developersguide
|
||||||
title: Internationalization
|
title: Internationalization
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# Internationalization
|
# Internationalization
|
||||||
|
|
||||||
{:.no_toc}
|
{:.no_toc}
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: documentation
|
||||||
title: Armbian
|
title: Armbian
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# Armbian
|
# Armbian
|
||||||
|
|
||||||
## What is Armbian?
|
## What is Armbian?
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: documentation
|
||||||
title: Docker
|
title: Docker
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# openHAB inside a Docker Container
|
# openHAB inside a Docker Container
|
||||||
|
|
||||||
Docker is the most popular among a collection of tools that provide containerization.
|
Docker is the most popular among a collection of tools that provide containerization.
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: documentation
|
||||||
title: Installation Overview
|
title: Installation Overview
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# Installation Overview
|
# Installation Overview
|
||||||
|
|
||||||
openHAB is written completely in Java.
|
openHAB is written completely in Java.
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: documentation
|
||||||
title: openHAB on Linux
|
title: openHAB on Linux
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# openHAB on Linux
|
# openHAB on Linux
|
||||||
|
|
||||||
The following instructions will guide you through the process of setting up openHAB and recommended packages for both .DEB (Ubuntu, Debian etc.) and .RPM (RedHat, CentOS, Fedora etc.) Linux systems.
|
The following instructions will guide you through the process of setting up openHAB and recommended packages for both .DEB (Ubuntu, Debian etc.) and .RPM (RedHat, CentOS, Fedora etc.) Linux systems.
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: documentation
|
||||||
title: macOS
|
title: macOS
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# Installation on macOS
|
# Installation on macOS
|
||||||
|
|
||||||
This page is structured as follows:
|
This page is structured as follows:
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: documentation
|
||||||
title: QNAP NAS
|
title: QNAP NAS
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# QNAP NAS
|
# QNAP NAS
|
||||||
|
|
||||||
The [QNAP NAS](https://www.qnap.com) is a NAS server solution for your home, allowing the installation of additional packages.
|
The [QNAP NAS](https://www.qnap.com) is a NAS server solution for your home, allowing the installation of additional packages.
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: documentation
|
||||||
title: Raspberry Pi
|
title: Raspberry Pi
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
**Contents**
|
**Contents**
|
||||||
{::options toc_levels="2..4"/}
|
{::options toc_levels="2..4"/}
|
||||||
|
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: documentation
|
||||||
title: Securing Communication and Access
|
title: Securing Communication and Access
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# Securing access to openHAB
|
# Securing access to openHAB
|
||||||
|
|
||||||
openHAB has mainly two ways to be accessed:
|
openHAB has mainly two ways to be accessed:
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: documentation
|
||||||
title: Synology DiskStation
|
title: Synology DiskStation
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# Synology DiskStation
|
# Synology DiskStation
|
||||||
|
|
||||||
The [DiskStation by Synology](https://www.synology.com/en-us/dsm) is a famous NAS server solution for your home, allowing the installation of additional packages.
|
The [DiskStation by Synology](https://www.synology.com/en-us/dsm) is a famous NAS server solution for your home, allowing the installation of additional packages.
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: documentation
|
||||||
title: Windows
|
title: Windows
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# openHAB on Windows
|
# openHAB on Windows
|
||||||
|
|
||||||
The following instructions will guide you through the process of setting up openHAB.
|
The following instructions will guide you through the process of setting up openHAB.
|
||||||
|
|
|
@ -2,7 +2,7 @@
|
||||||
layout: intro
|
layout: intro
|
||||||
title: openHAB 2 - Search Results
|
title: openHAB 2 - Search Results
|
||||||
---
|
---
|
||||||
{% include base.html %}
|
|
||||||
<h2>Search Results</h2>
|
<h2>Search Results</h2>
|
||||||
<div id="searchresults">
|
<div id="searchresults">
|
||||||
<div id="gsearch"></div>
|
<div id="gsearch"></div>
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: documentation
|
||||||
title: openhab-docs Markdown StyleGuide
|
title: openhab-docs Markdown StyleGuide
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# openHAB Documentation Style Guide
|
# openHAB Documentation Style Guide
|
||||||
|
|
||||||
## General Remarks
|
## General Remarks
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: documentation
|
||||||
title: Getting Started - First Steps
|
title: Getting Started - First Steps
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# First Steps
|
# First Steps
|
||||||
|
|
||||||
The following instructions will guide you through the initial steps after first installing openHAB.
|
The following instructions will guide you through the initial steps after first installing openHAB.
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: documentation
|
||||||
title: Getting Started - Introduction
|
title: Getting Started - Introduction
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# Welcome
|
# Welcome
|
||||||
|
|
||||||
Welcome to openHAB.
|
Welcome to openHAB.
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: documentation
|
||||||
title: Semantic Model
|
title: Semantic Model
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# Semantic Model
|
# Semantic Model
|
||||||
|
|
||||||
Things represent devices and the sensors and actuators of those devices.
|
Things represent devices and the sensors and actuators of those devices.
|
||||||
|
@ -209,5 +207,6 @@ This is a table describing the Equipment, Point and Property classes needed to e
|
||||||
| Humidity | Measurement | * | Measurement | Humidity |
|
| Humidity | Measurement | * | Measurement | Humidity |
|
||||||
|
|
||||||
This table is based off the sources:
|
This table is based off the sources:
|
||||||
|
|
||||||
- <https://github.com/openhab/openhab-webui/blob/main/bundles/org.openhab.ui/web/src/components/cards/glance/location/status-badge.vue#L63>
|
- <https://github.com/openhab/openhab-webui/blob/main/bundles/org.openhab.ui/web/src/components/cards/glance/location/status-badge.vue#L63>
|
||||||
- <https://github.com/openhab/openhab-webui/blob/main/bundles/org.openhab.ui/web/src/components/cards/glance/location/measurement-badge.vue#L48>
|
- <https://github.com/openhab/openhab-webui/blob/main/bundles/org.openhab.ui/web/src/components/cards/glance/location/measurement-badge.vue#L48>
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: documentation
|
||||||
title: Persistence
|
title: Persistence
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# Persistence
|
# Persistence
|
||||||
|
|
||||||
There are many times in home automation where one wants to keep, chart, and otherwise use the historic states of their Items.
|
There are many times in home automation where one wants to keep, chart, and otherwise use the historic states of their Items.
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: documentation
|
||||||
title: Adding Things - Advanced
|
title: Adding Things - Advanced
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# Adding Things - Advanced
|
# Adding Things - Advanced
|
||||||
|
|
||||||
Some bindings and technologies simply do not support automatic discovery.
|
Some bindings and technologies simply do not support automatic discovery.
|
||||||
|
|
|
@ -3,7 +3,6 @@ layout: documentation
|
||||||
title: Adding Things - Intermediate
|
title: Adding Things - Intermediate
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
Previous: [Adding Things - Simple]({{base}}/tutorial/things_simple.html)
|
Previous: [Adding Things - Simple]({{base}}/tutorial/things_simple.html)
|
||||||
|
|
||||||
# Adding Things - Intermediate
|
# Adding Things - Intermediate
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: documentation
|
||||||
title: Adding Things - Simple
|
title: Adding Things - Simple
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# Adding Things - Simple
|
# Adding Things - Simple
|
||||||
|
|
||||||
As covered in the [concepts section]({{base}}/concepts/index.html) of the openHAB Docs, a binding is an add-on to openHAB that understands how to communicate with a specific home automation technology or API.
|
As covered in the [concepts section]({{base}}/concepts/index.html) of the openHAB Docs, a binding is an add-on to openHAB that understands how to communicate with a specific home automation technology or API.
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: raw
|
||||||
title: Tutorials
|
title: Tutorials
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
<div class="container target">
|
<div class="container target">
|
||||||
<h1>Tutorials</h1>
|
<h1>Tutorials</h1>
|
||||||
<p>Choose one of the options below to learn more about openHAB, either by following along a tutorial or by looking at a few examples.</p>
|
<p>Choose one of the options below to learn more about openHAB, either by following along a tutorial or by looking at a few examples.</p>
|
||||||
|
|
|
@ -3,8 +3,6 @@ layout: documentation
|
||||||
title: Sitemaps
|
title: Sitemaps
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base.html %}
|
|
||||||
|
|
||||||
# Sitemaps
|
# Sitemaps
|
||||||
|
|
||||||
In openHAB a collection of [Things]({{base}}/concepts/things.html) and [Items]({{base}}/concepts/items.html) represent physical or logical objects in the user's home automation setup.
|
In openHAB a collection of [Things]({{base}}/concepts/things.html) and [Items]({{base}}/concepts/items.html) represent physical or logical objects in the user's home automation setup.
|
||||||
|
|
Loading…
Reference in New Issue