NetAlertX/front/plugins/newdev_template/config.json

{    
  "code_name": "newdev_template",
  "template_type": "database-entry",
  "unique_prefix": "NEWDEV",
  "plugin_type": "system",
  "enabled": true,
  "data_source": "template",  
  "show_ui": false,
  "localized": ["display_name", "description", "icon"],
  "display_name": [{
      "language_code": "en_us",
      "string": "New Devices"
    }],
  "description": [{
    "language_code": "en_us",
    "string": "The template used for new devices."
  }],
  "icon": [
    {
      "language_code": "en_us",
      "string": "<i class=\"fa fa-plus\"></i>"
    }
  ],
  "settings":[
        {
          "function": "ignored_MACs",
          "type": "list",
          "default_value": [
          ],
          "options": [],
          "localized": ["name", "description"],
          "name": [
            {
              "language_code": "en_us",
              "string": "Ignored MACs"
            }
          ],
          "description": [
            {
              "language_code": "en_us",
              "string": "List of MACs to ignore. Use <code>%</code> as a wildcard. Ignored devices will not be shown anywhere in the UI or notifications. <br/><br/>For example <code>02:42:ac:%</code> to filter out docker containers."
            }
          ]
        },
        {
          "function": "ignored_IPs",
          "type": "list",
          "default_value": [
          ],
          "options": [],
          "localized": ["name", "description"],
          "name": [
            {
              "language_code": "en_us",
              "string": "Ignored IPs"
            }
          ],
          "description": [
            {
              "language_code": "en_us",
              "string": "List of IPs to ignore. Use <code>%</code> as a wildcard. Ignored devices will not be shown anywhere in the UI or notifications. <br/><br/>For example <code>192.168.3.%</code> to filter out an IP range."
            }
          ]
        },
        {
          "function": "dev_MAC",
          "type": "readonly",
          "maxLength": 50,
          "default_value": "",
          "options": [],
          "localized": ["name", "description"],
          "name": [
            {
              "language_code": "en_us",
              "string": "Device MAC"
            }
          ],
          "description": [
            {
              "language_code": "en_us",
              "string": "The MAC address of the device. Uneditable - Autodetected."
            }
          ]
        },
        {
          "function": "dev_Name",
          "type": "readonly",
          "maxLength": 50,
          "default_value": "(unknown)",
          "options": [],
          "localized": ["name", "description"],
          "name": [
            {
              "language_code": "en_us",
              "string": "Device Name"
            }
          ],
          "description": [
            {
              "language_code": "en_us",
              "string": "The name of the device. Uneditable as internal functionality is dependent on specific new device names."
            }
          ]
        },
        {
          "function": "dev_Owner",
          "type": "string",
          "maxLength": 30,
          "default_value": "House",
          "options": [],
          "localized": ["name", "description"],
          "name": [
            {
              "language_code": "en_us",
              "string": "Device Owner"
            }
          ],
          "description": [
            {
              "language_code": "en_us",
              "string": "The owner of the device."
            }
          ]
        },
        {
          "function": "dev_DeviceType",
          "type": "text.select",
          "maxLength": 30,
          "default_value": "{value}",
          "options": [],
          "options_params" : [
            {
              "name"  : "value",
              "type"  : "sql",
              "value" : "SELECT '' as id, '' as name UNION SELECT dev_DeviceType as id, dev_DeviceType as name FROM (SELECT dev_DeviceType FROM Devices UNION SELECT 'Smartphone' UNION SELECT 'Tablet' UNION SELECT 'Laptop' UNION SELECT 'PC' UNION SELECT 'Printer' UNION SELECT 'Server' UNION SELECT 'NAS' UNION SELECT 'Domotic' UNION SELECT 'Game Console' UNION SELECT 'SmartTV' UNION SELECT 'Clock' UNION SELECT 'House Appliance' UNION SELECT 'Phone' UNION SELECT 'AP' UNION SELECT 'Gateway' UNION SELECT 'Firewall' UNION SELECT 'Switch' UNION SELECT 'WLAN' UNION SELECT 'Router' UNION SELECT 'Other') AS all_devices ORDER BY id;"
            },
            {
              "name"  : "uilang",
              "type"  : "setting",
              "value" : "UI_LANG"
            }
          ],
          "localized": ["name", "description"],
          "name": [
            {
              "language_code": "en_us",
              "string": "Device Type"
            }
          ],
          "description": [
            {
              "language_code": "en_us",
              "string": "The type of the device."
            }
          ]
        },
         {
          "function": "dev_Vendor",
          "type": "readonly",
          "maxLength": 250,
          "default_value": "",
          "options": [],
          "localized": ["name", "description"],
          "name": [
            {
              "language_code": "en_us",
              "string": "Device Vendor"
            }
          ],
          "description": [
            {
              "language_code": "en_us",
              "string": "The vendor of the device. Uneditable - Autodetected."
            }
          ]
        },
        {
          "function": "dev_Favorite",
          "type": "integer.checkbox",
          "default_value": 0,
          "options": [],
          "localized": ["name", "description"],
          "name": [
            {
              "language_code": "en_us",
              "string": "Favorite Device"
            }
          ],
          "description": [
            {
              "language_code": "en_us",
              "string": "Indicates whether the device is marked as a favorite."
            }
          ]
        },
        {
          "function": "dev_Group",
          "type": "string",
          "maxLength": 10,
          "default_value": "",
          "options": [],
          "localized": ["name", "description"],
          "name": [
            {
              "language_code": "en_us",
              "string": "Device Group"
            }
          ],
          "description": [
            {
              "language_code": "en_us",
              "string": "The group to which the device belongs."
            }
          ]
        },
         {
          "function": "dev_Comments",
          "type": "string",
          "default_value": "",
          "options": [],
          "localized": ["name", "description"],
          "name": [
            {
              "language_code": "en_us",
              "string": "Device Comments"
            }
          ],
          "description": [
            {
              "language_code": "en_us",
              "string": "Additional comments or notes about the device."
            }
          ]
        },
        {
          "function": "dev_FirstConnection",
          "type": "readonly",
          "format": "date-time",
          "default_value": "",
          "options": [],
          "localized": ["name", "description"],
          "name": [
            {
              "language_code": "en_us",
              "string": "First Connection"
            }
          ],
          "description": [
            {
              "language_code": "en_us",
              "string": "The date and time of the first connection with the device. Uneditable - Autodetected."
            }
          ]
        },
        {
          "function": "dev_LastConnection",
          "type": "readonly",
          "format": "date-time",
          "default_value": "",
          "options": [],
          "localized": ["name", "description"],
          "name": [
            {
              "language_code": "en_us",
              "string": "Last Connection"
            }
          ],
          "description": [
            {
              "language_code": "en_us",
              "string": "The date and time of the last connection with the device. Uneditable - Autodetected."
            }
          ]
        },
        {
          "function": "dev_LastIP",
          "type": "readonly",
          "maxLength": 50,
          "default_value": "",
          "options": [],
          "localized": ["name", "description"],
          "name": [
            {
              "language_code": "en_us",
              "string": "Last IP"
            }
          ],
          "description": [
            {
              "language_code": "en_us",
              "string": "The last known IP address of the device. Uneditable - Autodetected."
            }
          ]
        },
        {
          "function": "dev_StaticIP",
          "type": "integer.checkbox",
          "default_value": 0,
          "options": [],
          "localized": ["name", "description"],
          "name": [
            {
              "language_code": "en_us",
              "string": "Static IP"
            }
          ],
          "description": [
            {
              "language_code": "en_us",
              "string": "Indicates whether the device has a static IP address."
            }
          ]
        },
        {
          "function": "dev_ScanCycle",
          "type": "integer.checkbox",
          "default_value": 1,
          "options": [],
          "localized": ["name", "description"],
          "name": [
            {
              "language_code": "en_us",
              "string": "Scan Cycle"
            }
          ],
          "description": [
            {
              "language_code": "en_us",
              "string": "The default value of the <code>Scan device</code> dropdown. Enable if newly discovered devices should be scanned."
            }
          ]
        },
        {
          "function": "dev_LogEvents",
          "type": "integer.checkbox",
          "default_value": 1,
          "options": [],
          "localized": ["name", "description"],
          "name": [
            {
              "language_code": "en_us",
              "string": "Log Events"
            }
          ],
          "description": [
            {
              "language_code": "en_us",
              "string": "Indicates whether events related to the device shouldbe logged."
          }]
        },
        {
          "function": "dev_AlertEvents",
          "type": "integer.checkbox",
          "default_value": 1,
          "options": [],
          "localized": ["name", "description"],
          "name": [
            {
              "language_code": "en_us",
              "string": "Alert Events"
            }
          ],
          "description": [
            {
              "language_code": "en_us",
              "string": "Indicates whether events related to the device should trigger alerts. The default value of the <code>Alert All Events</code> checkbox."
            }
          ]
        },
        {
          "function": "dev_AlertDeviceDown",
          "type": "integer.checkbox",
          "default_value": 0,
          "options": [],
          "localized": ["name", "description"],
          "name": [
            {
              "language_code": "en_us",
              "string": "Alert Device Down"
            }
          ],
          "description": [
            {
              "language_code": "en_us",
              "string": "Indicates whether an alert should be triggered when the device goes down. The default value of the <code>Alert Down</code> checkbox."
            }
          ]
        },
        {
          "function": "dev_SkipRepeated",
          "type": "integer",
          "default_value": 0,
          "options": [],
          "localized": ["name", "description"],
          "name": [
            {
              "language_code": "en_us",
              "string": "Skip Repeated"
            }
          ],
          "description": [
            {
              "language_code": "en_us",
              "string": "The default value of the <code>Skip repeated notifications for</code> dropdown. Enter number of <b>hours</b> for which repeated notifications should be ignored for. If you enter <code>0</code> then you get notified on all events."
            }
          ]
        },
        {
          "function": "dev_LastNotification",
          "type": "readonly",
          "format": "date-time",
          "default_value": "",
          "options": [],
          "localized": ["name", "description"],
          "name": [
            {
              "language_code": "en_us",
              "string": "Last Notification"
            }
          ],
          "description": [
            {
              "language_code": "en_us",
              "string": "The date and time of the last notification sent for the device. Uneditable - Autodetected."
            }
          ]
        },
       {
          "function": "dev_PresentLastScan",
          "type": "integer.checkbox",
          "default_value": 1,
          "options": [],
          "localized": ["name", "description"],
          "name": [
            {
              "language_code": "en_us",
              "string": "Present Last Scan"
            }
          ],
          "description": [
            {
              "language_code": "en_us",
              "string": "Indicates whether the device should be marked as present after detected in a scan."
            }
          ]
        },
        {
          "function": "dev_NewDevice",
          "type": "integer.checkbox",
          "default_value": 1,
          "options": [],
          "localized": ["name", "description"],
          "name": [
            {
              "language_code": "en_us",
              "string": "New Device"
            }
          ],
          "description": [
            {
              "language_code": "en_us",
              "string": "Indicates whether the device is considered a new device. The default value of the <code>New Device</code> checkbox. If checked this will show the New status for the device and include it in lists when the New Devices filter is active. Doesn't affect notifications."
            }
          ]
        },
         {
          "function": "dev_Location",
          "type": "string",
          "maxLength": 250,
          "default_value": "",
          "options": [],
          "localized": ["name", "description"],
          "name": [
            {
              "language_code": "en_us",
              "string": "Device Location"
            }
          ],
          "description": [
            {
              "language_code": "en_us",
              "string": "The location of the device."
            }
          ]
        },
        {
          "function": "dev_Archived",
          "type": "integer.checkbox",
          "default_value": 0,
          "options": [],
          "localized": ["name", "description"],
          "name": [
            {
              "language_code": "en_us",
              "string": "Archived"
            }
          ],
          "description": [
            {
              "language_code": "en_us",
              "string": "Indicates whether the device is archived. The default value of the <code>Archived</code> checkbox."
            }
          ]
        },
        {
          "function": "dev_Network_Node_MAC_ADDR",
          "type": "text.select",
          "default_value": "{value}",
          "options": [],
          "options_params" : [
            {
              "name"  : "value",
              "type"  : "sql",
              "value" : "SELECT '' as name, '' as id UNION SELECT Dev_Name as name, dev_MAC as id FROM Devices WHERE EXISTS (SELECT 1 FROM Settings WHERE Code_Name = 'NETWORK_DEVICE_TYPES' AND LOWER(value) LIKE '%' || LOWER(dev_DeviceType) || '%' AND dev_DeviceType <> '')"
            },
            {
              "name"  : "target_macs",
              "type"  : "setting",
              "value" : "KNWN_target_macs"
            }
          ],
          "localized": ["name", "description"],
          "name": [
            {
              "language_code": "en_us",
              "string": "Network Node MAC Address"
            }
          ],
          "description": [
            {
              "language_code": "en_us",
              "string": "The MAC address of the network node."
            }
          ]
        },
         {
          "function": "dev_Network_Node_port",
          "type": "readonly",
          "default_value": 0,
          "options": [],
          "localized": ["name", "description"],
         "name": [
            {
              "language_code": "en_us",
              "string": "Network Node Port"
            }
          ],
          "description": [
            {
              "language_code": "en_us",
              "string": "The port number of the network node. Uneditable."
            }
          ]
        },
         {
          "function": "dev_Icon",
          "type": "string",
          "default_value": "",
          "options": [],
          "localized": ["name", "description"],
          "name": [
            {
              "language_code": "en_us",
              "string": "Device Icon"
            }
          ],
          "description": [
            {
              "language_code": "en_us",
              "string": "The icon associated with the device. Check the <a href=\"https://github.com/jokob-sk/Pi.Alert/blob/main/docs/ICONS.md\" target=\"_blank\">documentation on icons</a> for more details."
            }
          ]
        }
  ],
    "required": [
      "dev_MAC",
      "dev_Name",
      "dev_Owner",
      "dev_FirstConnection",
      "dev_LastConnection",
      "dev_LastIP",
      "dev_StaticIP",
      "dev_ScanCycle",
      "dev_LogEvents",
      "dev_AlertEvents",
      "dev_AlertDeviceDown",
      "dev_SkipRepeated",
      "dev_LastNotification",
      "dev_PresentLastScan",
      "dev_NewDevice",
      "dev_Location",
      "dev_Archived",
      "dev_Network_Node_MAC_ADDR",
      "dev_Network_Node_port",
      "dev_Icon"
    ],
    "additionalProperties": false
  }