Plugin <description> displayed in Hardware page

Python and python framework

Moderator: leecollings

Post Reply
User avatar
Dnpwwo
Posts: 820
Joined: Sunday 23 March 2014 9:00
Target OS: Raspberry Pi / ODroid
Domoticz version: Beta
Location: Melbourne, Australia
Contact:

Plugin <description> displayed in Hardware page

Post by Dnpwwo »

Update pushed to Domoticz to allow plugin authors to include guidance to users on plugin configuration or to just communicate what the plugin does.

The optional <description> tag in the plugin definition is now sent to the browser in the Hardware page and displayed as HTML.

For example:

Code: Select all

"""
<plugin key="Kodi" name="Kodi Players" author="dnpwwo" version="2.4.1" wikilink="https://github.com/dnpwwo/Domoticz-Kodi-Plugin" externallink="https://kodi.tv/">
    <description>
		<h2>Kodi Media Player Plugin</h2><br/>
		<h3>Features</h3>
		<ul style="list-style-type:square">
			<li>Comes with three selectable icon sets</li>
			<li>Display Domoticz notifications on Kodi screen</li>
			<li>Multiple Shutdown action options</li>
		</ul>
		<h3>Devices</h3>
		<ul style="list-style-type:square">
			<li>Status</li>
			<li>Volume</li>
			<li>Source</li>
			<li>Playing</li>
		</ul>
    </description>
    <params>
	...
will now look like this:
Untitled.png
Untitled.png (28.96 KiB) Viewed 709 times
The reasonable man adapts himself to the world; the unreasonable one persists to adapt the world to himself. Therefore all progress depends on the unreasonable man. George Bernard Shaw
User avatar
ycahome
Posts: 248
Joined: Sunday 12 February 2017 10:55
Target OS: Linux
Domoticz version: lat Beta
Contact:

Re: Plugin <description> displayed in Hardware page

Post by ycahome »

Hello,

tried to use without success.

Can you spot an error to my code regarding description?

https://github.com/ycahome/pp-manager/b ... /plugin.py
blauwebuis
Posts: 331
Joined: Wednesday 21 December 2016 9:11
Target OS: Raspberry Pi / ODroid
Domoticz version: current
Contact:

Re: Plugin <description> displayed in Hardware page

Post by blauwebuis »

User avatar
Dnpwwo
Posts: 820
Joined: Sunday 23 March 2014 9:00
Target OS: Raspberry Pi / ODroid
Domoticz version: Beta
Location: Melbourne, Australia
Contact:

Re: Plugin <description> displayed in Hardware page

Post by Dnpwwo »

@ycahome,

Assuming you are running a current beta you definition looks fine.

There was a change to the Hardware page itself, did you refresh your browser cache?
The reasonable man adapts himself to the world; the unreasonable one persists to adapt the world to himself. Therefore all progress depends on the unreasonable man. George Bernard Shaw
User avatar
ycahome
Posts: 248
Joined: Sunday 12 February 2017 10:55
Target OS: Linux
Domoticz version: lat Beta
Contact:

Re: Plugin <description> displayed in Hardware page

Post by ycahome »

@Dnpwwo

You are right but, requires not just a refresh but a clear cache/Delete Browser Data (depends on browser).

Thanks,
Post Reply

Who is online

Users browsing this forum: No registered users and 1 guest