DOCSEARCHbyAlgolia
Submit Docs

FUXA Documentation

repository·master·Indexed 26 days ago

https://github.com/frangoteam/fuxa

A web-based SCADA/HMI/Dashboard platform for industrial automation, IoT, and real-time process visualization. FUXA supports connectivity via Modbus, OPC-UA, MQTT, and Siemens S7. It can be deployed via Docker, installed from source using Node.js 18, or run as a standalone Electron desktop application. The platform features a customizable Angular frontend with support for SVG widgets, bar and pie graphs, and multiple UI themes.

Tokens
37.8K
Snippets
37
Records
293
Agent score
89%

What's inside FUXA

  1. Overview of FUXA capabilities

    master
    FUXA is a web-based software platform used to rapidly build and deploy scalable SCADA, HMI, Dashboard, or IIoT systems. It allows for the creation of modern process visualizations with custom designs for real-time data display and the control of automated industrial plant instruments. The system operates on a Node.js runtime, which is accessed via a web browser to use the editor or to run visualizations as a client.

  2. Use Editor Keyboard Shortcuts

    master

    The FUXA editor supports several keyboard shortcuts to accelerate item manipulation, navigation, and view control:

    Item Manipulation

    • Rotate: Ctrl + Left / Right (small step) or Ctrl + Shift + Left / Right (large step).
    • Move: Shift + Up / Down / Left / Right.
    • Duplicate: Ctrl + D.
    • Cut: Ctrl + X.
    • Copy / Paste: Ctrl + C / Ctrl + V.
    • Group / Ungroup: Ctrl + G.
    • Select All: Ctrl + A.
    • Lock Dimensions: Shift + [mouse resize] (hold Shift while resizing with the mouse to lock width or height).
    • Line Gradients: Shift + [Draw line] (applies horizontal, vertical, or 45° diagonal gradients).

    Selection & Navigation

    • Next / Previous Item: Shift + O / P or Tab / Shift + Tab.

    View & History

    • Zoom: Ctrl + Up / Down (central zoom in/out) or Shift + [SCROLLER] (zoom relative to mouse position).
    • Undo / Redo: Ctrl + Z / Ctrl + Y.

  4. Configure General Layout Settings

    master

    Access the Layout settings within the FUXA editor to configure the global behavior of the user interface. In the General tab, you can manage the following settings:

    • Start View: Defines the initial view (home) displayed when a user navigates to the application URL (e.g., http://localhost:1881).
    • Zoom: When enabled, allows users to zoom the view using the Mouse Scroll Wheel and pan the view using the Mouse Left Button.
    • Dialog Mode of input field: When enabled, input value controls will trigger a dialog box for value entry.
    • Show Navigation: Toggles the visibility of the Header bar and the navigation Menu.
    • Hide the development button: Hides the button used to switch between 'Edit' and 'Home' modes.

  5. Understand the FUXA User Interface views

    master

    FUXA provides two distinct views for managing your projects:

    1. FUXA-editor: The environment used to design and edit your SCADA, HMI, or Dashboard projects.
    2. FUXA-view: The client-side view used to display and run the resulting visualization products.

  9. Build a standalone Electron application

    master

    To create your own Electron application from the source, you must have Node.js 18 installed. Follow these steps in order:

    1. Build Server and Client:

    cd ./server
npm install
cd ../client
npm install
npm run build

    2. Package the Application:

    cd ./app
npm install
npm run package

    The resulting standalone Electron application will be located in the ./app directory.

    cd ./server
npm install
cd ../client
npm install
npm run build
cd ../app
npm install
npm run package