Troubleshooting
Inspecting Sat1 ESP32 Logs
I want to see Sat1 ESP32 logs via a USB-C cable.
(NOTE: If you need lower level DEBUG
logs then you're going to need to adopt the Sat1 to your ESPHome Dashboard and set log level from there.)
- Connect the Sat1 to your computer using a USB-C cable.
- Click the connect button below and select the correct JTAG device.
- Choose Logs & Console:
If you click on "Reset Device" you should see a whole bunch of useful messages and information. Scroll back up and take a look.
Scroll to the bottom and issue a command "Hey Jarvis, what time is it?"
I want to see Sat1 ESP32 logs via my Wi-Fi network (Over the Air)
These instructions will come soon. It's complicated depending on your environment.
Debugging your Voice Pipeline
Curious why your Sat1 is doing something different than what you'd expect? Use Home Assistant pipeline debugging tools.
- Determine what pipeline your Sat1 is using by retracing these steps: Assign a Voice Pipeline & Wake Word to your Satellite1
- In Home Assistant, go to Settings -> Voice Assistants and select the 3 dots next to that pipeline.
- Read here: Debugging a Voice Pipeline
Inspect Sat1 Audio Recording Files
Follow these steps to store a copy of your audio recordings in your Home Assistant server for inspection.
- Modify your
configuration.yaml
file and add the following:
- Now go to that path in your Home Assistant (recommend using Studio Code Server) and listen to the files there.
- Don't leave this on forever, it will clog up your server with audio recordings.
Clear WiFi Credentials to Restart BLE Improv
-
Press and hold the RIGHT (Action) button for approximately 22 seconds until the red LEDs complete their clockwise circle. When the LEDs glow blue you can release the action button and wait as the XMOS chip is erased. This process may take a few minutes before the Satelllite1 finally reboots to the factory firmware. Upon first boot you will see the blue LEDs complete another clockwise circle indicating the XMOS is being flashed with the facory embedded firmware.
-
Follow the steps to Add your Satellite1 to Home Assistant
Resetting to Factory Settings
This process will erase all settings on the Sat1 device and restore the latest production firmware, returning it to factory-new condition. You will need a USB-C cable and a computer with an internet connection (Google Chrome browser recommended).
First, remove the Sat1 from ESPHome & Home Assistant
- In your Home Assistant, go to Settings -> Devices and Services -> ESPHome and click the 3 dots next to the Satellite1 and select "Delete".
- If you "Took Control" of the Sat1 in your ESP Home Device Builder then go to Settings -> Add-Ons -> ESPHome Device Builder and open the Web UI to click the 3 dots next to the Satellite1 and select "Delete".
Then Flash your Satellite1 a Computer's USB-C Connection
-
Unplug the Sat1 from power.
-
Press and the HAT's "Action" button OR the CORE's "Boot" button.
-
While holding down the "Boot" button, plug the Sat1's "ESP32/CORE" connection into your computers USB-C port. Let go of the "Boot" button after 3 seconds.
-
Follow these steps to Add your Satellite1 to Home Assistant via a USB-C cable)
Need More Help?
While we hope this documentation will answer all your questions, but we realize support is sometimes needed. The FutureProofHomes team will do their best to keep up with support requests, but we also lean on our community to help all of us. See the links below and decide which method of support is best for your needs.
Have a general question and need quick help from the community?
Discord too chatty and you want a record of your general question?
Do you have a feature request you'd love to see?
Look through our existing Feature Requests first, then open a new request if necessary:
Request a New Feature on Github
Have you found a reproducible issue with the hardware or software?