From e32f1cdabdc58567d651989f118cb8f8dbf16403 Mon Sep 17 00:00:00 2001 From: Adam Cooper Date: Sun, 5 Nov 2017 13:11:54 +0000 Subject: [PATCH] Adding in docs for Vultr platform and sensors (#3663) * Added Vultr logo * Added v1 Vultr hub * Added init sensor docs for Vultr * Updated Vultr components to next version * Updating Vultr components * Added more details to vultr sensors * Updated Vultr component docs * Corrected Vultr name default values, added vultr sensor {} name option --- .../_components/binary_sensor.vultr.markdown | 42 +++++++++++++ source/_components/sensor.vultr.markdown | 59 ++++++++++++++++++ source/_components/switch.vultr.markdown | 42 +++++++++++++ source/_components/vultr.markdown | 35 +++++++++++ source/images/supported_brands/vultr.png | Bin 0 -> 6317 bytes 5 files changed, 178 insertions(+) create mode 100644 source/_components/binary_sensor.vultr.markdown create mode 100644 source/_components/sensor.vultr.markdown create mode 100644 source/_components/switch.vultr.markdown create mode 100644 source/_components/vultr.markdown create mode 100644 source/images/supported_brands/vultr.png diff --git a/source/_components/binary_sensor.vultr.markdown b/source/_components/binary_sensor.vultr.markdown new file mode 100644 index 00000000000..cb1421e38e1 --- /dev/null +++ b/source/_components/binary_sensor.vultr.markdown @@ -0,0 +1,42 @@ +--- +layout: page +title: "Vultr Binary Sensor" +description: "Instructions on how to set up Vultr binary sensors within Home Assistant." +date: 2017-10-17 21:00 +sidebar: true +comments: false +sharing: true +footer: true +ha_category: System Monitor +logo: vultr.png +ha_release: "0.57" +ha_iot_class: "Cloud Polling" +--- + +The `vultr` binary sensor platform allows you to monitor your [Vultr](https://www.vultr.com/) subscription to see if it is powered on or not. + +To use this binary sensor, you first have to set up your [Vultr hub](/components/vultr/). + +

+The following examples assume a subscription that has an ID of `123456` and a label of `Web Server` +

+ +Minimal `configuration.yaml` (produces `binary_sensor.vultr_web_server`): +```yaml +binary_sensor: + - platform: vultr + subscription: 123456 +``` + +Full `configuration.yaml` (produces `binary_sensor.totally_awesome_server`): +```yaml +binary_sensor: + - platform: vultr + name: totally_awesome_server + subscription: 12345 +``` + +Configuration variables: + +- **subscription** (*Required*): The subscription you want to monitor, this can be found in the URL when viewing a server +- **name** (*Optional*): The name you want to give this binary sensor, defaults to `Vultr {subscription label}` diff --git a/source/_components/sensor.vultr.markdown b/source/_components/sensor.vultr.markdown new file mode 100644 index 00000000000..154a21ba044 --- /dev/null +++ b/source/_components/sensor.vultr.markdown @@ -0,0 +1,59 @@ +--- +layout: page +title: "Vultr Sensor" +description: "Instructions on how to integrate Vultr sensor within Home Assistant." +date: 2017-10-17 21:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: vultr.png +ha_release: "0.57" +ha_category: System Monitor +ha_iot_class: "Cloud Polling" +--- + + +The `vultr` sensor will allow you to view current bandwidth usage and pending charges against your [Vultr](https://www.vultr.com/) subscription. + +To use this sensor, you must set up your [Vultr hub](/components/vultr/). + +

+The following examples assume a subscription that has an ID of `123456` and a label of `Web Server` +

+ +Minimal `configuration.yaml` (produces `sensor.vultr_web_server_current_bandwidth_used` and `sensor.vultr_web_server_pending_charges`): +```yaml +sensor: + - platform: vultr + subscription: 123456 +``` + +Full `configuration.yaml` using `{}` to format condition name (produces `sensor.server_current_bandwidth_used` and `sensor.server_pending_charges`): +```yaml +sensor: + - platform: vultr + name: Server {} + subscription: 123456 + monitored_conditions: + - current_bandwidth_used + - pending_charges +``` + +Custom `configuration.yaml` with only one condition monitored (produces `sensor.web_server_bandwidth`): +```yaml +sensor: + - platform: vultr + name: Web Server Bandwidth + subscription: 123456 + monitored_conditions: + - current_bandwidth_used +``` + +Configuration variables: + +- **subscription** (*Required*): The Vultr subscription to monitor, this can be found in the URL when viewing a subscription +- **name** (*Optional*): The name to give this sensor, defaults to `Vultr {Vultr subscription label} {monitored condition name}`. +- **monitored_conditions** array (*Optional*): List of items you want to monitor for each subscription. Defaults to all of them if omitted. + - **current_bandwidth_used**: The current (invoice period) bandwidth usage in Gigabytes (GB). + - **pending_charges**: The current (invoice period) charges that have built up for this subscription. Value is in US Dollars (US$). diff --git a/source/_components/switch.vultr.markdown b/source/_components/switch.vultr.markdown new file mode 100644 index 00000000000..0ac0bb3ad1e --- /dev/null +++ b/source/_components/switch.vultr.markdown @@ -0,0 +1,42 @@ +--- +layout: page +title: "Vultr Switch" +description: "Instructions on how to set up Vultr switches within Home Assistant." +date: 2017-10-17 21:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: vultr.png +ha_category: Switch +ha_release: "0.57" +ha_iot_class: "Cloud Polling" +--- + +The `vultr` switch platform allows you to control (start/stop) your [Vultr](https://www.vultr.com/) subscription. + +To control your Vultr subscription, you first have to set up your [Vultr hub](/components/vultr/). + +

+The following examples assume a subscription that has an ID of `123456` and a label of `Web Server` +

+ +Minimal `configuration.yaml` (produces `switch.vultr_web_server`): +```yaml +switch: + - platform: vultr + subscription: 123456 +``` + +Full `configuration.yaml` (produces `switch.amazing_server`): +```yaml +switch: + - platform: vultr + name: Amazing Server + subscription: 123456 +``` + +Configuration variables: + +- **subscription** (*Required*): List of droplets you want to control. +- **name** (*Optional*): The name you want to give this switch, defaults to `Vultr {subscription label}` diff --git a/source/_components/vultr.markdown b/source/_components/vultr.markdown new file mode 100644 index 00000000000..411f89f2c52 --- /dev/null +++ b/source/_components/vultr.markdown @@ -0,0 +1,35 @@ +--- +layout: page +title: "Vultr" +description: "Instructions on how to integrate Vultr within Home Assistant." +date: 2017-10-17 21:00 +sidebar: true +comments: false +sharing: true +footer: true +featured: false +ha_category: Hub +ha_release: "0.57" +logo: vultr.png +ha_iot_class: "Cloud Polling" +--- + + +The `vultr` component allows you to access information about and interact with your [Vultr](https://www.vultr.com) subscriptions (Virtual Private Servers) from Home Assistant. + +Obtain your API key from your [Vultr Account](https://my.vultr.com/settings/#settingsapi). + +

+Ensure you allow the public IP of Home Assistant under the Access Control heading. +

+ +To integrate your Vultr subscriptions with Home Assistant, add the following section to your `configuration.yaml` file: + +```yaml +vultr: + api_key: ABCDEFG12345 +``` + +Configuration variables: + +- **api_key** (*Required*): Your Vultr API key. diff --git a/source/images/supported_brands/vultr.png b/source/images/supported_brands/vultr.png new file mode 100644 index 0000000000000000000000000000000000000000..86595f312c1a7312b4643ec68847465c1e4f9903 GIT binary patch literal 6317 zcmX9@1z3~s*WT!m7RKlj3{pZIr4vSnO4o?dEsREnKM;@-LDGSOf-(n4hrmRT1_3uh zBoqN@=`rGa{eQcz<@-LT?sK2#oM*{qCb}$4d`ut^h(%vd`yL1cJ^((W80di4kn5bc zfH#_8xV||9@Q7wWB>~?V1NCfzf&2gddxFiV&%%Hop&>ffA@>8^L&BUNxPijL!eqVt zeS%$`1Knf;9(WXPs`G(ByjS(LZ<~j|*!U6gQBdbO;V-g7;weLB4CB)TB{eBreR5md4TWM9Lu6;L3(((oyMK$8&g`ysrm-7G7_Z2E3(PGMn&fpj)f93> z_y?P?LSL&zBjw=1$l-3Y@Uz3?km9h2=JM9#5Q}GJSMEq+VF4X+N-;<#HSqVZZMWw| z=ZhqMC-PTnZFSnQ#Sq7+4!#>8aBY}B7|E!u%|4`7_3)heZB2U67JVp<3dkKCOXqI8 zT)cwTv{1Aa1h0dQXc6E>>Kjz$Hp>vJylHPJewJ#T@gtu#(+r)x54PjgSeN$~&w9G; zoAY=AD*-`tH@7lNd0ZBIWnYyg8^c>-MVzPh~n)wxh3CRhpSqCt>Hyvu?`QONoY+ zxPDk`y!N$szvn*F{Jr_Pis3iTo8Va=Y_SCioN9R=vm4i#jZPKfrP&l$6D?5Qs~Og^ z{_^RWl5u|Ys(9|Ro%ZXj)ttNcpT!8lLOX{vV2&G5{Dp0Z(>g<;qc8USP-t=Y&OCub zg`Z{?h3$B=9$n#HcYHmtlc7+9ns@Ewvxc6RHko_4s<%?pYMFJONFuij>MPo&U5XNJ zz`=4KM}j6l!L&M71o`nQw9->a&iooo_HdP}QBil*1oJ{xKb}Tfe*=G!(vKYN8W$3p z`0Pr`8TB@vkL7KCOD%w^i?r$^3-tEt2s(k9L^`he%9IkX#r=X!h6vW+p0ubw%1nWw z8oAre9>}7@sP27h{ctJJK%b(Sc))|k7-L4L&VA}?5IEN~OS_QP@wlS_Vifo=FDw^0|IBEyjl4T6zFr4oGN|k6lKv< znfw)p#zZlX{491sm`!W0)*$8&(BWF7^dv@&S3U_R3f)ov>=LRU9=Q@;979%X=H#c+ zlDBmz)Do310qa#n=j^j&d7L>|g`e~1{Cto5UWoN#o>C)K{8RpP#JATH*Q?htu^Q z6AX9ylCAT)FA-zl&T05;@lIi}YE>2N!EWX6J7REQP^FBjpy+V{`pl-rX2{(NYe=mD zSGhejZXq?MOQNp4VT<447y@H%j!Vs`c#}P|2;8XJ7yD){!+Ak}=p&;B`@5Bfz%Tr; zapiiXVfNni=)J1r}?8P z$fQ@72p57%cg_-Y;uJi_r)UgxA}fnMuD;Kd!K?v<#qY|&I8JkuZ){>eoYfKncC4ze zln)mcmwBzoEt_PS<{wu4bA~5)P_nOZ=^&NiG)PPKqnI}L``v*)9<@KvQerTNa|(V} zW9a_3{()W|)x703iv!e4MB_r9Wr(KoUeM2irD16phiJU# zD>eMCLh#LyK~LrM^`MX3Nd9L-z0Did6J>5oR06Jb$8qShvsZE#9Va&~)T4F=b%({( zQdaEy=^Kh}Qr=QBepJ+7Ge(ap-57wKQ%ZI@;0zqH!pDw!^v25w++RW^s?qj)=WH}z2x!xT@ox- zteShu#h96CdO!J2>}9|7#ZO9%9a1kO-FF5f0xpYU`=NMA&IzTkSLpV)=YQc0qTU49 zc`EuW1vN11c#j}k&WCS^=VYdQ9+$Fb?mHC^Xnv&Rw`LR~EVX%>;~Wlz?A?i1`G37j zv@4`DGZ$x5QRA^s+a=lCMME8$a^d+cu(cAeO`f%nGB9D$c=ml~tSNrC80;R}j5~d~ z_?s!WD&O(e(FGHqbekL@dpOKuntxJV%tR=N3!ZfLH)3ASp=-;fZu;%FPR+w!nIePv zv9C=RH8a^2)*NDh%+;W?cMK5&%wD}xeEr1CDPmEU4%22Rvkv-CUzOZ{ zs@bINBcai}^D=rLh zCMyiVBpSbh%+USfH&ffG>2ds}_Wqd9BkHWz?-WOY@W_CNuZco{xDV}Eqh@{{c1-GYSSmC*t354qbpX*cON!c3VHpiq9)q*OhnxI?4ge#a0Ug5B`S{j z+iNEu4Va=}|9y(zQ~MP3T6k)wi@ql(^ZsoY6ZMB4Km!pj33$ub<5>@_Mxu@~L{1z7 zo#~+JY}P!y4QKO{3R^Pb#r{xy8K_k^zMt3vsDG94S(c8JI@3*S=Ik81l9!wzv7Itc zI3Cu9j4K_|Z2$Uyht!cYvjR|x?%Ih1a38&O(U(E(p0$Poa-*Puo|G-%(X!n#!*&3hi0;Gn64>tDYw$Z;tdo=1zJ)cYXduyz_ zvTWI>iJBV{in&W&I+BR;a+*8}a?KSmH-N{bTH1*j|HB`Ks^jyigE1Xl3mS-GJ5*ac z;r`rV7U3K_zmj&w`k&QfT~b-HKi`6fEl`>MpF_q_Jc1vuX<+%agYNy@Z&?UcvF+cK z($*O-g=dQb_gEQH3t)d26OoFCO)_WZ1}1{?wrOBZK90yr^uy|vXu!&EDWl#3Q^%r| zEMpgvpMtPIu;mSNcUY(VBX8lU_t;>>;hh$=-VA|2aK7c1fNd&kexv<9Pzor8v#FLo zAUS%Yv+20?zxBDn0 zfq*RK$2Y(WmH^fMDk7WuZ_1k3RZ-!PlPBKyC(jR>8BIaR3Rnh6!8mvr78?xhV*u)C zTb1o{hOk%Z^u+_oKP6r!m81lAc>FQ_w$0kfq1sf_PR|d%RR@A(oWh8Lue%69>JsW) zkla??+yCr8^gQt@Xa(A1--Y~tvPz>c;_r7S66g$^*-&-UeBpN5Z!dgi7LB*YUTk7j zrEZ#r6@OXRW{PUcD{I!WUf#Ma4h00_x7BL=52IRsWX`y6WH`h%8iT3jqRKY6=IvfhGN_o?q>z*cRzv{kof zJIgGd==Y{P)@x3>hu%bxjtQf!~Tq7UE5CVW1#Le~9Jt{1JKTA9~oIf-2MkdU|}7@1O{|GJu4l*tu~L}9hK z!Y>8dL0b9PqFpWKd<~pCvVEso*jst=j-x}j(=2`1CzK`@^OuBJW*+)B)=Chq2lWkC zC{pn&iX^gBAL3E$M7RHeysfdr)D6D7le9ZDZRZiJAjj^)NrjrF(YSq96-l&G-p?|eXP^Bz zSf*iE%fUbroT>*O|NL{XL#UwJ82ms z+$B(jaAAsCNsTtU42xQCV&*ud^tnnJ-;1Jp*7w7wp_< z@$afwS@o7xI1e`%^Kmcklns6AtC$?M>24&dCQE?fjkr1|o( za2w#0&2j)+>O1U7PR|dHS6f$MxlcCuIcobEfv(I2{eJh#Hlvfi_R;sp=Wp&NXoShK z!%DyFrdgI!HEi{iH7`8m;}|bk0J7cCdO_HLeu?A8G(b&|^|HqHP}0{QiRW*E5`Mt6 zAV)e*lQd3SCMrs{ZK;6Ta?Ajg>#8*1s&`$a!$Q9KFD*<^oPw40GW|a~jam(-Bu$Zk z{(VI*?b>?tb&ryiX4?(|Y_6KbH}*ur0}`1C6eIfaO%K1tRXMLi0FdtP9Dr{u+Dj z)o;N3@vNA=q}`>cddknUt1c6W5V%@Ze(5R4<0q6hFaM^(MW?+ zFlA7OVf1iQ!cIoE>oIEJvr1#N-EuML;YD7R1nw64L|%LY^{hZsM`Bzt{TC&8`-O#| z%!P4apM>O_=I_WJ;Xr~M57W?R$B*uF!uJ%`PT&Nc_^Y0Q&LiA6xf}+sSIv2m+1C#- zbGlzlZrBc8me0Mn7{jeaJ*!1F98sQF-(j0%YzMGV2M2b$~pwROYLeYke*xCOjHAhzfU=m19gm0c&~cYP19F*LC_e}-?;0H zqT0~of3bo*X>7*oC8M|Zcx+VIJL9VToba3ki*$!VkB zA4gZ!YaaI)w@wn>#^j~qFWa2+9N6FZU&C4N4KHAI&?BKpX+Z=iK?Z?~Nwd@-pDNno z{pw(k-Vf}#I&Av02BHpa7)86h_rn14oC`0o?R7{YgVjRHnwR6Y0E`@G^$s07m;WI1 zC$g{-Gr&^y*qQf%2wXA(SCy%e6AqLAFyJr@o}FQ9p%`{m6gzcq@8jx8$Fpa zGn~^(VaaICC6)m7wG+-#A{b@tAt+O!_{c9VfLaQQe~3_#SxY04Zz`w_=z>B;3NwH+ zE}@HuYMSQXgrz-WOF%%&X%nqm_f3&QVT})uXna?F&U-}Xe7|#(FX+WX?*a-WA}IF8 zRCa9?cis2>UZET6yadmEkWJ^YaNMT**<>Evwz*xe@zxV44~(L7K4YB7S3i`asyb`zQzw9?j)1D<$;}^L@w=H zvOV`9k}o=G2EIi<9HE=5^7Ee6$%lt!u`!N%`bn>M&^)^=UDDbD1j%b_LqR(z|t%d~ly zWrz>TzOcx?=GAw*<=loEfF`+M9gQr?9Em)s*wg+T*;Y*ZQ6OB(th{-D`I!dK%~9BS z{$rKiv_-v_#U8z_ZL2h5GrC85hFr13CZ|wqPTpOC?Q+fs?+jM_>a}h$C;m)aObHQ~ z`0ZawV#~2D_Xb&2Pk+d;plR(E3 zK-F&G(IF6wkpn}P(!xtnWHI@wOV@U)s3o5obGL%A+$X>xF?o%3$7S|_t<40AR}o)R zi|`;eXRk}nbCJl1xiA%5zYF$+igMo~+UPD=tnOA#Mf#|>^we|8-S^QOiI-5tQ{@f& zir+o=Mdy_)+Z+0@s1CL;)|gjvOceG~qAV&U-k09jNF|>Z<