Skip to content

Commit

Permalink
Merge pull request #89 from FutureProofHomes/develop
Browse files Browse the repository at this point in the history 
Correcting lots of small typos
  • Loading branch information
@that1guy
that1guy authored Jan 15, 2025
2 parents ccd96a1 + 0bf5d70 commit 185b7aa
Show file tree
Hide file tree
Showing 10 changed files with 84 additions and 86 deletions.
12 changes: 6 additions & 6 deletions docs/index.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Welcome the FutureProofHomes Documentation page. Our goal is to help you get the most out of the FutureProofHomes voice assistnat hardware and software so that you can control your smart home with your voice and your own private AI. In fact, thats our slogan!
Welcome to the FutureProofHomes Documentation page. Our goal is to help you get the most out of the FutureProofHomes voice assistant hardware and software so that you can control your smart home with your voice and your own private AI. In fact, that's our slogan!

![Image title](/assets/slogan_black_and_white.png#only-dark)
![Image title](/assets/slogan_white_and_black.png#only-light)
Expand All @@ -8,14 +8,14 @@ Welcome the FutureProofHomes Documentation page. Our goal is to help you get th
## A Quick Note About Modular Hardware Design
Most customers think in terms of complete "products”. So, at FutureProofHomes **we will sell complete pre-assembled products**. However, unlike most hardware companies, our products will comprise of "modules", and each module is made up of "components”. In simple terms, we like to think of FutureProofHomes as the “Ikea of hardware”.

Good modular hardware design allows us to quickly iterate our products and innovate faster than monolithic hardware companies. It also allows our customers to easily repair and upgrade their products. And finally it's also helps us assure our customers that we will avoid the pitfalls of [planned obsolescence](https://en.wikipedia.org/wiki/Planned_obsolescence) which many hardware companies fall into.
Good modular hardware design allows us to quickly iterate our products and innovate faster than monolithic hardware companies. It also allows our customers to easily repair and upgrade their products. And finally, it also helps us assure our customers that we will avoid the pitfalls of [planned obsolescence](https://en.wikipedia.org/wiki/Planned_obsolescence) which many hardware companies fall into.

In summary, a strong modular design strategy helps us keep a competitive advantage and adhere to our [core principals](https://futureproofhomes.net/pages/our-core-principles).
In summary, a strong modular design strategy helps us keep a competitive advantage and adhere to our [core principles](https://futureproofhomes.net/pages/our-core-principles).


## 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.
While we hope this documentation will answer all your questions, 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.

!!! question "Have a general question and need quick help from the community?"

Expand All @@ -27,7 +27,7 @@ While we hope this documentation will answer all your questions, but we realize

!!! success "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: <br>
[Requst a New Feature on Github :fontawesome-solid-rocket:](https://github.com/FutureProofHomes/Satellite1-ESPHome/issues/new?template=feature-request--.md){ .md-button }
[Request a New Feature on Github :fontawesome-solid-rocket:](https://github.com/FutureProofHomes/Satellite1-ESPHome/issues/new?template=feature-request--.md){ .md-button }

!!! bug "Have you found a reproducable issue with the hardware or software? "
!!! bug "Have you found a reproducible issue with the hardware or software?"
[Report a Bug on Github :fontawesome-solid-bug:](https://github.com/FutureProofHomes/Satellite1-ESPHome/issues/new?template=bug-report--.md){ .md-button }
16 changes: 8 additions & 8 deletions docs/satellite1-assembly.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,28 +3,28 @@ The Satellite1 comes in 2 pieces:
- The "Hat" (round board)
- The "Core" (rectangular board)

You'll notice a standard Raspberry Pi 40-pin connector on the Hat board (marked in red). Carefully align the Core board's 2 rows of pins with the Hat's 40 pin connector and press them together.
You'll notice a standard Raspberry Pi 40-pin connector on the Hat board (marked in red). Carefully align the Core board's 2 rows of pins with the Hat's 40 pin connector and press them together.

![Mount Core to Hat](/assets/mount_core_to_hat.png){ width="100%" }

## Millimeter-wave presence sensors.
The Satellite1 HAT has two ports for optionally mounting external mmWave presence sensors: LD2410 or LD2450. [Please read more about setting up and calibrating your presense sensors here.](satellite1-presence-sensors.md)
## Millimeter-wave presence sensors
The Satellite1 HAT has two ports for optionally mounting external mmWave presence sensors: LD2410 or LD2450. [Please read more about setting up and calibrating your presence sensors here.](satellite1-presence-sensors.md)

<br>
<figure markdown="span">
![LD2410 mmWave](/assets/presence-sensors/sat1_ld2410.jpg){ width="100%" loading=lazy}
![LD2410 mmWave](/assets/presence-sensors/sat1_ld2410.jpg){ width="100%" loading="lazy"}
<figcaption>LD2410 Mounted on Sat1 HAT</figcaption>
</figure>

<figure markdown="span">
![LD2450 mmWave](/assets/presence-sensors/sat1_ld2450.jpg){ width="100%" loading=lazy}
![LD2450 mmWave](/assets/presence-sensors/sat1_ld2450.jpg){ width="100%" loading="lazy"}
<figcaption>LD2450 Mounted on Sat1 HAT</figcaption>
</figure>

### Sensor Positioning
When the sensor is directly mounted to the HAT it will point in the direction of the microphone and LEDs, which may work for your situation. However, you can also use the sensors' included JST cable to position the sensor in any orientation you'd like so it is not directly mounted to the HAT.
When the sensor is directly mounted to the HAT it will point in the direction of the microphone and LEDs, which may work for your situation. However, you can also use the sensors' included JST cable to position the sensor in any orientation you'd like so it is not directly mounted to the HAT.

![Sensor JST cable](/assets/presence-sensors/sensor_jst_cable.jpg){ width="100%" loading=lazy}
![Sensor JST cable](/assets/presence-sensors/sensor_jst_cable.jpg){ width="100%" loading="lazy"}

<!-- Watch this video to see how easy it is to assemble your Satellite1 boards.
<!-- Watch this video to see how easy it is to assemble your Satellite1 boards.
<iframe width="560" height="315" src="https://www.youtube.com/embed/yqWX86uT5jM?si=qK_A1XmaSsqYQ9js" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe> -->
54 changes: 27 additions & 27 deletions docs/satellite1-connecting-to-ha.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,44 +7,44 @@ Your Satellite1 arrives pre-flashed with all the necessary firmware to get you u
Open the Home Assistant Companion App on your Android or iPhone. Make sure Bluetooth on your phone is on and that you're nearby the Sat1!

1. <b>Tap "Settings":</b>
<br>![Tap "Settings":](/assets/ble_improv/1_go_to_settings.png){ width="50%" loading=lazy }</br>
<br>![Tap "Settings":](/assets/ble_improv/1_go_to_settings.png){ width="100%" loading=lazy }</br>

2. <b>Tap "Devices & Services":</b>
<br>![Tap "Devices & Services":](/assets/ble_improv/2_go_to_devices.png){ width="50%" loading=lazy }</br>
<br>![Tap "Devices & Services":](/assets/ble_improv/2_go_to_devices.png){ width="100%" loading=lazy }</br>

3. <b>Tap "Add" next to your Sat1 device (contains last 6 of device MAC address):</b>
<br>![Tap "Add" next to your Sat1 device (contains last 6 of device MAC address):](/assets/ble_improv/3_improv_discovered_device.png){ width="50%" loading=lazy }</br>
<br>![Tap "Add" next to your Sat1 device (contains last 6 of device MAC address):](/assets/ble_improv/3_improv_discovered_device.png){ width="100%" loading=lazy }</br>

4. <b>Type in your 2.4ghz network credentials:</b>
<br>![Type in your 2.4ghz network credentials:](/assets/ble_improv/4_improv_add_wifi_credentials.png){ width="50%" loading=lazy }</br>
<br>![Type in your 2.4ghz network credentials:](/assets/ble_improv/4_improv_add_wifi_credentials.png){ width="100%" loading=lazy }</br>

5. <b>On the Sat1 HAT, press the right "Action button" to give authorization:</b>
<br>![On the Sat1 HAT, press the right "Action button" to give authorization:](/assets/ble_improv/5_improv_press_authorization_button.png){ width="50%" loading=lazy }</br>
<br>![Click action buttons](/assets/ble_improv/6_click_action_button.png){ width="50%" loading=lazy }</br>
<br>![On the Sat1 HAT, press the right "Action button" to give authorization:](/assets/ble_improv/5_improv_press_authorization_button.png){ width="100%" loading=lazy }</br>
<br>![Click action buttons](/assets/ble_improv/6_click_action_button.png){ width="100%" loading=lazy }</br>

6. <b>Tap "Continue" after successfull Wifi connection:</b>
<br>![Tap "Continue" after successfull Wifi connection:](/assets/ble_improv/8_improv_successful_wifi_connection.png){ width="50%" loading=lazy }</br>
6. <b>Tap "Continue" after successful Wifi connection:</b>
<br>![Tap "Continue" after successfull Wifi connection:](/assets/ble_improv/8_improv_successful_wifi_connection.png){ width="100%" loading=lazy }</br>

7. <b>Tap "Ok" to begin setting up ESPHome:</b>
<br>![Tap "Ok" to begin setting up ESPHome:](/assets/ble_improv/9_esphome_setup_request.png){ width="50%" loading=lazy }</br>
<br>![Tap "Ok" to begin setting up ESPHome:](/assets/ble_improv/9_esphome_setup_request.png){ width="100%" loading=lazy }</br>

8. <b>Tap the name if your Sat1 device and then tap the "Submit" button:</b>
<br>![Tap the name if your Sat1 device and then tap the "Submit" button:](/assets/ble_improv/10_esphome_select_device.png){ width="50%" loading=lazy }</br>
8. <b>Tap the name of your Sat1 device and then tap the "Submit" button:</b>
<br>![Tap the name if your Sat1 device and then tap the "Submit" button:](/assets/ble_improv/10_esphome_select_device.png){ width="100%" loading=lazy }</br>

9. <b>The Wizard will pull down the most recent Sat1 Firmware:</b>
<br>![The Wizard will pull down the most recent Sat1 Firmware:](/assets/ble_improv/12_wizard_checking_for_updates.png){ width="50%" loading=lazy }</br>
<br>![The Wizard will pull down the most recent Sat1 Firmware:](/assets/ble_improv/12_wizard_checking_for_updates.png){ width="100%" loading=lazy }</br>

10. <b>The Wizard will ask you to say the Wake Word twice:</b>
<br>![The Wizard will ask you to say the Wake Word twice:](/assets/ble_improv/13_wizard_first_wake_word_test.png){ width="50%" loading=lazy }</br>
<br>![The Wizard will ask you to say the Wake Word twice:](/assets/ble_improv/13_wizard_first_wake_word_test.png){ width="100%" loading=lazy }</br>

11. <b>Type the Area this Sat1 falls in:</b>
<br>![Type the Area this Sat1 falls in:](/assets/ble_improv/15_wizard_assign_area.png){ width="50%" loading=lazy }</br>
<br>![Type the Area this Sat1 falls in:](/assets/ble_improv/15_wizard_assign_area.png){ width="100%" loading=lazy }</br>

12. <b>Stick with the default or change the wake word, conversation agent, and voice:</b>
<br>![Stick with the default or change the wake word, conversation agent, and voice:](/assets/ble_improv/16_wizard_quick_pipeline_config.png){ width="50%" loading=lazy }</br>
<br>![Stick with the default or change the wake word, conversation agent, and voice:](/assets/ble_improv/16_wizard_quick_pipeline_config.png){ width="100%" loading=lazy }</br>

13. <b>After completing the Wizard, do NOT click to add the Sat1 to ESPHome again. Simply refresh and this will go away.</b>
<br>![After completing the Wizard, do NOT click to add the Sat1 to ESPHome again. Simply refresh and this will go away.](/assets/ble_improv/17_ignore_device_discovered.png){ width="50%" loading=lazy }</br>
<br>![After completing the Wizard, do NOT click to add the Sat1 to ESPHome again. Simply refresh and this will go away.](/assets/ble_improv/17_ignore_device_discovered.png){ width="100%" loading=lazy }</br>

Congrats. You're done!

Expand All @@ -53,34 +53,34 @@ Your Satellite1 arrives pre-flashed with all the necessary firmware to get you u
Plug your Sat1 directly into your computer with a USB-C cable that supports a data connection.

1. <b>Click <esp-web-install-button id="install-button" manifest="https://raw.githubusercontent.com/FutureProofHomes/Documentation/refs/heads/main/manifest.json" install-supported></esp-web-install-button> and select the JTAG device in the browser's notification:</b>
<br>![Select JTAG](/assets/ESPHome-SerialConn.png){ width="50%" loading=lazy }</br>
<br>![Select JTAG](/assets/ESPHome-SerialConn.png){ width="100%" loading=lazy }</br>

2. <b>Click "Install":</b>
<br>![Image title](/assets/ESPHome-Install.png){ width="50%" loading=lazy }</br>
<br>![Image title](/assets/ESPHome-Install.png){ width="100%" loading=lazy }</br>

3. <b>Optionally erase the device, then click "Next" and then "Install":</b>
<br>![Image title](/assets/ESPHome-Erase.png){ width="50%" loading=lazy }</br>
<br>![Image title](/assets/ESPHome-ConfirmInstall.png){ width="50%" loading=lazy }</br>
<br>![Image title](/assets/ESPHome-Erase.png){ width="100%" loading=lazy }</br>
<br>![Image title](/assets/ESPHome-ConfirmInstall.png){ width="100%" loading=lazy }</br>

4. <b>Installation will complete. Click "Next":</b>
<br>![Image title](/assets/ESPHome-InstallationComplete.png){ width="50%" loading=lazy }</br>
<br>![Image title](/assets/ESPHome-InstallationComplete.png){ width="100%" loading=lazy }</br>

5. <b>Type in your2.4ghz WiFi network and click "Connect". Your device will begin sparkling blue while attempting to connect.</b>
<br>![Image title](/assets/ConfigureWifi.png){ width="50%" loading=lazy }</br>
5. <b>Type in your 2.4ghz WiFi network and click "Connect". Your device will begin sparkling blue while attempting to connect.</b>
<br>![Image title](/assets/ConfigureWifi.png){ width="100%" loading=lazy }</br>

6. <b>Congrats you're now connected to your Wifi. Your device will now begin sparkling red. This means it needs to be connected to ESPHome in your Home Assistant instance.</b>
<br>![Image title](/assets/ESPHome-WiFiConnected.png){ width="50%" loading=lazy }</br>
<br>![Image title](/assets/ESPHome-WiFiConnected.png){ width="100%" loading=lazy }</br>

7. <b>Inside Home Assistant, go to "Settings -> Devices & Services" and notice you have a Discovered `Satellite1 xxxxxx' device. Click add and follow the onboarding steps.</b>
<br>![Image title](/assets/discovered_sat1.png){ width="50%" loading=lazy }</br>
<br>![Image title](/assets/discovered_sat1.png){ width="100%" loading=lazy }</br>

Congrats. You're done!


## ESPHome User Interface
Once your Sat1 is connected to Home Assistnat you should familiarize yourself with all the server-side settings you may want to change:
Once your Sat1 is connected to Home Assistant you should familiarize yourself with all the server-side settings you may want to change:

1. <b>Inside your Home Assistnat, head over to "Settings -> Devices & Services -> ESPHome" and click on your Sat1 device:</b>
1. <b>Inside your Home Assistant, head over to "Settings -> Devices & Services -> ESPHome" and click on your Sat1 device:</b>
<br>![esphome device list](/assets/esphome/1_esphome_device_list.png){ width="100%" loading=lazy }</br>

2. <b>Understand all the features of your Sat1 device:</b>
Expand Down
7 changes: 5 additions & 2 deletions docs/satellite1-faqs.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,15 @@
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?"
Satellite1 currently supports "hey Jarvis" and "OK 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.
???+ 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.

<a id="faq_anchor_wake_word_success"></a>
???+ note "The wake word isn't always responding!"

1. Try both "Okay Nabu" and "Hey Jarvis".
2. "Okay Nabu" is more trained and may have a higher success rate.
3. Speak normally. Don't scream.
Expand Down
Loading

0 comments on commit 185b7aa

Please sign in to comment.