Cumulus MX Local API: Difference between revisions

1,997 bytes removed ,  14:16, 18 October 2020
no edit summary
(Add graph data)
No edit summary
Line 44: Line 44:
== Predetermined Data ==
== Predetermined Data ==
=== Graph Data ===
=== Graph Data ===
Cumulus MX will return graph data on request, it is formatted as JSON
Cumulus MX will return graph data on request, it is formatted as JSON, please refer to this page [[API Graph Data]]
 
The general format of the request is as follows...
<pre>http://localhost:8998:/api/graphdata/xxxxx</pre>
Where xxxx is the specific request as below:
==== tempdata.json ====
Returns inside temp, dew point, apparent temp, feels like, wind chill, heat index, outdoor temp as a JSON object, each value is an array of timestamp (JavaScript number) and value pairs...
{
    "intemp": [[timestamp1,value1],[timestamp2,value2]...],
    "dew": [[timestamp1,value1],[timestamp2,value2]...],
    "apptemp": [[timestamp1,value1],[timestamp2,value2]...],
    "feelslike": [[timestamp1,value1],[timestamp2,value2]...],
    "wchill": [[timestamp1,value1],[timestamp2,value2]...],
    "heatindex": [[timestamp1,value1],[timestamp2,value2]...],
    "temp": [[timestamp1,value1],[timestamp2,value2]...]
}
==== winddata.json ====
Same as temp data...
{
    "wgust": [[,],[,]...],
    "wspeed": [[,],[,]...]
}
==== raindata.json ====
Same as temp...
{
    "rfall": [[,],[,]...],
    "rrate": [[,],[,]...]
}
==== pressdata.json ====
Same as temp...
{
    "press": [[,],[,]...]
}
==== wdirdata.json ====
Same as temp...
{
    "bearing": [[,],[,]...],
    "avgbearing": [[,],[,]...]
}
==== humdata.json ====
Same as temp...
{
    "hum": [[,],[,]...],
    "inhum": [[,],[,]...]
}
==== solardata.json ====
Same as temp...
{
    "UV": [[,],[,]...],
    "SolarRad": [[,],[,]...],
    "CurrentSolarMax": [[,],[,]...]
}
==== sunhours.json ====
Same as temp...
{
    "sunshours": [[,],[,]...]
}
==== dailyrain.json ====
Same as temp...
{
    "dailyrain": [[,],[,]...]
}
==== dailytemp.json ====
{
    "mintemp": [[,],[,]...],
    "maxtemp": [[,],[,]...],
    "avgtemp": [[,],[,]...]
}
==== units.json or graphconfig.json ====
Returns the units of measurement used for the graph values above.
{
    "temp": {"units": "C|F", "decimals": 0|1|2},
    "wind": {"units": "windunit", "decimals": N},
    "rain": {"units": "rainunit", "decimals": N},
    "press": {"units": "pressunit", "decimals": N},
    "hum": {decimals": N},
    "UV": {decimals": N}
}