From 3ec79fd74b47f27c486efba26472524dc04cd9c5 Mon Sep 17 00:00:00 2001 From: Teemu R Date: Fri, 9 Mar 2018 19:28:40 +0100 Subject: [PATCH] Add sony songpal docs (#4570) * add sony songpal docs * use configuration, add a title for configuration section * remove oxford comma, add link to media_player's services * add entity_id desc for service * be more descriptive which devices are supported * Update songpal supported devices + bump version * discoverY * Update media_player.songpal.markdown * Fix invalid syntax --- .../_components/media_player.songpal.markdown | 68 ++++++++++++++++++ source/images/supported_brands/sony.png | Bin 0 -> 7152 bytes 2 files changed, 68 insertions(+) create mode 100644 source/_components/media_player.songpal.markdown create mode 100644 source/images/supported_brands/sony.png diff --git a/source/_components/media_player.songpal.markdown b/source/_components/media_player.songpal.markdown new file mode 100644 index 00000000000..65874f99b26 --- /dev/null +++ b/source/_components/media_player.songpal.markdown @@ -0,0 +1,68 @@ +--- +layout: page +title: "Sony SongPal compatible devices" +description: "Instructions how to integrate Sony Songpal devices into Home Assistant." +date: 2018-02-03 09:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: sony.png +ha_category: Media Player +ha_iot_class: "Local Polling" +ha_release: 0.65 +--- + +The `songpal` platform allows you to control Sony's Songpal ("[Audio Control API](https://developer.sony.com/develop/audio-control-api/)") compatible devices such as soundbars, AV receivers and wireless speakers from Home Assistant. + +Even when the API officially supports only a few devices (HT-ST5000, HT-MT500, HT-CT800, SRS-ZR5 and STR-DN1080), it has also been confirmed to work on others. [The list of supported devices](http://vssupport.sony.net/en_ww/device.html) from Sony's Songpal website lists devices which are likely to be compatible with this platform. + +If the platform works with your non-listed device, or you encounter bugs, please feel free to [report them upstream](https://github.com/rytilahti/python-songpal). + +A few notes: + +- The quick start-up mode has to be enabled in order to turn the device on. +- Supports currently only one output terminal, i.e. the volume control works only on the first volume controller as reported by the backend library. +- Some devices, e.g. HT-XT3, do not support decreasing the volume step-by-step correctly. +- Feel free to improve the available services! + +## {% linkable_title Configuration %} + +The platform will be loaded automatically by discovery component. If you want to manually configure it, add the following to your `configuration.yaml` file: + +```yaml +media_player: + - platform: songpal + name: my soundbar + endpoint: http://IP_ADDRESS:10000/sony +``` + +{% configuration %} +name: + description: The name to display for this device. + required: false + type: string +endpoint: + description: API endpoint of the device. + required: true + type: string +{% endconfiguration %} + +See [python-songpal's documentation](https://github.com/rytilahti/python-songpal#locating-the-endpoint) how to get your API endpoint. + +## {% linkable_title Services %} + +In addition to the general [media player services](https://home-assistant.io/components/media_player/#services), the following services are provided: + +### {% linkable_title Service `media_player/songpal_set_sound_setting` %} + +For a list of available settings and their values use [`songpal sound`](https://github.com/rytilahti/python-songpal#sound-settings) command. + +| Service data attribute | Optional | Description | +|------------------------|----------|--------------------------------------------------| +| `entity_id` | yes | Target entity, leave unset for all devices | +| `name` | no | Configuration variable, e.g. `nightmode` | +| `value` | no | New configuration value, e.g. `on` | + + + diff --git a/source/images/supported_brands/sony.png b/source/images/supported_brands/sony.png new file mode 100644 index 0000000000000000000000000000000000000000..78a8e8440b1a2c18c03bf7c2791ac9de0f673b1d GIT binary patch literal 7152 zcmV004R>004l5008;`004mK004C`008P>0026e000+ooVrmw00002 zVoOIv0RM-N%)bBt00(qQO+^Rc2nhu=1_(Ct!*XW<#e$xohsqt|p@@obR?q_xP=udS1v~_4LPAqOy0nA< zQA$D&NuJ*yz!Aceu)8y}JNslm`+E8EMV_7cPW$Y4X1)bHc<|sMpCU+k4Utr&EF~yT z35pX%5M251IW7VxNhOt2B$C8o(!C+M3Bo8t3}q=r6vc_67$HC;p`5};8kw9XgR`V_ zmK2Wh2PypSb(;qdb`fAPYEzHe)Swd46gTmvkE0}#ND{l*!d6nf0Rn=kLVapdooZC4 zyoD0Zv!8<;U^m;@L88~C9z4h=?$^ygk8w3!imnapP#v!$-~G*?{1A-+^v{_T#a0q=6j@4pWu zN{cykl8KhyyN3q0%DJDf&HTJ7V@PpegO>Mmk-79H%r61v{#G9irb%_i^1F8ZdAUz# z(AtI`c+-ZqyrcAE{f;B!Q#jX;mmc$HkHy~n#AZ1cL9jv5>hUGJ8Ad7Xbl5PuF^dC? zv}7RSl-_+WOWDN>+@hs?Vf14)tLdVNrZ0l$ndbNN=)nWV2(SUO`Gxxplcf_V#|REE zlSbM8t+bYshVv-DGM_uNCzsYNU^CraKgavCAV9CpJSZo?5`4@idTC95R}o5IHZuRp z)kk|8YN%N~!Ea2Wwrl1`1Lm+gkIN)?;7*oP##`(j%n@J^53`ejt{}hco69xqVjVwd zX4VnR!|dWiD!6Wrv}O%oyHM`zXv`X_dduB|aRMyEf0?Y|nV%8Vpt)wWeH$B?Ol8;3 zlRoU=c?!6ArdMSRjlBi$!59IyVH0b)g@gkR~axRx|h*vCoEE3T&z8+gH0Mf)TP?}QQ!Yx!Jmhu5$egP28f0XDP`$%9f``E`m zj&tt1zeQ1os>BjYEn1k0#bX5FjHL_xIpWe031b>%80Rf~5B>=-h);M-Lb*P6u%2Jp z#&!;xemjCHR40yxG$PiuWY~o%lI{Gqv6wZi<7ghgImIb<{ckjD(~359kt#=fHgP{I zT&t76OL>Oj^A^8{8!=kgy80JJ(@CP{QIxxQjTM}iY6Gs?6QlrdlO<8!jSQ!zfHZgT z5l1D;bBVu6=%qIu^HunQP$}c=d4jmy6Xbe4AXMB2o~DvAN(rYUEI$=Or%GElAiONxbE5LP6CYMoW+9DnP}TBXH8yZht>pG ziLH_b=ol|iQnGZnGL;NT@-3m5k{&Ecb$apb2Dz*tEU z{mwC3awO<$s3%QBU9U9$NJ*wDrNG_9+Avr9a>=kn7ig(emRih~+=l~{_uncDQhjMY zobdCOnxCrN#3Oe^GLW5`5nvS#N|{#EBqkQ{kGmx4squ=mz^hjlUnr%(Bev{ZJ}@lL z$F>l1s>B|AP`SJxo0e&q`AUj&+(P5GJD~gJJlA^A(#eM!0<6S-2~#S?rT_%tj5WDE z^Z%?ZyGv3A1QV^X4_R;qc`LemdwVk{lX zqa4ajS>BrJlj70Ug%^4q{n zo>kn-M(HNnws9}X7HR$WyfP_YF)7IeYt?kKbj+w5?%;@n1o$7}X_Rimd5Ztf-!ut} zV3;!b?zY7w;!UNWo*xWKQOw41k0w!4-(}E6iG=r?ytV$;>fO1OO~&o$hcbq>Fxdq7 zr0^t4bI?&gh<`~~1RWJg*U~1du+JqKNBhG(gEH6~!mS=BCG}mJf-o7aOgcZTrI6L> zpJG8NAgfz6gDMo=Wx%7Q{eAZR3cdu+YDpB%hkkK6h@6t><%>1L0Ved z{gOlH#hPTLJ=W{5ZlSqJ=!(LuvzY)33j3#I@F&OnEr?GgcvrZa0DZ(Oih%i*!TLjO zANPLJjH6c*E={T^wwtt^5U@wN-_qA!U&I*rcE}_^asTOoTJ&28bA?;d&*cQ@V;5Bv zw85w~qZ65-Uy#;!QzS_g%2Ja~11&_Vd)d-`WigE@@Xnjw2+JeD`lM@YMqmy_Oxs-L ze2z*Fz-2c9`bbugO=hyex+5JK_wmyD?nNo`nA?kF(o?LuiJDq~i{MS02rz_r!6~yt z*}0PyG!;J0oalN2^l^#~lG`vz!&~5M2$tp`mnp%B|3#B^3P&&f%2HEzYkCcG^(641 zEd=-%!3lFgyWDl68=@>4xSjxgT#)SI`JusjOFA^_5tck|{Rbfso6)^ZdMCXt-uU?z zn>s`5;OGzAK!62=w~QmT>$hMMgpH!zPk=r$d0Ju{CK#;Mxm?yIB*a*{>LF&`m#LY_ zh*V$8;GlVyo4SZ{+7e)Bo{nj92=GC{sgh{ba!Dy#3f>E5N_OaSh5&u|7%j~>`dx!H zI_X?m*@8bvW z0Mivv;ABauK*t!YFUHYvZ$z4;ew%LL(^1r9h=!fA4h%jLZtfl?@c?lSSTW^=a(TpI zlR<#}g>BAs&2|zkXdas(H3_*<0_h%-={g$6K-9Q z0|W@=`B}kC-XW}+8I5XEQ-iU8MN+SwrLo~U&4pvWBro_v0pKS^9a)fiIb5XENFteJ z4s(P=j*`eRG87Kw{ODLxhb7@AhfnRoKtf`WpW})0B?@^=!8o4n{CZ5@hV+g%yW@|7| z5d`s@U=YqI&0E+*aAYSrq5%SgF++)Qv`DxLqt=!6wHW&XmQCYwKI;uQ_ci8>$-8;! znBo`#`a4J5$wL0k5V}%FTVrd{5KZ&7r}zlL8^IIOw)kcV5Q2DH$;|9!xed=6tfP@8 zqhDCq!^vo<+-Q^0+^4CyI_#zq0p>hPO=1O~F^q0h*J6Wk8LtYq>p}E~s4+}an+foG zH?kp8@}1<|uMD=>hQT)XnK(*G+ZX0#>|ey>ne8$)8Aw7orY!|tzj55kEJo3fTOEm; zaSh7_b%|mwAi(Z|qczk~0))QOV%=qbUbm!y3^Z7J3ysFVnuR!_{*{>Aa;}81z*I@w z)Eyj+a|HojZ)^4|Q+bv)4p3o)$yl{HpC4Uu&KYSUpRK=Vq0IzX)Xzc19|~sP6btsQ zj~FbwwN^8riOJKs+{69)C-w=ZN=c@YO18h`Itskz0kD}#^j8$h(jPhsyI8pc8--e# zCh5q+ss;#9Pg>rK?9V*Y#?eNdCfjK?1GI4Hs!Db?qZ5s)45x9 zLn|pcF>&JA$w;ZLST|yZAW@fa2?5@xg|CYk0YVfj6wI>irZS-PHCXCh8qR{zl6vf$ zY>`_Un6xqYs~rt}IY0>T^1$%Bc1+SAZbC2mAcKF1hE83hyKw2)NGT|ahoa!fY@Zk;k^6A+@B1!_ntC%UH?RBhi8qeTI9GB-GM1 z+7KYX3)1qRWxwAvmd~$~!SZ@&IuD{Goupo%6LU672?hYdaHSOnPj{d4Bd|+$0q_14_@~F|D2Sts#=P z_?fnnN)sKDV=n4BFLPYkEBZm%PFAsY*@}fd^XjU zPEUSOUyc8qN(nSk7A4SGv|+7q4iirUG>*a=w&@_PStY&H?kvwEafufI7fa!qO! z7#bkJNd99(Ew3=up5_GSp@I&hg-{e+T~V6vOj+^E)`|+bsINq2)%7&_Jbn03dZ~5z ziMoFO5(sC2S22hsiffo?pSOJ8X@xh?h`#I(I0`JsB8q$4Lglh%*}B~~cRH2HV1|$- zS%zp<`L#9(Bm%rdA2us2f05;=i_!@YvY16(o(nhW$k_s4 z#d!WAyvfgr;wAV4ymIjNxB1KcZpJcJ4GvL-l(JE+L> ztP2<#eA}W)%pZdFR&h}uRTO&rs0&)Sg!a`axB4_PBtFWL?=>iuK;0d9YPLm>oQCB$YnsqF@6wI!Vv*~lC48HSsSE&&FqJ|A; zB0iARQ!fO@xmsZwGl0>2!&bq>L3ZU6iMG(nj|FRO;gZpOT(F(>T||ITfQbrb*jA!} z2!p>K<+>Fg!dwZx^lt(XK}6GzzcQMcY~Ylp6!;GdEqhY1&cC^21g8iFAq#aC0RoIr zu!lKF9SRuy?Hev!=Y@omsLyfD?YH2GQXKd4ByTW{RUFhL51kcXm%75)5!`{@LakgR zNeZI`SX@eNk0_Xz$7yAdSl@Ex%8n6IZ_=I2kz?nzdn#MmdY$rIj*65gniwh&O$_Di zjs6Ni95vZx@}2D*6N)O+mJky%)rhU-xt5}A2}<)d+& z;DinYIEhDd{nZf0E2uk@q#Uu?f+$Ng<*7&oDqJDQ2<3gy#WVr>SRr(0bqnqJLHlXl zLogSEI|&dLayttor%@ITR_&CCm9RF6D*lbS)!=~G2wpiw| zT=3GquL}rJ><;%NKfCs@CV^HgR-9Tjun5q#Fh+o}4oa9p3hT0cN#kfpBN`DWEvm|` z7T)=eEFmiH$zVG@9xb3W?S$T+*e}b{@+R<3!dC{B7LhnzvH4v7%kL)A7?rDG?0itQf`m0D|7(E3D$%-A)Y2l#i z`s#o|f{sZ(y8@akhmThoWaDY3M}V3VV0S8L-jcZjmPpo2Xx|kK40fMjZW494Pf$CZ z&&~i^BcITVbKVv>e-mIBPifzl8J5rGtR3NQ77T0^!h2fwV5PI>9_U*AYMH4O8_Yc7X z@`_BxG=sUgnUX%;O~m4i(2> z1_+ig+H_zEcP+vU9%qcF0Xp#U(d3I0!F;-F+#V}2Jk|=;c!nnhWiHGjL9=5y=p`KU zXSY&v&}FH=#M8>myuB^3<^%}g%;vA!wx@xGcUBA5xsVxxC6s3|w>aE$?U^ok1fRtd z(i0`>iTCNt1tleWmmrQ|lBp=JA847_r?!Q7w7*MeNfCY(jvAamNe6qb6{*54P<8v; z)L{Mg#uaWWm@?G=v(BaLF;1Y(hux(CUdEHGq?UHWVC6bt8tKCIo~9?KgqQgm$5N*E zWT|k>$EB9CtH|6I7PPg`R?$ZI^w-k>U8@0JPGmgHfe`k&qpqbqbh1KybsVJy(HWBx``1JPpu21n9%ZE_!G(1d(jAApcy65)7BH z08aC;t-V%=k0eNaftCto>}*g9C!*^V6U-4UBSn`Em>~4ocQFC_@UekEIc~pHj5QV{ z&!CP}DaJ@y1hZ^A&1%SYDY=!^+65R*LfXlZnHSEN5()5EmlEJ)fi|CUI|2Iev5%K2 z@0jc@*<(rSPozsChXRx6qP)*S8O8+(vSx6KTuOk;g<4(8 z{RHU4$0g>{-R7fcsLEuEr*Hd|BzqboX(=pGnuwq~yQD~&seH>`hBJoA!?_db=Oml} z`|z>XmGoDUvqG(YGB616@^g;)JZ_6NSb(l9usrcD(MpkA|B}>`8BC;-0{NOrJGaVU zpze9L%YQ|+q=p(jIVEvd9~^cTKFs!hE-$gdWEF`0n=F!R`Q zljuHkB^W;WLwmjzj_s2~jArx}m51|dVTx0eeiC+4J{Gf%W2EL0T;zLF-Jk*He12mp zgNT!KO;VEHOyZERRAUuSn+_b8*oW&GEUZ)4;uQ`^l<5dfCG^wFie{ZN2GemQ3CfnN zoqpHIff4fm)N{ucIQP4rcqZ`-w^PwH8J3|vPw|DMb1NU?ZE&2gOuW?o%VagrQOmUC z1!%%+Y?C~it0bjJ2rL4G7{Q)S@d(gf0<_Qhx-iXXcIE#s@*BT#h!l=;loT$JMkc2y zNH_(FAcA6)qC90NLltUD4I1j>bw=3G-UGB{49`lV+F)AKns+(QPy9pzdr8W}B|nTx z)TBABX+~kmE%Wg%FKM3E-6C0p=6z z;6Aq6TH_+>@)nON*>ZQu7>0Tppc@dJZ(5qkJ2bYL{s2-L z$UUw#aLtZ=bfvFHe})bThVi1MAfX-sYD|Ff{GiByKs`3ok{3AdQ0?DSpBHs;`LTra z{FAzZX+ZNA-r@lZtHs*_YfFIRXhBD!8O}l1X)b@J3F{q|A)U9V!3VDVfMha-+Kf~b z0yJ-D%DyLyS=3h8AAx2D zlM@X|HYuHM6d2%UFh(`Ni=51+5zM6<(G0O6PpSy^@;9pSzE)b-ejcI*A33%eH-k%j zPCfcq%(d(R;AdK~)6)UnuL0(^VB>g$o!aRwnJnNQtuJ^=^O|Yhz|Q9n#@gbP73dlu zKuJ@f+6rnmQ$0_RJPGhJYV&sz$kL*lwlIQNSA23p>CIA2dhL2Ij{!v3)Cc*20HGk? z8kVkzM}T$`pwVCm7YuxvqUp|Ew9R%}XeWGZ<{M_a&fugH{rNL>wUA{GGnmdE8*7Ym zfQ}9*OKO?d#_{#3CcLzp8q7{JZk@~1MuWYiGd(2$XA zcJS-EmC^rmRP^8>-ykTPCX!cX+APx-9>K)XhNd*3mXd>AAG?Vsp4Du1Z(jNvw84An zNPDTi&v_%26)a_eE9204@F0-@)gh8wX+lHlQb+h~DU$>2U<2{QXSV+|;IXl2fE`h-8vD#2)r?F&~Xi z49%!dJ?axH;Z8e)y=-M0TS?F*6`=05UK! zH!UzYEigG$Ff}?gGCD9eD=;uRFfhO;h=KqB03~!qSaf7zbY(hiZ)9m^c>ppnF*hwR mI4v+aR4_F