Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion wiki/docs/extend-functionality/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@ title: "Automations & Views"
sidebar_position: 4
---

View Assist is easily extendable by adding custom sentences automations which provide data to different custom views. In this section you will find a gallery of premade custom sentence blueprints for easy installation. You will find links to the requird integrations, required views and installation instructions.
View Assist is easily extendable by adding custom sentences automations which provide data to different custom views. On this page you will find a gallery of premade custom sentences blueprints. You will find links to the requirements and installation instructions. These blueprints have been made available for easy installation. You MUST use these to extend the base Home Assistant voice experience to fully utilize View Assist. Use these blueprints to create automations to fit your needs.

We encourage everyone to share their creations so that others might enjoy what you have brought to life. Note that these submissions will be provided under the 'Community Submissions' section for the blueprints, views and integration requirements. These items are supported by the author of these submissions and any questions or comments should be directed to the author or discussed in the 'Community Submissions' channel on our Discord server.
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@

- Music Assistant server installed and integrated with Home Assistant
- View: [Music view](../views/music)
- The recently added musicplayer_device must be added to your View Assistant device configuration as explained in the [Satellite Custom Device Configuration](https://github.com/dinki/View-Assist/wiki/View-Assist-device-configuration#satellite-custom-device-configuration) portion of the wiki. This should be a Music Assistant player device. Typically these will be named the same as your mediaplayer_device but with a \_2 on the end

## Translations

Expand Down
4 changes: 3 additions & 1 deletion wiki/docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,9 @@ View Assist provides visual feedback for the Home Assistant Assist voice assista
<details>
<summary>Why is the dashboard on my PC browser is showing a box telling me to register the device</summary>

You are trying to use View Assist on a PC or other nonView Assist satellite device. The dashboard is only for use on VA satellite devices. The dashboard is only used by View Assist satellites and will not work for general browsing outside of those registered devices
You are trying to use View Assist on a PC or other nonView Assist satellite device. The dashboard is only for use on VA satellite devices. The dashboard is only used by View Assist satellites and will not work for general browsing outside of those registered devices. The original intent of View Assist was to be an alternative to the Alexa Show and Next Home display devices. Those are not general purpose tablets but a supplemental view for voice. Further, the View Assist views provided are not static views like most Home Assistant views. These views are dynamic. The voice commands provide variable data stored in the attributes of each individual VA satellite device. The views are set to look at those attributes. This allows device independence and easy expansion of additional satellites without having to create multiple dashboards with a dedicated one per device.

All said, VA is a framework and you are more than welcome to adapt it to your needs but the way things are now will probably not change much, if any, unless someone can provide a suitable way of providing that underlying data with touch.

</details>

Expand Down
20 changes: 9 additions & 11 deletions wiki/docs/supported-devices/esphome-devices/m5stack-atom-echo.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar_position: 2

![Image](./m5stackecho.jpg)

The M5Stack Atom Echo Smart Speaker ([Amazon](https://amzn.to/4eC8Tto)/[M5Stack Shop](https://shop.m5stack.com/collections/m5-controllers/products/atom-echo-smart-speaker-dev-kit)/[AliExpress](https://www.aliexpress.us/item/3256803113017446.html?aff_platform=portals-tool&sk=_A8G2YF&aff_trace_key=90326d2a90444b4887632f62dd533ce4-1654058373639-07963-_A8G2YF&terminal_id=c5517a8c9bb44b4fb32147398fbc2576&aff_fcid=90326d2a90444b4887632f62dd533ce4-1654058373639-07963-_A8G2YF&tt=CPS_NORMAL&aff_fsk=_A8G2YF&gatewayAdapt=glo2usa4itemAdapt)) is a small device that allows for easy set up via a webbased flashing tool. This is one of the easiest devices to get started with Home Assistant voice. Do know, however, that it is far from perfect in regards to its audio output. The speaker is very small and does not sound great but it is an inexpensive device and does get the job done for light work.
The M5Stack Atom Echo Smart Speaker ([Amazon](https://amzn.to/4eC8Tto)/[M5Stack Shop](https://shop.m5stack.com/collections/m5-controllers/products/atom-echo-smart-speaker-dev-kit)/[AliExpress](https://www.aliexpress.us/item/3256803113017446.html?aff_platform=portals-tool&sk=_A8G2YF&aff_trace_key=90326d2a90444b4887632f62dd533ce4-1654058373639-07963-_A8G2YF&terminal_id=c5517a8c9bb44b4fb32147398fbc2576&aff_fcid=90326d2a90444b4887632f62dd533ce4-1654058373639-07963-_A8G2YF&tt=CPS_NORMAL&aff_fsk=_A8G2YF&gatewayAdapt=glo2usa4itemAdapt)) is a small device that allows for easy set up via a webbased flashing tool. This is one of the easiest devices to get started with Home Assistant voice. Do know, however, that it is far from perfect in regards to its audio output. The speaker is very small and does not sound great but it is an inexpensive device and does get the job done for light work.

## Installation

Expand All @@ -21,15 +21,13 @@ Then after follow the tutorial found here:

https://www.home-assistant.io/voice_control/thirteen-usd-voice-remote/

You will then fast forward through most of the configuration steps. Note that you will not need to set up a timer helper for this device as that is only used for View Assist satellites with displays.
You will then fast forward through most of the configuration steps.

Follow this link to add your M5Stack Atom Echo device as a voice only satellite in View Assist:

https://dinki.github.io/View-Assist/docs/viewassist-setup/homeassistant-configuration/viewassist-configuration/device-configuration#satellite-custom-device-configuration
At this point you can add your M5Stack Atom Echo device as a View Assist device with no display.

### Use the M5Stack Atom Echo as a microphone only (Optional)

User @Tohur has come up with a clever way to use an M5Stack Atom Echo device as a microphone replacement for his inferior microphone on their Android tablet. This use case is not common and most can skip this altogether but for some it may prove to be very useful.
User @Tohur has come up with a clever way to use an M5Stack Atom Echo device as a microphone replacement for his inferior microphone on their Android tablet. This use case is not common and most can skip this altogether but for some it may prove to be very useful.

@Tohur explains how to use his method here:

Expand All @@ -39,11 +37,11 @@ Initially follow the setup above for your M5Stack Atom echo.

**ESPHome**

Next we install ESPHome by going to Settings -> Add-ons and clicking the button on the bottom right and searching for ESPHome or
Next we install ESPHome by going to Settings -> Add-ons and clicking the button on the bottom right and searching for ESPHome or

[![ESPHome](https://my.home-assistant.io/badges/supervisor_addon.svg 'ESPHome')](https://my.home-assistant.io/redirect/supervisor_addon/?addon=5c53de3b_esphome&repository_url=https%3A%2F%2Fgithub.com%2Fesphome%2Fhome-assistant-addon)
[![ESPHome](https://my.home-assistant.io/badges/supervisor_addon.svg "ESPHome")](https://my.home-assistant.io/redirect/supervisor_addon/?addon=5c53de3b_esphome&repository_url=https%3A%2F%2Fgithub.com%2Fesphome%2Fhome-assistant-addon)

Make sure to turn on the sidebar view for easy access to ESPHome. Once you have ESPHome installed and running go to the ESPHome webui in a Chromium based browser and you should see your configured M5Stack Atom Echo ready to be adopted by ESPHome. Follow the adoption process and once its configured click edit and paste the provided firmware yaml.
Make sure to turn on the sidebar view for easy access to ESPHome. Once you have ESPHome installed and running go to the ESPHome webui in a Chromium based browser and you should see your configured M5Stack Atom Echo ready to be adopted by ESPHome. Follow the adoption process and once its configured click edit and paste the provided firmware yaml.

The firmware yaml can be found here: [m5stack-atom-echo.yaml](./m5stack-atom-echo.yaml)

Expand All @@ -54,15 +52,15 @@ substitutions:
name: "m5stack-atom-echo"
friendlyname: "M5Stack Atom Echo"
api_key: "encryption key"
# Home assistant media player entity
# Home assistant media player entity
HA_mediaplayer: "media_player.bedroom"
# tts to use to bypass the onboard processing to prevent having to repeat yourself when the echo goes idle.
# Default is set to Nabu Casa, but can be google, piper, or any other TTS you have configured.
# Can go to Developer -> Actions and serach for tts to find the proper tts to use.
HA_tts: "tts.cloud_say"
```

Replace name and friendlyname values with your device name and friendlyname and replace the api_key value with your encryption key aquired earlier. HA_mediaplayer should be the media player entitiy for your View Assist satellite as with the firmware you are only using the microphone of the M5Stack Atom echo and all audio is outputted over your View Assist satellite. Then find the tts service you use and set HA_tts to that service, This is needed to bypass the onboard TTS processing as when the echo goes idle you may have to repeat yourself to get an audio response, this bypasses that and lets HA do 100% of the tts processing. Also make sure to look at the cofig in the wfi section and make sure you have an static ip set matching your network details.
Replace name and friendlyname values with your device name and friendlyname and replace the api_key value with your encryption key aquired earlier. HA_mediaplayer should be the media player entitiy for your View Assist satellite as with the firmware you are only using the microphone of the M5Stack Atom echo and all audio is outputted over your View Assist satellite. Then find the tts service you use and set HA_tts to that service, This is needed to bypass the onboard TTS processing as when the echo goes idle you may have to repeat yourself to get an audio response, this bypasses that and lets HA do 100% of the tts processing. Also make sure to look at the cofig in the wfi section and make sure you have an static ip set matching your network details.

Once you have your config edited make sure to save before clicking Install. If wifi is already setup and ready to go you should be able to install using the wifi option other wise choose to install from the browser you are using and by plugging the Atom Echo directly into your HA Instances machine and install directly over USB.

Expand Down