Add README.md

2019-12-20 22:46:49 +00:00
parent bfa6eb9075
commit c9eef00395
1 changed files with 17 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -0,0 +1,17 @@
+# Home Assistant Custom Component for Pioneer VSX 920 
+Older Pioneer VSX amplifier/receivers require extra carriage returns to be sent to the receiver before they are ready to accept commands.
+
+This custom component fixes that issue.  
+
+## Configuration.yaml
+```yaml
+  - platform: pioneervsx
+    name: "VSX920"
+    host: 192.168.1.2
+    port: 8102
+    enabled_sources_only: true
+```
+
+## Extra Features
+* enabled_sources_only: 
+  Limits the list of sources to only those enabled on the Receiver. (true by default, set to false to see all sources)