factoryinput-panel

Documentation of factoryinput-panel

3 minute read

This microservice is still in development and is not considered stable for production use.

Getting started

UMH Factoryinput Panel allows to easily execute MQTT messages inside the UMH stack from the Grafana Panel.

Requirements

  • A united manufacturing hub stack
  • External IP or URL of the grafana-proxy server.
    • In most cases it is the same IP as your Grafana dashboard

Installation

If you have installed the UMH-Stack as described in our quick start Tutorial, then this plugin is already installed on your Grafana installation

If you want to develop this Panel further, please follow the instructions below

Build from source

  1. Goto united-manufacturing-hub/grafana-plugins/umh-factoryinput-panel

  2. Install dependencies

yarn install
  1. Build plugin in development mode or run in watch mode
yarn dev
  1. Build plugin in production mode (not recommended due to Issue 32336)
yarn build
  1. Move the resulting dist folder into your grafana plugins directory
  • Windows: C:\Program Files\GrafanaLabs\grafana\data\plugins
  • Linux: /var/lib/grafana/plugins
  1. Rename the folder to umh-factoryinput-panel

  2. Enable the enable development mode to load unsigned plugins

  3. Restart your grafana service

Usage

Prerequisites

  1. Open your Grafana instance
  2. Log in
  3. Open your Profile and check if your organization name inside Grafana matches the rest of your UMH stack

Creating a new Panel

  1. Create a new Dashboard or edit an existing one
  2. Click “Add an empty panel”
  3. On the right sidebar switch the Visualization to “Button Panel”
  4. Fill out the fields inside “REST Integration”
    1. URL
      • http://{URL to your grafana-proxy}/api/v1/factoryinput/
      • Example:
        • http://172.21.9.195:2096/api/v1/factoryinput/
    2. Location
      • Location of your Asset
    3. Asset
      • Name of the Asset
    4. Value
      • MQTT prefix
        • Example prefixes:
          • count
          • addShift
          • modifyShift
    5. Customer
      • Your organization name
    6. Payload
      • JSON encoded payload to send as MQTT message payload
  5. Modify any additional options are you like
  6. When you are finished customizing, click on “Apply”

Example Panel

Notes

  1. Clicking the button will immediately send the MQTT message, through our HTTP->MQTT stack. Please don’t send queries modifying date you would later need !

Common pitfalls

  • Pressing the button just changes the cog to an warning sign
    1. Open your network inspector view (Ctrl+Shift+I on Chrome)
    2. Press the button again
    3. If no request appears, then you haven’t filled out all required fields
    4. Your request shows:
      • 403
        • Make sure the customer field is set to your grafana organization name
      • 400
        • Your request was incorrectly formatted
        • Check that the URL is in the format specified above
        • Check if your payload contains valid JSON
          • You can validate your payload here
        • Check that the Value field matches a valid MQTT command

Technical information

Below you will find a schematic of this flow, through our stack

License

Last modified September 15, 2021: fix: markdown checker (#541) (d6d82c6)