OpenGarage Firmware and Documentation

This Github repository contains the firmware source code and documentation for OpenGarage. For product details, visit https://opengarage.io.

For official firmware release notes, please go to the OpenGarage Firmware Releases page on GitHub.

OpenGarage's Built-in Web UI

AP homepage Log Basic Options Integration Advanced Options Firmware Update Webapp Blynk

Download and unzip (or git clone) this (OpenGarage-Firmware) repository.
Install the latest LTS version of Node.js from https://nodejs.org/ if you don't already have it.
In your terminal, navigate to the OpenGarage-Firmware/OpenGarage folder (the source code folder) and run npm install html-minifier-terser.
Install Visual Studio Code (VS Code) from https://code.visualstudio.com/, if you don't already have it.
Launch VS Code and install the PlatformIO extension.

In VS Code, click File -> Open Folder and select the OpenGarage-Firmware/OpenGarage folder.
PlatformIO will recognize the platformio.ini file in that folder, which contains all the libraries and settings needed to compile the firmware.
Click the PlatformIO: Build button (with the checkmark icon ✓) in the blue status bar at the bottom of the screen to build the firmware.

The built-in web UI files are located in the html subfolder.
You do not need to run any scripts manually. When you build the project, a Python script (run_prebuild.py) automatically calls the compress_htmls.mjs script to minify, compress, and convert the HTML files into firmware program strings stored in htmls.h, which are then compiled into the final firmware.
After editing any files in the html folder, simply build the project again.

OpenGarage firmware supports OTA (over-the-air) updates, allowing you to upload the firmware directly through the web UI.

Download a firmware file (e.g. og_x.x.x.bin where x.x.x is the firmware version).
Before starting, close the Blynk and OpenGarage mobile apps to prevent them from interfering with the update process.
Open your OpenGarage's homepage, click Firmware Update at the bottom of the page.
- If your OpenGarage is in WiFi AP (Access Point) mode, the update page is available at http://192.168.4.1/update.
Select the firmware file your downloaded, enter your device key, and click Submit.
Wait for the process to finish. If the upload fails, you can try again. If the device hangs, unplug and replug the power, then try again.

Firmware Corruption: If the firmware upload fails and the device no longer boots, you'll need to re-flash the firmware using a USB-serial programmer.
Flash Memory Requirement: Early OpenGarage units (v1.0, v1.1, v1.2, made before 2018) have only 2MB of flash memory. These cannot be upgraded to firmware 1.2.0 or later, which require 4MB. All newer versions (v1.3 and above) include 4MB flash and support the latest firmware.
Checking Flash Size: If you are unsure how much flash memory is available on your OpenGarage, you can first update to firmware 1.1.3. After the update, open a browser and go to http://<your_og_ip>/db. This will display a JSON string. Look for the flash_size value: if it's 4194304, you have 4MB of flash and can upgrade. If it is 2097152, your device is not upgradeable to firmware 1.2.0 and beyond.
Factory Reset Warning: Upgrading from an early firmware to version 1.2.0 will erase all setings due to changes in the flash memory layout. Be sure to write down your configuration before proceeding.

The release notes of each firmware can be found on github.