Merge pull request #99 from FutureProofHomes/develop

Updating Factory Reset Instructions & Wake Word Instruction

docs/satellite1-assembly.md

@@ -26,6 +26,7 @@ The below instructions assume you have connected the HAT to the CORE and are pow
 
 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 [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).
+![ESP32 Power & Data Port](/assets/sat1_inputs_and_outputs.jpg){ width="100%" }
 3. Upon first boot, you will see the blue LEDs count down clockwise as the device flashes the XMOS audio processor.
 4. Finally, the LEDs will begin to sparkle a warm white color. Congrats! Move to the next step.
 

docs/satellite1-faqs.md

@@ -18,11 +18,16 @@
     1. This is a "Dev Kit" and the sensors are on the device for development purposes.
     2. We are working on advanced enclosures which will place sensors in the correct location. Stay tuned.
 
-```markdown
 <a id="faq_anchor_wake_words"></a>
-???+ note "What 'wake words' are supported?"
+???+ note "What wake words are supported?"
 
-    Satellite1 currently supports "Hey Jarvis" and "Okay Nabu" wake words. This support is built directly into the Satellite1 firmware, so you do not need to install the "Open Wakeword" Add-On. We will be adding additional wake word options in the future.
+    The Satellite1 uses ESPHome's [microWakeWord](https://esphome.io/components/micro_wake_word.html) and supports the "Hey Jarvis" and "Okay Nabu" wake words.  If you'd like to add other wake word please read [How do I add other 'wake words'](/satellite1-faqs/#faq_build_custom_wake_word)]
+
+<a id="faq_add_more_wake_words"></a>
+???+ note "How do I add other wake words to the Sat1?"
+
+    If you're a developer you can modify [the Sat1 firmware](https://github.com/FutureProofHomes/Satellite1-ESPHome/blob/3c4ff992ce5a7d21c2ff5dd76fc711d3b8321a94/config/common/voice_assistant.yaml#L46-L50) and add other compatible [MicroWakeWord models](https://github.com/esphome/micro-wake-word-models) or even [create your own custom wake word.](https://github.com/kahrendt/microWakeWord/blob/november-update/notebooks/basic_training_notebook.ipynb) 
+    <br><br><b>NOTE:</b> The more wake words you add to the firmware the less resouces your Sat1 has for other tasks.
 
 <a id="faq_anchor_wake_word_success"></a>
 ???+ note "The wake word isn't always responding!"
@@ -38,11 +43,6 @@
 
     Still having issues? This will get better in time. We have lots of ideas to solve these problems.
 
-<a id="faq_anchor_custom_wake_word"></a>
-???+ note "How do I build my own custom wake word?"
-
-    [This will require time and GPU horsepower.](https://github.com/kahrendt/microWakeWord/blob/november-update/notebooks/basic_training_notebook.ipynb){ .md-button .md-button--primary }
-
 <a id="faq_anchor_report_issue"></a>
 ???+ note "How do I get help or report issues?"
     Need further help or have suggestions for the product or documentation? Reach out!

docs/satellite1-set-up-voice-control.md

@@ -86,7 +86,7 @@ Always use 12hr time formats.
 2. **In the Configuration section, select your Voice Pipeline.**  
    <br>![Assistant Dropdown](/assets/Pipeline5.png){ width="100%" loading=lazy }>
 
-3. **You can also set your preferred wake word. (NOTE: If you want to build your own custom wake word, then [read here](/faqs#faq_anchor_custom_wake_word))**  
+3. **You can also set your preferred wake word. (NOTE: If you want to build your own custom wake word, then [read here](/faqs#faq_add_more_wake_words))**  
    <br>![Set Wake Word](/assets/Pipeline7.png){ width="100%" loading=lazy }>
 
 Congratulations! You've created your own voice pipeline for your Satellite1.

docs/satellite1-troubleshooting.md

@@ -52,24 +52,36 @@ assist_pipeline:
 3. Don't leave this on forever, it will clog up your server with audio recordings.
 
 
-## Resetting to Factory Settings
+## Clear WiFi Credentials to Restart BLE Improv
 
 1. 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.
 
-2. In your Home Assistant, go to Settings -> Devices and Services -> ESPHome and click the 3 dots next to the Satellite1 and select "Delete".
+2. Follow the steps to [Add your Satellite1 to Home Assistant](satellite1-connecting-to-ha.md)
+
+
+## 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).
+
+??? abstract "First, remove the Sat1 from ESPHome & Home Assistant"
 
-3. Follow the steps to [Add your Satellite1 to Home Assistant](satellite1-connecting-to-ha.md)
+    1. In your Home Assistant, go to Settings -> Devices and Services -> ESPHome and click the 3 dots next to the Satellite1 and select "Delete".
+    ![Delete ESPHome ESPHome](/assets/delete_sat1_esp_device.png){ width="100%" }
+    2. 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".
+    ![Remove from ESPHome Builder](/assets/delete_sat1_from_esp_builder.png){ width="100%" }
 
 
-## Start the Device in "Boot" mode:
+??? abstract "Then Flash your Satellite1 a Computer's USB-C Connection"
 
-1. Unplug the Sat1 from power.
+    1. Unplug the Sat1 from power.
 
-2. Press and hold the Core board's "Boot" button.  <i>(NOTE: If the HAT is attached you can use the "Action" button.)</i>
+    2. Press and the HAT's "Action" button OR the CORE's "Boot" button.
+    ![CORE BOOT Button](/assets/boot_reset_button.jpg){ width="100%" }
+    ![HAT BOOT Button](/assets/right_action_button.jpg){ width="100%" }
 
-3. Apply power to the Sat1 and let go of the "Boot" button after 3 seconds.
+    3. 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.
+    ![ESP32 Power & Data Port](/assets/sat1_inputs_and_outputs.jpg){ width="100%" }
 
-4. Follow the steps to [Add your Satellite1 to Home Assistant via a USB-C cable](satellite1-connecting-to-ha.md))
+    4. Follow these steps to [Add your Satellite1 to Home Assistant via a USB-C cable](satellite1-connecting-to-ha.md))
 
 ## Need More Help?