Installation Guide
Welcome to OpenRF Platform. Choose the installation method that best matches your needs.
🧑💻 Source Code
Best for: Developers and contributors.
Download: OpenRF-Platform-v1.0.0.zip
- Modify the source code
- Compile with PlatformIO
- Build your own firmware
⚡ Precompiled Firmware
Best for: Most users.
Downloads: firmware.bin + littlefs.bin
- No compiling required
- Ready to flash
- Quick installation
Installing from Source Code
- Download and extract the source package.
- Open the project in Visual Studio Code with PlatformIO.
- Build the project.
- Upload the firmware.
- Build and upload the LittleFS filesystem.
- Restart the ESP8266.
Installing Precompiled Firmware
What is firmware.bin?
firmware.bin is the operating software of OpenRF Platform. It contains the RF communication, Wi-Fi, MQTT, Home Assistant integration, OTA support and all platform features. Without this file the device cannot start.
What is littlefs.bin?
littlefs.bin is the internal filesystem that stores the built-in web interface.
It contains:
- Configuration pages
- HTML
- CSS
- JavaScript
- Images and icons
Think of firmware.bin as the operating system of OpenRF Platform and littlefs.bin as the website stored inside the device.
Without littlefs.bin the ESP8266 will still operate normally, including RF communication, MQTT and Home Assistant integration, but the configuration website will not be available.
First Installation
- Flash firmware.bin.
- Flash littlefs.bin.
- Restart the ESP8266.
- If no Wi-Fi credentials are configured, the device starts in Access Point (AP) mode.
- Connect to the OpenRF Platform Wi-Fi network.
- Open the web interface and complete the initial configuration.
Updating
First installation?
Flash firmware.bin + littlefs.bin.
Already using OpenRF Platform?
If the release notes mention WebUI, HTML, CSS, JavaScript or LittleFS changes, flash both files.
Otherwise, flash firmware.bin only.
Version Compatibility
| Correct | Incorrect |
|---|
firmware.bin v1.0.0
littlefs.bin v1.0.0 | firmware.bin v1.1.0
littlefs.bin v1.0.0 |
Quick Start
- I just want to use OpenRF Platform → Download firmware.bin and littlefs.bin.
- I want to develop OpenRF Platform → Download OpenRF-Platform-v1.0.0.zip.