Enhance documentation
This commit is contained in:
		
							parent
							
								
									1dbf47c7c5
								
							
						
					
					
						commit
						15474a698d
					
				|  | @ -1,6 +1,6 @@ | |||
| export default defineAppConfig({ | ||||
|   docus: { | ||||
|     title: 'YASSI', | ||||
|     title: '🔊 Yassi', | ||||
|     description: 'HomeAssistant: Yet another Samsung soundbar integration', | ||||
|     image: 'https://user-images.githubusercontent.com/904724/185365452-87b7ca7b-6030-4813-a2db-5e65c785bf88.png', | ||||
|     socials: { | ||||
|  | @ -28,7 +28,7 @@ export default defineAppConfig({ | |||
|       fluid: true | ||||
|     }, | ||||
|     header: { | ||||
|       logo: true, | ||||
|       logo: false, | ||||
|       showLinkIcon: true, | ||||
|       exclude: [], | ||||
|       fluid: true | ||||
|  |  | |||
|  | @ -5,24 +5,19 @@ title: "YASSI" | |||
| --- | ||||
| cta: | ||||
|   - Why another HomeAssistant integration? | ||||
|   - #why-another-integration | ||||
|   - /first-things-first/why-another-integration | ||||
| secondary: | ||||
|   - Open on GitHub → | ||||
|   - https://github.com/nuxtlabs/docus | ||||
| snippet: | ||||
|   - Custom Components | ||||
|   - "- input selection" | ||||
|   - "- soundmode selection" | ||||
|   - "- eq-preset selection" | ||||
|   - "- woofer settings" | ||||
|   - "- other cool things" | ||||
|   - https://github.com/samuelspagl/ha_samsung_soundbar | ||||
| --- | ||||
| 
 | ||||
| #title | ||||
| Yassi | ||||
| Yassi - Yet another Samsung Soundbar integration | ||||
| 
 | ||||
| #description | ||||
| Yet another Samsung soundbar integration for HomeAssistant | ||||
| **YASSI** is a **HomeAssistant** integration for **Samsung Soundbars**. It enhances control, and adds features like equalizer settings. Install it via HACS or manually. Kudos to the original idea by @PiotrMachowski and @thierryBourbon! 🎶🔊 | ||||
| 
 | ||||
| [](https://my.home-assistant.io/redirect/hacs_repository/?owner=samuelspagl&repository=ha_samsung_soundbar&category=integration) | ||||
| :: | ||||
| 
 | ||||
| ::card-grid | ||||
|  | @ -34,36 +29,42 @@ Quick-Start | |||
| #default | ||||
|   ::card | ||||
|   #title | ||||
|   Getting Started. | ||||
|   ❓ Why another integration? | ||||
|   #description | ||||
|   Go, Go, Go... Here you will find information on "How to install / configure". | ||||
|   Weather you thought about it or not, here is the answer ;). | ||||
|   <br> | ||||
|   <br> | ||||
|   :button-link[click here]{href="/getting-started"} | ||||
|   :button-link[click here]{href="/first-things-first/why-another-integration"} | ||||
|   :: | ||||
| 
 | ||||
|   ::card | ||||
|   #title | ||||
|   Features | ||||
|   🚀 Getting Started | ||||
|   #description | ||||
|   Go, Go, Go... Here you will find information on "How to install / configure". | ||||
|   <br> | ||||
|   <br> | ||||
|   :button-link[click here]{href="/first-things-first/getting-started"} | ||||
|   :: | ||||
| 
 | ||||
|   ::card | ||||
|   #title | ||||
|   ✨ Features | ||||
|   #description | ||||
|   Many cool features are awaiting your eyes to see ✨. | ||||
|   <br> | ||||
|   <br> | ||||
|   :button-link[click here]{href="/features"} | ||||
|   :: | ||||
| 
 | ||||
|   ::card | ||||
|   #title | ||||
|   ⚙️ SmartThings API related information | ||||
|   #description | ||||
|   If you want to know some background information on how equalizer support and | ||||
|   other things were implemented, this is your section. | ||||
|   <br> | ||||
|   <br> | ||||
|   :button-link[click here]{href="/features"} | ||||
|   :: | ||||
| :: | ||||
| 
 | ||||
| 
 | ||||
| ## Why another integration | ||||
| 
 | ||||
| The current Samsung Soundbar Integration by @PiotrMachowski / @thierryBourbon are already pretty cool. | ||||
| But I wanted it to appear as a device, and base the Foundation on the `pysmartthings` python package. | ||||
| 
 | ||||
| Additionally, I wanted full control over the *Soundmode* and more. So I tried out a few things with the API, | ||||
| and found that also the **Subwoofer** as well as the **Equalizer** are controllable. | ||||
| 
 | ||||
| I created a new wrapper around the `pysmartthings.DeviceEntity` specifically set up for a Soundbar, and this | ||||
| is the Result. | ||||
| 
 | ||||
| I hope to integrate also controls for **surround speaker** as well as **Space-Fit Sound**, but as these features | ||||
| are not documented... ;)  | ||||
|  | @ -0,0 +1,13 @@ | |||
| # ❓ Why another integration | ||||
| 
 | ||||
| The current Samsung Soundbar Integration by @PiotrMachowski / @thierryBourbon are already pretty cool. | ||||
| But I wanted it to appear as a device, and base the Foundation on the `pysmartthings` python package. | ||||
| 
 | ||||
| Additionally, I wanted full control over the *Soundmode* and more. So I tried out a few things with the API, | ||||
| and found that also the **Subwoofer** as well as the **Equalizer** are controllable. | ||||
| 
 | ||||
| I created a new wrapper around the `pysmartthings.DeviceEntity` specifically set up for a Soundbar, and this | ||||
| is the Result. | ||||
| 
 | ||||
| I hope to integrate also controls for **surround speaker** as well as **Space-Fit Sound**, but as these features | ||||
| are not documented... ;)  | ||||
|  | @ -0,0 +1,17 @@ | |||
| # ‼️ Issues and other things | ||||
| 
 | ||||
| As the creator of this personal and fun project, I am thrilled to see people using it. While I won’t always have immediate availability to address every request, I’ll do my best to fix issues and implement features. Thanks a lot in advance! 🙌 | ||||
| 
 | ||||
| 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 | ||||
|     - Samsung Soundbar Model | ||||
|     - Other Relevant Details | ||||
| 3. 🎇 Icons for Fun: | ||||
|     - 📦 = Feature Request | ||||
|     - 🐛 = Bug Report | ||||
|     - ❓ = General Questions | ||||
| 
 | ||||
| Let’s collaborate to enhance your soundbar experience! 🎶🔊 | ||||
|  | @ -1,4 +1,4 @@ | |||
| # Features Overview | ||||
| # ✨ Features Overview | ||||
| 
 | ||||
| Yassi allows you to retrieve and set the status of various features on your Samsung Soundbar. Below is a breakdown of capabilities organized by entity type. | ||||
| 
 | ||||
|  | @ -41,4 +41,4 @@ Yassi allows you to retrieve and set the status of various features on your Sams | |||
| |-------------------|----------------|-----------------| | ||||
| | Media Cover Art   | display        | Read            | | ||||
| 
 | ||||
| This table 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. | ||||
|  |  | |||
		Loading…
	
		Reference in New Issue