From 7776584bd613b75c3c01a51f40cd9267300c59ca Mon Sep 17 00:00:00 2001 From: Thom Troy Date: Mon, 23 Oct 2017 07:25:36 +0100 Subject: [PATCH] Add irish rail docs (#3633) * Add irish rail docs * make main example be basic * Small spelling & grammar fixes --- .../sensor.irish_rail_transport.markdown | 52 ++++++++++++++++++ source/images/supported_brands/irishrail.png | Bin 0 -> 5062 bytes 2 files changed, 52 insertions(+) create mode 100644 source/_components/sensor.irish_rail_transport.markdown create mode 100644 source/images/supported_brands/irishrail.png diff --git a/source/_components/sensor.irish_rail_transport.markdown b/source/_components/sensor.irish_rail_transport.markdown new file mode 100644 index 00000000000..2735bad819e --- /dev/null +++ b/source/_components/sensor.irish_rail_transport.markdown @@ -0,0 +1,52 @@ +--- +layout: page +title: "Irish Rail Transport" +description: "Instructions on how to integrate timetable data for traveling on Irish Rail within Home Assistant." +date: 2017-10-15 16:50 +sidebar: true +comments: false +sharing: true +footer: true +logo: irishrail.png +ha_category: Transport +ha_iot_class: "Cloud Polling" +ha_release: 0.56 +--- + + +The `irish_rail_transport` sensor will give you the time until the next two departures (within 90 minutes) from an Irish Rail station using the RTPI information. + +A station name is the full station name as specified on the Irish Rail search site, for example, `Tara Street` or `Dublin Connolly`. + +To activate the sensor add the data to your `configuration.yaml` file as shown in the example: + +```yaml +# Example configuration.yaml entry +sensor: + - platform: irish_rail_transport + station: "Tara Street" + name: "To Greystones" +``` + +Configuration variables: + +- **station** (*Required*): The name of the station. +- **direction** (*Optional*): The direction of the train. Typically either `Northbound` or `Southbound`. +- **destination** (*Optional*): The name of the destination station to filter by. +- **stops_at** (*Optional*): An optional filter based on the name of a station that the train stops at. +- **name** (*Optional*): A friendly name for this sensor. + +Using the `stops_at` option will cause an extra request per train found. Therefore, if you are looking at a busy station, it is recommended that you also use at least one other filter. For example: + +```yaml +# Example full configuration.yaml entry +sensor: + - platform: irish_rail_transport + station: "Tara Street" + direction: Southbound + destination: Greystones + stops_at: "Dun Laoghaire" + name: "To Greystones" +``` + +The above example will show the next 2 `Southbound` trains that leave `Tara Street` station, going to `Greystones` via `Dun Laoghaire`: diff --git a/source/images/supported_brands/irishrail.png b/source/images/supported_brands/irishrail.png new file mode 100644 index 0000000000000000000000000000000000000000..204e1c2f899f50189c6e40b212902a6c25cdae30 GIT binary patch literal 5062 zcmai2S6EY9w*^7EQbJSdi1ZFpq!7fLvLI@B=MB0%mVCWqr z22gsF7U?CF1c4tt-q&*<#@a7?&GF4K#$I!OE6&VB_Y&PzIx;e{OZs{si}NSx9Hul> z=WE;A*fALyAWb&R-8iXObnquz0R003v*e`JjlODl{B5`?fOWJ!w3+U#D&ssRW^p zN~1|DC%-4KNT2U<0l(2^ICHHU`ZLkJG*Ff~Bn0fc_fDHprBMS~;L_+@7pX^h$}}Ac z@eQ}IHvH>CH7$YS6>T53NCl##j@4Tu*wszzQNB2Fw)M_(FjazcTwHpzvs2>eL zHQ#SeA#8Fbrh_dGc`)yFvEU4*IFsMi?q3AJHxG$Z7b{z^6ZIQ(mbfwlq#y!C4F~I? zr6)ODz#lcg(~i4+p_bM1Cc!E+2oJVaiv9CAB=}i!`5I1k(YK5x8XTM!QYTbAsmm?| zhH}5fbF`2%`lK!;i9iPb!9NrrMPPQ8g^qvZB69g|m8mhUu^>@l^Fl!dFwNEDM`4Ds zAmLcAW`&AZaXN>@=c+GxTUous5WW`$N#wkTDGW(3l3P=!d>JWlD@{;2Y}n{xWHf9KHp0@ zuHVySMkh_VHF^fgoFnY!^DDS+n*~97Wd82Yy5cEjfa@HP;iUEJV_#tnxRyYMvz@{5 zSy|jMiH3wTw$gs3m?~NPNqc(XM!4GjGwbcri4e9jq{R)|DF*O`#-*M0ue&zX!z~)G zn|MEy|G+$miGJ#L`kqS(_GV>{g!Cp85yY``a}!7 zr^1JG3^UK?$)Y>xgZfyQJUC$X6%Fhc>E>^m)qL^7pkCeapVRgaJdJ9#O>^A$A6I-1 z>x;_8UuksDa@jEP*7A#3PorPfpT9^IF^ni^|M~5qpxfBC`M;i@T6X0b>+m-`z|XtM z=^JrNTE*+wb<}bh70=RG`Wv8bpj@xT^4jnInT|H~#6# zq^;Is35hblQdZtdl?pd@ZsOc7j9K6*+<+Bl?){>?tEgPmKNqY7Ie=<1xlfFG^~KH` z5dUFT_tZ6hMk>E*(qn?ija*lW-@c#}F}$7PG#f%n{%Bv-lB)z!VSLo+^^7>1WL?d@LEDqsIw1TlK5?1{<#sxE0;H zlCBb{ob&1%sUQaP_Cvu;$gTu#QzwU<+Y4Q$m63Wr5%>f8RPmhn{IwZ}@@*1^W%Pmg z9!v=hA76aDd#PMg1YqjUBYWLd!j_4@b~hu_G4~oyx|gRNQ)w6Q=D`?xd0ae(TVR8E zyZ+Td74($}D#zBu=MdWS^wGVK4KzFzL@^Q&7yoiHZB4~cpF=w@xVj)sT+%d7S}4YF z2Ys!=XGIq}s@yk+>|pE}p3@jVIkVQUs#o#D*>7Dq6^mxEb(;UQj82}lm{fCvN(ws* z_n5d@_*HKb+Zt^HUU0O!O-0_#mT{9aHp+cOn}VmrZLA2-c#0X}($$2P5*+{vLw(n; z#fIMA=yQ`FXcjGb3$q$ZYGB4R0Wm5Dr2F1689cBNl4GMm8~~P`-b{tXg)rMEz+giM zHnz2M?LTPzi7r=08r`sByg-nO9D;^=gK?Rn&J^At=P)s`2Za?JNQ~TJ$8gnH{+fwk1$6 zzD+9fs!zce^Y91-vV=6LS}U+j8)J&n)aa)diMM;J?7CFaK9w?I8+g+(bpCe<+JpkC z2 zl>^UsZ@?KJYSJs;Zj7oiKpirGc&!IOqcLWF(y3vd4AC;fOKP3XORKFt93gYrs>`iw ztIGVhfPPPVHG(WXpVn-avxC#Yb47Cs;?SFrrA3QDWZ>V)u*r4?@fReePFy!ji; zBZUfKb*Z}TEP@B*ZMsU%$R9&x0VjEPQqkZ8MXg@V$$o!8AiBBwLsI=&w(8%Hyh7_> zo+;!lQ|NHT?-*thi1xu}7mLR0_eA|?w6br7r3iu008rg6Dw1&HHQZzg07xZ{Z8Ijw z+G0Yg2^@($N^Yr7A|CT}(A3E`9PxM;#&d=vp~sA(9r$QO;g(b=!5;`DYsymg+t z!J@)@heJFCmr`ff_+Bcqoc{tOLwc9N{i(>`gAVgaERIyBk0wWiFgb@oroWvh>s0J# z;SrF=1fE%*U)XOmRLNE%`R^R{fXzDl3kK18W~i15FQoN~!ct>?V78jwmgMN%T8+$O zrJ}E|os5lcfKmA%6y84bdQPLHzTfYoek8c_TV+XEqv25j!ajXQ2N5wGZv}Pxw(46Q zv_bVZvy<(O>pYLAOM3LhhcbYJnI*+-20n$SYAC4J-(n5R%}lr!{+M=RXIG)Oa362w$*6k5t3%hi!Be z$AW(*L2Bn>6OGj30iSZ2eRIlp*qG6z(%>2euK82thtC^*Lv*$M^jpIH7Br5b^B67i`y_I7)C{y3>~t>JC z>3sG3-BMQKJN*c*HbvH;QOwHjgsA6ohswlahlL%@%;h0X^;;RL;Yk*ANeKI%sou`@ z)e+G;zA_3BOgdDAtczgIG{urIXE!r-2j(?>=XliUBRI?UwH99^TcvJr<5$JeoA(N2 zT4tr`Abkt>)wF1o*hKxOdkk`|_spA>XUwMZ@2qftc=iydt#)NJ-!C z#Ltn6zyFdA@UFDu53WvDk`OK3-g_LzrR+Q|N>2C8U_8u^>4(+uU?=x%I2F)fh7381 zy>)k`4b9QEP~&CDVrdIJ$Qb`PV$1gyE0xc!QFjcn7`y|1J|K-xWFp>Lx~0&tkwbh zc}whw28gvpO&{g>lM%W+yM<>^k4e1;VRe0xi*uS)k2*jzR`hIqpE?~{{hKi{Gvj+w z+%t0RVvoO5q)pR}zd8Br_L4cI*uuKnyDl;XPu*fB!!SVR;P&&3{*goU$`^D@Jzl^E zjLh22D^=EgrZ=S~pJW@JQN`CZrnUJCo8LKbuP0G$>}L0YsD~`{EQd{>Y3fJvT<~dK z=FD_sa*|j7KVYQQHs=@9@iK(EYIx2~PMmmu4!GJovAuK+RaQ7lJLn#`N$35CjDrHF zga0HVTX_F5^3C{wvir@F@FL11yVwnq#G+RQv!O8%5Z>)$erF%(4NsYCWS|U#&4x}K zo|3CJIc4lWvQ{99{>}+?z%Z3WQ0$GGc#zL)my(R4JIW|}IGD1cxYhxYHsoWCd_x=Q zMTbgT3>$2*-oC@7NS-*n@SeFvo+#q~yS8-1mZmpCLpe)V*x%*8^s?iVgstC>_%JE0 zz(Cyx4t=HjG~R-E`rU9#KN~=cyg^gFEru~x*)i1@{?uBATW#@9lA#*h<4jDNKVBwxBGn0#W*7JTkC87uq7p!+);}&s zU~HSiucTQ*aZ(7Qrfv!Fvck2SKkV#%rV&FUFVTE1N?T{z}DvH`-C6Y z8)(Y-gWn_s#31S)2B|6b6y09$c46HfBPf4h9H3W&OIQ2w+jWsjlI$sr#{vkw+h16ay?Fikdf# zP`65MQffXWaB|-YjnJ6QgknDDvjnEtOMHmC+!=MCO`y$3TYuLhG`lXTxEnsEd%awYSpR4%m2wYvb$ad=Xu44ep9tP%cj6{({!c#|tRrq^9j|Cj@l257WOb zFG9#kqE;i8_nrgnDQUc9S$=)mr_5C*%8p+isEg;guht`ls?v>F)jAd--ByAmf-2DI z>I|#(4VY6S$N8;gTYKM^to8#O*8}Q#3SZDxlX15)7e2oM=P5wLzXtd{HJDaNeIvDK zg0j9nG!pQEf~Ba#GWEf%4hMOJolmQ2=r7t_(xN44`K#92k`P;O;`$GqosWogbuwD` zSgavI)0OWv(>r02g%~{PiNe0NkL*t7rJ0+YK~pYfr#y(l(g1mZ9GzrGoKAq+Efpc= z%F*blns?dn4_E=;E+`7;yq`w~nV)_?S5s>{*_4gu^ruVS@QTA2o}ddaB~}!jTKmaf z{&Lx`~^mz_JNa`*C(GY7y27xkooUfbvO4KOJHd~Km2 z0IQ2DiP9rXzOXk`68)KzepI(~&pwTac^=t?b}&W55y;m_7A2KdW{OrPOJi0Fi%N<= z#xO^OoqVYyZ2a89cc=E34JsZL0h;@yy4G<~z6JD#K0?V^Q84$fZ8lP3I0#8uGNdU% znzkI@U6|&CtI);mHGfTL5dCHW;QDssH6Dn_V*7*_xb5BVKO1JMiB!=}vJ@{H^sP%x zQ)jHS5g9m_!``3YUQ`lhS~eKQ`VpV5SRnn&<<@vlvTD@!D z#(iw*csZ<=B$o3^m{uI1d+&oYV=}Jd*}0W`>OxCRw65bWRMHJJE7-ic2i0ZjmvMWy ziRe#XqxeW5-WxR}jwMd}UQ6x%Jq*$izq}wHzl`vex*Vw4tgaRR388 zD>9J&q^9O*!mBUIdiS}&f>^}PoV?N*p&-+`8(5g6pj0(4bu~ztQ5}|@^Bm?zoajFa zotX4QLz^j$zON~$!eA?H1zGUH)`eufG-QH!K@%&>a`%I_=^s3oJB@szAI1wmXXcF7 parsZM=RV~858OMiBanVZ0nKs^6~-!Mp5M=r>Fbz)%C#IL{s&i!`Z53j literal 0 HcmV?d00001