From 132f76d78cd467a000c359c25bdb1355cc582dbf Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Mon, 15 Jul 2024 09:41:05 +0200 Subject: [PATCH] Add section on updating S3-BOX firmware (#33701) * Add section on updating S3-BOX firmware * Update source/voice_control/s3_box_voice_assistant.markdown Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Update source/voice_control/s3_box_voice_assistant.markdown Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Update source/voice_control/s3_box_voice_assistant.markdown Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Update source/voice_control/s3_box_voice_assistant.markdown Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Apply suggestions from code review * Update source/voice_control/s3_box_voice_assistant.markdown * Remove duplicate line * Update source/voice_control/s3_box_voice_assistant.markdown Co-authored-by: Keith Burzinski --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: Keith Burzinski --- .../s3_box_voice_assistant.markdown | 20 +++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/source/voice_control/s3_box_voice_assistant.markdown b/source/voice_control/s3_box_voice_assistant.markdown index 5baacabaaa0..581255f0e33 100644 --- a/source/voice_control/s3_box_voice_assistant.markdown +++ b/source/voice_control/s3_box_voice_assistant.markdown @@ -18,7 +18,7 @@ related: title: ESPHome projects page --- -This tutorial will guide you to turn an ESP32-S3-BOX, ESP32-S3-BOX-3, or an ESP32-S3-BOX-Lite into a Home Assistant voice assistant. Note, the term ESP32-S3-BOX may be used to refer to any of the 3 product variants. +This tutorial will guide you to turn an ESP32-S3-BOX, ESP32-S3-BOX-3(B), or an ESP32-S3-BOX-Lite into a Home Assistant voice assistant. Note, the term ESP32-S3-BOX may be used to refer to any of the 3 product variants. @@ -29,10 +29,11 @@ This tutorial will guide you to turn an ESP32-S3-BOX, ESP32-S3-BOX-3, or an ESP3 - [Home Assistant Cloud](/voice_control/voice_remote_cloud_assistant/) or a manually configured [Assist Pipeline](/voice_control/voice_remote_local_assistant) - The password to your 2.4 GHz Wi-Fi network - Chrome or Edge browser on a desktop (not Android/iOS) -- One of the three Espressif ESP32-S3-BOX variants: +- One of the Espressif ESP32-S3-BOX variants: - ESP32-S3-BOX-3B - ESP32-S3-BOX-3, ESP32-S3-BOX, or ESP32-S3-BOX-Lite (not currently on the market) - USB-C cable to connect the ESP32-S3-BOX +- This procedure assumes that this is the first time you are installing ESPHome firmware on the device. If you have previously completed this tutorial and now want to install the latest software version, follow the steps on [updating the software on the S3-BOX](#updating-the-software-on-the-s3-box). ## Installing the software onto the ESP32-S3-BOX @@ -206,3 +207,18 @@ Before you can use this device with Home Assistant, you need to install a bit of - Disable **LCD Backlight**. ![Toggle to enable/disable wake word](/images/assist/s3-box-disable-screen.png) + +## Updating the software on the S3-BOX + +To update the software on your S3-BOX, follow the steps below that reflect your setup. + +- **Option 1**: You have Home Assistant 2024.7 or later, and have not manually altered your ESPHome configuration for the S3-BOX: + - Once an update is available, you will receive an update notification, just like any other update. + - To install the precompiled new firmware directly on your box, make sure the S3-BOX is connected to your network, and under **ESP32 S3 BOX...Firmware**, select **Install**. +- **Option 2**: You have Home Assistant 2024.6 or older, and have not manually altered your ESPHome configuration for the S3-BOX: + - Follow steps 1-3 of the procedure on [installing the software onto the S3-BOX](#installing-the-software-onto-the-esp32-s3-box). + - This installs the latest, precompiled firmware for your S3-BOX. +- **Option 3**: You have manually changed the configuration file for your S3-BOX: + - You need to compile your own firmware. To do so, either: + - Use the ESPHome dashboard add-on within Home Assistant. While the easiest option, it tends to be the slowest and may fail, particularly on older systems or on systems with limited memory/CPU resources. + - Follow the steps in the [ESPHome documentation](https://esphome.io/guides/getting_started_command_line) and use a desktop-class system to compile and install the firmware. Initial setup is more complex, but the process is significantly faster and more reliable.