Skip to content

Modifying the Firmware

Import the Sat1 to your ESPHome Dashboard

The firmware running on the Satellite1 is open source. This means you can modify the firmware to build all kinds of amazing things with it! All we ask contribute back the FutureProofHomes community by submitting pull requests to the Satellite1-ESPHome repository.

After taking control of your device's firmware you will no longer receive firmware updates from the community. If you'd like to get back in sync with the community you'll need to restore factory firmware back to the Sat1.
Please also be aware that flashing custom firmware can potentially damage the Sat1 device. These instructions are provided with the understanding that you have the necessary expertise to proceed. We will assume a certain level of familiarity with the process. Proceed with caution, and enjoy the journey!

There are two ways you can modify the firmware running on your Satellite1:

I want to make simple changes from my Home Assistant server via the ESPHome Device Builder dashboard software. (Recommended)

NOTE: Your Home Assistant instance must have the ability to run "Add-Ons". If you cannot run add-ons, see alternate ways to run this software by reading ESPHome's official documentation.

  1. Install the ESPHome Device Builder Add-on by clicking below:
    Install ESPHome Device Builder

  2. After the install is complete click "Open Web UI":
    Open WebUI

  3. Click "SHOW" to see your Sat1 devices you have not taken control of:
    Show Devices

  4. Click "Take Control" and give the device a name:
    Take Control

    Give device a name

  5. Wait while the firmware compiles and your Sat1 is flashed over-the-air with your new firmware. This can take a significant amount of time depending on your server's hardware specs (Recommend 8gb RAM or more to avoid compilation errors). Please be patient:
    Compile Firmware

  6. When the firmware is uploaded to the Sat1, you'll see the boot logs on your screen. You can close the window and return to the ESPHome Device Builder dashboard and click the "EDIT" button and have fun!
    Edit the Firmware

Congrats. You're done!

I'm a developer and want to make heavy changes in my IDE or from the command line. (Advanced)

I'll keep this simple. Just read here: Getting Started with the ESPHome Command Line

If you master this stuff then please join the Discord and our contributor team! We'd love to have you!