Skip to content

Commit

Permalink
Docs/webserver: added screenshots to plugin examples
Browse files Browse the repository at this point in the history
  • Loading branch information
dexterbg committed Jul 7, 2019
1 parent fb38c41 commit 4fac065
Show file tree
Hide file tree
Showing 8 changed files with 61 additions and 0 deletions.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -1,8 +1,22 @@
Twizy: Dashboard Tuning Plugin
==============================

.. image:: dashboard-tuneslider.png
:scale: 50%
:align: right

This plugin adds two sliders to adjust neutral and braking recuperation levels to the dashboard.

The sliders listen to driving profile changes and update accordingly.

If not yet logged in, the sliders are disabled.

**Install**: add the plugin as a ``hook`` type to page ``/dashboard``, hook ``body.pre``.

:download:`dashboard-tuneslider.htm <../../dev/plugin-twizy/dashboard-tuneslider.htm>` (hint: right click, save as)

|clearfix|

.. literalinclude:: ../../dev/plugin-twizy/dashboard-tuneslider.htm
:language: html
:linenos:
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -1,6 +1,21 @@
Twizy: Drivemode Button Editor
==============================

.. image:: drivemode-config.png

This plugin has been added to the Twizy code. It's used here as a more complex
example of what can be done by plugins.

It's an editor for the drivemode buttons the Twizy adds to the dashboard for
quick tuning profile changes. The editor allows to change the layout (number
and order of buttons) and the profiles to use.

It includes a profile selector built with the dialog widget, that retrieves
the available profiles from the OVMS config store.

**Install**: not necessary if vehicle Twizy is configured (see "Twizy" menu). If
you'd like to test this for another vehicle, add as a ``page`` plugin e.g. ``/test/dmconfig``.

:download:`drivemode-config.htm <../../dev/plugin-twizy/drivemode-config.htm>` (hint: right click, save as)

.. literalinclude:: ../../dev/plugin-twizy/drivemode-config.htm
Expand Down
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -1,8 +1,25 @@
Twizy: Tuning Profile Editor
============================

.. image:: profile-editor.png
:scale: 40%
:align: right

This plugin has been added to the Twizy code. It's used here as a more complex
example of what can be done by plugins.

It's a full featured SEVCON tuning profile editor including dialogs to load & save
profiles from the OVMS configuration and to create & read base64 profile codes.

See Twizy documentation for details on tuning profiles and capabilities.

**Install**: not necessary if vehicle Twizy is configured (see "Twizy" menu). If
you'd like to test this for another vehicle, add as a ``page`` plugin e.g. ``/test/profed``.

:download:`profile-editor.htm <../../dev/plugin-twizy/profile-editor.htm>` (hint: right click, save as)

|clearfix|

.. literalinclude:: ../../dev/plugin-twizy/profile-editor.htm
:language: html
:linenos:
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
15 changes: 15 additions & 0 deletions vehicle/OVMS.V3/components/ovms_webserver/docs/regenmon.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,23 @@
Regen Brake Monitor
===================

.. image:: regenmon.png
:scale: 50%
:align: right

This plugin defines a page including an acceleration level gauge chart, number metrics
for the acceleration, speed and battery power and two large indicators for the
regen brake light and the brake pedal state.

It's useful to fine tune the regen brake settings, as you can monitor the actual
deceleration levels while driving and check the smoothing level.

**Install**: add the source as a ``page`` plugin, e.g. ``/dev/regenmon``.

:download:`regenmon.htm <../dev/regenmon.htm>` (hint: right click, save as)

|clearfix|

.. literalinclude:: ../dev/regenmon.htm
:language: html
:linenos:

0 comments on commit 4fac065

Please sign in to comment.