From c90ee42f993fb0d7af0a446604363b5998a99dad Mon Sep 17 00:00:00 2001 From: Trevor Date: Fri, 9 Jun 2017 10:51:39 -0500 Subject: [PATCH] Add Radarr sensor (#2567) * Create sensor.radarr.markdown * Update sensor.radarr.markdown * Add radarr.png * Update sensor.radarr.markdown Updated date and ha_version. * Update sensor.radarr.markdown --- source/_components/sensor.radarr.markdown | 123 ++++++++++++++++++++++ source/images/supported_brands/radarr.png | Bin 0 -> 10860 bytes 2 files changed, 123 insertions(+) create mode 100644 source/_components/sensor.radarr.markdown create mode 100644 source/images/supported_brands/radarr.png diff --git a/source/_components/sensor.radarr.markdown b/source/_components/sensor.radarr.markdown new file mode 100644 index 00000000000..c31402ea428 --- /dev/null +++ b/source/_components/sensor.radarr.markdown @@ -0,0 +1,123 @@ +--- +layout: page +title: "Radarr Sensor" +description: "Instructions how to integrate Radarr sensors with Home Assistant" +date: 2017-05-04 00:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: radarr.png +ha_category: Sensor +ha_release: 0.47 +--- + + +This `radarr` sensor platform pulls data from a given Radarr instance. + +To use your [Radarr](https://radarr.tv/) sensor in your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yml entry +sensor: + - platform: radarr + api_key: YOUR_API_KEY + host: IP_ADDRESS + port: PORT +``` + +Configuration variables: + +- **api_key** (*Required*): Your Radarr API key, found in Settings > General in the Radarr Web UI. +- **monitored_conditions** array (*Required*): Conditions to display on the frontend. + - **movies**: The number of movies in Radarr. + - **upcoming**: The number of upcoming movie releases (physical and in cinemas). + - **commands**: The number of commands being run. + - **diskspace**: Available disk space. + - **status**: System status information +- **host** (*Optional*): The host Radarr is running on (Default: localhost). +- **port** (*Optional*): The port Radarr is running on (Default: 7878). +- **urlbase** (*Optional*): The base URL Radarr is running under (Default: /). +- **days** (*Optional*): How many days to look ahead for the upcoming sensor, 1 means today only (Default: 1). +- **include_paths** (*Optional*): Array of filepaths to include when calculating diskspace. Leave blank to include all. +- **unit**: (*Optional*): The unit to display disk space in (Default: GB). +- **ssl**: boolean (*Optional*): Whether or not to use SSL for Radarr. + +## {% linkable_title Examples %} + +In this section you find some real life examples of how to use this sensor. + +### {% linkable_title Get Episodes airing in next 2 days %} + +```yaml +# Example configuration.yml entry +sensor: + - platform: radarr + api_key: YOUR_API_KEY + host: 192.168.1.8 + monitored_conditions: + - upcoming + days: 2 +``` + +### {% linkable_title Enable SSL %} + +SSL may run on a different port than the default (7878). The SSL port can be bound to any port in Radarr, so it should be set in the config here (unless it is changed to 7878). + +```yaml +# Example configuration.yml entry +sensor: + - platform: radarr + api_key: YOUR_API_KEY + host: 192.168.1.8 + port: 9898 + monitored_conditions: + - upcoming + days: 2 + ssl: true +``` + +### {% linkable_title Get disk space for all storage locations %} + +```yaml +# Example configuration.yml entry +sensor: + - platform: radarr + api_key: YOUR_API_KEY + host: 192.168.1.8 + monitored_conditions: + - diskspace +``` + +### {% linkable_title Get disk space for listed storage locations %} + +The storage locations Radarr returns are in the system page and in some cases this can list duplicates if sub paths are mounted separately. By listing paths to include, you can choose what data is reported by the sensor. + +```yaml +# Example configuration.yml entry +sensor: + - platform: radarr + api_key: YOUR_API_KEY + host: 192.168.1.8 + monitored_conditions: + - diskspace + include_paths: + - /tank/plex +``` + +### {% linkable_title Get disk space in different unit %} + +The Radarr API returns available space in bytes, but this sensor will default to reporting it in GB to make the number more manageable. This can be overridden if your storage needs require a different unit. All units from bytes (B) to yottabytes (YB) are supported. + +*This calculation is done using base 2 math, and may differ from systems calculating using base 10 math.* + +```yaml +# Example configuration.yml entry +sensor: + - platform: radarr + api_key: YOUR_API_KEY + host: 192.168.1.8 + monitored_conditions: + - diskspace + unit: TB +``` diff --git a/source/images/supported_brands/radarr.png b/source/images/supported_brands/radarr.png new file mode 100644 index 0000000000000000000000000000000000000000..c053975a41f91dfa2e20b4e21382bf292233d25b GIT binary patch literal 10860 zcmX|n1yGz#6Xv^%ySrO(cL?q-!GgOb5G(`;vOsXx;1&o3CqR(k?(XjHuDh4-zpJa7 zn(66&`l+d@uF;OrR9C=2B}D}Q07FSpRvQ37|3nag4EL}3P;Q{}uYtFdQj-FJnmDu< z3xxly?%E2{K;;vnQpTwMG&)GjU%2(Y!aMMOk^gM&js zL2-6=#>B+b(9i&bK@=1eii(PagoH*$Mvjh-XlQ5>5)#Y{zIZ;)eLJjS)6>&~_Df$}oWBkz+Su60%F2?HlQ%Xtq9B2>(cvCj zxi&X9pT{iE&dxkMJRlGVwD;}nkUAL|+0*pr%hT=X=;*m0%)!CI?d|QcAIW|NQlFfh zgxQiTE-v1!72a)>UL7yp?6h5;?cX+YTpi6_ACBGZb-#=nKP*H)EG0cnIcffCmnKHTAG%YR+>9SYdqcc z{=of8R(N>$;o;%x>gw;`zZ;@x^`x)|2M71}_vQF8CArYY#>SS5nRj+}jOB6OP#{m{ zGT&}Dy$tJ!u%VF?BEEKT65+s?mX_w`<_@Ma78Vws)w8?k64r#$SgGPBCnwL%%{@;z zJkI(J7pE-$cA`w%&q?W^MYANx&--J zmAHyDyNk7AAcBG9zrYgm&{ls3SUpY?!aPCH=My-jT?5W;$DONTIa@iG0BS%BX4!mmtpC%O#j#6@0aJb z=XTiF@y8)yyRq~@=5>6(T*l)QxREbw>yJa{?CZ}g_|Akd3(h~s4=3+}!{W}C>h(Eu zAwaHaYqKYXnD0droXDTAu4(OCH3Tq=RmA8lE{;455d8{G%p2fyy#&%1DOB-gvv zar-!0=IW`hG}Bh4%Wh}7Z4G)Q>PaARIh7srOj2y!+omx(Co@m8))DJnfmi?OFOJ_s0L43wOG@<9@`*4@$<4A|c~eYu8MalMQyA8E z>ILg7sE9VQVa4if^rT!ymB-j;48Ys=bXe+}4ie8ZF{B+5dJrPLdXxufVID0W9CEzrLEOoBB8-Tme-wykH%7hewbR*Md^Va-RtTWQ4e z=q?Meoqf}{tzAQ*A)gC%)(+@-M|_=GOi~p;EqDnhCfr5wbpMFq{Ynu1U9mSd{mclF z)3dWIfOT8WjWjpBHOHO*{y2O!8)neymGW^Z!lW3^*oQRwft}R$dbSZ`4WXl}yuB?l z=d^)i1$pUS-irJsSSq)9BJ-v_5w&A8*o)33ec8i6g0JgQ#712udXxQp5@v~NUUVjN z!sdp?ZOR~)bfv^O=!*eg7PfIaXuQhVZa9Dt*GdA%E3`z z&D!oT9LSr&Jnf%zKNDX7kSx}!)t8FZ{|#;ApAF&A-#zW78jo;ELQL^_k#C;d%Yu5nDSu&$8Xj1g{pI=^gEMqm+uu zkyvO);Sur~jduOtMn-PJK1T=#w^l!H5WhWRp&Oxx%u_pvd#y+<1m@Zm^l7FiGdj<{ zCJZR)pVmy#r|5b`qGDxYGo--36XO@Z;MktM}<b}<}{UALM@Kk>>`7E4bA^=`&zjv1;10Y;qj@N-D0GOebpIJtML8z_* z%AdYCW&)6p_eTMUbtpiIOu1KKZW6r9T!Jqd0Q8>CzzB*k00>=e7M(0-7o5vAyEz`P z0eQX&C_(xI0GKkzjnh$>hyj}*m&|$?own@9S~-T7+$;0VTJ7Zxj#rI?Nk{=>x-mUC zZ%I*{qIvXiqL=2=Bk~RmCWg$3iouTBzn)fxF=tyde2g*2F_XoXWs=t|!4!o)C+-pl zz28XZ6XxL*4XaLa;I0|edQh6O#O*?VSeS$1G@(!|B5S?u%hc0+5JuUiKg65#ciYxwOqk3wc8s;c~4{3Y+5g2ZdI=GatfS&)kI=Kh6y*8JBD0g@`|X_@+b@pnr8*aU=dM7^$!ICsCN_0R6%XD%H} zz`|%^P!s^sKC2; z;kyo8;4_!?%pzv(09FRjzzISFUhF+XHt!U8fS;wtp&gDC)nEup=8vREHUMyz65#4w zA49l6s0KRB7#cEceW~F9d*eFPJJLV`K($5KU!V&Nn78^xnd2J+^Rt8i)AF0Y)3+h$ zK%OfK)j}qGIbe?4M7I`M3qYPkM)GSCu%9qPlQPjjhuu@(5~eI~l+N`|l4&kNT_Xle zut!?KtBy}kRA`(16A?)0Be|A)vEJWDlI#=m-Ovy*kd{;5En$|{=hS}wjS+52V{0+- z`_muGCiK8@bVF%)6Hr|}YzCNC)!|ch-C9OU5I#tN0UC-0kr7W>Zphc=+|Te5ezMla^49RfUxP0- zMXiyuN~c5KkbdC8*k$rczOyPlmq7Lrt^XSof7%)H1~+E%1mgCZt`vcjkVa8c#W@IH zJjT$7jJVJYN146W@#&4E6_4vz3vwzHzjvV>ucFk7JsP)@DOy@YOh<7Ey1ikC4^lx# z?;fw$jmP?~zZraD!o-=(A9Feno+?jIs{Jf7zB4*%Lef;&S&sJ*Jj3ALnNV%on+ppU@^HP=KFGdM155 zKnKx<@UkN1Wj2tM=eP@4XCQTCq$=a2-6H)1ixa?Ch8N`S0S2?V@3Ux;@;tFTa2x#p z?ZwS47}mf+VRKe0P4#0cKAqfFOq^)P~#b7);tIu$$=lW3aFa9b*f9MT?G}prPM_-ma z;7k(X;w>$zZ3kcPmcy)hA!0bY879UP*hZL2Y8Td0CV8X&-UD(c zjw?@=1h{11zZg%vcH8l_dRVnglF0Y+8l5H`OHvoKGu!8`I~2b@Sib45sy^G~;>CCDm$&hsbES|dim z@LnL#EoD|x>#IGYKYSrzzf|`@uC$CKI$oZr z14H`=OLmHJ8`x(J#1Y>^sYMY_=W##195~$l{T@v~g|dyO1R} zD}3$1V2e-@rMCXeGQ4tgCvq2`;QLIM7Z>V1EM+n2lVuR-7Oj-%>Y!8|S=@!_&Qea> z@_kqtQmKZSe-Rd2Xw_DxPfNs1I$?lam1#35gW0{go>F*e%})XK&sl||rSt9!xa`wx z`}0EYI&mx=_4C?cZ+B^CgP3RI;~a4p)HJ?wRQ4d>MHVquEsb17fjxr04_g$0rq;|V z5Q7%?qP7}Z5HEZp8I6`1{^6lYTP_uC-AIr5x4O+9m+LMe0;`-xqBSRs`yL|#k?k8C zeMdbHDkq`z3axlFZ zTRA`i*pZXskPUvA#Rs_<2c+pZVgiL=jWip0Dba&-ZGaEcG^R)X>e0{<5XzUhPL)UP za7_~z*7QLvA4&pi?i{4KOEC1&PynjxMce)VR=u*qeE=QFj|Q&eQWj}Vs1V$Nzh6n0 zl>`FjI~1h?0@Com8lX!4;w6&uj1N!02GX)xVrv?8PyrA0+bh8aI9rl>lpr{o2AZ)! zBkWIOvN*i)I`6xwkcUQmI&1Q$5mDjPov`g|e~M`3jglZ`wZ%$T&)RH*ZqMDv@9Ml| zU!K$I*b={V@Ccfe4-R5W@L<}#o+mT)uq8zCp}0wKd^tWht9abDTc`4~dOcqkr_{my zsER(D;N?p)oD~uLNVH$I%|^{J_V|85t#R(H9%gH2K!|nL4_ne?+|1pR0YQ=YaFQo^ zilHXk#emg({_mrX&f|@3dzz=d2RdVr7JZDSJQfRO`jBJABydX4V8u`-ahLdb+=S@J zw4~ztIri_2p!M(9_Ym1W8qwmPz0^d%pi}o%hNZM^-lzG#PX07as6SOyM`rfa^W7+p zRjnQQQQV2uYC;DB+%CS*TDzdDqSAeE*5@&;!B1T6>9e>|;=`$`{B5fAdL@`bQ*cbo z;E0!fY>&j3QV=7=uY*zW6BCs=~Jz$I{~!4ZEdfV;js>+|@FrD<+jX-bB@!3{e-N zokY3jZsy{^`!lx$IBur$H(8GF!(XpYK5_EKIkq;}lBUKgB+S^Q#**cI@**CL79B6r z@4sqdqP|6+MY)Ke!|)W(H!LSwV~gHRT2B#PPyF@^^cE{R25&cSlH51Uiam6#@DZKs zJ)7nZwTX=K>D!Qkt@3aRT0Xmu!}M6tM4)YED6clwhyuOzT&4yFKAhy`()fx~tY`X? zyem#t68Hj>ru)Lb2ZtHJSJ~wkS+grkSbO&|9_)gVN~yyn??QRG?1%y=;X6!__k+@8 zYFsMR!4TAD_!oliynReXV4y(oB6FCQyhjn07PAJv~Our z)<*lY$3WFdYr+Ezl-L+eJ;D4;MyOBSZExyv%vri#s!1Jf06h;EObF%-@}*<45BNIP zLMnQlu4*A^MMA=HTFG9VmWNLVsbmxqqb`tzzMzN!Kq=oFfIP+ng3&FB315_xGwY+H z7_|Rh{aJYrh!@?`6MZuxLb=Fo(1KvwBECo&CWMhT4{)W=<>`*WY04eH526QFq~a4li9wne8nCOV0+CtUF zvQd+YSjCH4mqW2dO3H$r%dUa&X9QE8hCv*Up;jo%F#eT2M)QC-Ksf1>>c}74 zd_2Q%QNCIn=5K)xX!=)r{x&W!Qx_Q`D2fGC zP#;>h!b2petqxGcIcUMa#1R$mmtVC{hVR{6JAwpKRsXMZ9JotjZ zEnM>Zg5ZR1a<&?|)y;1>($+p=;||A?(LGjN1_s!__(0rfmO5M_FJi$a*w@`XE#f~p z=FOfC*gLMv+2Qye990XkAVECAmveUA;;@Cyy3Eh}=kLXs?l8!vy?4^ z3=2#cfA~E@O(*J>kzr}xGsrJF%8afOxuN|jVd6?O5=_U%cULjPOse9vqNbh=r*ioD zGe)wA+?O8{#OSe5dV~#kAF099F`znl&Am_=BorR>18VH$8)^uaL~ae#7ve@p)mBYb zP6YCrW4g8r;8Ab@N()DE`IDf|GZF>)aC z!v;KR|4e0#8tg|s&UB}4c*oSVhhC=)GqCl+JsjOE1uQvEE8f3M6Lwcu0i~>LnD@B* zviY;7E@FrrIT=jdCKREKupSRKFHB*)8Tz=n=6w1jaHj5TI^N4H3|#!2w4e%6FtAGo zn|pq~6ZZ8M(e$vAt(fJ^tA~Z8Mm~A?KFYCXZtn3j$rE6d#TAHe@sefd!u8;y?)Vjy z^?Wa$ynX!ebFtbBzfv+YUTuGBU?`rsM(7bBJVcEieAsA9X+4L-FT~J5m*W`vfW(Z@ zKT)q_B84+~5xaQnjZg7Zim%rYbcg+A(Nv}=YOgzKP|4WVnS&$iXP6Cs%3;N#YsK4AaNIwHjKOqCu{`G%gNC1K>Al-zS73hg82II9R%F@}nLWV7Xv& z?7Pe-Y>^oMbWXk7FFTIQX>LE-fSs5=ug0Cv6x?Jv92sX7cFZ!&WxZ^QL}H6JpqPg9 z9SpmAV^?Yzc}?2wG4Pq=q}<i-mGzN}$#zYS8iOw;(9~ED!3z@h@Vb_nd z?0q^5yqFk5pHlH}dRLi1Xk+VF&1G((l3o~&%JGBF$@Kl+4OHJ!MQ(6#y8MMYa@ep^ z4g*fY6)}*<0Y$}ugu+-+X|8ozDcHWqt>78}2%0~)54di-)R%`A*Tv&<6fwY=7u3Gw zA_9fqU(~|HdIos_4iy!Ld`rjvBH(~Sq*#IifZ*1nejV+sJB$)x1_H3SMByLZe9Q(& z7jj(G1C)V{cW7i`v5O#Ez?YGe83m2SG!+zom<62y0NcL&>_lcb^VF6+T9#iZ^O9L5 zj3I8p-Op4j?Wy4+aCVV5I#EmF5R;m%%DzonYt^p(h6LBfSsJ@E>yBJ@-FeFB?Cp%C z!Oq4ly#AFjp-X7Wqaj>wS_zt3G&{Zgq>dAxnV~M;C*=~%O_}M*l6+#+O*D<)Y9r*-_VC08p- zf_(=vLkrt3?|`Ml={xXyC&^c?Xnpc@SZRlHX9Knl$-pOsBT}uHorf14vZ(r>hp zN){oT1&lO-P72Z8Q4zgK3~)KWS1f=fINsQSKii05cM{tlCo4a+7FfsEMzebCG2~uAYuv+PS&9?UOp$Rkc4(ZWLHNq{+{ zk9kfPzfJGn_TF7leLn@U0f-5%2D3jCj8O`K15P8S-$BbK^t?cU|i(H*B7Z~zr zrwLkcnM`8hwesF}iDe3Ml(UslrX%IzE~}SUiQHGJ;*V|Gy1a3J$3RTj4p_fukUox;HCgP-iaf)BfZb%$x?PDREo^J zr%s(>m9*X0ApAu(H z`U~Rw1dolqI0>Fj?2aGSaLdme3LD_d{!Yf5+{CxHw7V2UR&U4a+`LI47oGFtY|}FD zRc!0WbNaz-ie%9~Bi}DK<8m4BEx9Y+a%O9!v2*T~(>JoD*w9CYgNffrqF-;Xb7=@; zx8RP~Fuy_eaTU(C2u-ouBEF73&TM$-B_LgnfQ@XBtV^|PPb)O-^-O@2V=JfZ`^eWA z5Sd$8$gA1Z2h}xy@71G}h`(Jsm^da!$#_K8A5MvxPw|*ognW&0bq~!CO|{I`Q*W50 z*aiFR7Cmm;v=IR>^B+)LAhEoVR87Ql!@^b7*F2^Z+jtdw&SfjBUii*A105)0tF!G? zY(ujK^4c>e45xK<(M-AW_3%>@8*0>5G5b}3iL|A1AH@%xM%$T?&0-RL%bgl=t%Ce zQvpauRoutg=a-T(-;%W1d*E4$tPKkmN(3i;YQzaE<|o~4C6tp z6QLd2wJbs{zGPl<{Oq>kH=Ay}?f7m3E|`3?aG|Aa$or;&h&+eXZ#U+zL~SR8-h$8u z9P@_7P+-pNe8GRwe}jOPfT#9GG>?Uh!I6>BpE2@2rK@TTKQYkUjI}^H>@>3|Ur2`B z)Zs>p*(^E|8>wt|OPhA4tk_8ccL>R!pQgIe9ka+kweHtFY9Wtqk(?tRi=^J*a`4*0 zu?C~f6xh5us`P^7b0F~<$63~b7|l`$*aA*(8-}{RhnMcBcBf5PJVXWiIe{f7ky2+H zInYza*Bh0EKm37CV-QjhJ>f;8?Np+Q$c`ZT8l`>~Jl6+QY3IQn;U#&jHTqN`F;mDE7D=Zl!#wCUUrT`0LTCACW@5&4gn0H?~z`#Jr)TG|4#w&?803bI1mkU7P&-LZz zjsXooR+=G)H6TOW7`ADfic>)VW@a%36u|)4m^%Fv14MkqP7Dz`*AVL6I-|3pCYeyz8FQ=s#K@e< zZK&_|br1?tJCn$GbiUL;j}~w{^%ToEi~YyDaBugJ*eV!p6)1QxVbhAu$$J-E%ydu$ ztVmNh0#DQ{^y+0`Kau`0)3`(Y(Apvcw;^Vfg-$GzzZR_^NM)*v`1`OJgL*krc#vPW z`9d~pV#~f*Vlru$U`00h-EpVD3q%iLZVp*Ug2Yzj2fXRYgq+DY6_v&v6$aH`9WlY5 z?}-Hm0)=K0FmExYJJfqOsSu5!g8Tfvl-9{P9c>&Gs6}E9?NC(M+JSLzs;QTyz4-Z5 zZslkMBZr^bM+-t{3KOnD3V`eW0R#$n>f(I*k=C=>1RRiVzMs0?fg4YO)32 zC=F9Wr$<~EJfqy%RIV6?T(Cm_`v|%{>%i`KMo%Bp%{+7|wYbVfc*zZshQo2y3`;yf z!JI>~gE#i5>LM6g1JV5~0K{*|zrKe@bpkfl!)an}J`)4I$aOepl}>n&jM{(M02%`ilF`0~5U z;V=~Y;fDYfW2N+&RhF`Wma+9MK_8u)C+SH+rj)_tOByN0C8FhPKNFK;fX6KiL#+9{ zw`N^P(u-R~-kp$#GO?C>f@Bo;axlL1NK-Eem1*+yTKyDXrx2-ax;#`zG-N@7e0GeL zIs1uln_D<))O8NOjOGqYah_CMM&qrHlu{_-g(!_CJC4oTK75b~1LuO6O8{jNx5 zO@fdWw&$8We=trPpV>%{JhOS)zRna9RVWro2v7bNU2@8_FUs0N*=sA;H6(TIlz<}% zht9P%49la8q$=@?ibPl7Rss~2DDsm+9RcEtRmc}m^%m7ZlL*GeyGFg7v!Lw@wY9$<-3)u7RBn%rfSmiwVu(Y`;7T7|vt42F0ABluVQb??+2{0dgJ^346oxycb-@gdq)-78CJSXU~=mN@J`o4j)Afdxa$%Wqnp1)` z_BM^Ud+zrBn?rddtkAuf+zi2zOOo|@{Y&J5Jj!kcvAw+$-`c@SpZMobEluvRJN`Ed zl)?CM(REZJdUM*AV+EysKlcP;2O{@=_La*0PNmQ8!*r_h>ajMDBl2bA$IfbS@}7k9X=4-c!rOcEU8}UyWSe{!o zQl;9zI+Vv*HGd&}rLtOLr9`?se;#?r@ywrS+JA`kdnJfVdB8ZnJ9((tUefkkS-2ec zB-<7&gWGnoG5N*8mMr*tOY-dw|^h Q%ZdY(50dg^NdN!< literal 0 HcmV?d00001