homebridge-grumptech-netnanny

    1.4.2 • Public • Published

    Homebridge Net Nanny

    Homebridge Net Nanny, by GrumpTech, is a Homebridge dynamic platform plug-in that publishes metrics measuring the health of a network. This plugin was inspired by Dave Hamilton's, of the Mac Observer, 3-Ping strategy for evaluating network health.

    Change Log

    The change history can be viewed here

    Security Policy

    Please refer to our security policy for information on which versions are receiving security updates and how to report security vulnerabilities.

    Installation

    This plug-in is intended to be used with the homebridge-config-ui-x homebridge management tool. If using homebridge-config-ui-x, simply search for homebridge-grumptech-netnanny for installation, plug-in management, and configuration.

    To install the plugin manually:
    npm install -g homebridge-grumptech-netnanny

    Configuration

    homebridge-config-ui-x

    This plugin is best experienced when running as a module installed and managed by the homebridge-config-ui-x plugin. When running under homebridge-config-ui-x, visiting the plugin settings will allow you to change the polling interval and the low space alarm threshold, as shown below.
    homebridge-config-ui-x plugin settings screen for Net Nanny homebridge-config-ui-x plugin configuration JSON settings for Net Nanny (Page 1) homebridge-config-ui-x plugin configuration JSON settings for Net Nanny (Page 2)
    For details on the configuration settings, please refer to the Configuration Settings section below.

    Additionally, especially if this system will be running other homebridge modules, it is strongly encouraged to run this plugin as an isolated child bridge. This setting page can be found by clicking on the wrench icon on the plugin and then selecting Bridge Settings. With the child bridge enabled, revisiting the setting page after homebridge is rebooted will show a QR code for pairing to the child bridge. The username (mac address) and port are randomly generaged by homebridge-config-ui-x.
    homebridge-config-ui-x plugin configuration showing the child bridge disabled homebridge-config-ui-x plugin configuration showing the child bridge active (unpaired)

    Configuration Settings

    Setting Description Field Name Parameter Type Data Type Units Default Minimum or Allowed Values Maximum Comments
    Ping Period The time, in seconds, to initiate a series of ping requests. ping_period Common Number Time:seconds 20 6 N/A
    Ping Interval The time, in seconds, between each ping request. ping_interval Common Number Time:seconds 1 1 N/A
    Ping Count The number of ping request for each series. ping_count Common Number Count 5 3 N/A
    Packet Size The size, in bytes, of each ping request. packet_size Common Number Bytes 56 56 N/A
    Target Type Type of target. ping_targets:items:target_type Per Target String N/A ipv4 uri, ipv4, ipv6, gateway, cable_modem
    Target Destination Destination for the ping ping_targets:items:target_dest Per Target String Not applicable for gateway or cable_modem
    Packet Loss Limit The limit, in percent, of lost packets that will be tolerated. ping_targets:items:loss_limit Per Target Number Percent 5 0 100
    Expected Latency The expected latency, in milliseconds, for the ping. ping_targets:items:expected_latency Per Target Number Time:milliseconds 10 >0 N/A
    Expected Jitter The expected jitter, in milliseconds, of the ping latency. ping_targets:items:expected_jitter Per Target Number Time:milliseconds 1 >0 N/A
    Peak Expiration Time The time, in hours, used to reset the peak values. ping_targets:items:peak_expiration Per Target Number Time:hours 12 0 N/A
    Data Filter Time Window The time, in seconds, over which to filter the ping results. data_filter_time_window Per Target Number Time:seconds 180 6 N/A Values less than the 'Ping Period' will be ignored.
    Sensor Alert Indicates which of the Carbon Dioxide sensors issue CO2 aleets when the data exceeds specified limits. sensor_alert_mask Per Target Number Bitmask 7 0 7 Bit#0:Time, Bit#1:Packet Loss; Bit#2:Standard Deviation

    Manual Configuration

    If you would rather manually configure and run the plugin, you will find a sample config.json file in the ./config folder. It is left to the user to get the plugin up and running within homebridge. Refer to the section above for specifics on the configuration parameters.

    Usage

    The plugin will create, or restore, a dynamic accessory for each network target specified in the configuration. Each accessory will advertise four services: (1) switch, and (3) carbon dioxide sensors. All of the data presented for the carbon dioxide sensors is the result of the ping results. In an effort to keep outliers from affecting the reported values, a user-specified number of outliers will be excluded from the moving average computation. The outliners that are excluded alternate between the highest then lowest values until the number of values to exclude has been reached.

    • Power: A switch, with the name of the Target Destination, that controls the active state of the network performance target.
    • Latency: The average ping latency, in milliseconds. The peak value is also displayed. Alerts are triggered when the reported value exceeds: Expected Latency + (3 * Expected Jitter)
    • Jitter: The jitter, in milliseconds, of the ping latency results. The peak value is also displayed. Alerts are triggered when the reported value exceeds: Expected Jitter
    • Packet Loss: The packet loss, in percent. The peak value is also displayed. Alerts are triggered when the reported value exceeds: Packet Loss Limit

    When the current value for any of the carbon dioxide sensors exceeds the user-specified expected limits, the sensor’s alert will be set and, in addition, the sensor’s Detected value will be set to abnormal levels, if configured. Each Carbon Dioxide sensor can be configured to not set the Detected value to abnormal when a fault is encountered. Setting the Detected value to abnormal levels should result in am alert noticiation from HomeKit.

    Because the ping results can be noisy, the results are filtered using the AVT (Antonyan Vardan Transform) algorithm. The amount of data considered in the filter is implicitly set via the Data Filter Time Window configuration parameter on each network target. The size of the data buffer is computed as the ratio Data Filter Time Window to Ping Period. The larger this ratio, the more ping results that will be considered in the filter. The value reported by the filter is the median value after excluding the data points that are beyond one standard deviation. Therefore, one can assume that the alerts will not be detected until at least half of the Data Filter Time Window has elapsed with raw results that exceed the user specified limits. This should have the tendency to limit false positive detections. However, if the ratio is too small (not enough data in the buffer), then the reporting will be more responsive and alerts will be issued for transient glitches in the network performance that do not necessarially indicate a systemic problem.

    It should also be noted, that the Detected value will not be set to abnormal until the Data Filter Time Window has elapsed after startup. This will prevent an occasional bad result from immediately resulting in the detection of abnormal carbon dioxide levels at startup.

    When the accessory is inactive, the Active and Low Battery Status are set.

    Restrictions

    This module operates by using shell commands to the ping and route programs. At this time, the plugin assumes macOS output when parsing the results. While the ping output is consistent across operating systems, the route output is operating system specific. As a result, the gateway/router type selection is limited to macOS.

    Known Issues and Planned Enhancements

    Refer to the bugs and enhancements listed here

    Contributing

    1. Fork it!
    2. Create your feature/fix branch: git checkout -b my-new-feature
    3. Commit your changes: git commit -am 'Add some feature'
    4. Push to the branch: git push origin my-new-feature
    5. Submit a pull request

    Credits

    Many thanks to all the folks contributing to Homebridge and to oznu for homebridge-config-ui-x, allowing for the possibility of this sort of fun and learning.
    Special thanks to Dave Hamilton's, John F. Braun, and the MacGeekGab podcast for inspiring the idea for this plugin.

    License

    Refer to LICENSE.md for information regarding licensincg of this source code.

    Install

    npm i homebridge-grumptech-netnanny

    DownloadsWeekly Downloads

    4

    Version

    1.4.2

    License

    ISC

    Unpacked Size

    472 kB

    Total Files

    13

    Last publish

    Collaborators

    • pricemi115