Webtags
This page is the new Webtags page. This page and subpages hold a complete rewrite of the Webtags page.
The information that was on this old Webtags page has been moved to Webtags (preserving history). You are advised to use that page until this page is ready and this message has been removed. If any questions or remarks please send a PM to HansR on the forum. Do not use the discussion tab unless accompanied by a PM: there is no automated signal to HansR if you use that page.
This page and its subpages will document the Webtags from the point of view of the CumulusMX software and not the Cumulus 1 legacy software. Cumulus 1 is no longer maintained and will eventually disappear. If you are still using it, please refer to the original Webtags page where @sfws has tried to give both packages equal value. That effort is no longer maintained in this Webtags page. We hope you will understand this approach.
Please do not edit this page while it is being worked on i.e. while this message is still here.
Introduction
Data gathered by CMX is stored locally in the database (see e.g. dayfile and standard logfiles and a range of ini files, Extra Sensor files, Airlink logfiles etc...). To make these data - and calcu;lated derivatives - available to the user CumulusMX (CMX) uses a system of Webtags. In short, a Webtag is a symbolic name which is translated into a value when asked by CMX. So e.g.:
temp -> (process) -> 17.1
The webtags can have modifiers to change the output or the input e.g. you can change the decimal point to a comma (output modifier). All these will be described below (or in a sub-page)
For using Webtags see below
List of all tags
The local List
From version 3.12.0 the complete list of Webtags can be generated from your running CumulusMX instance.
Goto the interface. In the menu go to Program settings=>General options, tick List web tags. The next time that MX is restarted, it will create a file called WebTags.txt in the same folder as where the executable is found. Unticking that parameter will have the inverse effect.
The WebTags.txt file will list all the tags your build of Cumulus can currently handle. This list only contains the bare tag_names. Parameters and modifiers will need to be looked up and added to make use of these. This list can be of use if you are using the tags to create your own program or website while interfacing with CumulusMX. It is useful to save it now and then with the CMX version nr in its name. This will make it possible to find the new tags easily through making a difference.
The full List
The full list of Webtags carries a lot of additional information so it has its own Webtag page.
Using Webtags
There are basically two main methods to ask CMX to do this translation both of which will be discussed below (or in a sub-page). The two methods are:
- Processing files through the running instance of CumulusMX
- Getting the value by using the local interface GET method.
In the first case you use <#temp> in the file which will then show up as 17.1 in the output file.
In the second case you use the URL in your browser: http://<ip-address>:8998/api/tags/process.json?temp which returns {"temp":"12,7"}.
The first method is used in files used as input for the Extra Web Files in CMX which are then processed by CMX if you tick process The output file then contains the value. The second method can give you a quick view of a value from the browser but its principal use is to be used programmatically from anywhere you can reach the CumulusMX machine.
In addition, there are two other methods to retrieve the value of the webtag:
- Getting the values through the HTTP POST method
- Using MySQL through the Custom Upload feature
All methods are described in the Using Webtags page.
