# proxy-node-red-dashboard

## Introduction

"proxy-node-red-dashboard" is packaged in the Flow Creator application that provides a set of nodes to quickly create a live data 
dashboard.

## Orientation

The 'proxy-node-red-dashboard' node is part of the Flow Creator x86 application, which is located on the IED device.

<br>

<p style="text-align: center;">
  <img src="./docs/overview_fc.png" width="900" heigth="auto" /><br>
  <b>Figure :</b> Orientation of the system.
</p>

## Top-Level Design

<p style="text-align: center;">
  <img src="./docs/component_fc.png" width="900" heigth="auto" /><br>
  <b>Figure :</b> Architecture at a top level design (with key module/classes).
</p>

## Dependencies

- Node  
- Npm 

## Setup Guide

Run the following command in the root directory of your Flow Creator

    npm install node-red-dashboard

## Usage
No API Exposed

## System / Object Design

- [`Architecture Docs for Flow Creator`](https://wiki.siemens.com/display/IndustrialEdge/IE+Flow+Creator)

## Reference 

Please refer to [`README.original`](README.original.md) for dashboard node readme detials.

## Deployment

[This component is added as a .tgz file in the Flow Creator repository and is pre-packaged into Flow Creator during the Docker image build process](https://code.siemens.com/industrial-edge/apps/flowcreator/sim-edge-flow-creator/-/tree/develop/artifacts?ref_type=heads)

## License

Please refer to [`COPYING`](COPYING.md) for full license details.

Please refer to[`LICENSE.original`](LICENSE.original.md) for dashboard node license detials.

For Siemens Inner Source License, see [`LICENSE`](LICENSE.md)

## Maintainers and Contribution

- Maintainers 

  * [Preetham Bhat](mailto:preetham.bhat@siemens.com)
  * [Saurabh Upadhyay](mailto:saurabh.upadhyay@siemens.com)
  * [Rakesh Mutharaju](mailto:rakesh.mutharaju@siemens.com)
  * [Gowri HR](mailto:gowri.hr@siemens.com)

- Contributors

  [`CONTRIBUTING`](CONTRIBUTING.md) outlines guidelines for contributing to this component, please read it before trying to contribute in any way to this repository.

  [`CONTRIBUTING.original`](CONTRIBUTING.original.md) outlines guidelines for dashboard contributing detials.
