Skip to content

Commit

Permalink
Fix Android USAGE.md import, fixes openhab#617
Browse files Browse the repository at this point in the history
Signed-off-by: Thomas Dietrich <[email protected]>
  • Loading branch information
Thomas Dietrich authored and Thomas Dietrich committed Jan 7, 2018
1 parent c4db6d7 commit 4b76867
Show file tree
Hide file tree
Showing 8 changed files with 29 additions and 20 deletions.
27 changes: 17 additions & 10 deletions addons/uis/apps/android.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,26 @@
---
layout: documentation
title: Android openHAB App
title: Android App
source: https://github.com/openhab/openhab-android/blob/master/docs/USAGE.md
---

{% include base.html %}

<!-- Attention authors: Do not edit directly. Please add your changes to the appropriate source repository -->

# Android openHAB App
# Android App

The openHAB Android application is a native client for openHAB. The app follows the basic principles of the other UIs, like Basic UI, and presents your predefined openHAB [sitemap(s)](http://docs.openhab.org/configuration/sitemaps.html).
The openHAB Android application is a native client for openHAB, compatible with phones and tablets.
The app follows the basic principles of the other openHAB UIs, like Basic UI, and presents your predefined openHAB [sitemap(s)](http://docs.openhab.org/configuration/sitemaps.html).

<a href="https://play.google.com/store/apps/details?id=org.openhab.habdroid"><img src="https://play.google.com/intl/en_us/badges/images/generic/en_badge_web_generic.png" height="80"></a>
<a href="https://play.google.com/store/apps/details?id=org.openhab.habdroid">
<img alt="Get it on Google Play" src="images/en_badge_web_generic.png" width="240px">
</a>

## Features

* Control your openHAB server and/or [openHAB Cloud instance](https://github.com/openhab/openhab-cloud), e.g., an account with [myopenHAB](http://www.myopenhab.org/)
* Receive notifications through an openHAB Cloud connection, [read more](http://docs.openhab.org/addons/actions.html)
* Receive notifications through an openHAB Cloud connection, [read more](http://docs.openhab.org/addons/actions.html)
* Change items via NFC tags
* Send voice commands to openHAB
* Supports wall mounted tablets
Expand All @@ -29,14 +33,17 @@ The openHAB Android application is a native client for openHAB. The app follows
## Getting Started

When first installed the app is in "Demo Mode".
To connect it to your own openHAB server, first navigate to Settings and uncheck the "Demo Mode" option.
Normally, after unchecking the Demo Mode, the app will be able to use multicast DNS to autodetect to your openHAB server if it is on the same network.
To connect to your own openHAB server, first navigate into the Settings menu and uncheck the "Demo Mode" option.
Normally, after unchecking the Demo Mode, the app will be able to use multicast DNS to auto-detect your openHAB server if it is on the same network.

You also have the option to manually set the server URL in the settings.

**Local server settings:** Please enter the base URL to your openHAB server as you would enter it in the browser to reach the openHAB dashboard.
**Local server settings:**
Please enter the base URL to your openHAB server as you would enter it in the browser to reach the openHAB dashboard.

**Remote server settings:** If you want to use openHAB cloud, please enter URL, user and password of you cloud instance here. Please make sure to [secure this connection](http://docs.openhab.org/installation/security.html).
**Remote server settings:**
If you want to use openHAB cloud, please enter URL, user and password of you cloud instance here.
Please make sure to [secure this connection](http://docs.openhab.org/installation/security.html).

The URL might look like one of the following examples:

Expand All @@ -50,7 +57,7 @@ There are a number of strategies available to provide [secure remote access]({{b

## Permanent Deployment

If you want to use openHAB Android on a wall mounted tablet, go to settings and tick `Disable display timer` and `Full Screen`.
If you want to use openHAB Android on a wall mounted tablet, go to settings and tick `Disable display timer` and `Fullscreen`.

## Help and Technical Details

Expand Down
Binary file removed addons/uis/apps/images/English_Get_it_Win_10.png
Binary file not shown.
File renamed without changes
File renamed without changes
14 changes: 8 additions & 6 deletions addons/uis/apps/ios.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,21 @@
---
layout: documentation
title: iOS openHAB App
title: iOS App
---

{% include base.html %}

# iOS openHAB App
# iOS App

<!-- https://developer.apple.com/app-store/marketing/guidelines/de/#downloadOnAppstore -->

We provide a native iOS app for openHAB, compatible with iPhone and iPad.
The openHAB iOS application is a native client for openHAB, compatible with iPhone and iPad.
It uses the REST API of openHAB to render sitemaps of your openHAB installation for a natural iOS feeling.

<a href="https://itunes.apple.com/us/app/openhab/id492054521">
<img alt="Download on the App Store" src="images/download-on-the-app-store.png" width="240px">
</a>

## Features

- View and control openHAB sitemaps
Expand All @@ -30,8 +34,6 @@ It uses the REST API of openHAB to render sitemaps of your openHAB installation

The latest release version of the app is always available through the Apple App Store.

[![Download openHAB app on the App Store](images/download-on-the-app-store.png)](https://itunes.apple.com/us/app/openhab/id492054521)

The app will start in Demo mode by default.
A demo home automation setup is shown.
This allows you to explore the possibilities of a typical openHAB installation.
Expand All @@ -46,6 +48,6 @@ The openHAB app will henceforth first try connecting to the local URL, then fall

## Help and Resources

If your question or problem isn't covered here in the documentation pages, check the [openHAB Community Forum](https://community.openhab.org).
If your question or problem isn't covered here in the documentation pages, check the [openHAB Community Forum](https://community.openhab.org).

Also, please refer to the [openhab.ios project](https://github.com/openhab/openhab.ios) on GitHub for more technical details.
4 changes: 2 additions & 2 deletions addons/uis/apps/windows.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
layout: documentation
title: Windows 10 openHAB App
title: Windows 10 App
---

{% include base.html %}

# Windows 10 openHAB 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).
It uses the REST API of openHAB to render sitemaps of your openHAB installation.
Expand Down
4 changes: 2 additions & 2 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -393,7 +393,7 @@
<outputDirectory>${basedir}/configuration</outputDirectory>
<resources>
<resource>
<directory>${basedir}/.external-resources/openhab-bundles/uis/org.openhab.ui.habpanel/docs</directory>
<directory>${basedir}/.external-resources/openhab-bundles/uis/org.openhab.ui.habpanel/doc</directory>
<includes>
<include>habpanel.md</include>
<include>images/*.png</include>
Expand All @@ -412,7 +412,7 @@
<outputDirectory>${basedir}/addons/uis/apps</outputDirectory>
<resources>
<resource>
<directory>${basedir}/${basedir}/.external-resources/openhab-android/docs</directory>
<directory>${basedir}/.external-resources/openhab-android/docs</directory>
<includes>
<include>images/*.png</include>
</includes>
Expand Down

0 comments on commit 4b76867

Please sign in to comment.