Skip to content

Spruik/Libre-Production-Line-Time-Setter-Panel

Repository files navigation

Libre Production Line Time Setter Panel

Libre panel to set a Production Line start time

This panel enables users to update the daily production start time for each production line. By clicking a row users can update the start time. This panel is part of Libre suite of Grafana plugins and dashbaords. The production line start time limits when orders can be scheduled on the line. This plugin interfaces to a no security json rest api for equipment running on the same grafana server. This panel is targeted at Grafana v6.x.x only.

Equipment objects have 5 properties.

  1. site - Name of the site limited to 50 characters
  2. area - Name of the area limited to 50 characters
  3. production_line - Name of the line limited to 50 characters
  4. equipment - Name of the equipment limited to 50 characters
  5. start_time - time at which orders can be scheduled limited to 10 characters

Production Line Time Setter Panel

Installation

The easiest way to get started with this plugin is to download the latest release, unzip into grafana plugin directory and restart grafana.

Download the latest release

$ wget https://github.com/Spruik/Libre-Production-Line-Time-Setter-Panel/releases/latest/download/libre-production-line-time-setter-panel.zip
Resolving github.com (github.com)... 140.82.114.4
...
2020-06-24 20:47:59 (1.08 MB/s) - 'libre-production-line-time-setter-panel.zip' saved [90150]

Unzip into your Grafana plugin directory

$ unzip libre-production-line-time-setter-panel.zip -d /var/lib/grafana/plugins
Archive: libre-production-line-time-setter-panel.zip
...
inflating: /var/lib/grafana/libre-production-line-time-setter-panel/utils.js.map

Restart Grafana

$ service grafana-server restart
 * Stopping Grafana Server
 * Starting Grafana Server

Usage

In order to get the most out of this panel:

  1. Add a Table metric to query operations. For example
SELECT
  distinct site
  ,area
  ,production_line
  ,start_time
FROM equipment
WHERE area IS NOT NULL
  AND production_line IS NOT NULL
ORDER BY site ASC
  ,area ASC
  ,production_line DESC

Panel Metrics

Update

Click a row, enter a new start time and save.

Developing

Getting Started

A docker-compose and grunt script is provided in order to quickly evaluate source code changes. This requires

Prerequisites

  • docker (>= 18 required)
  • docker-compose (>= 1.25 required)
  • node (>= 12 required)
  • npm (>= 6 required)

Start by cloning this repository

~/
$ git clone https://github.com/Spruik/Libre-Production-Line-Time-Setter-Panel
Cloning into 'Libre-Production-Line-Time-Setter-Panel'...
remote: Enumerating objects: 46, done.
remote: Counting objects: 100% (46/46), done.
remote: Compressing objects: 100% (31/31), done.
remote: Total 46 (delta 13), reused 46 (delta 13), pack-reused 0
Unpacking objects: 100% (46/46), done.

Enter project and install dependencies

$ cd ./Libre-Production-Line-Time-Setter-Panel
~/Libre-Production-Line-Time-Setter-Panel
$ npm install
...
added 417 packages in 6.822s

Install Grunt globally

$ npm install grunt -g
C:\Users\user\AppData\Roaming\npm\grunt -> C:\Users\user\AppData\Roaming\npm\node_modules\grunt\bin\grunt
+ grunt@1.1.0
updated 1 package in 1.364s

Run grunt to build the panel

$ grunt
Running "clean:0" (clean) task
>> 1 path cleaned.

Running "clean:1" (clean) task
>> 1 path cleaned.

Running "copy:src_to_dist" (copy) task
Created 3 directories, copied 8 files

Running "copy:libs" (copy) task
Copied 1 file

Running "copy:readme" (copy) task
Created 1 directory, copied 7 files

Running "copy:pluginDef" (copy) task
Copied 1 file

Running "babel:dist" (babel) task

Done.

Start docker-compose.dev.yml detached

~/Libre-Production-Line-Time-Setter-Panel
$ docker-compose -f docker-compose.dev.yml up -d
Starting libre-production-line-time-setter-panel_postgres_1 ... done
Starting libre-production-line-time-setter-panel_postrest_1 ... done
Starting libre-production-line-time-setter-panel_grafana_1   ... done
Starting libre-production-line-time-setter-panel_simulator_1 ... done

Run grunt watch to recompile on change

~/Libre-Production-Line-Time-Setter-Panel
$ grunt watch
Running "watch" task
Waiting...

Open your favourite editor and start editing ./src files. The grunt watch task will detect this and recompile the panel. Use your favourite web browser and point to http://localhost:3000 login and create a dashboard with this panel. Your browser will need to be refreshed to reflect your changes to this panel, ensure your browser isn't caching files.

Building

Prerequisites

  • node (>= 12 required)
  • npm (>= 6 required)

Build panel and zip into archive

~/Libre-Production-Line-Time-Setter-Panel
$ grunt build
Running "clean:0" (clean) task
>> 1 path cleaned.

Running "clean:1" (clean) task
>> 0 paths cleaned.

Running "clean:0" (clean) task
>> 0 paths cleaned.

Running "clean:1" (clean) task
>> 0 paths cleaned.

Running "copy:src_to_dist" (copy) task
Created 3 directories, copied 8 files

Running "copy:libs" (copy) task
Copied 1 file

Running "copy:readme" (copy) task
Created 1 directory, copied 7 files

Running "copy:pluginDef" (copy) task
Copied 1 file

Running "babel:dist" (babel) task

Running "compress:main" (compress) task
>> Compressed 40 files.

Running "compress:tar" (compress) task
>> Compressed 40 files.

Done.

Find a completed build of this panel in the root directory named libre-production-line-time-setter-panel.zip.

Contributing

For any issue, there are fundamentally three ways an individual can contribute:

  • By opening the issue for discussion: For instance, if you believe that you have uncovered a bug in, creating a new issue in the GitHub issue tracker is the way to report it.
  • By helping to triage the issue: This can be done either by providing supporting details (a test case that demonstrates a bug), or providing suggestions on how to address the issue.
  • By helping to resolve the issue: Typically, this is done either in the form of demonstrating that the issue reported is not a problem after all, or more often, by opening a Pull Request that changes some bit of something in the panel in a concrete and reviewable manner.

Change log

  • 1.0.4

    • Fix modal url
    • Bump ini from 1.3.5 to 1.3.8
    • Bump bl from 4.0.2 to 4.0.3
  • 1.0.3 Add tar build output

    • Add tar build outout
    • Remove unused libraries
    • Fix npm audit
    • Update README shell outputs
    • Bump Revision
  • 1.0.2 Security Updates

    • Bump mixin-deep from 1.3.1 to 1.3.2
    • Bump lodash from 4.17.11 to 4.17.13
  • 1.0.1 Documentation Update

    • Fix subtitle & project clone path
    • Update package-lock.json
    • Rename extension yml to yaml
    • Remove unused grunt config
    • Fix docker-compose up output
  • 1.0.0 Initial Public Release