From 7fd7ef2d7f3ad8b78846ffb73f876166b9151311 Mon Sep 17 00:00:00 2001 From: Thibault Maekelbergh Date: Fri, 14 Dec 2018 16:57:08 +0100 Subject: [PATCH] Add docs for NMBS sensor (#7622) * Add docs * Update to use the standars * Update source/_components/sensor.nmbs.markdown Co-Authored-By: thibmaek * Update source/_components/sensor.nmbs.markdown Co-Authored-By: thibmaek * Update source/_components/sensor.nmbs.markdown Co-Authored-By: thibmaek * Update source/_components/sensor.nmbs.markdown Co-Authored-By: thibmaek * Update source/_components/sensor.nmbs.markdown Co-Authored-By: thibmaek * Update source/_components/sensor.nmbs.markdown Co-Authored-By: thibmaek * Update source/_components/sensor.nmbs.markdown Co-Authored-By: thibmaek * Update source/_components/sensor.nmbs.markdown Co-Authored-By: thibmaek * Add nmbs logo * Add note on where to find station identifiers * Update source/_components/sensor.nmbs.markdown Co-Authored-By: thibmaek * Change release version * Correct key --- source/_components/sensor.nmbs.markdown | 51 +++++++++++++++++++ source/images/supported_brands/sncb_nmbs.gif | Bin 0 -> 2046 bytes 2 files changed, 51 insertions(+) create mode 100644 source/_components/sensor.nmbs.markdown create mode 100644 source/images/supported_brands/sncb_nmbs.gif diff --git a/source/_components/sensor.nmbs.markdown b/source/_components/sensor.nmbs.markdown new file mode 100644 index 00000000000..664588f99c8 --- /dev/null +++ b/source/_components/sensor.nmbs.markdown @@ -0,0 +1,51 @@ +--- +layout: page +title: "NMBS Sensor" +description: "Instructions on how to integrate timetable data for traveling on the NMBS Belgian Railway within Home Assistant." +date: 2018-11-24 13:47 +sidebar: true +comments: false +sharing: true +footer: true +logo: sncb_nmbs.gif +ha_category: Transport +ha_iot_class: "Cloud Polling" +ha_release: 0.85 +--- + +The `nmbs` platform will create sensors for monitoring travel time and information between 2 stations. + +## {% linkable_title Configuration %} + +To enable this sensor, add the following lines to your `configuration.yaml`: + +```yaml +# Example configuration.yaml entry +sensor: + - platform: nmbs + station_from: "STATION_1" + station_to: "STATION_2" + station_live: "STATION_1" +``` + +The stations can only be provided by their standard names and not ids. The list of stations can be checked on the NMBS/SCNB website but for most accurate results check them on the [iRail API page](https://api.irail.be/stations/) which this component uses internally. + +{% configuration %} +station_from: + description: The station where the connection departs. + required: true + type: string +station_to: + description: The station where the connection arrives. + required: true + type: string +station_live: + description: Setting this will create another sensor to monitor the liveboard in a station. + required: false + type: string +name: + description: Name to use in the frontend. + required: false + type: string + default: "`NMBS`, `NMBS Live` for the liveboard sensor when set." +{% endconfiguration %} diff --git a/source/images/supported_brands/sncb_nmbs.gif b/source/images/supported_brands/sncb_nmbs.gif new file mode 100644 index 0000000000000000000000000000000000000000..f78f3f35f6dc63bc88279cce28531e432f86d2fc GIT binary patch literal 2046 zcmVM)j$~<` zXsWJk>%QM0&vY%rc&_i7EC>by;SeYqkI1AkA^bT8yr^`FSvY_MrFP5RG6f1Kbxb}D z9)?7B&2A$Z27$OtuTvb2tb5Pj!xeUcQFv;7hKFtk27rQ%Di3;yl9Ox+4Rel}919H$ zlt@f*ayK0_4+43SpNbBet`?o20R(ZFE&~bzLzJwqnGc1MmI@1WSE_~w4aL4?0|t|p zt(pV6!i>#P3Z93G*x3LM2Hbs$;5hO zK|l}+khNg|@SuhUhX}ND_+i07KNBfdNN31^MiU(W<);A|D1LUo8mc1}IM)FS|52m$T2!qd7|c3@Ruomz~b8U=hNVYl9zQ zn9=dMXQ?I!{c0MVq99M&as(PY5G!SX$u$Y++9B&EZxl3dWfdVHXUau32O5&Gx+NwI zc!CkL(-v51ouPaZ=YSkJvsoPr?smaCW;@NiYVjKN!zk3x=KJ z@S4<86!am@!hvkv9d$g&tons;K8{mtLyr7F#um>LHD{6iWDC30!w2~6oH>pGeWIHf zaGd3+3)Os2BJQF);_W9)LuVl$k@^fYMU#X7eZS#X!f9Tt@Bo53jnLF5wBhhzO)U^r z$qMc9v6ct}FvwDGx2e$I7QmsPpKDZY;-MQGzF^@R|Anv|AJ>tPVIL`OBA5;zAsksP$fq=cE3z!zdK^vDO58xV+(4pKHYLXaB1 z-~fs#c)12>ebl%?nOZ>U!j@B}aAOy84*63EVs-&035B3U=Nf}*KqMkR;$Wo~jdI{- z5izb1#srJ*ktl$&C|O@0A7t9a7^1eZDF$nP;;9RJ22d#lle$W(B&S|bsysZP$43W9 zx?TF5xx}&nZ_uTmig7*Y|3qE*c z2AqvH+yEpV_u`!zsKenlLw+s)<*u>K1Lgn#KCR-McXl-lOCLc2=$j+Lz$iA@kjps8 z;T#*}En9xMB;lUffWvrEaWmOh0*%PKA_PcD*eJwG+}3R%e=#DCryji&Ohb(_>4rEC zfZj>4n`_n*IM03YD3ra2=h($rf#j`s&w}XX@L>JQ8}*?(mejXU?-tUlP?jnHJvIdJ za~NBJU~Jcd>OGKKRz{l9|!QDwvfS+Jrw*G_x z^TiK+eo~bM$A$q7zL0~rfYuA(_YNB7EP*W0p$mqyfmVs{hbL^H3|~OO5{83(QP7+B zEFi=nvTy^*3SR^dF~ti1R8a*jQ=tftX#E;H$K^9@+0+=1ai5G}f?_9t!Wgs$_ zI09Z`Qk14_-vCc=!6Tf~0=WEC&gi-{dfshLv_Dvh*OIV$` znRw Bs;Kx|8aqCBKVywo~eO%wzEm+luj*+(tt}*O91cWf-f@`$QEF; z4fFJX@=7O+{e|HFoh5pV!y@VdU{Vw{b`$|dEouVH@FAohpx{R-1%r`F;hp>hkTC}r zQw==yJ_Q@*3s|$#ExgWx4*Mq#D0l!u3QVQdnG6m*dIX{7AewDJsR)2UQ8;MRoyoC- zZ93@!G{{X6bK${O)6@uzE;I$zu%}N6bJY~6G^34Rsu51Nf(7J42z_b7d&n@>*Z87C z<&f%kVn@;_*z>G*P$>i23Kb3*%`fMW%5aSOkp(3~uz`^4Tqzrn=`@HU^^6E-!Qokg zFjf<#mB(o{GEu}}wi&HmLqQsQ0gFhYroM_b`svm#saJ{iJw+C1i7Ka9~u##na-8B-vt0wSHaf8ngI>J zb?$4^TiaMfCINAH04dCH1-GQLarAY8ILu32ul(S^2>wA3@EV?81b8#{?J0Gh`(P>n zM#8cHYlZDlUJPf(0Aby5ChVF94{ISV=oRr4aG{Il>V_5qNU@3qv4CpmVi&Fv!dDDB c;|