🖊️
Teensy Fan Controller
  • Teensy Fan Controller
  • Usage
    • Fan Control
  • Hardware
    • Simple PCB
    • Breadboard
    • Prototype
  • Management UI
    • Overview
    • Controller Status
    • Hardware Setup
    • Fan Setup
    • Controller Log
  • Build Instructions
    • Project Setup
    • Firmware (Teensy)
    • Management UI
  • Demo
    • Router Cooling Demo
    • Water-cooled CPU and air-cooled GPU
  • Credits
    • Credits
Powered by GitBook
On this page
  • Software Requirements
  • Windows
  • Ubuntu 18.04
  • Fetching sources
  • Setup project build environment

Was this helpful?

  1. Build Instructions

Project Setup

PreviousController LogNextFirmware (Teensy)

Last updated 5 years ago

Was this helpful?

Software Requirements

The following software is required to build the project:

Windows

  • installation with add-on

  • Git for Windows (Bash)

  • MinGW (make)

  • Visual Studio 2017 (for Management UI builds)

  • Qt 5 (for Management UI builds)

This project uses Makefile, however build tools and board files are copied from an / installation.

If needed, copy MinGW/bin/mingw32-make.exe to MinGW/bin/make.exe, as this documentation refers to the command as make.

Requirements to regenerate protobuf () sources:

  1. Download protoc binaries, fe.:

  2. Extract zip, fe. c:\share\protoc-3.11.4

  3. Add protoc (fe., c:\share\protoc-3.11.4\bin) to PATH

Ubuntu 18.04

  • apt install build-essential

  • Qt 5 (for Management UI builds)

  • apt install protobuf libprotobuf-dev python-protobuf

sudo cp teensy_fan_controller/tools/49-teensy.rules /etc/udev/rules.d/

Fetching sources

You must initialize and pull the git sub-modules/sub-repositories:

git clone https://github.com/mstrthealias/TeensyFanController.git
git submodule init
git submodule update

Use the ui_qt5 sub-directory underneath the root project directory for Management UI builds.

Setup project build environment

Change directory to the project root, and use Makefile:

cd TeensyFanController
ARDUINO_DIR=/opt/Arduino make

Root Make targets:

  • make alias for make setup

  • make setup alias for make clean setup-toolchain setup-libs setup-nanopb protos

  • make protos alias for make runtime_config_v1.pb.c

  • make runtime_config_v1.pb.c generate RuntimeConfigV1 protobuf sources

  • make clean alias for make clean-build clean-setup

  • make clean-build delete builds produced by teensy_fan_controller/Makefile

  • make clean-setup delete files produced by this Makefile

installation with add-on

This project uses Makefile, however build tools and board files are copied from an / installation.

Requirements to regenerate protobuf () sources:

To communicate with the Teensy hardware as a non-root user, install the :

Use git to clone the root project ().

make setup-toolchain copy toolchain and Teensy3 cores from into project

make setup-libs copy libraries into project

make setup-nanopb copy into project libraries

Arduino
Teensyduino
Arduino
Teensyduino
nanopb
https://github.com/protocolbuffers/protobuf/releases/download/v3.11.4/protoc-3.11.4-win64.zip
Arduino
Teensyduino
Arduino
Teensyduino
nanopb
Teensy udev rule
TeensyFanController
Teensyduino
Teensyduino
nanopb