<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"></head><body style="word-wrap: break-word; -webkit-nbsp-mode: space; line-break: after-white-space;" class="">The for-v3.3 branch now has a simple working plugin repository. While it can download assets of all types (json, module, web_page, web_hook, and web_rsc), it currently only supports installation and enable/disable for scripts.<div class=""><br class=""></div><div class="">Some notes:</div><div class=""><br class=""></div><div class=""><ul class="MailOutline"><li class="">Repositories are used to store plugins. The repository has a name and a url, and is accessed over http/https for download. A repository ‘openvehicles’ at '<a href="http://api.openvehicles.com/plugins’" class="">http://api.openvehicles.com/plugins’</a> is installed by default. That repository published the OVMS v3 firmware plugins from our GitHub repository.<br class=""><br class=""></li><li class="">Repositories need to publish ‘plugins.json’ and ‘plugins.rev’ files in the root of their hosted directory. The first is JSON array of all the plugins hosted, and the second is a version number string for the repository. I’ve added a sample script to build the .json and .rev files from GitHub, and publish appropriately, in vehicle/OVMS.V3/support/buildplugins.pl.<br class=""><br class=""></li><li class="">You can add custom repositories with ‘plugin repo install’, and remove with ‘plugin repo remove’. The repository meta data is cached in RAM whenever a repository command is run (or you can force a refresh with ‘plugin repo refresh’.<br class=""><br class=""><font face="Andale Mono" class=""><span style="font-style: normal; font-size: 12px;" class="">OVMS# plugin repo list<br class="">Repository Version<br class="">openvehicles 3.2.014-98-g17b7989</span></font><div class=""><br class=""></div></li><li class="">Available plugins can be shown with ‘plugin list’.<br class=""><br class=""><font face="Andale Mono" class=""><span style="font-style: normal; font-size: 12px;" class="">OVMS# plugin list<br class="">Plugin Repo Version Description<br class="">chgthrottle openvehicles 1.2 Throttle charge current and/or stop charge if charger gets too hot.<br class="">helloworld openvehicles 0.1 This plugin is provided for demonstration and example purposes only.</span></font><br class=""><br class=""></li><li class="">You can use ‘plugin install <name>’ to install a plugin, and ‘plugin remove <name>’ to remove it. The system will automatically download the plugin from the repository for you.<br class=""><br class=""></li><li class="">Plugins can be enabled/disabled with ‘plugin enable <name>’ and ‘plugin disable <name>’, and updated with ‘plugin update {<name>}’ (if <name> is ommitted, all plugins are updated).<br class=""><br class=""></li><li class="">Installing and enabling a plugin that provides javascript modules will now result in those modules automatically being loaded at duktape initialisation time. You don’t need to add them to ovmsmain.js.<br class=""><br class=""></li><li class="">Both wifi and cellular network connections are supported.<br class=""><br class=""></li><li class="">There is a ‘helloworld’ plugin now available as an example.<br class=""><br class=""><font face="Andale Mono" class=""><span style="font-style: normal; font-size: 12px;" class="">OVMS# plugin install helloworld<br class="">Plugin: helloworld installed ok<br class="">I (620571) pluginstore: Downloading plugin: helloworld, with 2 element(s)<br class="">I (621671) pluginstore: Element: helloworld.js downloaded ok<br class="">I (622441) pluginstore: Element: helloworld.json downloaded ok<br class="">I (622441) pluginstore: Plugin: helloworld downloaded ok</span></font><div class=""><div class=""><font face="Andale Mono" class=""><span style="font-style: normal; font-size: 12px;" class=""><br class="">OVMS# script reload</span></font></div><div class=""><font face="Andale Mono" class=""><span style="font-style: normal; font-size: 12px;" class="">Reloading javascript engine</span></font></div><div class=""><font face="Andale Mono" class=""><span style="font-style: normal; font-size: 12px;" class="">I (635121) ovms-duktape: Duktape: Clearing existing context</span></font></div><div class=""><font face="Andale Mono" class=""><span style="font-style: normal; font-size: 12px;" class="">I (635251) ovms-duktape: Duktape: Creating heap</span></font></div><div class=""><font face="Andale Mono" class=""><span style="font-style: normal; font-size: 12px;" class="">I (635351) ovms-duktape: Duktape: Initialising module system</span></font></div><div class=""><font face="Andale Mono" class=""><span style="font-style: normal; font-size: 12px;" class="">I (635601) pluginstore: Loading enabled plugins</span></font></div><div class=""><font face="Andale Mono" class=""><span style="font-style: normal; font-size: 12px;" class="">I (635601) pluginstore: Load helloworld (0.1)<br class=""></span></font><div class=""><font face="Andale Mono" class=""><span style="font-style: normal; font-size: 12px;" class=""><br class="">OVMS# script eval '<a href="http://helloworld.info" class="">helloworld.info</a>()'</span></font></div><div class=""><font face="Andale Mono" class=""><span style="font-style: normal; font-size: 12px;" class="">Hello world</span></font></div></div></div></li></ul></div><div class=""><br class=""></div><div class=""><span style="caret-color: rgb(0, 0, 0); color: rgb(0, 0, 0);" class="">Next on my list is adding support for installing, enabling, and disabling web plugins; but I need to understand better how they integrate before I handle that.</span></div><div class=""><span style="caret-color: rgb(0, 0, 0); color: rgb(0, 0, 0);" class=""><br class=""></span></div><div class=""><font color="#000000" class="">After that, I need to handle the dependency system, and this should be done.</font></div><div class=""><br class=""></div><div class="">Regards, Mark.<br class=""><div><br class=""><blockquote type="cite" class=""><div class="">On 16 Jul 2020, at 8:52 AM, Mark Webb-Johnson <<a href="mailto:mark@webb-johnson.net" class="">mark@webb-johnson.net</a>> wrote:</div><br class="Apple-interchange-newline"><div class=""><meta http-equiv="Content-Type" content="text/html; charset=utf-8" class=""><div style="word-wrap: break-word; -webkit-nbsp-mode: space; line-break: after-white-space;" class="">Thanks, all, for the feedback.<div class=""><br class=""></div><div class="">@Nikolay: tags make sense and we can add. I think that in general the json could contain other fields (comments, notes, anything). The system itself really just needs name+version, with everything else as decoration or an enhancement to help searching.</div><div class=""><br class=""></div><div class="">@Derek: I’ll see how it looks when I upload. For download, a single zip is certainly easier, and this is not hard to do as part of the server script to publish a repository. Just not sure if it is actually necessary for us. Thanks for the link to the kodi repository structure.</div><div class=""><br class=""></div><div class="">@Michael: I think ‘module’ is the correct word (rather than ’script'. Let’s stick with that. I’ll work on this module side first, as I am not so familiar with the web extensions. The reason I suggested the ‘plugins’ directory (rather than ‘plugin’) was to allow us to move to this on an individual plugin basis. I’m not sure if that is necessary (we may instead be able to work off the existence of the json master file). I plan to try to make one plugin json and format first, then sort out the server side repository structure for that. Then we can review.</div><div class=""><div class=""><br class=""></div><div class="">Regards, Mark.</div><div class=""><br class=""><blockquote type="cite" class=""><div class="">On 14 Jul 2020, at 7:45 PM, Michael Balzer <<a href="mailto:dexter@expeedo.de" class="">dexter@expeedo.de</a>> wrote:</div><br class="Apple-interchange-newline"><div class="">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" class="">
<div class="">
Mark,<br class="">
<br class="">
full ack, has been on my list as well. I'll handle the web UI side.<br class="">
<br class="">
I don't think we need to migrate/change the folder structure, we
should be able to just add the meta data. I tried to define the
structure to be usable as a public repository. Did I miss something?<br class="">
<br class="">
Btw, I used the naming "module" plugins instead of "script" plugins,
as web plugins also consist mostly of scripts. I thought that would
clear things for users, but I'm not sure now.<br class="">
<br class="">
Regarding the plugin structure and meta data, we should decide
wether to split plugins into their elements or keep them bundled.
You seem to opt for bundles ("web subdirectory"). I would second
that, but we then need to take into account a plugin may consist of
multiple module and/or web plugins (see Edimax plugin for an
example). Normally it's just one module plugin, but we should not
restrict the system in that way. So the JSON file should allow to
define an array of plugin elements / options.<br class="">
<br class="">
Currently there's a version on each element, and but we could/should
simplify this to a central overall version for the plugin.<br class="">
<br class="">
To automatically install plugins, the meta data also needs to define
the types and default setups for web/frontend plugins.<br class="">
<br class="">
Draft: edimax.json:<br class="">
<br class="">
<tt class="">{<br class="">
name: "edimax",<br class="">
</tt><tt class=""><tt class=""> title: "Edimax: Smart Plug Control",<br class="">
description: "Smart Plug control for Edimax models SP-1101W,
SP-2101W et al",<br class="">
</tt></tt><tt class=""><tt class=""> group: "Home Automation",<br class="">
</tt> info:
<a class="moz-txt-link-rfc2396E" href="https://docs.openvehicles.com/en/latest/plugin/edimax/README.html">"https://docs.openvehicles.com/en/latest/plugin/edimax/README.html"</a>,<br class="">
</tt><tt class=""><tt class=""> maintainer: "Michael Balzer
<a class="moz-txt-link-rfc2396E" href="mailto:dexter@dexters-web.de"><dexter@dexters-web.de></a>",<br class="">
</tt> version: "2.1",<br class="">
prerequisites: ["ovms>=3.2.010"],<br class="">
elements: [{<br class="">
type: "script",<br class="">
path: "edimax.js",<br class="">
name: "edimax" // optional, defaults to plugin name<br class="">
},{<br class="">
type: "webpage",<br class="">
path: "edimax.htm",<br class="">
page: "/usr/edimax",<br class="">
label: "Edimax Smart Plug",<br class="">
menu: "Config",<br class="">
auth: "Cookie"<br class="">
},{<br class="">
type: "webhook",<br class="">
path: "edimax-status.htm",<br class="">
page: "/status",<br class="">
hook: "body.post"<br class="">
}]<br class="">
}</tt><tt class=""><tt class=""><tt class=""><tt class=""><br class="">
<br class="">
</tt></tt></tt></tt>A method to easily disable/enable
installed plugins would also be nice, i.e. as subcommands "plugin
disable" / "plugin enable".<br class="">
<br class="">
Regards,<br class="">
Michael<br class="">
<tt class=""><tt class=""><tt class=""><tt class=""><br class="">
<br class="">
</tt></tt></tt></tt>
<div class="moz-cite-prefix">Am 14.07.20 um 07:55 schrieb Mark
Webb-Johnson:<br class="">
</div>
<blockquote type="cite" cite="mid:6BAA0DAB-6CD2-4E30-A868-6C54B1D40CC5@webb-johnson.net" class="">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" class="">
<div class=""><br class="">
</div>
<div class="">I feel that our plugin system offers a missed
opportunity. By making small extensions to available
functionality, we can use this system to do so much - and with a
much lower complexity and barrier to entry compared to C++ ESP
IDF development.</div>
<div class=""><br class="">
</div>
<div class="">There are a couple of things I would like to now do:</div>
<div class=""><br class="">
</div>
<div class="">
<ol class="MailOutline">
<li class="">Implement a mechanism for plugins to directly
extend the console command language (other than the current
’script exec PLUGIN.fn’).<br class="">
<br class="">
</li>
<li class="">Implement a plugin repository, and command line
tools for managing plugins. We simply need to have a store
and directory of available plugins, a way of
searching/listing those, and a uniform way to install/remove
plugins. Once this is done, perhaps someone can handle the
web UI side of this, and perhaps that can even be done as a
plugin :-)</li>
</ol>
</div>
<div class=""><br class="">
</div>
<div class="">I’m already working on #1. Just an extension to the
existing script system to allow plugins to register commands,
and to have the command register/deregister done automatically
on plugin load/unload.</div>
<div class=""><br class="">
</div>
<div class="">However, #2 is a little more tricky and I’m looking
for feedback on the design of this. My idea is:</div>
<div class=""><br class="">
</div>
<div class="">
<ul class="MailOutline">
<li class="">Store the plugins in a new
github/openvehicles/Open-Vehicle-Monitoring-System-3/plugins
folder. Eventually the /plugin folder will all be migrated
to here.<br class="">
<br class="">
</li>
<li class="">Each plugin has a unique name; the directory in
/plugins.<br class="">
<br class="">
</li>
<li class="">Within each plugin directory, there is a
<name>.json file (JSON format) with defined tags to
describe the plugin. If the plugin delivers a web extension,
that is in the ‘web’ subdirectory. If the plugin delivered a
script extension, that is in the ’script’ directory.
Documentation (in rst format) is in the ‘docs' directory.
The JSON file would need the following, at a minimum:<br class="">
<br class="">
</li>
<ul class="">
<li class="">Name: The plugin ID</li>
<li class="">Title: One line title</li>
<li class="">Group: Group for the plugin</li>
<li class="">Version: The version string of the plugin</li>
<li class="">Description: Longer textual description of the
plugin</li>
<li class="">Prerequisites: Prerequisites to be checked<br class="">
(Each plugin installed provides name=version, the system
provides system-level ones such as the version of
firmware, and then the prerequisites is simple a list of
<name><operator><version> as required)<br class="">
<br class="">
</li>
</ul>
<li class="">We can automatically build the documentation, and
list, for all plugins for our <a href="http://docs.openvehicles.com/" class="" moz-do-not-send="true">docs.openvehicles.com</a> (in a
similar way to how it is done for /plugin now).<br class="">
<br class="">
</li>
<li class="">On a repository server, as part of a nightly
build job, we can automatically build a single directory
JSON file from the <name>,json descriptors. We can
publish this, as well as a git export/checkout of the
plugins, on a http download site.<br class="">
<br class="">
</li>
<li class="">On the module, we can store a list of repository
servers (allowing the user to add/remove as they require).<br class="">
<br class="">
</li>
<li class="">Contributors/authors of plugins simply GitHub
clone our repository, and issue pull requests as
appropriate. They can also have their own private repository
servers (just need to host the directory json file and
associated code files) and add it to their modules.<br class="">
<br class="">
</li>
<li class="">The ‘plugin’ command tree on the module will
provide commands for:<br class="">
<br class="">
</li>
<ul class="">
<li class="">List installed repositories</li>
<li class="">Add a new repository</li>
<li class="">Remove a repository</li>
<li class="">List installed plugins</li>
<li class="">List/Search available plugins</li>
<li class="">Install a plugin</li>
<li class="">Remove a plugin</li>
<li class="">Update a plugin<br class="">
<br class="">
</li>
</ul>
<li class="">I would like to try to unify the web and script
plugin systems a bit more closely. They are really two sides
of the same coin (with some plugins providing both).</li>
</ul>
</div>
<div class=""><br class="">
</div>
<div class="">Does that make sense? Any suggestions/comments?</div>
<div class=""><br class="">
</div>
<div class="">Regards, Mark.</div>
<div class=""><br class="">
</div>
<br class="">
<fieldset class="mimeAttachmentHeader"></fieldset>
<pre class="moz-quote-pre" wrap="">_______________________________________________
OvmsDev mailing list
<a class="moz-txt-link-abbreviated" href="mailto:OvmsDev@lists.openvehicles.com">OvmsDev@lists.openvehicles.com</a>
<a class="moz-txt-link-freetext" href="http://lists.openvehicles.com/mailman/listinfo/ovmsdev">http://lists.openvehicles.com/mailman/listinfo/ovmsdev</a>
</pre>
</blockquote>
<br class="">
<pre class="moz-signature" cols="72">--
Michael Balzer * Helkenberger Weg 9 * D-58256 Ennepetal
Fon 02333 / 833 5735 * Handy 0176 / 206 989 26
</pre>
</div>
_______________________________________________<br class="">OvmsDev mailing list<br class=""><a href="mailto:OvmsDev@lists.openvehicles.com" class="">OvmsDev@lists.openvehicles.com</a><br class=""><a href="http://lists.openvehicles.com/mailman/listinfo/ovmsdev" class="">http://lists.openvehicles.com/mailman/listinfo/ovmsdev</a><br class=""></div></blockquote></div><br class=""></div></div>_______________________________________________<br class="">OvmsDev mailing list<br class=""><a href="mailto:OvmsDev@lists.openvehicles.com" class="">OvmsDev@lists.openvehicles.com</a><br class="">http://lists.openvehicles.com/mailman/listinfo/ovmsdev<br class=""></div></blockquote></div><br class=""></div></body></html>