Category:JSON Files (preserving history): Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search
m (→‎Uploading data to a web server: add info about pre 3.10.x)
m (HansR moved page Category:JSON Files to Category:JSON Files (preserving history) without leaving a redirect: Rewrite of contents)
 
(5 intermediate revisions by one other user not shown)
Line 1: Line 1:
=Uploading data to a web server outside MX=
<big>Please note this Wiki page applies to releases 3.10.1 onwards.</big> <small>NOTE: Earlier MX releases used [[Cumulus template file|HTML template files]] that created web pages locally for uploading to a web server.</small>
This Wiki category page is the entry point to the documentation describing how the JSON format is used in [[New_Default_Web_Site_Information|optional web site functionality]] for updating data to a web server outside Cumulus MX.
The [[Webfiles folder|webfiles sub-folder]] contains the following web pages that are uploaded just once to your web server (obviously if they get changed in a new release, then the new files are uploaded to replace the old ones as another one-off operation).
*Each of these web pages depends on a number of other files (in '''lib''', ''js'', and '''css''' sub-folders).
*they also depend on one or more files being uploaded to supply data:
{| class="wikitable" border="1"
|-
!style="width:30px" | Web page
!style="width:100px" | Source file
!style="width:30px" | Upload file
!style="width:300px" |Settings
!style="width:300px" | Description
|-
|gauges.htm
|[[realtimegaugesT.txt]] in [[Web folder|web sub-folder]]
|realtimegauges.txt
| Internet settings -->> Web/FTP Settings -->> Realtime Settings  -->> realtimegauges.txt  -->> Generate
| Please see [[SteelSeries_Gauges]] (although that was written for legacy Cumulus 1)
|-
|historic.htm, trends.htm, selectachart.htm
|Generated in the code
|[[availabledata.json]], [[graphconfig.json]], plus files with data for what to be plotted (e.g. alldailyhumdata.json)
| Internet settings -->> Web/FTP Settings -->> Interval Settings -->>
|'''availabledata.json''' and '''graphconfig.json''' files must be uploaded just once after you select which graphs you want to plot (so if you for example decide to swap from apparent temperature to feels like, upload the first file again)
|-
|index.htm, monthlyrecord.htm, record.htm, thismonth.htm, thisyear.htm, today.htm, yesterday.htm
|[[websitedataT.json]]
|websitedata.json
| Internet settings -->> Web/FTP Settings -->> Standard File Settings -->> websitedata.json -->> Generate
|please see [[New Default Web Site Information]]
|-
|noaareport.htm
|Generated in code
|[[Reports folder|Reports sub-folder]]
|NOAA Settings -->> all sub-sections
| see [[Reports folder|here]]
|}
=Data Transfer Format=
=Data Transfer Format=


Line 13: Line 55:
For example, the page that displays weather for today and yesterday uses the 6 formats described on [[API_Today/Yesterday_Data|this page]].
For example, the page that displays weather for today and yesterday uses the 6 formats described on [[API_Today/Yesterday_Data|this page]].


=Uploading data to a web server=


This category page is the entry point for documentation of how the JSON format is used for the optional MX functionality of updating data to a web server outside Cumulus.


Pages listed below apply to [[New_Default_Web_Site_Information|web site functionality in releases 3.10.1 onwards]]. Earlier MX releases used [[Cumulus template file|HTML template files]] that created web pages locally for uploading to a web server.
=Links listed below=


<div style="background: LemonChiffon;padding:5px; margin:2px;">
<div style="background: LemonChiffon;padding:5px; margin:2px;">
Line 26: Line 66:


MX stores all the '''xxxx.json''' files, linked from this Wiki page, in the [[Web folder|'''web''' sub-folder]] of your MX installation.  
MX stores all the '''xxxx.json''' files, linked from this Wiki page, in the [[Web folder|'''web''' sub-folder]] of your MX installation.  
There is one file [[WebsitedataT.json|websitedataT.json]] that is part of MX release distributions from 3.10.1 onwards (3.10.0 was withdrawn) as a [[Cumulus template file]]. For this case, both the template (containing the tags as described in the linked page) '''websitedataT.json''', and the file for uploading (containing data) '''websitedata.json''' can be found in the '''web''' sub-folder.
The templates for the other files are part of the MX internal code, so do not appear in the folder. Determine which files are generated (and appear in the '''web''' sub-folder), what data is available for your web server, and whether MX uploads them, by selections in [[MX_Administrative_Interface#Internet_Settings|1) Standard file settings, 2) Graph file settings, and 3) Daily graph file settings]].


Please note if you are using an older release some files may not be available, and MX development may add files that need to be documented here.
Please note if you are using an older release some files may not be available, and MX development may add files that need to be documented here.




Latest revision as of 12:23, 29 September 2022

Uploading data to a web server outside MX

Please note this Wiki page applies to releases 3.10.1 onwards. NOTE: Earlier MX releases used HTML template files that created web pages locally for uploading to a web server.

This Wiki category page is the entry point to the documentation describing how the JSON format is used in optional web site functionality for updating data to a web server outside Cumulus MX.

The webfiles sub-folder contains the following web pages that are uploaded just once to your web server (obviously if they get changed in a new release, then the new files are uploaded to replace the old ones as another one-off operation).

  • Each of these web pages depends on a number of other files (in lib, js, and css sub-folders).
  • they also depend on one or more files being uploaded to supply data:
Web page Source file Upload file Settings Description
gauges.htm realtimegaugesT.txt in web sub-folder realtimegauges.txt Internet settings -->> Web/FTP Settings -->> Realtime Settings -->> realtimegauges.txt -->> Generate Please see SteelSeries_Gauges (although that was written for legacy Cumulus 1)
historic.htm, trends.htm, selectachart.htm Generated in the code availabledata.json, graphconfig.json, plus files with data for what to be plotted (e.g. alldailyhumdata.json) Internet settings -->> Web/FTP Settings -->> Interval Settings -->> availabledata.json and graphconfig.json files must be uploaded just once after you select which graphs you want to plot (so if you for example decide to swap from apparent temperature to feels like, upload the first file again)
index.htm, monthlyrecord.htm, record.htm, thismonth.htm, thisyear.htm, today.htm, yesterday.htm websitedataT.json websitedata.json Internet settings -->> Web/FTP Settings -->> Standard File Settings -->> websitedata.json -->> Generate please see New Default Web Site Information
noaareport.htm Generated in code Reports sub-folder NOAA Settings -->> all sub-sections see here

Data Transfer Format

JavaScript Object Notation (.json) format is one of the ways to transfer data with individual items labelled, on that linked page some of the other ways to transfer data are also explained.

Use of this format is introduced in Cumulus MX, and none of the files in this category are applicable to the legacy 1.9.4 software.

Documentation for local application programming interface

MX uses JSON format (specified as part of MX internal code) for the pages that show weather information in the MX Administrative Interface, on the web server generated by MX.

The Cumulus Wiki pages that document JSON usage in that interface are linked from the link in the heading above, and are not included in this category.

For example, the page that displays weather for today and yesterday uses the 6 formats described on this page.


Links listed below

Crystal Clear info.png Appeal to contributors:

Please work through all linked pages, and ensure Cumulus MX documentation is completed

MX stores all the xxxx.json files, linked from this Wiki page, in the web sub-folder of your MX installation.

Please note if you are using an older release some files may not be available, and MX development may add files that need to be documented here.


.

This category currently contains no pages or media.

Retrieved from "https://www.cumuluswiki.org/index.php?title=Category:JSON_Files_(preserving_history)&oldid=10775"