Added support for dashboard links to external services. #185

paulianttila · 2017-08-12T16:49:38Z

Signed-off-by: Pauli Anttila pauli.anttila@gmail.com

Signed-off-by: Pauli Anttila <pauli.anttila@gmail.com>

martinvw

Looks great! @kaikreuzer can you also take a look?

kaikreuzer

Thanks, a nice feature!
Just some suggestions on how to further improve it :-)

kaikreuzer · 2017-08-12T20:08:07Z

bundles/org.openhab.ui.dashboard/README.md

@@ -0,0 +1,34 @@
+# Dashboard tiles


-> Just "Dashboard"

kaikreuzer · 2017-08-12T20:08:14Z

bundles/org.openhab.ui.dashboard/README.md

@@ -0,0 +1,34 @@
+# Dashboard tiles
+
+OpenHAB dashboard is landing page for the user where all openHAB UI's can be found. Dashboard support also links to external services. Links can be added to dashboard by ```conf/services/dashboard.cfg``` configuration file.


-> to the dashboard by editing the...

Please put every sentence in a new line to make diffing and reviewing easier.

kaikreuzer · 2017-08-12T20:13:19Z

bundles/org.openhab.ui.dashboard/README.md

+|-----------------|---------|-----------------------------------------------------------------------------------------|
+| link-nameX      | String  | Name which is shown in the openHAB dashboard.                                           |
+| link-urlX       | String  | URL to external service.                                                                |
+| link-overlayX   | String  | Image overlay icon. Supported values are empty (no icon), "html5", "android" or "apple" |


Actually many more. If I remember right, all icons from https://icomoon.io/#preview-free should work as an overlay.

Dashboard embedded web/fonts/icomoon.ttf seems to contain only html5, android and apple icons.

I wonder if in that case this feature at all makes sense - the overlay was used in the past, but as everything ended up using the HTML5 overlay, we removed it. So it is rather in there as some legacy, which we might not want to promote again through a new feature. Wdyt?

It's totally fine for me to remove this feature. If more icons would be supported, this feature make more sense as well.

Ok, so may I ask you to remove the overlay support here for the external tiles as a last change before merging? Thanks :-)

kaikreuzer · 2017-08-12T20:15:09Z

bundles/org.openhab.ui.dashboard/README.md

+| link-overlayX   | String  | Image overlay icon. Supported values are empty (no icon), "html5", "android" or "apple" |
+| link-imageurlX  | String  | URL to image.                                                                           |
+
+Where X is link unique number (see examples). All configuration parameters need to start with ```org.openhab.ui.dashboard:``` prefix.


We should change the service pid from org.openhab.ui.dashboard to org.openhab.dashboard. With that change, the pid is derived from the filename and you can leave out the prefix in the file:

link-name1=openHAB Log Viewer link-url1=http://localhost:9001 link-overlay1= link-imageurl1=http://localhost:8080/static/image.png

Would be much nicer!

That was the missing piece. I was wondering why some of the configuration files works without prefix.

kaikreuzer · 2017-08-12T20:15:51Z

bundles/org.openhab.ui.dashboard/README.md

