Requires opCharts-4.0.9 and Above.
opCharts can display tabular data from most JSON endpoints which required no authentication or support token / bearer header tokens.
In this example we are showing weather data from the Gold Coast using the openweathermap.org API
| Key | Required | Description |
|---|---|---|
| Name |   | Name of the component which is shown under the opCharts data sources when creating a dashboard |
| data_source_type | | remote_json is used for opCharts to know it needs to make this type of request |
| model_view | | opmantek-remote-json for the table view, opmantek-pie to show the data in a pie chart |
| options.titleText | | Title of the component shown on the dashboard |
| remote_paramaters.url | | URL of your endpoint which returns JSON data |
| remote_paramaters.auth_type | ||
| remote_paramaters.data_key | ||
| remote_paramaters.pagination | server or client, defaults to server | |
| remote_paramaters.log_request | true or false, omkd_log_level also has to be debug for the web request to written into opCharts.log | |
| private.token | Opmantek Token Auth | |
| table_schema | opCharts 3.2.2 - Customising Table Columns | |
| external_url | Hyperlink which displays on the top right of the component | |
| external_url_label | Label for the hyperlink | |
| showLegend | Pie View only, default to true, use false to hide the legen |
/usr/local/omk/lib/json/opCharts/components.d
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"name": "Weather in Gold Coast, AU",
"data_source_type" : "remote_json",
"model_view" : "opmantek-remote-json",
"options": {
"titleText": "Weather in Gold Coast, AU"
},
"remote_paramaters": {
"pagination": "client",
"url": "https://api.openweathermap.org/data/2.5/forecast?id=2165087&APPID=__YOUR__API__KEY__&units=metric",
"data_key": "list"
},
"table_schema": [
{ "name": "dt",
"label": "Timestamp",
"cell": "String",
"formatter": "UnixTime",
"editable": false
},
{ "name": "wind.speed",
"label": "Wind Speed",
"cell": "ColouredByLevel",
"levels": ["red", 75, "orange", 50, "yellow", 25, "green", 0],
"editable": false
},
{ "name": "main.temp",
"label": "Temp",
"cell": "ColouredByLevel",
"editable": false,
"levels": ["red", 30, "orange", 25, "yellow", 18, "green", 0]
},
{ "name": "wind.deg",
"label": "Wind Direction",
"cell": "String",
"editable": false
},
{ "name": "main.pressure",
"label": "Pressure",
"cell": "String",
"editable": false
},
{ "name": "main.humidity",
"label": "Humidity",
"cell": "ColouredByLevel",
"levels": ["red", 75, "orange", 50, "yellow", 25, "green", 0],
"editable": false
},
{ "name": "weather.0.description",
"label": "Forcast",
"cell": "String",
"editable": false
}
]
}
|
...
The first step to create a new component is to add the json descriptor file in the path (A content example can be seen in the example above):
| Code Block |
|---|
omk/lib/jsonconf/opCharts/components.d/new_component.json |
Once the file is created it can be used as a component in a Dashboard.
