Mibew / button-refresh-plugin

Make the button represents the actuall operators state

Mibew Button Refresh plugin

It make the button refresents actual operator's state.

NB.: Actually the plugin adjusts the button generation process. So if you want to disable autorefresh of the button, it's not enough to only disable the plugin. One should also regenerate the button afterwards.

Installation

1. Get the archive with the plugin sources. You can download it from the official site or build the plugin from sources.

2. Untar/unzip the plugin's archive.

3. Put files of the plugins to the <Mibew root>/plugins folder.

4. (optional) Add plugins configs to "plugins" structure in "<Mibew root>/configs/config.yml". If the "plugins" stucture looks like plugins: [] it will become:

   plugins:
       "Mibew:ButtonRefresh": # Plugin's configurations are described below
           refresh_frequency: 3

5. Navigate to "<Mibew Base URL>/operator/plugin" page and enable the plugin.

6. Regenerate button at "<Mibew Base URL>/operator/button-code" page.

Beware that when the plugin will be disabled or uninstalled the button MUST be regenerated.

Plugin's configurations

The plugin can be configured with values in "<Mibew root>/configs/config.yml" file.

config.refresh_frequency

Type: Integer

Default: 3

Specify time in seconds between button refreshes. This value is optional and can be skipped.

Build from sources

There are several actions one should do before use the latest version of the plugin from the repository:

1. Obtain a copy of the repository using git clone, download button, or another way.
2. Install node.js and npm.
3. Install Gulp.
4. Install npm dependencies using npm install.
5. Run Gulp to build the sources using gulp default.

Finally .tar.gz and .zip archives of the ready-to-use Plugin will be available in release directory.

License

Apache License 2.0