+
+## Image URL
+
+Image URL support several URL formats. URL support direct http links to local or Internet servers, but also the "data" URL scheme (RFC2397) is supported. See e.g. [https://www.base64-image.de](https://www.base64-image.de) to convert images to base64 coded data.


Who needs access to the links? The server or the browser? Should be clarified.

kaikreuzer · 2017-08-12T20:16:48Z

bundles/org.openhab.ui.dashboard/README.md

+## Example configuration file
+```
+org.openhab.ui.dashboard:link-name1=openHAB Log Viewer
+org.openhab.ui.dashboard:link-url1=http://localhost:9001


If the answer to my question above is "the browser", your examples are pretty misleading - "localhost" won't really get you far...

kaikreuzer · 2017-08-12T20:17:31Z

bundles/org.openhab.ui.dashboard/README.md

+org.openhab.ui.dashboard:link-name1=openHAB Log Viewer
+org.openhab.ui.dashboard:link-url1=http://localhost:9001
+org.openhab.ui.dashboard:link-overlay1=
+org.openhab.ui.dashboard:link-imageurl1=http://localhost:8080/static/image.png


To avoid localhost, a relative url like ../static/image.png is probably better.

kaikreuzer · 2017-08-12T20:18:09Z

...g.openhab.ui.dashboard/src/main/java/org/openhab/ui/dashboard/internal/DashboardService.java

@@ -153,4 +162,30 @@ protected HttpServlet createServlet() {
        return new DashboardServlet(configurationAdmin, indexTemplate, entryTemplate, warnTemplate, setupTemplate,
                tiles);
    }
+
+    private void addTilesToExternalServices(Map<String, Object> properties) {


I'd prefer addTilesForExternalServices

kaikreuzer · 2017-08-12T20:19:12Z

...g.openhab.ui.dashboard/src/main/java/org/openhab/ui/dashboard/internal/DashboardTileImp.java

+ *
+ * @author Pauli Anttila - Initial contribution
+ */
+public class DashboardTileImp implements DashboardTile {


Could we fina a better class name? How about ExternalServiceTile?

Signed-off-by: Pauli Anttila <pauli.anttila@gmail.com>

paulianttila · 2017-08-13T07:25:06Z

Thanks @martinvw and @kaikreuzer for review. Hopefully all review comments are now fixed. I also improved configuration file syntax.

Signed-off-by: Pauli Anttila <pauli.anttila@gmail.com>

kaikreuzer

Sorry @paulianttila, another PR just got merged which now causes merge conflicts :-(
As you have to touch it again anyhow, let me add some further minor comments. Thanks!

kaikreuzer · 2017-08-15T11:14:55Z

bundles/org.openhab.ui.dashboard/README.md

+
+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


please add an empty line after the header

kaikreuzer · 2017-08-15T11:15:39Z

bundles/org.openhab.ui.dashboard/README.md

@@ -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.


Could you put every sentence in a new line?

Maybe change to "The openHAB dashboar is a landing page..."

You can use single backticks when highlighting code inline (no need to have three backticks).

Signed-off-by: Pauli Anttila <pauli.anttila@gmail.com>

kaikreuzer · 2017-08-18T14:18:37Z

Thanks for the update, but you missed the removal of overlays from the documentation...

Signed-off-by: Pauli Anttila <pauli.anttila@gmail.com>

kaikreuzer · 2017-08-18T15:17:11Z

Ah, I think we now have it 👍

kaikreuzer · 2017-08-18T15:18:58Z

bundles/org.openhab.ui.dashboard/README.md

@@ -0,0 +1,34 @@
+# Dashboard


@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?

I'll open an issue for this.

openhab-bot · 2017-11-30T19:50:58Z

This pull request has been mentioned on openHAB Community. There might be relevant details there:

https://community.openhab.org/t/how-to-add-additional-links-apps-to-the-openhab-8080-start-index-page/36770/9

@rkoshak

openhab#469) * Adding description on using sendCommand/postUpdate The use of sendCommand and postUpdate in rules is explained with an emphasis on discouraging the generic method sendCommand(Item,arg) over the method Item.sendCommand(arg) that provides much more reliable type conversions. Details as to the background have been added Signed-off-by: lipp.markus@gmail.com (github: LightIsLife) * Adding description on using sendCommand/postUpdate fixes openhab#185 openhab#469 Addressing comments by @rkoshak on commit 042dae745cb7f830d8c757e5d09a08e46c949dde Signed-off-by: lipp.markus@gmail.com (github: LightIsLife) * Updating language/editorial changes Some editorial changes throughout, and added more consistency in the use of "" where new_state has to be a string (in actions) and no quotation marks where this is not mandated (in methods). Signed-off-by: Markus Lipp <lipp.markus@gmail.com> (github: LightIsLife) * Addressing comments made Addressing all comments by @ThomDietrich: sentences are shortened and simplifies, heading capitalized and modified, text overall slightly shortened, etc * fixed typo just fixing a few typos * made sentences shorter Sentences shortened to address comments received * one line per sentence reformatting Adjustment as per style convention to each sentence begins on its own line * Add some further clarification Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich) * moved section to scripts, deleted details Addressing comments by @ThomDietrich. Moved the whole new section (Manipulating item states) into exisiting section "Scripts" Deleted the paras under "Details"

* Added dashboard support for links to external services. Signed-off-by: Pauli Anttila <pauli.anttila@gmail.com> GitOrigin-RevId: ef8d0df

Added dashboard support for links to external services.

c29fc7f

Signed-off-by: Pauli Anttila <pauli.anttila@gmail.com>

martinvw approved these changes Aug 12, 2017

View reviewed changes

kaikreuzer requested changes Aug 12, 2017

View reviewed changes

Review comments changes and improved configuration file syntax.

257d8a5

Signed-off-by: Pauli Anttila <pauli.anttila@gmail.com>

Removed useless NumberFormatException handling as suffix is text now

1f79964

Signed-off-by: Pauli Anttila <pauli.anttila@gmail.com>

kaikreuzer requested changes Aug 15, 2017

View reviewed changes

paulianttila added 4 commits August 15, 2017 19:38

More review changes

a7dec56

Signed-off-by: Pauli Anttila <pauli.anttila@gmail.com>

Fixed merge conflicts

3ba5941

Signed-off-by: Pauli Anttila <pauli.anttila@gmail.com>

Fixed merge problem

3db68c0

Signed-off-by: Pauli Anttila <pauli.anttila@gmail.com>

Changed component name to org.openhab.dashboard

6bcd0d9

Removed overlay support

efbb419

Signed-off-by: Pauli Anttila <pauli.anttila@gmail.com>

paulianttila force-pushed the dashboard-links branch from 5e311de to efbb419 Compare August 18, 2017 14:55

kaikreuzer merged commit ef8d0df into openhab:master Aug 18, 2017

kaikreuzer reviewed Aug 18, 2017

View reviewed changes

kaikreuzer added this to the 2.2 milestone Dec 15, 2017

kaikreuzer added the enhancement An enhancement or new feature of the Core label Dec 15, 2017

ThomDietrich mentioned this pull request Jan 3, 2018

Dashboard: Support hostname placeholder for external services #272

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added support for dashboard links to external services. #185

Added support for dashboard links to external services. #185

paulianttila commented Aug 12, 2017

martinvw left a comment

kaikreuzer left a comment

kaikreuzer Aug 12, 2017

kaikreuzer Aug 12, 2017

kaikreuzer Aug 12, 2017

kaikreuzer Aug 12, 2017

kaikreuzer Aug 12, 2017

kaikreuzer Aug 12, 2017

paulianttila Aug 13, 2017

kaikreuzer Aug 16, 2017

paulianttila Aug 17, 2017

kaikreuzer Aug 17, 2017

kaikreuzer Aug 12, 2017

paulianttila Aug 13, 2017

kaikreuzer Aug 12, 2017

kaikreuzer Aug 12, 2017

kaikreuzer Aug 12, 2017

kaikreuzer Aug 12, 2017

kaikreuzer Aug 12, 2017

paulianttila commented Aug 13, 2017 •

edited

kaikreuzer left a comment

kaikreuzer Aug 15, 2017

kaikreuzer Aug 15, 2017

kaikreuzer Aug 15, 2017

kaikreuzer Aug 15, 2017

kaikreuzer commented Aug 18, 2017

kaikreuzer commented Aug 18, 2017

kaikreuzer Aug 18, 2017

ThomDietrich Aug 19, 2017

openhab-bot commented Nov 30, 2017

		@@ -0,0 +1,34 @@
		# Dashboard tiles

		OpenHAB dashboard is landing page for the user where all openHAB UI's can be found. Dashboard support also links to external services. Links can be added to dashboard by ```conf/services/dashboard.cfg``` configuration file.


		## Image URL

		Image URL support several URL formats. URL support direct http links to local or Internet servers, but also the "data" URL scheme (RFC2397) is supported. See e.g. [https://www.base64-image.de](https://www.base64-image.de) to convert images to base64 coded data.


		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

		@@ -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.

Navigation Menu

Added support for dashboard links to external services. #185

Added support for dashboard links to external services. #185

Conversation

paulianttila commented Aug 12, 2017

martinvw left a comment

Choose a reason for hiding this comment

kaikreuzer left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

paulianttila commented Aug 13, 2017 • edited

kaikreuzer left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kaikreuzer commented Aug 18, 2017

kaikreuzer commented Aug 18, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

openhab-bot commented Nov 30, 2017

paulianttila commented Aug 13, 2017 •

edited