home-assistant.github.io/components/sensor.wsdot/index.html
2017-10-21 23:33:53 +00:00

246 lines
12 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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>Washington State DOT - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions on how to integrate WSDOT data into your home.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/sensor.wsdot/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Washington State DOT">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/sensor.wsdot/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions on how to integrate WSDOT data into your home.">
<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="Washington State DOT">
<meta name="twitter:description" content="Instructions on how to integrate WSDOT data into your home.">
<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">
Washington State DOT
</h1>
</header>
<hr class="divider">
<p>The <code class="highlighter-rouge">wsdot</code> sensor will give you travel time information from the <a href="http://wsdot.com/">Washington State Department of Transportation (WSDOT)</a>.</p>
<p>First, you need to get a free Traveler Information <code class="highlighter-rouge">api_key</code> from the <a href="http://wsdot.com/traffic/api/">WSDOT API webpage</a>. Just enter your email address to instantly get the key.</p>
<p>Once you have the code, create <code class="highlighter-rouge">wsdot</code> sensors by editing your <code class="highlighter-rouge">configuration.yaml</code> file as follows:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</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">wsdot</span>
<span class="s">api_key</span><span class="pi">:</span> <span class="s">XXXXXXXXXXXXXXXXXXXXXXX</span>
<span class="s">travel_time</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">id</span><span class="pi">:</span> <span class="s">95</span>
<span class="s">name</span><span class="pi">:</span> <span class="s">I-90 Eastbound HOV</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>api_key</strong> (<em>Required</em>): Your <code class="highlighter-rouge">api_key</code> from WSDOT.</li>
<li><strong>scan_interval</strong> (<em>Optional</em>): How frequently to query for new data. Default: 3 minutes.</li>
<li><strong>travel_time</strong> array (<em>Required</em>): List of routes.
<ul>
<li><strong>id</strong> (<em>Required</em>): Name of the route.</li>
<li><strong>name</strong> (<em>Optional</em>): Name of the route. Default just uses <code class="highlighter-rouge">id</code>.</li>
</ul>
</li>
</ul>
<p>Figuring out which Travel Time ID (<code class="highlighter-rouge">id</code>) is associated with your routes is a bit of a challenge. If you visit <code class="highlighter-rouge">http://wsdot.com/Traffic/api/TravelTimes/TravelTimesREST.svc/GetTravelTimesAsJson?AccessCode=[your_api_key_here]</code> substituting your <code class="highlighter-rouge">api_key</code>, you will get a list of all available routes. Search through it and then find the key <code class="highlighter-rouge">TravelTimeID</code>. That tells you the number you need.</p>
<p>Some common examples include:</p>
<div class="highlighter-rouge"><pre class="highlight"><code> 73 Issaquah-Seattle (WB PM)
74 Seattle-Issaquah (EB AM)
75 HOV Issaquah-Seattle (WB REV)
76 Issaquah-Seattle (WB REV)
77 HOV Redmond-Seattle (WB PM)
78 HOV Seattle-Redmond (EB AM)
79 Redmond-Seattle (WB PM)
80 Seattle-Redmond (EB AM)
81 HOV Redmond-Seattle via I-90 (WB PM)
82 HOV Seattle-Redmond via I-90 (EB AM)
83 Redmond-Seattle via I-90 (WB PM)
84 Seattle-Redmond via I-90 (EB AM)
85 HOV Redmond-Seattle via I-90 (WB REV)
86 Redmond-Seattle via I-90 (WB REV)
89 Bellevue-Seattle via 520 (WB PM)
90 HOV Bellevue-Seattle via 520 (WB PM)
91 HOV Seattle-Bellevue via 520 (EB AM)
92 Seattle-Bellevue via 520 (EB AM)
93 Bellevue-Seattle via I-90 (WB PM)
94 HOV Bellevue-Seattle via I-90 (WB PM)
95 HOV Seattle-Bellevue via I-90 (EB AM)
96 Seattle-Bellevue via I-90 (EB AM)
97 Bellevue-Seattle via I-90 (WB REV)
98 HOV Bellevue-Seattle via I-90 (WB REV)
</code></pre>
</div>
<p class="note info">
WSDOT does provide information about ferry schedules, mountain passes, tolls, etc. but so far only Travel Time data is available in this platform.
</p>
<p>Heres an example of the sensor in use:</p>
<p class="img">
<img src="/images/screenshots/wsdot_sensor.png" />
</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.wsdot.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
<img src='/images/supported_brands/wsdot.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.37
</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.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.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>
<a href='/components/sensor.uk_transport/'>UK transport</a>
</li>
<li>
<a href='/components/sensor.uber/'>Uber</a>
</li>
<li>
<a href='/components/sensor.vasttrafik/'>Västtrafik Public Transport</a>
</li>
<li>
Washington State DOT
</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>