Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/daveiano/weewx-wdc

Weather Data Center skin for WeeWX
https://github.com/daveiano/weewx-wdc

weather weather-app weewx weewx-skin weewx-weather

Last synced: 7 days ago
JSON representation

Weather Data Center skin for WeeWX

Awesome Lists containing this project

README 

        
[![Tests](https://github.com/Daveiano/weewx-wdc/actions/workflows/test.yml/badge.svg)](https://github.com/Daveiano/weewx-wdc/actions/workflows/test.yml)

![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/Daveiano/weewx-wdc?label=latest%20release&sort=semver)

![GitHub milestone](https://img.shields.io/github/milestones/issues-open/Daveiano/weewx-wdc/19)

![GitHub commits since latest release (by SemVer)](https://img.shields.io/github/commits-since/Daveiano/weewx-wdc/latest)

![GitHub all releases](https://img.shields.io/github/downloads/Daveiano/weewx-wdc/total)

![GitHub closed pull requests](https://img.shields.io/github/issues-pr-closed-raw/Daveiano/weewx-wdc)



# WeeWX Weather Data Center skin



A Skin for [WeeWX](https://weewx.com/), Open source software for your weather station.



- [WeeWX Weather Data Center skin](#weewx-weather-data-center-skin)

  - [Key Features](#key-features)

  - [Demo](#demo)

  - [Screenshots](#screenshots)

  - [Installation](#installation)

  - [Updating the skin](#updating-the-skin)

  - [Configuration/Usage](#configurationusage)

  - [Free Software](#free-software)

  - [Credits](#credits)



Inspired by and build with the [Carbon Design System](https://carbondesignsystem.com/). This skin uses the same technologies as [Weather Data Center](https://github.com/Daveiano/weather-data-center), a cross-platform Desktop App to import and analyze weather data, I wrote.



If you need help installing the skin, please have a look at https://github.com/Daveiano/weewx-interceptor-docker, a configured Dockerfile

which I use as a base for my local PI installation.



If you like the look and feel of the skin please consider having a look at the original [Weather Data Center](https://daveiano.github.io/weather-data-center/). **If you like the skin, please consider giving it a star!**



## Key Features



- Clear and beautiful UI thanks to [IBM Carbon](https://carbondesignsystem.com/), [nivo](https://nivo.rocks/) and [D3.js](https://d3js.org/)

- Configurable Statistic Tiles and Diagram tiles

- Combinable diagrams via skin.conf

- Responsive

- Day, week, month, year and all-time pages

- Archive and NOAA Reports

- Almanac

- Translated for DE, EN, IT, NL and FI

- Tabular representation with Carbon Data Tables

- Climatological days

- Calendar charts for rain days and average day temperature

- Support for [weewx-forecast](https://github.com/chaunceygardiner/weewx-forecast)

- Support for [weewx-dwd](https://github.com/roe-dl/weewx-DWD)

- User-generated "About page"

- Classic and alternative layout

- Windrose chart

- Dark mode

- Live updates using [weewx-mqtt](https://github.com/matthewwall/weewx-mqtt)

- Support for up to 4 webcams

- Station statics page (Telemetry)

- Configurable historical data via [weewx-xaggs](https://github.com/tkeffer/weewx-xaggs)

- Support for [weewx-cmon](https://github.com/matthewwall/weewx-cmon)

- Gauge Charts



## [Demo](https://www.weewx-hbt.de)



## Screenshots



    

        

            Classic layout

            Alternative layout

        

    

    

        

            



![Screenshot](https://public-images-social.s3.eu-west-1.amazonaws.com/weewx-wdc-classic-01.png)



![Screenshot](https://public-images-social.s3.eu-west-1.amazonaws.com/weewx-wdc-01.png)



## Installation



**Requires WeeWX >= 4.9 and Python >= 3.7**



1. Download the [latest version](https://github.com/Daveiano/weewx-wdc/releases)



```

wget -O "/tmp/weewx-wdc.zip" https://github.com/Daveiano/weewx-wdc/releases/download/v3.5.1/weewx-wdc-v3.5.1.zip

```



2. Create a new folder and unzip to that folder



```

mkdir /tmp/weewx-wdc/

unzip /tmp/weewx-wdc.zip -d /tmp/weewx-wdc/

```



3. Install the extension:



   `weectl extension install -y /tmp/weewx-wdc/`



4. Restart weewx



For help, please have a look at the [official weewx documentation](https://weewx.com/docs/utilities.htm#wee_extension_utility).



**Please note:** For installation, please use the generated zip archive from a release, eg. https://github.com/Daveiano/weewx-wdc/releases/download/v3.5.1/weewx-wdc-v3.5.1.zip.

Don't download the repository directly and don't use the GitHub generated zip and tar.gz archives that come alongside the release. Always use the zip archive named **weewx-wdc-vX.X.X.zip**



Background: The files in the src/ directory are the source files (TypeScript, SCSS). When creating a release, these source files get transformed and optimized, and the output location of these transformed files is the location which matches the location in the install.py script. The weewx-wdc-vX.X.X.zip should contain all these transformed files (like service-worker.js or main.css), but if you download the current state of the repo, these files are not included and this will throw multiple `FileNotFoundError` errors while installing. For manual building of these files, see [Development](https://github.com/Daveiano/weewx-wdc/wiki/Development#build-files-short-version).



## Updating the skin



**Note:** Please have a look at the [wiki](https://github.com/Daveiano/weewx-wdc/wiki/Configuration#persisting-changes-to-the-skinconf-between-updates) for help on persisting changes made to the skin.conf between updates.



When updating the skin to the latest version:



1. Uninstall the skin



   `weectl extension uninstall -y weewx-wdc`



2. Remove all generated content from your weewx html directory



   `rm -rf /var/www/html/weewx` (or whatever your output directory may be)



3. Do all 4 steps from the [Installation guide](#installation)

4. Run the reports to re-generate the html files



   `weectl report run WdcReport`



## [Configuration/Usage](https://github.com/Daveiano/weewx-wdc/wiki)



For detailed information on how to [configure the skin.conf](https://github.com/Daveiano/weewx-wdc/wiki/Configuration) or how to [add a page]() with its own generated content, please have a look at the [Projects Wiki](https://github.com/Daveiano/weewx-wdc/wiki). It also covers some other important things like a [FAQ](https://github.com/Daveiano/weewx-wdc/wiki#faq) or a guide to add [weewx-mqtt](https://github.com/Daveiano/weewx-wdc/wiki/Support-for-weewx-mqtt).



## Free Software



This skin uses only free software. You can read more about [Carbon IBM](https://github.com/carbon-design-system/carbon) (licensed under the Apache-2.0 license) here: https://carbondesignsystem.com/contributing/overview/#introduction. [nivo](https://github.com/plouc/nivo) is licensed under the MIT license.



## Credits



Thanks to [ngulden](https://github.com/ngulden) for the [niculskin](https://github.com/ngulden/niculskin) and

[neoground](https://github.com/neoground) for the [neowx-material skin](https://github.com/neoground/neowx-material). Both are amazing skins and gave me a basic understanding of creating a weewx skin.



The config, NOAA Reports and some templating ideas and concepts are based on the original Standard and Seasons

weewx skins by Tom Keffer and the weewx contributors.



Thanks to vince for the great [lastrain-extension](https://github.com/vinceskahan/vds-weewx-lastrain-extension)! The code of the Search list extension is completely based on his extension.



Thanks to Pat O'Brien for the [basic concept](https://github.com/poblabs/weewx-belchertown/blob/master/bin/user/belchertown.py#L923) of the code to get the most consecutive days with/without rain!