diff --git a/config_readme.md b/config_readme.md index 7009eab..56f3736 100644 --- a/config_readme.md +++ b/config_readme.md @@ -108,12 +108,12 @@ roles = admin #### Data Source Platforms DashMachine includes several different 'platforms' for displaying data on your dash applications. -Platforms are essentially plugins. All data source config entries require the `plaform` variable, +Platforms are essentially plugins. All data source config entries require the `platform` variable, which tells DashMachine which platform file in the platform folder to load. **Note:** you are able to -load your own plaform files by placing them in the platform folder and referencing them in the config. +load your own platform files by placing them in the platform folder and referencing them in the config. However currently they will be deleted if you update the application, if you would like to make them permanent, submit a pull request for it to be added by default! > To add a data source to your app, add a data source config entry from one of the samples below **above** the application entry in config.ini, then add the following to your app config entry: -`data_source = variable_name` \ No newline at end of file +`data_source = variable_name` diff --git a/dashmachine/platform/deluge.py b/dashmachine/platform/deluge.py index 0f6bb65..29c1845 100644 --- a/dashmachine/platform/deluge.py +++ b/dashmachine/platform/deluge.py @@ -14,7 +14,7 @@ password = MySecretPassword | Variable | Required | Description | Options | |-----------------|----------|-----------------------------------------------------------------|-------------------| | [variable_name] | Yes | Name for the data source. | [variable_name] | -| plaform | Yes | Name of the platform. | rest | +| platform | Yes | Name of the platform. | rest | | resource | Yes | Url of your deluge instance + '/json' | url | | value_template | Yes | Jinja template for how the returned data from api is displayed. | jinja template | | password | No | Password to use for auth. | string | diff --git a/dashmachine/platform/ping.py b/dashmachine/platform/ping.py index f182e5c..9a2067b 100644 --- a/dashmachine/platform/ping.py +++ b/dashmachine/platform/ping.py @@ -12,7 +12,7 @@ resource = 192.168.1.1 | Variable | Required | Description | Options | |-----------------|----------|-----------------------------------------------------------------|-------------------| | [variable_name] | Yes | Name for the data source. | [variable_name] | -| plaform | Yes | Name of the platform. | rest | +| platform | Yes | Name of the platform. | rest | | resource | Yes | Url of whatever you want to ping | url | diff --git a/dashmachine/platform/rest.py b/dashmachine/platform/rest.py index ef8825c..372617b 100644 --- a/dashmachine/platform/rest.py +++ b/dashmachine/platform/rest.py @@ -18,7 +18,7 @@ payload = {"var1": "hi", "var2": 1} | Variable | Required | Description | Options | |-----------------|----------|-----------------------------------------------------------------|-------------------| | [variable_name] | Yes | Name for the data source. | [variable_name] | -| plaform | Yes | Name of the platform. | rest | +| platform | Yes | Name of the platform. | rest | | resource | Yes | Url of rest api resource. | url | | value_template | Yes | Jinja template for how the returned data from api is displayed. | jinja template | | method | No | Method for the api call, default is GET | GET,POST |