Settings cleanup, docs and strings, Removal of ENABLE_ARPSCAN

This commit is contained in:
Jokob-sk
2023-08-16 08:01:56 +10:00
parent c8bae60060
commit a3359dbec4
11 changed files with 40 additions and 28 deletions

View File

@@ -463,7 +463,8 @@ Required attributes are:
- `"localized"` - a list of properties on the current JSON level which need to be localized
- `"name"` and `"description"` - Displayed on the Settings page. An array of localized strings. (see Localized strings below).
- (optional) `"events"` - `<test|run>` - to generate an execution button next to the input field of the setting (not fully tested)
- (optional) `"override_value"` - used to determine a user-defined override for the setting. Useful for template-based plugins, where you can choose to leave the current value or override it with the value defined in the setting. (wip)
- (optional) `"override_value"` - used to determine a user-defined override for the setting. Useful for template-based plugins, where you can choose to leave the current value or override it with the value defined in the setting. (work in progress)
- (optional) `"events": ["run", "test"]` - used to trigger the plugin. Usually used on the `RUN` setting. Not fully tested in all scenarios. Will show a play button next to the setting and then after clicking an event is generated for the backend in the `Parameters` database table to process the front-end event on the next run.
##### Supported settings `function` values

View File

@@ -19,11 +19,11 @@
"display_name": [
{
"language_code": "en_us",
"string": "Network scan (Arp-Scan)"
"string": "Arp-Scan (Network scan)"
},
{
"language_code": "es_es",
"string": "Escaneo de red (Arp-Scan)"
"string": "Arp-Scan (Escaneo de red)"
}
],
"icon": [
@@ -60,6 +60,7 @@
"default_value":"schedule",
"options": ["disabled", "once", "schedule", "always_after_scan", "on_new_device"],
"localized": ["name", "description"],
"events": ["run"],
"name" :[
{
"language_code":"en_us",

View File

@@ -17,7 +17,7 @@
"mapped_to_table": "DHCP_Leases",
"display_name" : [{
"language_code":"en_us",
"string" : "DHCP Leases"
"string" : "DHCP Leases (Device import)"
}],
"icon":[{
"language_code":"en_us",

View File

@@ -19,7 +19,7 @@
"display_name": [
{
"language_code": "en_us",
"string": "Network scan (PiHole)"
"string": "PiHole (Device sync)"
}
],
"icon": [
@@ -31,7 +31,7 @@
"description": [
{
"language_code": "en_us",
"string": "This plugin is to import devices from PiHole"
"string": "This plugin syncs devices from the PiHole database"
}
],
"params" : [