API Graph Data: Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search
No edit summary
No edit summary
 
Line 1: Line 1:
Back to [[Cumulus MX Local API]]
''Back to [[Cumulus MX Local API]]''


The general format of the graph data API request is as follows...
The general format of the graph data API request is as follows...
<pre>http://localhost:8998:/api/graphdata/xxxxx</pre>
<pre>http://localhost:8998:/api/graphdata/xxxxx</pre>

Latest revision as of 14:21, 18 October 2020

Back to Cumulus MX Local API


The general format of the graph data API request is as follows...

http://localhost:8998:/api/graphdata/xxxxx

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}
}

Example response

A truncated response for humdata.json...

{"hum":[[1602861480000,75],[1602861540000,75],[1602861600000,75],[1602861660000,74],....]}