orkun
/
ha_samsung_soundbar
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 1 Wiki Activity

Update documentation

This commit is contained in:
samuelspagl 2024-03-14 13:53:06 +01:00
parent b102447764
commit be963d25ce
4 changed files with 16 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -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: Before you begin, ensure you have the following:
- A Samsung Soundbar compatible with SmartThings. - A Samsung Soundbar compatible with SmartThings.
- HomeAssistant installed and running. - Home Assistant installed and running.
- HACS (Home Assistant Community Store) for easy installation. - HACS (Home Assistant Community Store) for easy installation.
### 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) [![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] > [!NOTE]
> It is planned to add it to the public `HACS` repository list, but not done yet. > It is planned to add it to the public `HACS` repository list, but not done yet.
### Configuration ### 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) - **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 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`). - **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 ## Support
For support, feature requests, or bug reporting, please visit the Issues section of this GitHub repository. For support, feature requests, or bug reporting, please visit the Issues section of this GitHub repository.

2
docs/content/1.first-things-first/1.getting-started.md
View File

@ -14,7 +14,7 @@ In the meantime, you can manually add this repository to HACS:
1. Click the following button and 'open link': 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) [![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. 2. Click 'add' to add the custom repository.
3. Download 'Yassi' and reboot Home Assistant. 3. Download 'Yassi' and restart Home Assistant.
### 📂 Manual Installation ### 📂 Manual Installation
If you prefer to install Yassi manually: If you prefer to install Yassi manually:

4
docs/content/1.first-things-first/2.issues-and-other-things.md
View File

@ -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)) 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: 2. 📋 Provide Details: Include essential information:
- HomeAssistant OS Version - Home Assistant OS Version
- Samsung Soundbar Model - Samsung Soundbar Model
- Other Relevant Details - Other Relevant Details (like debug logs)
3. 🎇 Icons for Fun: 3. 🎇 Icons for Fun:
- 📦 = Feature Request - 📦 = Feature Request
- 🐛 = Bug Report - 🐛 = Bug Report

8
docs/content/2.features/0.index.md
View File

@ -41,4 +41,12 @@ Yassi allows you to retrieve and set the status of various features on your Sams
|-------------------|----------------|-----------------| |-------------------|----------------|-----------------|
| Media Cover Art | display | Read | | 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. 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.