Weather Diary: Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search
m
Resequence existing content (previously C1 and MX were in turn, now each section covers both)
m (Resequence existing content (previously C1 and MX were in turn, now each section covers both))
=Introduction=
 
The Weather Diary feature allows the user to enter some short notes (up to 1024 characters) for each day, and to record whether snow was falling and/or lying on that day, along with the depth of snow.
 
If you have manual weather observations, or want a permanent record of general conditions each day, this diary is the place to hold such notes.
 
=Snow=
==Invitation==
Anybody with experience of using this feature is encouraged to contribute to this article.
 
The weather station models that Cumulus is programmed for do not include any automated snow measurement. However, many people asked Steve Loft, the developer of Cumulus, to provide functionality for manual snow recording. The functionality is provided by a weather diary, that allows you to record any data against a date, for example some people record events like thunderstorms, or hailstorms.
= Cumulus 1 functionality =
 
Obviously when snow melts, any snow sitting on top of (or inside) a rain gauge is counted as rain).
== Where is the diary held? ==
 
Please see [[Log.xml|Log.xml page]] for details about file, and how to read it using PHP Hypertext Preprocessor or a XML reader.
 
==Entering Snow Information==
This file can be opened as a text file, but there are database file readers that can open this sort of file and display them in a spreadsheet like format (or even convert them to formats like CSV). It is possible to upload this file, or a transformed version of it, onto your webspace and write coding to display the contents, see [https://cumulus.hosiene.co.uk/viewtopic.php?p=83883#p83883 Cumulus Weather Diary].
 
You can go outside with a ruler and measure the depth of any lying snow.
 
Meteorologists use centimetres, and MX is pre-programmed to expect that allowing 2 decimal places. In the original Cumulus software, any depth entered has to be a whole number, and in later versions, Cumulus 1 allows you to select the units (e.g. millimetres would allow you to report depth to nearest tenth of a cm; alternatively you could specify tenths of an inch). Some people record snow depth by counting marks on a stick or how many parts of a finger/hand are buried.
 
For Cumulus 1, you can record multiple entries in a single day, this feature makes the coding in the diary impossible to understand, even Steve Loft was unable to understand how the routine he borrowed worked!
 
 
The functionality for both Cumulus 1 and MX allows you to:
* tick ''snow falling'',
* tick ''snow lying'',
*enter ''snow depth'' (see note above as only MX allows decimal places)
* record a text note (this might cover include the time snow started falling, and/or stopped falling or something about the intensity of the snow storm),
 
The label on the button to store what you entered varies:
*In original Cumulus, click '''Update''' button, or all your entries will be lost.
*In MX admin interface, click '''Apply''' button, and wait until you see confirmation that an entry or update has been processed.
= Cumulus 1 and MX diary differences =
 
There are a number of differences between the Cumulus 1 and MX implementations, as covered in following sub-sections. There is some discussion in the Cumulus support forum at [https://cumulus.hosiene.co.uk/viewtopic.php?f=36&t=17919&p=139854&hilit=weather+diary#p139854 Weather Diary (C1 and MX Differences)].
 
 
= Where is the diary held? =
 
In all flavours, the diary is held in a file in the [[Data folder|data sub-folder]].
 
For Cumulus 1, see [[Log.xml|Log.xml page]] for details about file, and how to read it using PHP Hypertext Preprocessor or a XML reader.
 
The Cumulus 1 file can be opened as a text file, but there are database file readers that can open this sort of file and display them in a spreadsheet like format (or even convert them to formats like CSV). It is possible to upload this file, or a transformed version of it, onto your webspace and write coding to display the contents, see [https://cumulus.hosiene.co.uk/viewtopic.php?p=83883#p83883 Cumulus Weather Diary].
 
The MX weather diary is stored in a table called '''DiaryData''' in a SQLite3 database in a file called [[diary.db]]. Any application that can read ODBC files (e.g. Libre Office's Base functionality) can read the MX database and edit it. It is possible to upload this file into your webspace, where coding can display the contents, please see below.
 
If you have ability to run '''PHPLIteAdmin''' (i.e. web server running PHP Hypertext Preprocessor), that can read and edit the [[Setting_up_Raspberry_Pi#Editing_the_Weather_Diary|MX weather diary]].
 
 
=How to edit the contents=
 
Original Cumulus software: On the main Cumulus screen select Weather Diary from the [[Cumulus_Screenshots#View_Menu|View menu]].
 
Using the MX admin interface:
#Under the '''Edit''' tab, select '''Weather Diary''' and a calendar based selector appears.
#Click on required date, enter any Comment (stored as "Entry" in the database), tick the boxes for falling, and lying.
#Use the spin selector or type in a snow depth. This field takes decimals (it is labelled as "cm", although you could select a different unit and ignore units shown!).
 
==How do I change the time a diary day begins/ends?==
 
The Cumulus 1 diary loads displaying the current calendar day. The MX diary loads displaying a calendar with current calendar day highlighted, click on that to load the current day.
 
This may not be the right day to enter current information as the rollover time for Weather Diary information is configurable using [[Cumulus.ini]] e.g. ''SnowDepthHour=9'' means everything (not just snow depth) in yesterday's diary entry applies until 9am.
 
The SnowDepthHour label applies because the only part of the diary that is, in the original Cumulus 1, converted to a [[Webtags#Today|web tags]] is Snow Depth, and the time set is when ''<#snowdepth>'' is updated with the current day's value, until then it shows the value on yesterday's diary page. For MX, other web tags are available, and these apply to same day.
 
NOTE: This rollover time is totally independent of any overall 'log rollover' time set in station screen as accessed from Configuration menu. You may use midnight rollover, but want to go out and record manual observations (including measuring any snow) each morning at 9am (or any other time).
 
 
 
 
= Web tags available for your web site =
 
See [[Webtags#Today|web tags]] page for the definitive list.
 
For Cumulus 1, the only web tag is today's <#snowdepth>. Obviously a non-zero value means snow is lying, so it can be treated as a boolean for that. The '''snow index''' is calculated (see [https://cumulus.hosiene.co.uk/viewtopic.php?f=4&t=215 "snow index" forum post] and there is a [[Cumulus_Screenshots#View_Menu|menu item]] to show it.
 
For MX, today's <#snowfalling>, <#snowlying>, and <#snowdepth> are available as; this is everything in the weather diary for current day (except the comment). There are no web tags for past days. Snow index is not in MX functionality.
 
 
==Displaying on a customised web page==
 
If you understand HTML table syntax, the [[Webtag]] ''<#snowdepth>'' can be inserted on a web template (e.g. ''todayT.htm''). If you are using MX some other web tags can be used too. More help is available on the [[Customised templates]]) page.
 
If you understand JavaScript and HTML, you can arrange to upload a background with a scale on which the script can use ''<#snowdepth>'' to overlay the correct depth as a white blanket for example. The script would have similarities to the current part of the script provided with Cumulus 1 that plots rainfall as a bar chart.
 
Some sites use the ''current conditions'' feature in Cumulus 1 (optional box on main screen, plus ability to create a file that is deleted on use - see Cumulus 1 help) to display further snow information.
 
Some sites using Cumulus and updating databases as input for creating pages using PHP do manage to display other information from the diary on their web sites (search the support forum for mentions of snow).
 
 
==How to view the contents of Cumulus 1 diary on a web page==
 
The php script included in [[File:Cumulus 1 Weather Diary PHP reader.zip]] will read the Cumulus 1 weather diary and output it to a web page. Although that script is not in English, it is possible to translate the text, and it is possible to modify the script in various ways. For example, in one modification I made it combine the multiple entries possible for one day into a single "worst case" output and in another modification I supply it with a date and it only outputs records for that date as shown below:
}// end snow diary file processing</pre>
 
==How to edit the contents==
 
== Accessing MX diary outside MX ==
On the main Cumulus screen select Weather Diary from the View menu.
 
==How do I change the time a diary day begins/ends?==
 
The diary loads displaying the current calendar day.
 
This may not be the right day to enter current information as the rollover time for Weather Diary information is configurable using [[Cumulus.ini]] e.g. ''SnowDepthHour=9'' means everything (not just snow depth) in yesterday's diary entry applies until 9am.
The SnowDepthHour label applies because the only part of the diary that is, in the original Cumulus 1, converted to a [[Webtags#Today|web tags]] is Snow Depth, and the time set is when ''<#snowdepth>'' is updated with the current day's value, until then it shows the value on yesterday's diary page.
 
NOTE: This rollover time is totally independent of any overall 'log rollover' time set in station screen as accessed from Configuration menu. You may use midnight rollover, but want to go out and record manual observations (including measuring any snow) each morning at 9am (or any other time).
 
== Web tags available for your web site ==
 
For Cumulus 1, the only web tag is <#snowdepth>. Obviously a non-zero value means snow is lying, so it can be treated as a boolean for that.
 
For any more information you need to read the [[Log.xml|Log.xml file]] and process that as indicated on referenced page.
 
= Cumulus 1 and MX diary differences =
 
There are a number of differences between the Cumulus 1 and MX implementations, as covered in following sub-sections. There is some discussion in the Cumulus support forum at [https://cumulus.hosiene.co.uk/viewtopic.php?f=36&t=17919&p=139854&hilit=weather+diary#p139854 Weather Diary (C1 and MX Differences)].
[[Category:Cumulus 1]]
[[Category:Cumulus MX]]
 
=MX weather diary =
 
The MX weather diary is stored in a table called '''DiaryData''' in a SQLite3 database in a file called [[diary.db]].
 
== How to edit the MX Weather Diary ==
 
=== Using the admin interface ===
 
#Under the '''Edit''' tab, select '''Weather Diary''' and a calendar based selector appears.
#Click on required date, enter any Comment (stored as "Entry" in the database), tick the boxes for falling, and lying.
#Use the spin selector or type in a snow depth. This field takes decimals (it is labelled as "cm", although you could select a different unit and ignore units shown!).
 
=== Accessing outside MX ===
 
The weather diary is stored in [[diary.db|a sqLite database]] and that can be easily accessed by any ODBC software e.g. Libre Office. It can also be accessed using PDO instructions in PHP Hypertext Preprocessor.
 
Here is an example in a PHP 7.3 (thereplease arenote, this script will not work without changes for PHP 7.4, and PHP 8.x) script (modification of script available in [[File:Snow diary.zip]]) of accessing any one day ($rowMetDayStamp in yyyy-mm-dd format):
<pre>$diary = 'sqlite:' . $snowDiary; // Parameter to identify a SQLite database puts a prefix in front of file path
$dbhandle = new PDO($diary); // connect to db
</pre>
 
== Web tags available for your web site ==
 
Cumulus MX provides [[Webtags#Today|web tags]] for everything in the weather diary for current day (except the comment). There are no web tags for past days.
 
==How do I change the time a diary day begins/ends?==
 
The diary loads displaying the current calendar day.
 
This may not be the right day to enter current information as the rollover time for Weather Diary information is configurable using [[Cumulus.ini]] e.g. ''SnowDepthHour=9'' means everything (not just snow depth) in yesterday's diary entry applies until 9am.
The SnowDepthHour label applies because the only part of the diary that is converted to a [[Webtags#Today]] is Snow Depth, and the time set is when ''<#snowdepth>'' is updated with the current day's value, until then it shows the value on yesterday's diary page.
 
NOTE: This rollover time is totally independent of any overall 'log rollover' time set in station screen as accessed from Configuration menu. You may use midnight rollover, but want to go out and record manual observations (including measuring any snow) each morning at 9am (or any other time).
 
=Snow=
 
The weather station models that Cumulus is programmed for do not include any automated snow measurement. So Cumulus does not treat Snow the same way as automated measurements (until it melts and any left on top of, or inside, a rain gauge is counted as rain). Instead Cumulus assumes you will manually insert information.
 
==Entering Snow Information==
 
You can go outside with a ruler and measure the depth of any lying snow.
The option Weather Diary within the ''View'' menu allows you to navigate to the appropriate day (see above) and:
* make a text note (this might cover include the time snow started falling, and/or stopped falling or something about the intensity of the snow storm),
* tick ''snow lying'' (this is a snapshot, you can only tick/untick for the whole day),
* enter an integer representing the snow depth at your chosen updating time (this can be in any units, mm, cm, inches, thumbnails or marked stick - just remember to always use the same units as the units are not recorded)
* tick ''snow falling'' (this is a snapshot, you can only tick/untick for the whole day).
Click '''update''' button, or all your entries will be lost.
 
==Displaying on a customised web page==
 
If you understand HTML table syntax, the [[Webtag]] ''<#snowdepth>'' can be inserted on a ( for example the ''todayT.htm'') web template (see [[Customised templates]]) to display the snow depth (updating at time set in [[Cumulus.ini]] as explained above. If you understand JavaScript and HTML, you can arrange to upload a background with a scale on which the script can use ''<#snowdepth>'' to overlay the correct depth as a white blanket for example. The script would have similarities to the current part of the script provided with Cumulus that plots rainfall as a bar chart. If you are using MX some other web tags can be used too.
 
Some sites use the ''current conditions'' feature in Cumulus 1 (optional box on main screen, plus ability to create a file that is deleted on use - see Cumulus help) to display further snow information.
 
Some sites using Cumulus and updating databases as input for creating pages using PHP do manage to display other information from the diary on their web sites (search the support forum for mentions of snow).
 
[[Category: Terminology]]
[[Category:Log Files]]
[[Category:Cumulus 1]]
[[Category:Cumulus MX]]
5,838

edits

Navigation menu