mirror of
				https://github.com/taigrr/wtf
				synced 2025-01-18 04:03:14 -08:00 
			
		
		
		
	
		
			
				
	
	
		
			204 lines
		
	
	
		
			9.6 KiB
		
	
	
	
		
			HTML
		
	
	
	
	
	
			
		
		
	
	
			204 lines
		
	
	
		
			9.6 KiB
		
	
	
	
		
			HTML
		
	
	
	
	
	
<!DOCTYPE html>
 | 
						|
<html lang="en-us" class="wf-firasans-n4-active wf-active">
 | 
						|
	<head>
 | 
						|
    <link href="http://gmpg.org/xfn/11" rel="profile">
 | 
						|
<meta charset="utf-8">
 | 
						|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
 | 
						|
<!-- Enable responsiveness on mobile devices -->
 | 
						|
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">
 | 
						|
 | 
						|
 | 
						|
<meta name="generator" content="Hugo 0.38.2" />
 | 
						|
 | 
						|
<title>Modules: Weather | WTF - A Terminal Dashboard</title>
 | 
						|
<meta content="Modules: Weather - WTF - A Terminal Dashboard" property="og:title">
 | 
						|
<meta content=" - " property="og:description">
 | 
						|
<!-- CSS -->
 | 
						|
<link rel="stylesheet" href="//cdn.rawgit.com/milligram/milligram/master/dist/milligram.min.css">
 | 
						|
<link href="https://fonts.googleapis.com/css?family=Fira+Sans:300,300i,400,400i|Roboto+Mono:300,300i,400,400i" rel="stylesheet">
 | 
						|
<link rel="stylesheet" href="https://wtfutil.com/css/print.css" media="print">
 | 
						|
<link rel="stylesheet" href="https://wtfutil.com/css/poole.css">
 | 
						|
<link rel="stylesheet" href="https://wtfutil.com/css/hyde.css">
 | 
						|
<link rel="stylesheet" href="https://wtfutil.com/css/syntax.css">
 | 
						|
<link rel="stylesheet" href="https://wtfutil.com/css/wtf.css">
 | 
						|
<!-- Font-Awesome -->
 | 
						|
<script defer src="https://use.fontawesome.com/releases/v5.0.9/js/all.js" integrity="sha384-8iPTk2s/jMVj81dnzb/iFR2sdA7u06vHJyyLlAd4snFpCl/SnyUjRrbdJsw1pGIl" crossorigin="anonymous"></script>
 | 
						|
 | 
						|
<!-- Customised CSS -->
 | 
						|
<link rel="stylesheet" href="https://wtfutil.com/css/custom.css">
 | 
						|
<!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
 | 
						|
<!--[if lt IE 9]>
 | 
						|
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
 | 
						|
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
 | 
						|
<![endif]-->
 | 
						|
<!-- Icons -->
 | 
						|
<link rel="apple-touch-icon-precomposed" sizes="144x144" href="/apple-touch-icon-144-precomposed.png">
 | 
						|
<link rel="shortcut icon" href="/favicon.png">
 | 
						|
 | 
						|
