Merge pull request #95 from FutureProofHomes/develop

Documentation for new features, news & anchor links

docs/satellite1-faqs.md

@@ -1,12 +1,12 @@
 <a id="faq_anchor_factory_reset"></a>
 ???+ note "I messed something up, How do I start over?"
 
-    [Perform a Factory Reset](/troubleshooting/#resetting-to-factory-settings){ .md-button .md-button--primary }
+    [Perform a Factory Reset](/satellite1-troubleshooting/#resetting-to-factory-settings){ .md-button .md-button--primary }
 
 <a id="faq_anchor_inspect_logs"></a>
 ???+ note "How do I access the Sat1 logs?"
 
-    [If you want to look at the logs, click here](/troubleshooting/#inspecting-logs){ .md-button .md-button--primary }
+    [If you want to look at the logs, click here](/satellite1-troubleshooting/#inspecting-sat1-esp32-logs){ .md-button .md-button--primary }
 
 <a id="faq_anchor_temp_sensor"></a>
 ???+ note "Why is the temp sensor incorrect?"
@@ -47,4 +47,4 @@
 ???+ note "How do I get help or report issues?"
     Need further help or have suggestions for the product or documentation? Reach out!
 
-    [There are many ways to contact us, click here](/troubleshooting/#need-more-help){ .md-button .md-button--primary }
+    [There are many ways to contact us, click here](/satellite1-troubleshooting/#need-more-help){ .md-button .md-button--primary }

docs/satellite1-modifying-the-firmware.md

@@ -23,14 +23,11 @@ There are two ways you can modify the firmware running on your Satellite1:
     4. <b>Click "Take Control" and give the device a name:</b>
     <br>![Take Control](/assets/esphome_device_builder/3_take_control.png){ width="100%" loading=lazy }</br>
     <br>![Give device a name](/assets/esphome_device_builder/4_name_device.png){ width="100%" loading=lazy }</br>
-
-    5. <b>Click "Install" to provision the encryption key between the Sat1 and Home Assistant server:</b>
-    <br>![Enable Encryption](/assets/esphome_device_builder/5_accept_encryption.png){ width="100%" loading=lazy }</br>
 
-    6. <b>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. Please be patient:</b>
+    5. <b>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:</b>
     <br>![Compile Firmware](/assets/esphome_device_builder/6_firmware_compile.png){ width="100%" loading=lazy }</br>
 
-    7. <b>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!</b>
+    6. <b>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!</b>
     <br>![Edit the Firmware](/assets/esphome_device_builder/8_build_cool_stuff.png){ width="100%" loading=lazy }</br>
 
     Congrats.  You're done!

docs/satellite1-powering-on.md

@@ -1,6 +1,8 @@
-Please make sure you're using the [correct power supplies](recommended-accessories.md#power-supply) to power on your new Satellite1.
+
+## First Boot - Unboxing Experience
+The below instructions assume you have connected the HAT to the CORE and our powering the Satellite1 for the first time:
 
 1. Take a USB-C cable and plug one end into the USB socket on the Hat labeled "CORE/ESP".
-2. Plug the other end into a USB-C power supply, or a computer.
+2. Plug the other end into a [9V USB-C power supply](satellite1-recommended-accessories.md#power-supply) (if you want to power a speaker from the HAT), or a computer 5V USB-C connection (if you're plugging into the headphone jack).
 3. Upon first boot, you will see the blue LEDs count down clockwise as the device flashes the XMOS audio processor chip.
 4. Finally, the LEDs will begin to sparkle a warm white color. Congrats! Move to the next step.

docs/satellite1-presence-sensors.md

@@ -42,9 +42,9 @@ Both the LD2410 & LD2450 can be updated via the HLKRadarTool mobile app over blu
 ???+ tip "The FutureProofHomes team is working on making this process seemless so you do not have to modify the firmware.  Please stay tuned."
 
 1. [Follow these steps to modify the Sat1 Firmware](/modifying-the-firmware)
-2. Add the correct code depening on your sensor and recompile then upload the firmware to your Sat1:
-    1. For the LD2410: Uncomment the line `mmwave_ld2410: !include common/mmwave_ld2410.yaml` in the `OPTIONAL COMPONENTS` section of [satellite1.base.yaml](https://github.com/FutureProofHomes/Satellite1-ESPHome/blob/develop/config/satellite1.base.yaml#L89).
-    1. For the LD2450: Uncomment the line `mmwave_ld2450: !include common/mmwave_ld2450.yaml` in `OPTIONAL COMPONENTS` section of [satellite1.base.yaml](https://github.com/FutureProofHomes/Satellite1-ESPHome/blob/develop/config/satellite1.base.yaml#L90).
+2. Uncomment the correct lines depending on the mmWave sensor you want to use:
+    1. For the LD2410: Uncomment the line `mmwave_ld2410: !include common/mmwave_ld2410.yaml` in the `OPTIONAL COMPONENTS` section of [satellite1.yaml](https://github.com/FutureProofHomes/Satellite1-ESPHome/blob/develop/config/satellite1.yaml#L25).
+    1. For the LD2450: Uncomment the line `mmwave_ld2450: !include common/mmwave_ld2450.yaml` in `OPTIONAL COMPONENTS` section of [satellite1.yaml](https://github.com/FutureProofHomes/Satellite1-ESPHome/blob/develop/config/satellite1.yaml#L28).
 4. Boot the Sat1 and check it's device page in Home Assistant after device reboot.  You should see a ton more entities in your Sat1 device page.
 
 

docs/satellite1-streaming-music.md

@@ -1,17 +1,17 @@
 ## Set Up Music Assistant
 
-Your new Satellite1 can control your home now, but what about streaming music? The good news is there's a giant 25 Watt amplifier built into Satellite1, and if you have a good speaker or headphones (and the appropriate [power supply](satellite1-recommended-accessories.md/)), you'll be able to stream high-quality music to it with Music Assistant from Home Assistant. Follow this excellent guide to get Music Assistant (MA) installed and configured to stream to your Satellite1.
+Your new Satellite1 can now control your home, but what about streaming music? Here’s a guide to help you install and configure Music Assistant (MA) to stream music directly to your Satellite1.
 
 !!! warning "Music Assistant gets added to Home Assistant Core!"
 
-    This is a great thing! It makes MA easier to install. However, my understanding is that this version of Music Assistant does not have "voice control capabilities" (yet). So, as of December 2024, we will recommend installing Music Assistant via the old-fashioned way - by using HACS (Home Assistant Community Store).
+    This is great news—it makes installing Music Assistant (MA) much easier! However, as of December 2024, it’s important to note that this version of Music Assistant does not yet include “voice control capabilities.” We recommend [reviewing Music Assistant’s guidelines on setting up voice control capabilities](https://www.music-assistant.io/integration/voice/) for the most up-to-date information.
 
 !!! tip "A Couple Tips:"
 
     1. Spotify ONLY works if you are a paying subscriber.  This may or may not be addressed in future versions of MA.
     2. Watch your volume!  The 25W amplifier on the Sat1 can blow little speakers.
 
-[Install Music Assistant via HACS](https://music-assistant.io/integration/installation/#installation-of-the-deprecated-hacs-integration){ .md-button .md-button--primary }
+[Install Music Assistant](https://www.music-assistant.io/installation/){ .md-button .md-button--primary }
 
 ## Add a Music Provider
 
@@ -46,12 +46,12 @@ There are three ways to control music with your voice:
 
 ??? abstract "I want to control my music without an AI/LLM and have fewer capabilities."
 
-    [Use Custom HA Intents to Control Music](https://music-assistant.io/integration/voice/#ha-assist){ .md-button .md-button--primary }
+    [Use Custom HA Intents to Control Music](https://github.com/music-assistant/voice-support?tab=readme-ov-file#option-1-local-assistant-blueprint){ .md-button .md-button--primary }
 
-??? abstract "I want to control my music with an AI/LLM and have more capabilities that work often, but not perfectly."
+??? abstract "I want to control my music with a cloud-based AI/LLM and have more capabilities that work often, but not perfectly."
 
-    [Use OpenAI to Control Your Music](https://music-assistant.io/integration/voice/#ma-specific-conversation-agent){ .md-button .md-button--primary }
+    [Use OpenAI to Control Your Music](https://github.com/music-assistant/voice-support?tab=readme-ov-file#option-2-local-assist-enhanced-by-an-llm-integration-like-open-ai-conversation-chatgpt-or-google-generative-ai-gemini){ .md-button .md-button--primary }
 
-??? abstract "I want to control my music with an AI/LLM and have more capabilities that work often, but not perfectly."
+??? abstract "I want to control my music with an AI/LLM that I run locally and have more capabilities that work often, but not perfectly."
 
-    [Use a Local LLM to Control Your Music](https://music-assistant.io/integration/voice/#llm-conversation-agent){ .md-button .md-button--primary }
+    [Use a Local LLM to Control Your Music](https://github.com/music-assistant/voice-support?tab=readme-ov-file#option-3-script-which-can-be-used-as-a-tool-by-an-llm-integration-like-open-ai-conversation-chatgpt-or-google-generative-ai-gemini){ .md-button .md-button--primary }

docs/satellite1-troubleshooting.md

@@ -2,6 +2,8 @@
 
 ??? abstract "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](/satellite1-modifying-the-firmware/#import-the-sat1-to-your-esphome-dashboard) and set log level from there.)
+
     1. Connect the Sat1 to your computer using a USB-C cable. 
     2. Click the connect button below and select the correct JTAG device.
     3. Choose Logs & Console:
@@ -30,7 +32,7 @@ Curious why your Sat1 is doing something different than what you'd expect?  Use
 
 <br>![Debugging a Voice Pipeline](/assets/debug_assist.png){ width="100%" loading=lazy }</br>
 
-1. Determine what pipeline your Sat1 is using by retracing these steps: [Assign a Voice Pipeline & Wake Word to your Satellite1](/set-up-voice-control/#assign-a-voice-pipeline)
+1. Determine what pipeline your Sat1 is using by retracing these steps: [Assign a Voice Pipeline & Wake Word to your Satellite1](/satellite1-set-up-voice-control/#assign-a-voice-pipeline)
 3. In Home Assistant, go to Settings -> Voice Assistants and select the 3 dots next to that pipeline.
 4. Read here: [Debugging a Voice Pipeline](https://www.home-assistant.io/voice_control/troubleshooting/)