Files
weewx/README.md
2015-07-26 11:50:23 -04:00

99 lines
3.4 KiB
Markdown

<h1>
<a href='http://www.weewx.com'>WeeWX</a>
</h1>
<p><i>Open source software for your weather station</i></p>
<h2>Description</h2>
<p>The WeeWX weather system is written in Python and runs on Linux, MacOSX,
Solaris, and *BSD. It runs exceptionally well on a Raspberry Pi.
It generates plots, HTML pages, and monthly and
yearly summary reports, which can be uploaded to a web server. Thousands of
users worldwide!
</p>
<p>Support for many online services, including:</p>
<ul>
<li>The Weather Underground</li>
<li>CWOP</li>
<li>PWSweather</li>
<li>WOW</li>
<li>AWEKAS</li>
</ul>
<p>Support for over 50 types of hardware including, but not limited to:</p>
<ul>
<li>Davis Vantage;</li>
<li>Oregon Scientific WMR100, WMR200, WMR9x8, and other variants;</li>
<li>Fine Offset WH10xx, WH20xx, and WH30xx series (including Ambient,
Elecsa, Maplin, Tycon, Watson, and others);</li>
<li>LaCrosse WS-23XX and WS-28XX (including TFA);</li>
<li>Hideki TE923 (including TFA, Cresta, Honeywell, and others);</li>
<li>PeetBros Ultimeter;</li>
<li>RainWise CC3000 and MKIII;</li>
<li>AcuRite 5-in-1 via USB console or bridge;</li>
<li>KlimaLogg Pro;</li>
<li>One-wire (including Inspeed, ADS, AAG, Hobby-Boards).</li>
</ul>
<p>
See the <a href="http://www.weewx.com/hardware.html">hardware list</a> on the
WeeWX website for a complete list of supported stations, and for pictures to
help identify your hardware! The <a href="http://www.weewx.com/hwcmp.html">hardware comparison</a> shows specifications for many different types of hardware, including some not yet supported by WeeWX.
</p>
<h2>Features</h2>
<ul>
<li>Robust and hard-to-crash</li>
<li>Designed with the enthusiast in mind</li>
<li>Simple, easy to understand internal design that is easily extended
(Python skills recommended)</li>
<li>Growing ecosystem of 3rd party extensions</li>
<li>Internationalized language support</li>
<li>Localized date/time support</li>
<li>Support for US and metric units</li>
<li>Support for multiple skins</li>
<li>Support sqlite and MySQL</li>
<li>Optional uploads to Weather Underground, CWOP, AWEKAS, WOW, and others</li>
<li>Uploads to your website via FTP, SFTP, or rsync</li>
<li>Extensive almanac information</li>
</ul>
<h2>Downloads</h2>
<p>
For current and previous releases:
</p>
<p>
<a href='http://weewx.com/downloads'>http://weewx.com/downloads</a>
</p>
<h2>Documentation and Support</h2>
<p>
The WeeWX website includes a <a href="http://weewx.com/showcase.html">showcase</a> of sample web sites, a <a href="http://weewx.com/stations.html">map</a> of stations using WeeWX, and <a href="http://weewx.com/news.html">announcements</a>.
</p>
<p style='padding-left: 50px'>
<a href="http://weewx.com/">http://weewx.com/</a>
</p>
<p>
WeeWX documentation is in docs/readme.htm or at:
</p>
<p style='padding-left: 50px'>
<a href="http://weewx.com/docs.html">http://weewx.com/docs.html</a>
</p>
<p>
The wiki includes user-contributed extensions and suggestions at:
</p>
<p style='padding-left: 50px'>
<a href="https://github.com/weewx/weewx/wiki">https://github.com/weewx/weewx/wiki</a>
</p>
<p>
Community support can be found at:
<p style='padding-left: 50px;'>
<a href="https://groups.google.com/group/weewx-user">https://groups.google.com/group/weewx-user</a>
</p>
<h2>Licensing</h2>
<p>WeeWX is licensed under the GNU Public License v3.</p>