<script async defer src="https://buttons.github.io/buttons.js"></script>
 | 
						|
 | 
						|
	</head>
 | 
						|
    <body>
 | 
						|
        <div class="sidebar">
 | 
						|
	<div class="container">
 | 
						|
		<div class="sidebar-about text-center">
 | 
						|
			
 | 
						|
      <a href="https://wtfutil.com/"> <img src="/img/wtf.png" alt="WFT Logo" class="" width=""> </a>
 | 
						|
			<p class="lead">
 | 
						|
				 
 | 
						|
			</p>
 | 
						|
		</div>
 | 
						|
 | 
						|
    <div>
 | 
						|
      <h3 style="color: white;">Content</h3>
 | 
						|
 | 
						|
      <ul style="list-style-type: none;">
 | 
						|
        <li class="sidebar-list-item-1"><a href="/posts/overview/">Overview</a></li>
 | 
						|
        <li class="sidebar-list-item-1"><a href="/posts/installation/">Installation</a></li>
 | 
						|
        <li class="sidebar-list-item-1"><a href="/posts/configuration/">Configuration</a></li>
 | 
						|
        <li class="sidebar-list-item-2"><a href="/posts/configuration/attributes/">Attributes</a></li>
 | 
						|
        <li class="sidebar-list-item-2"><a href="/posts/configuration/iterm2/">iTerm2</a></li>
 | 
						|
        <li class="sidebar-list-item-1"><a href="https://github.com/senorprogrammer/wtf/releases">Releases</a></li>
 | 
						|
      </ul>
 | 
						|
 | 
						|
      <ul style="list-style-type: none;">
 | 
						|
        <li class="sidebar-list-item-1"><a href="/posts/modules/">Modules</a></li>
 | 
						|
        <li class="sidebar-list-item-2"><a href="/posts/modules/bamboohr/">BambooHR</a></li>
 | 
						|
        <li class="sidebar-list-item-2"><a href="/posts/modules/clocks/">Clocks</a></li>
 | 
						|
        <li class="sidebar-list-item-2"><a href="/posts/modules/cmdrunner/">CmdRunner</a></li>
 | 
						|
        <li class="sidebar-list-item-2"><a href="/posts/modules/git/">Git</a></li>
 | 
						|
        <li class="sidebar-list-item-2"><a href="/posts/modules/github/">Github</a></li>
 | 
						|
        <li class="sidebar-list-item-2"><a href="/posts/modules/gcal/">Google Calendar</a></li>
 | 
						|
        <li class="sidebar-list-item-2"><a href="/posts/modules/jira/">Jira</a></li>
 | 
						|
        <li class="sidebar-list-item-2"><a href="/posts/modules/newrelic/">New Relic</a></li>
 | 
						|
        <li class="sidebar-list-item-2"><a href="/posts/modules/opsgenie/">OpsGenie</a></li>
 | 
						|
        <li class="sidebar-list-item-2"><a href="/posts/modules/power/">Power</a></li>
 | 
						|
        <li class="sidebar-list-item-2"><a href="/posts/modules/security/">Security</a></li>
 | 
						|
        <li class="sidebar-list-item-2"><a href="/posts/modules/textfile/">Text File</a></li>
 | 
						|
        <li class="sidebar-list-item-2"><a href="/posts/modules/todo/">Todo</a></li>
 | 
						|
        <li class="sidebar-list-item-2"><a href="/posts/modules/weather/">Weather</a></li>
 | 
						|
      </ul>
 | 
						|
    </div>
 | 
						|
 | 
						|
    <p class="copyright">
 | 
						|
      © 2018 Chris Cummer.
 | 
						|
      <br />
 | 
						|
      <a href="https://creativecommons.org/licenses/by/4.0">Some Rights Reserved</a>.
 | 
						|
      
 | 
						|
    </p>
 | 
						|
	</div>
 | 
						|
</div>
 | 
						|
 | 
						|
        <div class="content container">
 | 
						|
            <div class="post">
 | 
						|
  <h1>Modules: Weather</h1>
 | 
						|
  
 | 
						|
  <div class="col-sm-12 col-md-12">
 | 
						|
    <span class="text-left post-date meta">
 | 
						|
      
 | 
						|
      
 | 
						|
        May 09, 2018
 | 
						|
      
 | 
						|
      
 | 
						|
      
 | 
						|
      
 | 
						|
      <br/>
 | 
						|
      
 | 
						|
      </span>
 | 
						|
  </div>
 | 
						|
  
 | 
						|
  
 | 
						|
 | 
						|
<p>Displays a configurable list of current weather report, including
 | 
						|
current temperature, sunrise time, and sunset time.</p>
 | 
						|
 | 
						|
<p><img src="/imgs/modules/weather.png" width="320" height="187" alt="weather screenshot" /></p>
 | 
						|
 | 
						|
<h2 id="source-code">Source Code</h2>
 | 
						|
<div class="highlight"><pre class="chroma"><code class="language-bash" data-lang="bash">wtf/weather/</code></pre></div>
 | 
						|
<h2 id="required-env-variables">Required ENV Variables</h2>
 | 
						|
 | 
						|
<p><span class="caption">Key:</span> <code>WTF_OWM_API_KEY</code> <br />
 | 
						|
<span class="caption">Action:</span> Your <a href="https://openweathermap.org/appid">OpenWeatherMap API</a> key.</p>
 | 
						|
 | 
						|
<h2 id="keyboard-commands">Keyboard Commands</h2>
 | 
						|
 | 
						|
<p><span class="caption">Key:</span> <code>/</code> <br />
 | 
						|
<span class="caption">Action:</span> Open/close the widget’s help window.</p>
 | 
						|
 | 
						|
<p><span class="caption">Key:</span> <code>h</code> <br />
 | 
						|
<span class="caption">Action:</span> Show the previous weather location.</p>
 | 
						|
 | 
						|
<p><span class="caption">Key:</span> <code>l</code> <br />
 | 
						|
<span class="caption">Action:</span> Show the next weather location.</p>
 | 
						|
 | 
						|
<p><span class="caption">Key:</span> <code>←</code> <br />
 | 
						|
