Category:JSON Files (preserving history): Difference between revisions
m (→Uploading data to a web server: add info about pre 3.10.x) |
m (→Uploading data to a web server: split into sub-sections for clarity) |
||
| Line 27: | Line 27: | ||
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. | ||
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. | |||
==Web Pages with tables== | |||
MX provides a number of default web pages in the [[Webfiles folder|Webfiles sub-folder]]; these pages are installed on the web server and are fed with data from one file. | |||
Its [[Cumulus template file]] [[WebsitedataT.json|websitedataT.json]] is part of MX release distributions from 3.10.1 onwards (3.10.0 was withdrawn. | |||
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. | |||
==Web pages with graphs== | |||
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]]. | |||
Revision as of 06:42, 15 May 2021
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.
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 web site functionality in releases 3.10.1 onwards. Earlier MX releases used HTML template files that created web pages locally for uploading to a web server.
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.
Web Pages with tables
MX provides a number of default web pages in the Webfiles sub-folder; these pages are installed on the web server and are fed with data from one file.
Its Cumulus template file websitedataT.json is part of MX release distributions from 3.10.1 onwards (3.10.0 was withdrawn.
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.
Web pages with graphs
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 1) Standard file settings, 2) Graph file settings, and 3) Daily graph file settings.
.
This category currently contains no pages or media.
