New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Added support for dashboard links to external services. #185
Changes from 3 commits
c29fc7f
257d8a5
1f79964
a7dec56
3ba5941
3db68c0
6bcd0d9
efbb419
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
# Dashboard | ||
|
||
openHAB dashboard is landing page for the user where all openHAB UIs can be found. Dashboard support also links to external services. Links can be added to the dashboard by editing the ```conf/services/dashboard.cfg``` configuration file. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Could you put every sentence in a new line? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Maybe change to "The openHAB dashboar is a landing page..." There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. You can use single backticks when highlighting code inline (no need to have three backticks). |
||
|
||
## Link Configuration | ||
|
||
| Parameter name | Type | Description | | ||
|-----------------|---------|-----------------------------------------------------------------------------------------| | ||
| X.link-name | String | Name which is shown in the openHAB dashboard. | | ||
| X.link-url | String | URL to external service. | | ||
| X.link-overlay | String | Image overlay icon. Supported values are empty (no icon), "html5", "android" or "apple" | | ||
| X.link-imageurl | String | URL to image which is shown in the dashboard. | | ||
|
||
Where X is link unique identifier (see examples). | ||
|
||
## Image URL | ||
|
||
Browser fetch image from image URL. URL can be direct http link or data URIs according to [RFC2397](https://tools.ietf.org/html/rfc2397). If data URIs are used, browser should support them as well. All five major browsers (Chrome, Firefox, IE, Opera and Safari) support data URIs . See e.g. [https://www.base64-image.de](https://www.base64-image.de) to convert images to base64 coded data. | ||
|
||
## Example configuration file | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. please add an empty line after the header |
||
``` | ||
frontail.link-name=openHAB Log Viewer | ||
frontail.link-url=http://<server-adddress>:9001 | ||
frontail.link-overlay= | ||
frontail.link-imageurl=../static/image.png | ||
|
||
nodered.link-name=Node-RED | ||
nodered.link-url=http://<server-adddress>:1880 | ||
nodered.link-overlay= | ||
nodered.link-imageurl=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAXwAAACfCAIAAA...QmCC | ||
|
||
``` | ||
|
||
Note: **nodered** image data URL is not valid (it's shorten for the sake of clarity). |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,82 @@ | ||
/** | ||
* Copyright (c) 2010-2017 by the respective copyright holders. | ||
* | ||
* All rights reserved. This program and the accompanying materials | ||
* are made available under the terms of the Eclipse Public License v1.0 | ||
* which accompanies this distribution, and is available at | ||
* http://www.eclipse.org/legal/epl-v10.html | ||
*/ | ||
package org.openhab.ui.dashboard.internal; | ||
|
||
import org.openhab.ui.dashboard.DashboardTile; | ||
|
||
/** | ||
* The dashboard tile for external services. | ||
* | ||
* @author Pauli Anttila - Initial contribution | ||
*/ | ||
public class ExternalServiceTile implements DashboardTile { | ||
private String name; | ||
private String url; | ||
private String overlay; | ||
private String imageUrl; | ||
|
||
private ExternalServiceTile(DashboardTileBuilder builder) { | ||
this.name = builder.name; | ||
this.url = builder.url; | ||
this.overlay = builder.overlay; | ||
this.imageUrl = builder.imageUrl; | ||
} | ||
|
||
@Override | ||
public String getName() { | ||
return name; | ||
} | ||
|
||
@Override | ||
public String getUrl() { | ||
return url; | ||
} | ||
|
||
@Override | ||
public String getOverlay() { | ||
return overlay; | ||
} | ||
|
||
@Override | ||
public String getImageUrl() { | ||
return imageUrl; | ||
} | ||
|
||
public static class DashboardTileBuilder { | ||
|
||
private String name; | ||
private String url; | ||
private String overlay; | ||
private String imageUrl; | ||
|
||
public DashboardTileBuilder withName(String name) { | ||
this.name = name; | ||
return this; | ||
} | ||
|
||
public DashboardTileBuilder withUrl(String url) { | ||
this.url = url; | ||
return this; | ||
} | ||
|
||
public DashboardTileBuilder withOverlay(String overlay) { | ||
this.overlay = overlay; | ||
return this; | ||
} | ||
|
||
public DashboardTileBuilder withImageUrl(String imageUrl) { | ||
this.imageUrl = imageUrl; | ||
return this; | ||
} | ||
|
||
public ExternalServiceTile build() { | ||
return new ExternalServiceTile(this); | ||
} | ||
} | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ThomDietrich Any suggestion where this page might best fit in on docs.openhab.org and whether we should automatically pick the page up from here, or simply copy the content over to openhab-docs?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll open an issue for this.