<span class="caption">Action:</span> Show the previous weather location.</p>
 | 
						|
 | 
						|
<p><span class="caption">Key:</span> <code>→</code> <br />
 | 
						|
<span class="caption">Action:</span> Show the next weather location.</p>
 | 
						|
 | 
						|
<h2 id="configuration">Configuration</h2>
 | 
						|
<div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">weather<span class="p">:</span><span class="w">
 | 
						|
</span><span class="w">  </span><span class="c"># From http://openweathermap.org/help/city_list.txt</span><span class="w">
 | 
						|
</span><span class="w">  </span>cityids<span class="p">:</span><span class="w">
 | 
						|
</span><span class="w">  </span>-<span class="w"> </span><span class="m">6173331</span><span class="w">
 | 
						|
</span><span class="w">  </span>-<span class="w"> </span><span class="m">3128760</span><span class="w">
 | 
						|
</span><span class="w">  </span>-<span class="w"> </span><span class="m">6167865</span><span class="w">
 | 
						|
</span><span class="w">  </span>-<span class="w"> </span><span class="m">6176823</span><span class="w">
 | 
						|
</span><span class="w">  </span>colors<span class="p">:</span><span class="w">
 | 
						|
</span><span class="w">    </span>current<span class="p">:</span><span class="w"> </span><span class="s2">"lightblue"</span><span class="w">
 | 
						|
</span><span class="w">  </span>enabled<span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
 | 
						|
</span><span class="w">  </span>language<span class="p">:</span><span class="w"> </span><span class="s2">"EN"</span><span class="w">
 | 
						|
</span><span class="w">  </span>position<span class="p">:</span><span class="w">
 | 
						|
</span><span class="w">    </span>top<span class="p">:</span><span class="w"> </span><span class="m">0</span><span class="w">
 | 
						|
</span><span class="w">    </span>left<span class="p">:</span><span class="w"> </span><span class="m">2</span><span class="w">
 | 
						|
</span><span class="w">    </span>height<span class="p">:</span><span class="w"> </span><span class="m">1</span><span class="w">
 | 
						|
</span><span class="w">    </span>width<span class="p">:</span><span class="w"> </span><span class="m">1</span><span class="w">
 | 
						|
</span><span class="w">  </span>refreshInterval<span class="p">:</span><span class="w"> </span><span class="m">900</span><span class="w">
 | 
						|
</span><span class="w">  </span>tempUnit<span class="p">:</span><span class="w"> </span><span class="s2">"C"</span></code></pre></div>
 | 
						|
<h3 id="attributes">Attributes</h3>
 | 
						|
 | 
						|
<p><code>cityids</code> <br />
 | 
						|
A list of the <a
 | 
						|
href="http://openweathermap.org/help/city_list.txt">OpenWeatherMap city
 | 
						|
IDs</a> for the cities you want to view. <br />
 | 
						|
Values: A list of positive integers, <code>0..n</code></p>
 | 
						|
 | 
						|
<p><code>colors.current</code> <br />
 | 
						|
The color to highlight the current temperature in. <br />
 | 
						|
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
 | 
						|
color name</a>.</p>
 | 
						|
 | 
						|
<p><code>enabled</code> <br />
 | 
						|
Determines whether or not this module is executed and if its data displayed onscreen. <br />
 | 
						|
Values: <code>true</code>, <code>false</code>.</p>
 | 
						|
 | 
						|
<p><code>language</code> <br />
 | 
						|
The human language in which to present the weather data. <br />
 | 
						|
Values: Any <a href="https://openweathermap.org/current">language identifier</a> specified by OpenWeatherMap.</p>
 | 
						|
 | 
						|
<p><code>position</code> <br />
 | 
						|
Defines where in the grid this module’s widget will be displayed. <br /></p>
 | 
						|
 | 
						|
<p><code>refreshInterval</code> <br />
 | 
						|
How often, in seconds, this module will update its data. <br />
 | 
						|
Values: A positive integer, <code>0..n</code>.</p>
 | 
						|
 | 
						|
<p><code>tempUnit</code> <br />
 | 
						|
The temperature scale in which to display temperature values. <br />
 | 
						|
Values: <code>F</code> for Fahrenheit, <code>C</code> for Celcius.</p>
 | 
						|
 | 
						|
</div>
 | 
						|
 | 
						|
            <div class="footer">
 | 
						|
                
 | 
						|
 | 
						|
 | 
						|
            </div>
 | 
						|
        </div>
 | 
						|
        
 | 
						|
                
 | 
						|
    </body>
 | 
						|
</html>
 |