harmacist/DashMachine
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #38 from odinsride/odinsride-patch-1

Browse Source 
Fix typos in readme and platform files
This commit is contained in:
sportivaman 2020-03-18 20:46:33 -04:00 committed by GitHub
commit 80c622e1bb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
config_readme.md
View File

@ -108,9 +108,9 @@ roles = admin
#### Data Source Platforms #### Data Source Platforms
DashMachine includes several different 'platforms' for displaying data on your dash applications. 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 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 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! permanent, submit a pull request for it to be added by default!

2
dashmachine/platform/deluge.py
View File

@ -14,7 +14,7 @@ password = MySecretPassword
| Variable | Required | Description | Options | | Variable | Required | Description | Options |
|-----------------|----------|-----------------------------------------------------------------|-------------------| |-----------------|----------|-----------------------------------------------------------------|-------------------|
| [variable_name] | Yes | Name for the data source. | [variable_name] | | [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 | | 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 | | value_template | Yes | Jinja template for how the returned data from api is displayed. | jinja template |
| password | No | Password to use for auth. | string | | password | No | Password to use for auth. | string |

2
dashmachine/platform/ping.py
View File

@ -12,7 +12,7 @@ resource = 192.168.1.1
| Variable | Required | Description | Options | | Variable | Required | Description | Options |
|-----------------|----------|-----------------------------------------------------------------|-------------------| |-----------------|----------|-----------------------------------------------------------------|-------------------|
| [variable_name] | Yes | Name for the data source. | [variable_name] | | [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 | | resource | Yes | Url of whatever you want to ping | url |

2
dashmachine/platform/rest.py
View File

@ -18,7 +18,7 @@ payload = {"var1": "hi", "var2": 1}
| Variable | Required | Description | Options | | Variable | Required | Description | Options |
|-----------------|----------|-----------------------------------------------------------------|-------------------| |-----------------|----------|-----------------------------------------------------------------|-------------------|
| [variable_name] | Yes | Name for the data source. | [variable_name] | | [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 | | resource | Yes | Url of rest api resource. | url |
| value_template | Yes | Jinja template for how the returned data from api is displayed. | jinja template | | 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 | | method | No | Method for the api call, default is GET | GET,POST |