From 958588ea705b840e98857048d8c7c00a335cc596 Mon Sep 17 00:00:00 2001 From: Rayvenhaus Date: Fri, 15 Apr 2022 09:19:49 +1000 Subject: [PATCH] Creating the Stable Release Branch --- .gitignore | 2 - AIR_QUALITY_MODULES.md | 11 -- CODE_OF_CONDUCT.md | 76 ------------ COLLABORATION and DEVELOPMENT.md | 29 ----- EUROPEAN_WEATHER_ALERTS.md | 59 ---------- HIGHCHARTS_GUIDE.md | 85 -------------- README.md | 192 ------------------------------- REMOTE_SERVER.md | 18 --- TROUBLESHOOTING.md | 31 ----- gitignore | 26 ----- 10 files changed, 529 deletions(-) delete mode 100644 .gitignore delete mode 100644 AIR_QUALITY_MODULES.md delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 COLLABORATION and DEVELOPMENT.md delete mode 100644 EUROPEAN_WEATHER_ALERTS.md delete mode 100644 HIGHCHARTS_GUIDE.md delete mode 100644 README.md delete mode 100644 REMOTE_SERVER.md delete mode 100644 TROUBLESHOOTING.md delete mode 100644 gitignore diff --git a/.gitignore b/.gitignore deleted file mode 100644 index da8d1e24..00000000 --- a/.gitignore +++ /dev/null @@ -1,2 +0,0 @@ - -.vscode/settings.json diff --git a/AIR_QUALITY_MODULES.md b/AIR_QUALITY_MODULES.md deleted file mode 100644 index 5ddfe950..00000000 --- a/AIR_QUALITY_MODULES.md +++ /dev/null @@ -1,11 +0,0 @@ -The new air qualiy modules require a database source of particle concentration data. The new WeeWX 4.x.x extended database schema includes fields for PM1.0, PM2.5 and PM10.0. Due to the variety of air quality measuring devices that are now available, it is beyond the remit of these instructions to describe in detail the process for each type of sensor. It is assumed for the purposes of these instructions that you are using the extended database and the particle concentration fields are being populated. The new modules are as follows: - - -Module 1. Top Line Module WORLD (US EPA) AQI PM2.5 and requires the database field pm2_5 to be populated. This modules gives a read out for the Global AQI and NOW which is based on the United States Environmental Protection Agency method of calculation. - -Module 2. Top Line Module UK DAQI PM2.5 and PM10 which requires both the pm2_5 and pm10_0 database fields to be populated. The United Kingdom Daily Air Quality Index for both 2.5 and 10.0 particle extensions are displayed. - -Both these modules have information pop-up windows when the centre of a module is clicked. Selection of these modules is facilitated from the Weather34 settings page. - -Module 3. This is a regular sized model and again selected from the Weather34 settings page. It displays the World (US EPA) AQI PM2.5 figure. Links to charts for PM2.5 and PM10.0 particle concentrations can be found at the base of this module. - - diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md deleted file mode 100644 index d506a839..00000000 --- a/CODE_OF_CONDUCT.md +++ /dev/null @@ -1,76 +0,0 @@ -# Contributor Covenant Code of Conduct - -## Our Pledge - -In the interest of fostering an open and welcoming environment, we as -contributors and maintainers pledge to making participation in our project and -our community a harassment-free experience for everyone, regardless of age, body -size, disability, ethnicity, sex characteristics, gender identity and expression, -level of experience, education, socio-economic status, nationality, personal -appearance, race, religion, or sexual identity and orientation. - -## Our Standards - -Examples of behavior that contributes to creating a positive environment -include: - -* Using welcoming and inclusive language -* Being respectful of differing viewpoints and experiences -* Gracefully accepting constructive criticism -* Focusing on what is best for the community -* Showing empathy towards other community members - -Examples of unacceptable behavior by participants include: - -* The use of sexualized language or imagery and unwelcome sexual attention or - advances -* Trolling, insulting/derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information, such as a physical or electronic - address, without explicit permission -* Other conduct which could reasonably be considered inappropriate in a - professional setting - -## Our Responsibilities - -Project maintainers are responsible for clarifying the standards of acceptable -behavior and are expected to take appropriate and fair corrective action in -response to any instances of unacceptable behavior. - -Project maintainers have the right and responsibility to remove, edit, or -reject comments, commits, code, wiki edits, issues, and other contributions -that are not aligned to this Code of Conduct, or to ban temporarily or -permanently any contributor for other behaviors that they deem inappropriate, -threatening, offensive, or harmful. - -## Scope - -This Code of Conduct applies both within project spaces and in public spaces -when an individual is representing the project or its community. Examples of -representing a project or community include using an official project e-mail -address, posting via an official social media account, or acting as an appointed -representative at an online or offline event. Representation of a project may be -further defined and clarified by project maintainers. - -## Enforcement - -Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported by contacting the project team at info@weather34.com. All -complaints will be reviewed and investigated and will result in a response that -is deemed necessary and appropriate to the circumstances. The project team is -obligated to maintain confidentiality with regard to the reporter of an incident. -Further details of specific enforcement policies may be posted separately. - -Project maintainers who do not follow or enforce the Code of Conduct in good -faith may face temporary or permanent repercussions as determined by other -members of the project's leadership. - -## Attribution - -This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, -available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html - -[homepage]: https://www.contributor-covenant.org - -For answers to common questions about this code of conduct, see -https://www.contributor-covenant.org/faq diff --git a/COLLABORATION and DEVELOPMENT.md b/COLLABORATION and DEVELOPMENT.md deleted file mode 100644 index 63a0ae07..00000000 --- a/COLLABORATION and DEVELOPMENT.md +++ /dev/null @@ -1,29 +0,0 @@ -# Collaboration - -weewx-Weather34 is a strong supporter of the wider WeeWX community with its reputation for collaboration and collective support. Collaboration is important to weewx_Weather34 as one key workstream for its continued development. - - -# Versioning - -The version nomenclature consists of 3 digits seperated by a '.' - -**First digit** indicates a major version update with significant changes to core features, coding and major new features. -**Second digit** indicates a mid-version update to add additional features. -**Third digit** indicates fixes and corrections made during the duration of the version. - -For example 4.3.5 would represent version 4 with 3 additional features and 5 fixes applied. - - -# weewx_Weather34 Repository - -This repository consists of 3 branches - -**The 'main' branch** is the current stable version. -**The 'development' branch** which is in constant devlopment and is the basis for the next major version update. -**The 'gh-pages' branch** which hosts the pre-installation input page. - - -# If you wish to collaborate - -Make you own fork from the 'development' branch and use that for your own working platform. Any pull requests you make should be made back to the 'development' branch where it will be evaluated. - diff --git a/EUROPEAN_WEATHER_ALERTS.md b/EUROPEAN_WEATHER_ALERTS.md deleted file mode 100644 index 5aafe028..00000000 --- a/EUROPEAN_WEATHER_ALERTS.md +++ /dev/null @@ -1,59 +0,0 @@ -This new function is only available for Geographical European users and is based on warning data published by Meteoalarm. - -Settings can be found in the web services section of the Weather34 settings page. To ascertain your own alerts location go to https://www.meteoalarm.eu and select your country and region from the map and make a note of the the URL that you arrive at. From this URL you will see your country and region codes. - - For example, the URL for the Germany Dresden Region is https://www.meteoalarm.eu/en_UK/0/0/DE363-Stadt%20Dresden.html - From this URL the key piece of information is DE363. Splitting this into DE and 363, produces the country code and region code. The other two pieces of information required by the Weather34 settings page are Update Frequency and local network IP address of the device that is running the software. Include the port address if it is not the default 80. You will also need to select a webservice code string which includes which includes 'al' - -After clicking on save, restart WeeWX to prime the new service. - -When an alert is force, a brief description and either a yellow, orange or red warning triangle will appear in the top row advisory module. Clicking on the alert will activate a pop-up window with more details of the alert(s) either in force or about to be in force. - -I would welcome Weather34 users' input to code interfaces for othe weather alert systems in othe parts of the Globe to make this a complete service. - -Below is a copy of an e-mail to Ken True of saratoga-weather.com outlining the conditions that are required by EUMETNET - MeteoAlarm for public use of the data. - -Date: Thu, 11 Sep 2008 11:39:52 +0200 -From: karin buchauer -Organization: zamg - -Dear Mr True, - -you are quite right: -you can use the material featured on the website, without modifying it, providing the source (link) as well as time and date of issue of the data, as stipulated in the Terms & Conditions. - -With best regards, -Karin Buchauer - - - -Ken True schrieb: -> Dear Sirs, -> -> I am an amateur weather enthusiast who also writes scripting for other weather enthusiasts to incorporate weather data into their personal, non-commercial weather websites. Many of my scripts (which I write as a hobby, and are distributed gratis) are in use on personal weather websites worldwide. -> -> I've had requests to package the excellent data from www.meteoalarm.eu for weather advisories in EU countries, and before I generate a script for that purpose, I'd like to have your permission to proceed. -> -> Your Terms and Conditions page (http://www.meteoalarm.eu/terms.asp?lang=EN ) says: -> -> "The material featured on this site is the common property of the Meteoalarm partners, and is subject to copyright protection. -> The ownership and intellectual rights on all operational and updated awareness and warning information delivered to the Meteoalarm system remain with the Meteoalarm partners who originally delivered this information. The information on this web site may be used freely by the public. -> Before using information obtained from this server special attention should be given to the date & time of the data and products being displayed. -> In case this information is re-used: This information shall not be modified in content and the source of the information has always to be displayed as EUMETNET - MeteoAlarm, or if a single country, the providing national Institute (for internet application in all cases in the form of a link to: www.meteoalarm.eu). The time of issue at www.meteoalarm.eu must be count. -> -> Third parties producing copyrighted works consisting predominantly of the material of this website must provide notice with such work(s) identifying the source of material incorporated and stating that such material is not subject to copyright protection. Further information can be obtained from this following address: meteoalarm@zamg.ac.at" -> -> My reading of this implies that you do permit re-use/publishing of the information with attribution and an active link to the source page for the data on your site, and a note that the data is copyrighted by the data providing organization (and not subject to copyright by the 3rd-party website including/displaying the data). Is that correct? -> -> Is it ok with you for me to generate a script for displaying national/regional weather alerts using your data from www.meteoalarm.eu with the appropriate attribution. -> -> Please feel free to examine other scripts I've written which use NOAA, Environment Canada, US Geological Services, and temis.nl as data sources (http://saratoga-weather.org/scripts.php ). -> -> Thank you in advance for your response, -> -> Best regards, -> Ken True -> webmaster@saratoga-weather.org -> Saratoga, California, USA - - diff --git a/HIGHCHARTS_GUIDE.md b/HIGHCHARTS_GUIDE.md deleted file mode 100644 index 07d1414d..00000000 --- a/HIGHCHARTS_GUIDE.md +++ /dev/null @@ -1,85 +0,0 @@ -# Highcharts for Weather34 (requires WeeWX 3.9.2 or later) - -Credits: - - -Gary (gjr80) whose WeeWX Highcharts extension (https://github.com/gjr80/weewx-highcharts) provided motivation and a start point for this project. - -Jerry Dietrich who did 99% of the heavy lifting by engaging and volunteering his ideas, vision and coding skill at an early stage of this project. This project would certainly not have reached this point without his massive input. Thank you Jerry. - -This repository contains the instructions and code to enable Highcharts to be used with the WeeWX version of Weather34 skin as an alternative to the default CanvasJS. - -The following charts have been created: - Temperature, Humidity, Dewpoint, Temp/Hum/Dew, Indoor Temp, Windchill/HeatIndex, Barometer, Wind Speed, Wind Direction, Windrose, Wind Speed/Wind Gust/Wind Direction, UV, Radiation, Radiation/UV, Rainfall, Rainfall Monthly, Luminosity, Lightning, Barometer/Temp/Wind. - -Most charts have both weekly (1hour, 6hours, 12hours, 24hours, 36hours and 7days) and yearly (1day, 1week, 1month, 6months and 1year) spans. Please note, the 6month button is only functional when there is at least 6 months data in the database. - -The following charts have radial views: Temp, Dewpoint, Humidity, Barometer, Indoor, Derived, Wind Speed - -Most charts can change from yearly to weekly to daily by clicking the "hook point" on the graph. If there is no hook point then that chart cannot change. For example Windrose chart does not switch. - -Different dates can be compared with some charts. If there is a compare dates option in the menu dropdown (context menu, top right) then choosing this option will display a chart that compares the two dates in the From and To fields of the chart. - -Charts can be reloaded by choosing the reload option in the context menu. - -Some charts can have realtime updates by choosing the realtime update option in the context menu. - -Some charts can be display as radial charts by choosing the radial chart option in the context menu. - -Most charts can be automatically updated at a 1 minute interval by choosing the Auto Update option in the context menu. - -Changing the dates in From and To fields will change what is displayed based on what the span is. Most useful when displaying charts with yearly spans - -Holding the left mouse down allows the chart to be scrolled left to right within the chosen span. Using this feature with the zoom selector allows a user to drill down into the chart. - -# Setup Instructions for Weather34 Highcharts Option - -1. You must select the 'w34highcharts' option for the WeeWX Chart Data field in the Weather34 settings page. -2. Setting the correct paths. Go to 'w34highcharts/scripts' in the root of your WX-HWS installation and edit the file 'plots_config.js'. The path settings are in the first few lines: - - - var pathweewx = '/weewx/' //Path from web server home location to weewx directory - var pathpws = '/weather34/' //Path from web server home location to weather34 directory - var pathweewxbin ='/home/weewx/bin' //Physical path to weewx include files for wee_report_w34 if setup.py installed WeeWX - //var pathweewxbin ='/usr/share/weewx' //Physical path to weewx include files for wee_report_w34 if DEB installed WeeWX - - var realtimefile = pathweewx + "w34realtime.txt"; //Location of real-time data from web server - var pathjsonfiles = pathpws + "w34highcharts/json/"; //Location weewx report output json files from home location of weewx. DO NOT CHANGE UNLESS YOU CHANGE SKIN DIRECTORY. - - var dayplotsurl = pathpws + "w34highcharts/getDayChart.php"; //Location of day reports php file from home location of pws. - var pathjsondayfiles = "json_day/"; //Location day report output json files from home location of where wee_report_34 run. DO NOT CHANGE UNLESS YOU CHANGE SKIN DIRECTORY. - var weereportcmd = "./wee_reports_w34"; //Command to run wee_report_34. DO NOT CHANGE. - -Ensure that these paths are correct for your installation. - -3. Finally make sure that you have ownership of your weather34 root folder and it contents. From the command line: - - - sudo chown username:www-data -R /your_path_to_weather34_root_folder. - (as an example sudo chown www-data:www-data -R /var/www/html) - -4. Re-start WeeWX. Wait for the first archive period to elapse. Additional folders 'json' and 'json_day' should now have been created in the 'w34highcharts folder'. These contain the day, week and year json data files which are updated every archive period and the json_day files which are updated when you click through data points on the charts. Please note that the json_day/day report feature is not currently available with a local WeeWX remote webserver setup. -5. Open your website page and click on any of the chart links and a new chart will be displayed. -6. You will find additional controls which allows you change the time frame and zoom-in on data etc. -7. Apart from the many features metioned earlier, the context menu (button top right in each chart) allows the charts to be displayed full screen, printed or saved. - -8. You will notice that not all of the available charts are represented in the links on the alternative index page. If you wish to add or change the links the following format must be used, where '[chart_ID]' is the name of the chart e.g. 'humidityplot and '[time_frame]' is either 'weekly' or 'yearly': - - - href="/highcharts.html?chart='[chart_ID]'&span='[time_frame]'&temp=''&pressure=''&wind=''&rain='" data-lity > - -# Further Details for Weather34 Highcharts Option - -On a normal setup (WeeWX and webserver on the same machine) the getDayChart.php code uses the info found in weewxserverinfo.txt (located in the weewx directory) to establish a socket connection to weather34.py to send the modified WeeWX config file along with a timestamp so that the WeeWX report engine can generate the report and write it to the json_day folder. - -If the socket connection fails the the getDayChart.php code uses the location of the weewx system found in weewxserverinfo.txt to set the pythonpath and then run w34_reports. In this case weather34.py is not used, but the output follows the same path as before. - -If weewxserverinfo.txt is not there then the php falls back to hardcoded WeeWX paths in the getDayChart.php to execute w34_reports. If WeeWX is still not found the errors are logged in the webserver log file. - -As a side note the w34_reports command is always logged into the webserver error log for reference. This is why next to the syslog log this is the most important log followed by the browser console log. - -If using a remote webserver then the setup is different and now rsync needs to be used since the python path will not work and the file w34_reports is a noop now and weather34.py is the only path. - -The user must setup keys and the transfer in the WeeWX config to to rsync for any transfers to work from a WeeWX server to a remote webserver. - -Note in the plots_config.js you can turn off all day plots using the info var disable_day_plots = false; //Disable day plots by changing this setting to true. This is useful to suppress pop-up error messages when the configuration is unable to use day plots. - -To summarise there are multiple ways for day plots to work with local setups, with each level down getting a little more brittle. With remote machines there is only one way and everything must be setup correctly. - -Any problems, please raise an Issue in this repository attaching a debug report (see here for details http://www.weewx.com/docs/utilities.htm#wee_debug_utility), your skin.conf files and a syslog tail report covering at least two archive cycles from startup. - diff --git a/README.md b/README.md deleted file mode 100644 index 0d295816..00000000 --- a/README.md +++ /dev/null @@ -1,192 +0,0 @@ -# Weather34 skin for WeeWX -Weather Station website skin with Live Data for WeeWX. This version is compatible with WeeWX 4.x.x builds / Python 2.7 and Python 3.x. **This version of the template requires either the extended database schema introduced with WeeWX 4.0.0 or one that has been manually extended to included fields for lightning data.** It is strongly recommended that you start with an entirely new clean Python3 install of WeeWX 4.4.0 or later. - -Version W34-HC-IMJD-4.3.0 - -Packaged for installation using its own unique installer and an online pre-installation settings form https://steepleian.github.io/weewx-Weather34 - -This repository contains the WeeWX version of Brian Underdown's Weather34 website template set. Brian's main website is https://weather34.com/homeweatherstation/index.html In January, 2019, Brian asked others to take over the distribution/maintainence of his design whilst he concentrated on development only for MB NanoSD, called Weather34 MB-SMART. This WeeWX version of the template is actively developed by Ian Millard and Jerry Dietrich. - -The repository contains a main and development branch. To maintain integrity of the main branch, all pull request must be made via the development branch. - -This version requires WeeWX version 4.1.1 or later software. WeeWX is available at http://weewx.com. It is PHP 8 compatible. - -This version is designed explicitly to harness the powerful WeeWX database to generate the weather data charts and statistical data. It was originally built on the current MB-UB40-IHVN which is now maintained by Lightmaster (Meteobridge-Weather34-Template). Although we maintain a similar look and feel with MB-UB40-IHVN,the weewx-Weather34 now has many unique features. - -This version is assembled as an install package and uses its own unique installer and un-installer utilities. This greatly simplifies the installation process from that of previous versions. Depending on your own WeeWX setup, minor edits may be required to be made to weewx.conf and Weather34 skin.conf files. Please see the Weather34 skin Installation Guide for detailed instructions. - -# What's New in this Version W34-4.3.0 - -DarkSky has been removed as a source of forecasting data etc - the API has been withdrawn by its owners Apple. - -AerisWeather is now included and is the default forecasting, alerts and current conditions data source. A free developers subscribtion is required via the link in the install instructions. Weather Underground is also included as an alternative source but it does not supply the same level of data via its API. - -The services.txt generating form has been updated with an improved interface, thanks to User Stephen. - -With newer versions of Python3.x several fixes have add to be applied. Thanks once again to Jerry Dietrich in keeping us on track with the changes and fixes. - -There are one or two other features included at the suggestion of User Sean, so thanks to him as well. - -The default symbol set is now based on the yr.no symbols. (Please note that Weather Underground still uses the old set for forecasts). - -Significant update of settings page. - -Compliant with WeeWX 4.7.0 for remote syncrinisation. Thanks to Jerry (and to Chris for raising the issue). - -Various bugs squashed. Thanks to mutiple users support in raising issues. - -# Demo - -A live example of Weather34 WeeWX skin can be seen at https://claydonsweather.org.uk - -# Weather34 Historic Timeline of design 2014-2019 -https://weather34.com/homeweatherstation/weather34timeline/weather34timeline.html - -# Template Screenshots - -**Dark Theme** - -![image](https://user-images.githubusercontent.com/18438654/86633765-fb60a200-bfc8-11ea-99dc-f8dc8de56e8c.png) - -**Light Theme** - -![image](https://user-images.githubusercontent.com/18438654/86635273-c8b7a900-bfca-11ea-9efd-76962364c2fd.png) - -**Pop Up Chart - Dark Theme** - -![image](https://user-images.githubusercontent.com/18438654/86635575-277d2280-bfcb-11ea-9452-e7acd7f44e62.png) - -**Pop Up Chart - Light Theme - -![image](https://user-images.githubusercontent.com/18438654/86636143-dae61700-bfcb-11ea-966d-4db7b487033f.png) - -**Pop Up AQI Info** - -![image](https://user-images.githubusercontent.com/18438654/86636425-2c8ea180-bfcc-11ea-957d-72c1180f44fb.png) - -**Pop UP Alerts** - -![image](https://user-images.githubusercontent.com/18438654/86637661-da4e8000-bfcd-11ea-8df6-1f872a6bb6ed.png) - -**Radial Charts** - -![Untitled](https://user-images.githubusercontent.com/18438654/86875356-34d50280-c0da-11ea-9b39-33acd451eb46.png) - -**Hays Charts** - -![image](https://user-images.githubusercontent.com/18438654/86639506-e25bef00-bfd0-11ea-9da3-043d2a640b46.png) - - -# Setup - -**If you are upgrading from a previous version of this skin, due to the significant changes, you must recreate your settings1.php file by running the full install process. Just copying your previous settings1.php will cause errors which are then more difficult to resolve.** - -Follow the instructions in the 'installation guide' (INSTALLATION_GUIDE.md) to install the template. -Browse to http://your/path/to/weewx/weather34/templateSetup.php -There is no initial password when the page prompts the first time -- just press LOGIN to enter the page. -IMPORTANT set a password in the screen for future use -- your browser can remember it. This will make future updates reasonably secure so only you can do the updates to the configuration. -Make setting entries in the templateSetup.php page and SAVE. The next time you run it, use the password you set in the step above. -Repeat running templateSetup.php until the main screen appears as you like it. - -# License - -Copyright (c) 2016-2019 by Brian Underdown (https://weather34.com) - -Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Template”), to deal in the Template without restriction, including without limitation the rights to, can use, can not copy without prior permission, can modify for personal use, can use and publish for personal use ,can not distribute without prior permission, can not sublicense without prior permission, and can not sell copies of the Template, and subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Template. - -THE TEMPLATE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE TEMPLATE OR THE USE OR OTHER DEALINGS IN THE TEMPLATE. - -Attribution-NonCommercial 4.0 International based on a work at https://weather34.com/homeweatherstation -Non-weeWX versions Available - -# An Excerpt from Meteobridge-Weather34-Template MB-UB40-RRW README.md -Github repository for the Meteobridge version of the original weather34 template -Weather Template for Meteobridge users only - -# This work is not permitted to be used in any other versions without prior permission unless listed below -# Permission is granted for use in Cumulus version maintained by Ken True -# Permission is granted for use in Weewx version maintained by Ian Millard - -*This work means CSS/SVG/PHP . - -Meteobridge Version available via download maintained by Lightmaster (https://github.com/lightmaster/Meteobridge-Weather34-Template) - -Cumulus Version available via download and more info supported by Ken True ( https://github.com/ktrue/CU-HWS ). This version now also supports WeeWX and WeatherCat - -# Credits for this version - -Apart from Brian Underdown without him, this template would never exist, I would aslo like to acknowledge the following people: - - -Jerry Dietrich for his massive contribution in converting my wild ideas into reality, putting me straight on my mediocre coding skills and having the patience of a dozen saints. Aslo Stephen, Sean, Chris, Ray, Mauro, Frank for their invaluable contribution. - -Gary Roderick for his original coding of Highcharts for WeeWX. - -William Bailey aka Lightmaster who maitains the MB version of Weather34. Incredibly helpful and always on the end of Telegram when I need a chat, night or day. - -Ken True for sharing files and who makes my job of maintaining the WeeWX version so much easier. - -Thomas Sosio for his invaluable contribution in producing the Meteobridge lookup code to translate WeeWX database output. - -David Marshall for contributing technical knowledge and solutions to create some original .tmpl files and alternative solutions for weather alerts. - -Taylormia for contributing his excellent setup example for instances where WeeWX and server/template are remote to each other. - -Gary Portellas for a helpful suggestion to further simplify the installation process. - -Drealine for his recent work on extending the French translations. - -All those unamed people who have helped me with testing updates. - -The creators of WeeWX without which there would be no point. - -# Alternative versions - -# Meteobridge -you can find the Meteobridge version maintained by Lightmaster (William) at -https://github.com/weather34/Meteobridge-Weather34-Template34/ - -# Cumulus -you can find the Cumulus version maintained by Ken True (Saratoga) at -https://github.com/ktrue/CU-HWS - -# Weewx -you can find a Weewx version maintained by Ian Millard is also avaialble via -https://github.com/steepleian/weewx-Weather34 - -# Weatherflow -you can find a Weatherflow version not maintained but fully tested as of May 5th 2019 -https://github.com/weather34/Weather34-Weatherflow - - -# This work is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License. -http://creativecommons.org/licenses/by-nc-nd/4.0/ - -# Credits and thanks to the contributors who made the original version of Weather34 possible between 2015 and 2019. - - Erik M Madsen for language idea and initial script - - Paul @komoka weather in Canada for continous support and testing - - Josep for Spanish/Catalan language translation and for many ideas and refinements - - Pascal Catte French translation and ideas fowarded - - Steve the developer of Cumulus for support and providing a platform to resolve issues - - Mats Ahlklo Swedish translation and his work on using Davis weatherlink - - Betejuice (Cumulus Forum) for providing a solution for meteor shower listings - - Ken True (Saratoga) for kindly granting permission allowing use of many scripts he developed which gave inspiration and ideas though not used today it was the inspiration that allowed to do something more suited to the design. - - Eric Rechlin Special thanks for originally creating the theme switching and extensive work on metrics/non metrics - - Boris at smartbedded (meteobridge) for ongoing support and upkeep of meteobridge - - Wim van der Kuil for the original meteobridge script - - David St John at weatherflow for providing hardware for testing and his non bias logical views - - Paul Wilman , Tina Thomas, Vaggos , Chuck M , Aaron Gersztoff , Ian Millard, and many many more for continous constructive supportive feedback .. diff --git a/REMOTE_SERVER.md b/REMOTE_SERVER.md deleted file mode 100644 index 17bf60b1..00000000 --- a/REMOTE_SERVER.md +++ /dev/null @@ -1,18 +0,0 @@ -To use a remote webserver(s) to display the Weather34 template the -following are required to be setup: - - -**RSYNC** - -Instructions for the use of rsync with WeeWX can be found at http://weewx.com/docs/usersguide.htm#config_RSYNC. If the machines are not on the same local network or you require secure communications, SSH keys need to be created for running weewx on both the remote webserver(s) and the weewx machine. This can sometimes be a tricky process to setup. An excellent tutorial can be found at https://www.digitalocean.com/community/tutorials/how-to-copy-files-with-rsync-over-ssh - -**Webserver** - -In the weewx.conf file the webserver_address needs to be the ip address of the webserver(s) or a DNS name that a lookup can be done to get an IP address. This can be a comma separated list if there are more than one remote webserver. - -**Open a Port** - -Port 25252 needs to be open on the weewx machine and all the remote webserver machine(s) and any network device between these machines. - -**Further Reading** - -An excellent online guide by User Chris Alemany can be found at https://www.chrisalemany.ca/2021/02/24/installing-the-weather34-skin-on-weewx-with-remote-web-server-2021-edition/ diff --git a/TROUBLESHOOTING.md b/TROUBLESHOOTING.md deleted file mode 100644 index 22dcc8b4..00000000 --- a/TROUBLESHOOTING.md +++ /dev/null @@ -1,31 +0,0 @@ -# Troubleshooting Guide - -* Issues can be submitted here https://github.com/steepleian/weewx-Weather34/issues - -* Before sumitting a new issue, please look through the open and closed issue logs to see if there is previous history of the problem you encountered. -* When submitting an issue it will help us to deal with your problem more quickly if you can supply the following information and run the listed procedures: - -* Make sure you have rebooted the machine running weewx and the machine running your webserver (if your webserver machine is different than your weewx machine). - - 1. Is your WeeWX installation and webserver on the same machine? - - 2. cd to your w34highcharts/scripts folder and run cat plots_config.js - - 3. run cat /var/log/syslog | grep weewx - - 4. run cat on your webserver error log - - 5. cd to your webserver /weewx folder and run ls -l weather34 - - 6. cd to your /weather34 folder and run ls -lR w34highcharts - - 7. run ls -l /home/weewx/bin (or ls -l /usr/share/weewx or ls -l /Users/Shared/weewx/bin/ depending on your WeeWX setup) - - 8. cd to your /skins folder and run ls -lR "\*34\*" - - 9. run ./wee_debug --output This will generate weewx.debug report which includes weewx.conf with all sensitive information like passwords and keys removed. The default location for the output is /var/tmp/weewx.debug. More details can be found here http://www.weewx.com/docs/utilities.htm#wee_debug_utility - - 10. need error console output from your browser - - There is no need to save the various outputs to a file, just cut and paste each one in to seperate issue log comment windows indicating the type of output. - -* Remember Github is all about collaboration. Be precise as possible in the issues you raise or respond to. By being open and transparent we help each other to help ourselves. \ No newline at end of file diff --git a/gitignore b/gitignore deleted file mode 100644 index 991404a2..00000000 --- a/gitignore +++ /dev/null @@ -1,26 +0,0 @@ -# -# Ignore file for weewx-Weather34 configuration -# -# ignore the downloaded json files (but not the wuupdate.php there -jsondata/*.txt - -# ignore the graphics data file downloads -chartswudata/* - -# ignore the demodata files -demodata/* - -# ignore settings1.php as it contains the user's current configuration -settings1.php - -# ignore menu-extras.php as it contains the user's current configuration -menu-extras.php - -# ignore all compare backup files -*.bak - -# ignore these remnants from Apple compressed files -.DS_Store - -# ignore these experimental files -*.php1