Skip to main content

Detection and Privacy

Report undocumented sensor and panel statuses back to the author so support for new devices can be added, with personally identifiable fields automatically redacted before anything is sent.

How Detection Works

The plugin has a built-in feature that notifies the author when it detects anomalies in sensor states and panel statuses.

  • Notifications are triggered when a status is encountered that the plugin does not yet recognize.
  • Undocumented statuses are the primary trigger, since the author needs the raw values to add support for new devices and states.

The plugin adheres to the verified Homebridge plugin requirements, so it does not track you in any way.

Privacy Redaction

Any personally identifiable details in a report are redacted before the information leaves your system.

Redacted fields are replaced with the literal string *** REDACTED FOR PRIVACY ***, because these values are not needed to improve the plugin.

Field typeDescription
IP addressesBroadband, device, and router LAN/WAN addresses.
MAC addressesBroadband and device hardware addresses.
Serial numbersHardware serial numbers reported by the gateway.
Update timesLast and next scheduled update timestamps.
Master codeThe security panel's master access code shown on the portal.
Session tokensThe sat authentication token embedded in scraped portal requests.

Privacy Warnings

A warning is issued each time you might send a report, so the redaction behavior is never a surprise.

  • The warning appears when you use the included scripts, when the plugin starts, and when the plugin is about to notify the author.
  • The reminder restates that identifying fields are redacted before any information is sent.

Example Report

Here is an example of the information the author sees when the plugin detects unknown statuses from the gateway.

json
{
  "communication": {
    "broadbandConnectionStatus": "Active",
    "cellularConnectionStatus": "N/A",
    "cellularSignalStrength": "N/A",
    "primaryConnectionType": "Broadband"
  },
  "manufacturer": "ADT Pulse Gateway",
  "model": "PGZNG1",
  "network": {
    "broadband": {
      "ip": "*** REDACTED FOR PRIVACY ***",
      "mac": "*** REDACTED FOR PRIVACY ***"
    },
    "device": {
      "ip": "*** REDACTED FOR PRIVACY ***",
      "mac": "*** REDACTED FOR PRIVACY ***"
    },
    "router": {
      "lanIp": "*** REDACTED FOR PRIVACY ***",
      "wanIp": "*** REDACTED FOR PRIVACY ***"
    }
  },
  "serialNumber": "*** REDACTED FOR PRIVACY ***",
  "status": "Online",
  "update": {
    "last": "*** REDACTED FOR PRIVACY ***",
    "next": "*** REDACTED FOR PRIVACY ***"
  },
  "versions": {
    "firmware": "1.0.0-9",
    "hardware": "HW=2, BL=1.0.0, PL=1.0.0, SKU=12345"
  }
}

The unredacted fields, such as connection status, model, firmware, and hardware version, are the values that describe the undocumented status itself.

Raw HTML Reports

In some scenarios, the plugin identifies anomalies while parsing portal data rather than reading a known status.

  • These reports may contain raw HTML data, which is redacted in your local logs.
  • The raw HTML sent to the author remains unfiltered, so undocumented portal layouts can be updated promptly.

Opting Out

You can prevent this functionality by blocking the URL that the plugin uses to notify the author.

warning

If you block the notification URL, the author will not be able to offer assistance or support, since the plugin can no longer report the undocumented statuses it needs to diagnose issues.

View on GitHub