From be963d25ceed0f739e0d0f49502177cf01c4994f Mon Sep 17 00:00:00 2001 From: samuelspagl Date: Thu, 14 Mar 2024 13:53:06 +0100 Subject: [PATCH] Update documentation --- README.md | 13 +++++-------- .../1.first-things-first/1.getting-started.md | 2 +- .../2.issues-and-other-things.md | 4 ++-- docs/content/2.features/0.index.md | 8 ++++++++ 4 files changed, 16 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 8608672..380f9be 100644 --- a/README.md +++ b/README.md @@ -49,31 +49,28 @@ For the full feature list per entity type, please take a look at the [documentat Before you begin, ensure you have the following: - A Samsung Soundbar compatible with SmartThings. -- HomeAssistant installed and running. +- Home Assistant installed and running. - HACS (Home Assistant Community Store) for easy installation. ### Installation -1. Add this repository as a custom repository in HACS or manually copy the `samsung_soundbar` folder to the `custom_components` directory in your HomeAssistant configuration. +1. Add this repository as a custom repository in HACS or manually copy the `samsung_soundbar` folder to the `custom_components` directory in your Home Assistant configuration. [![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=samuelspagl&repository=ha_samsung_soundbar&category=integration) -2. Restart HomeAssistant. +2. Restart Home Assistant. > [!NOTE] > It is planned to add it to the public `HACS` repository list, but not done yet. ### Configuration -To integrate your Samsung Soundbar with HomeAssistant using YASSI, you'll need the following variables: +To integrate your Samsung Soundbar with Home Assistant using YASSI, you will be asked for the following variables: - **SmartThings API Key**: [Retrieve your API key from SmartThings Tokens.](https://account.smartthings.com/tokens) - **Device ID**: [Find your device ID at SmartThings Devices.](https://my.smartthings.com/advanced/devices) -- **Device Name**: Choose a name for your soundbar to be recognized in HomeAssistant. +- **Device Name**: Choose a name for your soundbar to be recognized in Home Assistant. - **Max Volume**: Define the maximum volume level for the `media_player` slider (between `1` and `100`). -Please use the HomeAssistant UI to setup the integration, providing a yaml configuration in the `configuration.yaml` -should be possible but is not recommended. - ## Support For support, feature requests, or bug reporting, please visit the Issues section of this GitHub repository. diff --git a/docs/content/1.first-things-first/1.getting-started.md b/docs/content/1.first-things-first/1.getting-started.md index cc5ce75..9aa28e6 100644 --- a/docs/content/1.first-things-first/1.getting-started.md +++ b/docs/content/1.first-things-first/1.getting-started.md @@ -14,7 +14,7 @@ In the meantime, you can manually add this repository to HACS: 1. Click the following button and 'open link': [![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=samuelspagl&repository=ha_samsung_soundbar&category=integration) 2. Click 'add' to add the custom repository. -3. Download 'Yassi' and reboot Home Assistant. +3. Download 'Yassi' and restart Home Assistant. ### 📂 Manual Installation If you prefer to install Yassi manually: diff --git a/docs/content/1.first-things-first/2.issues-and-other-things.md b/docs/content/1.first-things-first/2.issues-and-other-things.md index 1111b59..50b5b9f 100644 --- a/docs/content/1.first-things-first/2.issues-and-other-things.md +++ b/docs/content/1.first-things-first/2.issues-and-other-things.md @@ -6,9 +6,9 @@ Here are some best practices to help me help you: 1. 🐞 GitHub Issues: For any issues or bugs, please submit them via GitHub Issues. ([🔗 click here](https://github.com/samuelspagl/ha_samsung_soundbar/issues/new)) 2. 📋 Provide Details: Include essential information: - - HomeAssistant OS Version + - Home Assistant OS Version - Samsung Soundbar Model - - Other Relevant Details + - Other Relevant Details (like debug logs) 3. 🎇 Icons for Fun: - 📦 = Feature Request - 🐛 = Bug Report diff --git a/docs/content/2.features/0.index.md b/docs/content/2.features/0.index.md index 623092a..e0f6099 100644 --- a/docs/content/2.features/0.index.md +++ b/docs/content/2.features/0.index.md @@ -41,4 +41,12 @@ Yassi allows you to retrieve and set the status of various features on your Sams |-------------------|----------------|-----------------| | Media Cover Art | display | Read | + +## `sensor` Entity + +| **Feature** | **Capability** | **Access Type** | +|-------------|--------------------|-----------------| +| Volume | float sensor value | Read | + + Hopefully this format provides a clear and concise view of what Yassi can do with your Samsung Soundbar, making it easier to understand and configure.