# Management UI

{% hint style="warning" %}
You should have cloned the [root project](https://github.com/mstrthealias/TeensyFanController) and it's sub-modules (which includes this project directory).

That-way the **parent directory** contains the **HIDAPI** and **teensy\_fan\_controller** projects.
{% endhint %}

## Windows

Prerequisites:

1. Qt Installer
2. MSVC 2017 64-bit
3. Recent Qt release (Qt 5.13.2 at time of writing) for MSVC 2017 64-bit
4. Qt Charts component

{% hint style="warning" %}
The application is NOT compatible with MinGW builds due to the use of [hidapi](https://github.com/libusb/hidapi). HIDAPI will compile with mingw32 (NOT mingw64-32bit), however Qt must be built from source to use this stack.
{% endhint %}

Note:

First, build the static [HIDAPI](https://github.com/mstrthealias/HIDAPI-Qt5) library:

1. Launch **x64 Native Tools Command Prompt for VS 2017**
2. Add Qt5 to PATH, fe.:

   ```
    SET PATH=%PATH%;c:\share\Qt\5.13.2\msvc2017_64\bin
   ```
3. Change directory to HIDAPI
4. Run qmake:

   ```
    qmake
   ```
5. Run nmake:

   ```
    nmake
   ```
6. Verify HIDAPI.lib was created:

   ```
        dir windows\HIDAPI.lib

        ...
        12/30/2019  11:03 AM            27,960 HIDAPI.lib
   ```

Building the Fan Controller UI:

{% hint style="warning" %}
Until the Fan Controller UI's installer is published, it is easiest to run the application using Qt Creator.

You may build using the CLI with qmake and nmake, but will have to copy all Qt runtime dependencies (qml, plugins, dlls) into the release directory to start the application.
{% endhint %}

## Linux (Ubuntu 18.04)

Prerequisites:

1. Qt Installer
2. Recent Qt release (Qt 5.13.2 at time of writing) for GCC 64-bit
3. Qt Charts component
4. `apt install build-essential libxkbcommon-x11-0 libhidapi-dev libhidapi-hidraw0 libgl1 libgl1-mesa-dev libx11-xcb1`

{% hint style="info" %}
I experienced issues launching the application using X11 forwarding and ended up installing and launching xfce (`apt install xfce4`).
{% endhint %}

First, build the static [HIDAPI](https://github.com/mstrthealias/HIDAPI-Qt5) library:

1. In non-root Shell, add Qt5 to PATH, fe.:

   ```
    PATH=$PATH:~/Qt/5.13.2/gcc_64/bin
    QT_QPA_PLATFORM_PLUGIN_PATH=~/Qt/5.13.2/gcc_64/plugins
   ```
2. Change directory to HIDAPI, fe.:

   ```
    cd ~/TeensyFanController/HIDAPI
   ```
3. Run qmake:

   ```
    qmake
   ```
4. Run make:

   ```
    make
   ```
5. Verify libHIDAPI.a was created:

   ```
    ls linux/libHIDAPI.a
   ```

Build the Fan Controller UI:

1. Change directory to HIDAPI, fe.:

   ```
    cd ~/TeensyFanController/teensy_fan_controller
   ```
2. Run qmake:

   ```
    qmake
   ```
3. Run make:

   ```
    make
   ```
4. Launch using `sudo` (note: replace /home/username/Qt/5.13.2 with path to Qt release):

   ```
    sudo bash -c 'QT_BASE=/home/username/Qt/5.13.2 QML2_IMPORT_PATH="$QT_BASE/gcc_64/qml" QML_IMPORT_PATH="$QT_BASE/gcc_64/qml" QT_QPA_PLATFORM_PLUGIN_PATH="$QT_BASE/gcc_64/plugins"  ./tfctrl'
   ```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://mstrthealias.gitbook.io/teensy-fan-controller/build-instructions/ui.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.