294 lines
20 KiB
HTML
294 lines
20 KiB
HTML
<!doctype html>
|
||
<!--[if lt IE 7]> <html class="no-js lt-ie9 lt-ie8 lt-ie7"> <![endif]-->
|
||
<!--[if IE 7]> <html class="no-js lt-ie9 lt-ie8"> <![endif]-->
|
||
<!--[if IE 8]> <html class="no-js lt-ie9"> <![endif]-->
|
||
<!--[if gt IE 8]><!--> <html> <!--<![endif]-->
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||
<title>UK transport - Home Assistant</title>
|
||
<meta name="author" content="Home Assistant">
|
||
<meta name="description" content="Display the current status of UK train and bus departures.">
|
||
<meta name="viewport" content="width=device-width">
|
||
<link rel="canonical" href="https://home-assistant.io/components/sensor.uk_transport/">
|
||
<meta property="fb:app_id" content="338291289691179">
|
||
<meta property="og:title" content="UK transport">
|
||
<meta property="og:site_name" content="Home Assistant">
|
||
<meta property="og:url" content="https://home-assistant.io/components/sensor.uk_transport/">
|
||
<meta property="og:type" content="article">
|
||
<meta property="og:description" content="Display the current status of UK train and bus departures.">
|
||
<meta property="og:image" content="https://home-assistant.io/images/default-social.png">
|
||
<meta name="twitter:card" content="summary_large_image">
|
||
<meta name="twitter:site" content="@home_assistant">
|
||
<meta name="twitter:title" content="UK transport">
|
||
<meta name="twitter:description" content="Display the current status of UK train and bus departures.">
|
||
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
|
||
<link href="/stylesheets/screen.css" media="screen, projection, print" rel="stylesheet">
|
||
<link href="/atom.xml" rel="alternate" title="Home Assistant" type="application/atom+xml">
|
||
<link rel='shortcut icon' href='/images/favicon.ico' />
|
||
<link rel='icon' type='image/png' href='/images/favicon-192x192.png' sizes='192x192' />
|
||
</head>
|
||
<body >
|
||
<header class='site-header'>
|
||
<div class="grid-wrapper">
|
||
<div class="grid">
|
||
<div class="grid__item three-tenths lap-two-sixths palm-one-whole ha-title">
|
||
<a href="/" class="site-title">
|
||
<img width='40' src='/demo/favicon-192x192.png'>
|
||
<span>Home Assistant</span>
|
||
</a>
|
||
</div>
|
||
<div class="grid__item seven-tenths lap-four-sixths palm-one-whole">
|
||
<nav>
|
||
<input type="checkbox" id="toggle">
|
||
<label for="toggle" class="toggle" data-open="Main Menu" data-close="Close Menu"></label>
|
||
<ul class="menu pull-right">
|
||
<li><a href="/getting-started/">Getting started</a></li>
|
||
<li><a href="/components/">Components</a></li>
|
||
<li><a href="/docs/">Docs</a></li>
|
||
<li><a href="/cookbook/">Examples</a></li>
|
||
<li><a href="/developers/">Developers</a></li>
|
||
<li><a href="/blog/">Blog</a></li>
|
||
<li><a href="/help/">Need help?</a></li>
|
||
<li><a href='#' class='show-search'><i class="icon-search"></i></a></li>
|
||
</ul>
|
||
</nav>
|
||
<div class='search-container' style='display: none'>
|
||
<div class='search'>
|
||
<i class="icon-search"></i>
|
||
<input id='search' placeholder='Search the docs…'>
|
||
<a href='#' class='close'><i class="icon-remove-sign"></i></a>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</header>
|
||
<div class="grid-wrapper">
|
||
<div class="grid grid-center">
|
||
<div class="grid__item two-thirds lap-one-whole palm-one-whole">
|
||
<article class="page">
|
||
<header>
|
||
<h1 class="title indent">
|
||
UK transport
|
||
</h1>
|
||
</header>
|
||
<hr class="divider">
|
||
<p>The <code class="highlighter-rouge">uk_transport</code> sensor will display the time in minutes until the next departure in a specified direction from of a configured train station or bus stop. The sensor uses <a href="http://www.transportapi.com/">transportAPI</a> to query live departure data and requires a developer application ID and key which can be obtained <a href="https://developer.transportapi.com/">here</a>. The <a href="http://www.transportapi.com/plans/">free tier</a> allows 1000 requests daily, which is sufficient for a single sensor refreshing every 87 seconds.</p>
|
||
<p class="note warning">
|
||
Additional sensors can be added but at the expense of a reduced refresh rate. 2 sensors can be updated every 2*87 = 174 seconds, and so on.
|
||
</p>
|
||
<p>Queries are entered as a list, with the two transport modes available being <code class="highlighter-rouge">bus</code> and <code class="highlighter-rouge">train</code>.</p>
|
||
<p>Train departure sensors require three character long <code class="highlighter-rouge">origin</code> and <code class="highlighter-rouge">destination</code> station codes which are searchable on the <a href="http://www.nationalrail.co.uk/times_fares/ldb.aspx">National Rail enquiries</a> website (e.g. <code class="highlighter-rouge">WAT</code> is London Waterloo). The validity of a route can be checked by performing a GET request to <code class="highlighter-rouge">/uk/train/station/{station_code}/live.json</code> in the <a href="https://developer.transportapi.com/docs?raml=https://transportapi.com/v3/raml/transportapi.raml##request_uk_train_station_station_code_live_json">API reference webpage</a>.</p>
|
||
<p>To add a single train departure sensor add the following to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
|
||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry for a single sensor</span>
|
||
<span class="s">sensor</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">uk_transport</span>
|
||
<span class="s">app_id</span><span class="pi">:</span> <span class="s">abc123</span>
|
||
<span class="s">app_key</span><span class="pi">:</span> <span class="s">efg456</span>
|
||
<span class="s">queries</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">mode</span><span class="pi">:</span> <span class="s">train</span>
|
||
<span class="s">origin</span><span class="pi">:</span> <span class="s">MAL</span>
|
||
<span class="s">destination</span><span class="pi">:</span> <span class="s">WAT</span>
|
||
</code></pre>
|
||
</div>
|
||
<p>Configuration variables:</p>
|
||
<ul>
|
||
<li><strong>app_id</strong> (<em>Required</em>): Your application id</li>
|
||
<li><strong>app_key</strong> (<em>Required</em>): Your application key</li>
|
||
<li><strong>queries</strong> array (<em>Required</em>): At least one entry required.</li>
|
||
<li><strong>mode</strong> (<em>Required</em>): One of <code class="highlighter-rouge">bus</code> or <code class="highlighter-rouge">train</code>.</li>
|
||
<li><strong>origin</strong> (<em>Required</em>): Specify the three character long origin station code.</li>
|
||
<li><strong>destination</strong> (<em>Required</em>): Specify the three character long destination station code.</li>
|
||
</ul>
|
||
<p>A large amount of information about upcoming departures is available within the attributes of the sensor. The example above creates a sensor with ID <code class="highlighter-rouge">sensor.next_train_to_wat</code> with the attribute <code class="highlighter-rouge">next_trains</code> which is a list of the next 25 departing trains. The status of the next departing train is accessed using the <a href="https://home-assistant.io/components/sensor.template/">template sensor</a> below, as are the train origin, estimated and scheduled departure times, and the departure platform.</p>
|
||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry for a template sensor to access the attributes of the next departing train.</span>
|
||
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">template</span>
|
||
<span class="s">sensors</span><span class="pi">:</span>
|
||
<span class="s">next_train_status</span><span class="pi">:</span>
|
||
<span class="s">friendly_name</span><span class="pi">:</span> <span class="s1">'</span><span class="s">Next</span><span class="nv"> </span><span class="s">train</span><span class="nv"> </span><span class="s">status'</span>
|
||
<span class="s">value_template</span><span class="pi">:</span> <span class="s1">'</span><span class="s">{{states.sensor.next_train_to_wat.attributes.next_trains[0].status}}'</span>
|
||
<span class="s">next_trains_origin</span><span class="pi">:</span>
|
||
<span class="s">friendly_name</span><span class="pi">:</span> <span class="s1">'</span><span class="s">Next</span><span class="nv"> </span><span class="s">train</span><span class="nv"> </span><span class="s">origin'</span>
|
||
<span class="s">value_template</span><span class="pi">:</span> <span class="s1">'</span><span class="s">{{states.sensor.next_train_to_wat.attributes.next_trains[0].origin_name}}'</span>
|
||
<span class="s">next_trains_estimated</span><span class="pi">:</span>
|
||
<span class="s">friendly_name</span><span class="pi">:</span> <span class="s1">'</span><span class="s">Next</span><span class="nv"> </span><span class="s">train</span><span class="nv"> </span><span class="s">estimated'</span>
|
||
<span class="s">value_template</span><span class="pi">:</span> <span class="s1">'</span><span class="s">{{states.sensor.next_train_to_wat.attributes.next_trains[0].estimated}}'</span>
|
||
<span class="s">next_trains_scheduled</span><span class="pi">:</span>
|
||
<span class="s">friendly_name</span><span class="pi">:</span> <span class="s1">'</span><span class="s">Next</span><span class="nv"> </span><span class="s">train</span><span class="nv"> </span><span class="s">scheduled'</span>
|
||
<span class="s">value_template</span><span class="pi">:</span> <span class="s1">'</span><span class="s">{{states.sensor.next_train_to_wat.attributes.next_trains[0].scheduled}}'</span>
|
||
<span class="s">next_trains_platform</span><span class="pi">:</span>
|
||
<span class="s">friendly_name</span><span class="pi">:</span> <span class="s1">'</span><span class="s">Next</span><span class="nv"> </span><span class="s">train</span><span class="nv"> </span><span class="s">platform'</span>
|
||
<span class="s">value_template</span><span class="pi">:</span> <span class="s1">'</span><span class="s">{{states.sensor.next_train_to_wat.attributes.next_trains[0].platform}}'</span>
|
||
|
||
</code></pre>
|
||
</div>
|
||
<p>Bus sensors require as their <code class="highlighter-rouge">origin</code> a bus stop ATCO code which can be found by browsing OpenStreetMap data as
|
||
follows:</p>
|
||
<ol>
|
||
<li>On <a href="http://www.openstreetmap.org/">OpenStreetMap.org</a> zoom right in on a bus
|
||
stop you’re interested in</li>
|
||
<li>Click the layers picker button on the right hand side</li>
|
||
<li>Tick the ‘map data’ layer, and wait for clickable objects to load</li>
|
||
<li>Click the bus stop node to reveal its tags on the left</li>
|
||
</ol>
|
||
<p>The <code class="highlighter-rouge">destination</code> must be a valid location in the “direction” field returned by a GET query to <code class="highlighter-rouge">/uk/bus/stop/{atcocode}/live.json</code> as described in the <a href="https://developer.transportapi.com/docs?raml=https://transportapi.com/v3/raml/transportapi.raml##bus_information">API reference webpage</a>. A bus sensor is added in the following <code class="highlighter-rouge">configuration.yaml</code> file entry:</p>
|
||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry for multiple sensors</span>
|
||
<span class="s">sensor</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">uk_transport</span>
|
||
<span class="s">app_id</span><span class="pi">:</span> <span class="s">abc123</span>
|
||
<span class="s">app_key</span><span class="pi">:</span> <span class="s">efg456</span>
|
||
<span class="s">queries</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">mode</span><span class="pi">:</span> <span class="s">bus</span>
|
||
<span class="s">origin</span><span class="pi">:</span> <span class="s">340000368SHE</span>
|
||
<span class="s">destination</span><span class="pi">:</span> <span class="s">Wantage</span>
|
||
<span class="pi">-</span> <span class="s">mode</span><span class="pi">:</span> <span class="s">train</span>
|
||
<span class="s">origin</span><span class="pi">:</span> <span class="s">MAL</span>
|
||
<span class="s">destination</span><span class="pi">:</span> <span class="s">WAT</span>
|
||
</code></pre>
|
||
</div>
|
||
<p>And the template sensor for viewing the next bus attributes.</p>
|
||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry for a template sensor to access the attributes of the next departing bus.</span>
|
||
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">template</span>
|
||
<span class="s">sensors</span><span class="pi">:</span>
|
||
<span class="s">next_bus_route</span><span class="pi">:</span>
|
||
<span class="s">friendly_name</span><span class="pi">:</span> <span class="s1">'</span><span class="s">Next</span><span class="nv"> </span><span class="s">bus</span><span class="nv"> </span><span class="s">route'</span>
|
||
<span class="s">value_template</span><span class="pi">:</span> <span class="s1">'</span><span class="s">{{states.sensor.next_bus_to_wantage.attributes.next_buses[0].route}}'</span>
|
||
<span class="s">next_bus_direction</span><span class="pi">:</span>
|
||
<span class="s">friendly_name</span><span class="pi">:</span> <span class="s1">'</span><span class="s">Next</span><span class="nv"> </span><span class="s">bus</span><span class="nv"> </span><span class="s">direction'</span>
|
||
<span class="s">value_template</span><span class="pi">:</span> <span class="s1">'</span><span class="s">{{states.sensor.next_bus_to_wantage.attributes.next_buses[0].direction}}'</span>
|
||
<span class="s">next_bus_scheduled</span><span class="pi">:</span>
|
||
<span class="s">friendly_name</span><span class="pi">:</span> <span class="s1">'</span><span class="s">Next</span><span class="nv"> </span><span class="s">bus</span><span class="nv"> </span><span class="s">scheduled'</span>
|
||
<span class="s">value_template</span><span class="pi">:</span> <span class="s1">'</span><span class="s">{{states.sensor.next_bus_to_wantage.attributes.next_buses[0].scheduled}}'</span>
|
||
<span class="s">next_bus_estimated</span><span class="pi">:</span>
|
||
<span class="s">friendly_name</span><span class="pi">:</span> <span class="s1">'</span><span class="s">Next</span><span class="nv"> </span><span class="s">bus</span><span class="nv"> </span><span class="s">estimated'</span>
|
||
<span class="s">value_template</span><span class="pi">:</span> <span class="s1">'</span><span class="s">{{states.sensor.next_bus_to_wantage.attributes.next_buses[0].estimated}}'</span>
|
||
|
||
</code></pre>
|
||
</div>
|
||
<p>Powered by <a href="http://www.transportapi.com/">transportAPI</a></p>
|
||
</article>
|
||
</div>
|
||
<aside id="sidebar" class="grid__item one-third lap-one-whole palm-one-whole">
|
||
<div class="grid">
|
||
<section class="aside-module grid__item one-whole lap-one-half">
|
||
<div class='edit-github'><a href='https://github.com/home-assistant/home-assistant.github.io/tree/current/source/_components/sensor.uk_transport.markdown'>Edit this page on GitHub</a></div>
|
||
<div class='brand-logo-container section'>
|
||
<img src='/images/supported_brands/train.png' />
|
||
</div>
|
||
<div class='section'>
|
||
IoT class<sup><a href='/blog/2016/02/12/classifying-the-internet-of-things/#classifiers'><i class="icon-info-sign"></i></a></sup>: Cloud Polling
|
||
</div>
|
||
<div class='section'>
|
||
Introduced in release: 0.50
|
||
</div>
|
||
<div class='section'>
|
||
Source:
|
||
<a href='https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/sensor/uk_transport.py'>sensor/uk_transport.py</a>
|
||
</div>
|
||
<div class='section'>
|
||
<h1 class="title delta">Category Transport</h1>
|
||
<ul class='divided'>
|
||
<li>
|
||
<a href='/components/sensor.deutsche_bahn/'>Deutsche Bahn</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.dublin_bus_transport/'>Dublin Bus Transport</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.google_travel_time/'>Google Maps Travel Time</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.irish_rail_transport/'>Irish Rail Transport</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.london_underground/'>London Underground</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.lyft/'>Lyft Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.mvglive/'>MVG</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.nederlandse_spoorwegen/'>Nederlandse Spoorwegen</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.gtfs/'>Public Transit (GTFS)</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.swiss_public_transport/'>Swiss Public Transport</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.torque/'>Torque (OBD2)</a>
|
||
</li>
|
||
<li>
|
||
UK transport
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.uber/'>Uber</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.viaggiatreno/'>ViaggiaTreno Italian Railroads</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.vasttrafik/'>Västtrafik Public Transport</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.wsdot/'>Washington State DOT</a>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</aside>
|
||
</div>
|
||
</div>
|
||
<footer>
|
||
<div class="grid-wrapper">
|
||
<div class="grid">
|
||
<div class="grid__item">
|
||
<div class="copyright">
|
||
<a rel="me" href='https://twitter.com/home_assistant'><i class="icon-twitter"></i></a>
|
||
<a rel="me" href='https://facebook.com/homeassistantio'><i class="icon-facebook"></i></a>
|
||
<a rel="me" href='https://plus.google.com/110560654828510104551'><i class="icon-google-plus"></i></a>
|
||
<a rel="me" href='https://github.com/home-assistant/home-assistant'><i class="icon-github"></i></a>
|
||
<div class="credit">
|
||
Contact us at <a href='mailto:hello@home-assistant.io'>hello@home-assistant.io</a> (no support!).<br>
|
||
Website powered by <a href='http://jekyllrb.com/'>Jekyll</a> and the <a href='https://github.com/coogie/oscailte'>Oscalite theme</a>.<br />
|
||
Hosted by <a href='https://pages.github.com/'>GitHub</a> and served by <a href='https://cloudflare.com'>CloudFlare</a>.
|
||
</div>
|
||
<a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png" /></a><br /><span xmlns:dct="http://purl.org/dc/terms/" property="dct:title">home-assistant.io</span> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</footer>
|
||
<script>
|
||
var _gaq=[['_setAccount','UA-57927901-1'],['_trackPageview']];
|
||
(function(d,t){var g=d.createElement(t),s=d.getElementsByTagName(t)[0];
|
||
g.src=('https:'==location.protocol?'//ssl':'//www')+'.google-analytics.com/ga.js';
|
||
s.parentNode.insertBefore(g,s)}(document,'script'));
|
||
</script>
|
||
<link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.css" />
|
||
<script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.js"></script>
|
||
<script type="text/javascript">
|
||
docsearch({
|
||
apiKey: 'ae96d94b201c5444c8a443093edf3efb',
|
||
indexName: 'home-assistant',
|
||
inputSelector: '#search',
|
||
debug: false // Set debug to true if you want to inspect the dropdown
|
||
});
|
||
document.querySelector('.search .close').addEventListener('click', function(ev) {
|
||
ev.preventDefault();
|
||
document.querySelector('.search-container').style.display = 'none';
|
||
});
|
||
document.querySelector('.show-search').addEventListener('click', function(ev) {
|
||
ev.preventDefault();
|
||
document.querySelector('.search-container').style.display = 'block';
|
||
document.getElementById('toggle').checked = false;
|
||
document.querySelector('.search-container input').focus();
|
||
});
|
||
</script>
|
||
</body>
|
||
</html>
|