Webtags (preserving history): Difference between revisions

m
Line 663: Line 663:
This is meant for services either on the same computer as Cumulus or on your local network. It is not secure, and should not be available, nor requested, via any external network or the internet.
This is meant for services either on the same computer as Cumulus or on your local network. It is not secure, and should not be available, nor requested, via any external network or the internet.


In earlier versions of Cumulus if you wanted to make use of values processed by Cumulus, you wrote a script file referencing the web tags you wanted to use. Now if you are running other software on your device that runs MX (or a computer or other device linked directly on your personal network), you can request web tags values on demand via an application programming interface (api hereafter). Obviously this creates a processing overhead on Cumulus so use this feature wisely.
In earlier versions of Cumulus if you wanted to make use of values processed by Cumulus, you wrote a script file referencing the web tags you wanted to use. Now if you are running other software on your device that runs MX (or a computer or other device linked directly on your personal network), you can request web tags values on demand via an application programming interface (api hereafter).  
 
Obviously each api request creates a processing overhead on Cumulus so use this feature wisely.
 
The examples below focus on obtaining current information, but in practice it is more likely that the api will be used to request information that does not keep changing, such as what units are being used for temperature, rainfall, and wind speed. The admin interface uses api techniques for all the information it needs, but each page has an api request for the version and build being used, that is another example of information that changes seldom, but can be useful to other software running on your local network.


== "GET" approach ==
== "GET" approach ==
5,838

edits