matterbridge-valetudo 1.0.2

package/matterbridge-valetudo.schema.json

@@ -0,0 +1,279 @@
+{
+  "title": "Matterbridge Valetudo Plugin Configuration",
+  "description": "Multi-vacuum support for Valetudo-enabled robot vacuums with automatic mDNS discovery",
+  "type": "object",
+  "required": ["name", "type"],
+  "properties": {
+    "name": {
+      "title": "Plugin Name",
+      "description": "Plugin identifier (read-only)",
+      "type": "string",
+      "readOnly": true
+    },
+    "type": {
+      "title": "Plugin Type",
+      "description": "Platform type (read-only)",
+      "type": "string",
+      "readOnly": true
+    },
+    "discovery": {
+      "title": "Auto-Discovery",
+      "description": "Automatic mDNS discovery of Valetudo vacuums on your network",
+      "type": "object",
+      "properties": {
+        "enabled": {
+          "title": "Enable Auto-Discovery",
+          "description": "Automatically find and add Valetudo vacuums on your network",
+          "type": "boolean",
+          "default": true
+        },
+        "timeout": {
+          "title": "Discovery Timeout (ms)",
+          "description": "How long to wait for mDNS responses (1000-30000ms)",
+          "type": "number",
+          "default": 5000,
+          "minimum": 1000,
+          "maximum": 30000
+        },
+        "scanIntervalSeconds": {
+          "title": "Periodic Scan Interval (seconds)",
+          "description": "Re-scan interval: 0 = scan once at startup, >0 = periodic scanning (useful for detecting new vacuums or IP changes)",
+          "type": "number",
+          "default": 300,
+          "minimum": 0,
+          "maximum": 86400
+        }
+      }
+    },
+    "vacuums": {
+      "title": "Manual Vacuum Configuration",
+      "description": "Manually add vacuums by IP address (works alongside auto-discovery)",
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": ["ip"],
+        "properties": {
+          "ip": {
+            "title": "IP Address",
+            "description": "Static IP address or hostname of the Valetudo vacuum",
+            "type": "string",
+            "pattern": "^(?:[0-9]{1,3}\\.){3}[0-9]{1,3}$|^[a-zA-Z0-9][a-zA-Z0-9-_.]*[a-zA-Z0-9]$"
+          },
+          "name": {
+            "title": "Custom Name",
+            "description": "Optional friendly name (defaults to manufacturer + model from vacuum)",
+            "type": "string"
+          },
+          "enabled": {
+            "title": "Enabled",
+            "description": "Enable or disable this vacuum",
+            "type": "boolean",
+            "default": true
+          }
+        }
+      },
+      "default": []
+    },
+    "pollingInterval": {
+      "title": "Polling Interval (ms)",
+      "description": "How often to check vacuum status (5000-60000ms, applies to all vacuums)",
+      "type": "number",
+      "default": 30000,
+      "minimum": 5000,
+      "maximum": 60000
+    },
+    "enableServerMode": {
+      "title": "Apple Home Server Mode",
+      "description": "Enable server mode (required for Apple Home support, creates separate QR code for each vacuum)",
+      "type": "boolean",
+      "default": false
+    },
+    "positionTracking": {
+      "title": "Position Tracking",
+      "description": "Track which room/area the vacuum is currently cleaning",
+      "type": "object",
+      "properties": {
+        "enabled": {
+          "title": "Enable Position Tracking",
+          "description": "Show current room/area during cleaning",
+          "type": "boolean",
+          "default": true
+        }
+      }
+    },
+    "consumables": {
+      "title": "Consumables Tracking",
+      "description": "Monitor brush, filter, and sensor lifetime (applies to all vacuums)",
+      "type": "object",
+      "properties": {
+        "enabled": {
+          "title": "Enable Consumable Tracking",
+          "description": "Track and log consumable status",
+          "type": "boolean",
+          "default": true
+        },
+        "warningThreshold": {
+          "title": "Warning Threshold (%)",
+          "description": "Trigger warning when lifetime falls below this percentage (0-100)",
+          "type": "number",
+          "default": 10,
+          "minimum": 0,
+          "maximum": 100
+        },
+        "exposeAsContactSensors": {
+          "title": "Expose as Contact Sensors",
+          "description": "Create contact sensors for each consumable (open = needs replacement, closed = OK)",
+          "type": "boolean",
+          "default": false
+        },
+        "maxLifetimes": {
+          "title": "Maximum Lifetimes (minutes)",
+          "description": "Expected lifetime for each consumable type",
+          "type": "object",
+          "properties": {
+            "mainBrush": {
+              "title": "Main Brush",
+              "description": "Default: 18,000 minutes (300 hours)",
+              "type": "number",
+              "default": 18000,
+              "minimum": 60
+            },
+            "sideBrush": {
+              "title": "Side Brush",
+              "description": "Default: 12,000 minutes (200 hours)",
+              "type": "number",
+              "default": 12000,
+              "minimum": 60
+            },
+            "dustFilter": {
+              "title": "Dust Filter",
+              "description": "Default: 9,000 minutes (150 hours)",
+              "type": "number",
+              "default": 9000,
+              "minimum": 60
+            },
+            "sensor": {
+              "title": "Sensor Cleaning",
+              "description": "Default: 1,800 minutes (30 hours)",
+              "type": "number",
+              "default": 1800,
+              "minimum": 60
+            }
+          }
+        }
+      }
+    },
+    "intensityPresets": {
+      "title": "Intensity Presets (Advanced)",
+      "description": "Override default fan speed and water usage for each intensity level",
+      "type": "object",
+      "properties": {
+        "auto": {
+          "title": "Auto Intensity",
+          "type": "object",
+          "properties": {
+            "fanSpeed": {
+              "title": "Fan Speed",
+              "description": "e.g., 'low', 'medium', 'high', 'max'",
+              "type": "string",
+              "default": "medium"
+            },
+            "waterUsage": {
+              "title": "Water Usage",
+              "description": "For mop modes: 'min', 'low', 'medium', 'high', 'max'",
+              "type": "string",
+              "default": "medium"
+            }
+          }
+        },
+        "quiet": {
+          "title": "Quiet Intensity",
+          "type": "object",
+          "properties": {
+            "fanSpeed": {
+              "title": "Fan Speed",
+              "type": "string",
+              "default": "low"
+            },
+            "waterUsage": {
+              "title": "Water Usage",
+              "type": "string",
+              "default": "low"
+            }
+          }
+        },
+        "quick": {
+          "title": "Quick Intensity",
+          "type": "object",
+          "properties": {
+            "fanSpeed": {
+              "title": "Fan Speed",
+              "type": "string",
+              "default": "high"
+            },
+            "waterUsage": {
+              "title": "Water Usage",
+              "type": "string",
+              "default": "high"
+            }
+          }
+        },
+        "max": {
+          "title": "Max Intensity",
+          "type": "object",
+          "properties": {
+            "fanSpeed": {
+              "title": "Fan Speed",
+              "type": "string",
+              "default": "max"
+            },
+            "waterUsage": {
+              "title": "Water Usage",
+              "type": "string",
+              "default": "high"
+            }
+          }
+        }
+      }
+    },
+    "mapCache": {
+      "title": "Map Cache (Advanced)",
+      "description": "Cache configuration for efficient position tracking",
+      "type": "object",
+      "properties": {
+        "enabled": {
+          "title": "Enable Map Caching",
+          "description": "Reduce processing overhead during position tracking",
+          "type": "boolean",
+          "default": true
+        },
+        "refreshIntervalHours": {
+          "title": "Refresh Interval (hours)",
+          "description": "Hours between automatic cache refreshes (0.1-24)",
+          "type": "number",
+          "default": 1,
+          "minimum": 0.1,
+          "maximum": 24
+        },
+        "refreshOnError": {
+          "title": "Refresh on Error",
+          "description": "Auto-refresh cache when position tracking errors occur",
+          "type": "boolean",
+          "default": true
+        }
+      }
+    },
+    "debug": {
+      "title": "Debug Mode (Development)",
+      "description": "Enable verbose debug logging",
+      "type": "boolean",
+      "default": false
+    },
+    "unregisterOnShutdown": {
+      "title": "Unregister on Shutdown (Development)",
+      "description": "Remove all devices when plugin stops (development only)",
+      "type": "boolean",
+      "default": false
+    }
+  }
+}

package/matterbridge.svg

@@ -0,0 +1,50 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 296.2 296.2">
+    <defs>
+        <linearGradient id="lg1" x1="16.6" y1="16.6" x2="279.6" y2="279.6" gradientUnits="userSpaceOnUse">
+            <stop offset="0" stop-color="#00b48d" />
+            <stop offset=".1" stop-color="#3faa77" />
+            <stop offset=".3" stop-color="#234148" />
+            <stop offset=".7" stop-color="#203b44" />
+            <stop offset=".9" stop-color="#ad2e6e" />
+            <stop offset="1" stop-color="#c81b74" />
+        </linearGradient>
+        <linearGradient id="lg2" x1="31.1" y1="31.1" x2="265.1" y2="265.1" gradientUnits="userSpaceOnUse">
+            <stop offset="0" stop-color="#00b48d" />
+            <stop offset=".2" stop-color="#285251" />
+            <stop offset=".4" stop-color="#234148" />
+            <stop offset=".8" stop-color="#203b44" />
+            <stop offset=".9" stop-color="#a8316c" />
+            <stop offset="1" stop-color="#c81b74" />
+        </linearGradient>
+        <linearGradient id="lg3" x1="116.2" y1="143.9" x2="139.8" y2="143.9"
+            gradientUnits="userSpaceOnUse">
+            <stop offset="0" stop-color="#8bc751" />
+            <stop offset="1" stop-color="#0db14b" />
+        </linearGradient>
+        <linearGradient id="lg4" x1="136.1" y1="100.8" x2="159.6" y2="100.8"
+            xlink:href="#lg3" />
+        <linearGradient id="lg5" x1="155.3" y1="143.9" x2="178.9" y2="143.9"
+            xlink:href="#lg3" />
+        <linearGradient id="lg6" x1="46.8" y1="25.7" x2="89.6" y2="74.8" gradientUnits="userSpaceOnUse">
+            <stop offset="0" stop-color="#b1d34a" />
+            <stop offset="1" stop-color="#50b848" />
+        </linearGradient>
+    </defs>
+        <rect width="296.2" height="296.2" rx="56.7" ry="56.7" style="fill:url(#lg1)" />
+        <rect x="16.3" y="16.3" width="263.6" height="263.6" rx="50.5" ry="50.5" style="fill:url(#lg2)" />
+        <circle cx="128" cy="143.9" r="11.8" style="fill:url(#lg3)" />
+        <circle cx="147.8" cy="100.8" r="11.8" style="fill:url(#lg4)" />
+        <path
+            d="m244.6 114.5.4-.5L160 33a17 17 0 0 0-24.7-.5l-86.4 83.3a15 15 0 0 0 9.2 26.9h19.3v-4.7l-13.7-12.7v-.1l83.7-80.8 84.2 81-13.9 12.8v4.5h19.5a15 15 0 0 0 7.4-28.1Z"
+            style="fill:url(#lg3)" />
+        <circle cx="167.1" cy="143.9" r="11.8" style="fill:url(#lg5)" />
+        <path fill="#fff" d="M219 89.3V35.5a10.5 10.5 0 1 0-21 0v33.7l21 20Z" />
+        <path
+            d="M91.4 73.3H83a37 37 0 0 0-14.5-28.4L65 50.2c.1 0 12.6 9 11.7 25.4-5.3-.4-11.2-1.9-16.3-5.3-11.8-7.8-16-23.7-11.9-46 8.7 1.5 34 7 43 22.8 4.1 7.3 4.1 16.1 0 26.2Z"
+            style="fill:url(#lg6)" />
+        <path
+            d="M65.9 80a49.6 49.6 0 0 0 17.8 2.2l16.6-16c1.6-8.3.5-15.7-3.3-22.4C84.6 22 47.8 17.5 46.2 17.4l-3-.4-.6 3c-3.8 18.4-5.9 50.6 23.2 60ZM48.4 24.4c8.7 1.5 34 7 43 22.8 4.1 7.3 4.1 16.1 0 26.2H83a37 37 0 0 0-14.5-28.4l-3.7 5.3c.1 0 12.6 9 11.7 25.4-5.3-.4-11.2-1.9-16.3-5.3-11.9-7.8-16-23.7-11.9-46Z"
+            fill="#1e5857" />
+        <path fill="#fff"
+            d="M250.5 90.5a17.4 17.4 0 1 1 0-34.8 17.4 17.4 0 0 1 0 34.8Zm0-22.7a5.4 5.4 0 0 0 0 10.7 5.3 5.3 0 0 0 0-10.7ZM258.8 148.2a15.9 15.9 0 0 0-9.6 28.5c-.8 4.2-5.4 4.6-5.4 4.6h-26v-43l13.6-13-1.8-2-82.2-79-81.2 78.3-2.5 2.6 13.7 13v42.9H53a21.5 21.5 0 1 0 11.7 15h12.6v18.8c0 7.8 6.4 14.1 14.1 14.1h29.3v14.8H64a10.6 10.6 0 0 0-17.7 8 10.6 10.6 0 0 0 17.6 8h157.6a16.3 16.3 0 1 0 0-16h-84.8V229h66.8c7.8 0 14.2-6.3 14.2-14.1v-19.2h27.6c14.3 0 17.8-12.8 18.5-16.6a15.9 15.9 0 0 0-5-30.9ZM43.7 210.8a10.3 10.3 0 1 1 0-20.6 10.3 10.3 0 0 1 0 20.6Zm192 36a5 5 0 1 1 0 10 5 5 0 0 1 0-10Zm-77-34.8h-22v-34h22v34Zm8.4-79.8c2.7 0 5.2 1 7.2 2.5v-10.4L188 137s2.6 1.3 4.6 1.3h6.7v68c0 3.2-2.6 5.7-5.7 5.7h-19v-34h1.4a7.5 7.5 0 0 0 0-15H120a7.5 7.5 0 0 0 0 15h.7v34h-19.3a5.7 5.7 0 0 1-5.7-5.6v-68.1h6.7c2 0 4.6-1.3 4.6-1.3l13.7-12.7v10.4a11.7 11.7 0 0 1 16 1.6v-13a14.9 14.9 0 0 0-25-10.8s-.1.2-.1.2l-.5.5-6.9 7H92.5l55-53.2 55.1 53.2h-11.8l-7-7c0-.2-.2-.3-.4-.5l-.2-.2a14.8 14.8 0 0 0-25 10.9v12.9c2.2-2.5 5.3-4.1 8.9-4.1Zm91.7 36.7a4.9 4.9 0 1 1 0-9.7 4.9 4.9 0 0 1 0 9.7Z" />
+</svg>

package/npm-shrinkwrap.json

@@ -0,0 +1,127 @@
+{
+  "name": "matterbridge-valetudo",
+  "version": "1.0.2",
+  "lockfileVersion": 3,
+  "requires": true,
+  "packages": {
+    "": {
+      "name": "matterbridge-valetudo",
+      "version": "1.0.2",
+      "license": "Apache-2.0",
+      "dependencies": {
+        "multicast-dns": "^7.2.5",
+        "node-ansi-logger": "3.1.1",
+        "node-persist-manager": "2.0.0"
+      },
+      "engines": {
+        "node": ">=20.0.0 <21.0.0 || >=22.0.0 <23.0.0 || >=24.0.0 <25.0.0"
+      }
+    },
+    "node_modules/@leichtgewicht/ip-codec": {
+      "version": "2.0.5",
+      "resolved": "https://registry.npmjs.org/@leichtgewicht/ip-codec/-/ip-codec-2.0.5.tgz",
+      "integrity": "sha512-Vo+PSpZG2/fmgmiNzYK9qWRh8h/CHrwD0mo1h1DzL4yzHNSfWYujGTYsWGreD000gcgmZ7K4Ys6Tx9TxtsKdDw==",
+      "license": "MIT"
+    },
+    "node_modules/dns-packet": {
+      "version": "5.6.1",
+      "resolved": "https://registry.npmjs.org/dns-packet/-/dns-packet-5.6.1.tgz",
+      "integrity": "sha512-l4gcSouhcgIKRvyy99RNVOgxXiicE+2jZoNmaNmZ6JXiGajBOJAesk1OBlJuM5k2c+eudGdLxDqXuPCKIj6kpw==",
+      "license": "MIT",
+      "dependencies": {
+        "@leichtgewicht/ip-codec": "^2.0.1"
+      },
+      "engines": {
+        "node": ">=6"
+      }
+    },
+    "node_modules/multicast-dns": {
+      "version": "7.2.5",
+      "resolved": "https://registry.npmjs.org/multicast-dns/-/multicast-dns-7.2.5.tgz",
+      "integrity": "sha512-2eznPJP8z2BFLX50tf0LuODrpINqP1RVIm/CObbTcBRITQgmC/TjcREF1NeTBzIcR5XO/ukWo+YHOjBbFwIupg==",
+      "license": "MIT",
+      "dependencies": {
+        "dns-packet": "^5.2.2",
+        "thunky": "^1.0.2"
+      },
+      "bin": {
+        "multicast-dns": "cli.js"
+      }
+    },
+    "node_modules/node-ansi-logger": {
+      "version": "3.1.1",
+      "resolved": "https://registry.npmjs.org/node-ansi-logger/-/node-ansi-logger-3.1.1.tgz",
+      "integrity": "sha512-tFeCSxwiRg5XaNda5nC27alzraZP76nLtUk1JDZqb9byhW4WYaSGL7/lmxFHEI16gypQDMEYljuF+wcG+cPPHw==",
+      "hasShrinkwrap": true,
+      "license": "Apache-2.0",
+      "engines": {
+        "node": ">=18.0.0 <19.0.0 || >=20.0.0 <21.0.0 || >=22.0.0 <23.0.0 || >=24.0.0 <25.0.0"
+      },
+      "funding": {
+        "type": "buymeacoffee",
+        "url": "https://www.buymeacoffee.com/luligugithub"
+      }
+    },
+    "node_modules/node-persist": {
+      "version": "4.0.4",
+      "resolved": "https://registry.npmjs.org/node-persist/-/node-persist-4.0.4.tgz",
+      "integrity": "sha512-8sPAz/7tw1mCCc8xBG4f0wi+flHkSSgQeX998iQ75Pu27evA6UUWCjSE7xnrYTg2q33oU5leJ061EKPDv6BocQ==",
+      "license": "MIT",
+      "dependencies": {
+        "p-limit": "^3.1.0"
+      },
+      "engines": {
+        "node": ">=10.12.0"
+      }
+    },
+    "node_modules/node-persist-manager": {
+      "version": "2.0.0",
+      "resolved": "https://registry.npmjs.org/node-persist-manager/-/node-persist-manager-2.0.0.tgz",
+      "integrity": "sha512-jpgOqCCn4ZEnIr4WcvqkyyGmmLJarV6aUyBlDQdG1G84X9UUmOmI1W2OZtc9K0z375CYWhjtGEXaY7GXNiEOfA==",
+      "license": "MIT",
+      "dependencies": {
+        "node-persist": "4.0.4"
+      },
+      "engines": {
+        "node": ">=18.0.0 <19.0.0 || >=20.0.0 <21.0.0 || >=22.0.0 <23.0.0 || >=24.0.0 <25.0.0"
+      },
+      "funding": {
+        "type": "buymeacoffee",
+        "url": "https://www.buymeacoffee.com/luligugithub"
+      }
+    },
+    "node_modules/p-limit": {
+      "version": "3.1.0",
+      "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-3.1.0.tgz",
+      "integrity": "sha512-TYOanM3wGwNGsZN2cVTYPArw454xnXj5qmWF1bEoAc4+cU/ol7GVh7odevjp1FNHduHc3KZMcFduxU5Xc6uJRQ==",
+      "license": "MIT",
+      "dependencies": {
+        "yocto-queue": "^0.1.0"
+      },
+      "engines": {
+        "node": ">=10"
+      },
+      "funding": {
+        "url": "https://github.com/sponsors/sindresorhus"
+      }
+    },
+    "node_modules/thunky": {
+      "version": "1.1.0",
+      "resolved": "https://registry.npmjs.org/thunky/-/thunky-1.1.0.tgz",
+      "integrity": "sha512-eHY7nBftgThBqOyHGVN+l8gF0BucP09fMo0oO/Lb0w1OF80dJv+lDVpXG60WMQvkcxAkNybKsrEIE3ZtKGmPrA==",
+      "license": "MIT"
+    },
+    "node_modules/yocto-queue": {
+      "version": "0.1.0",
+      "resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-0.1.0.tgz",
+      "integrity": "sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q==",
+      "license": "MIT",
+      "engines": {
+        "node": ">=10"
+      },
+      "funding": {
+        "url": "https://github.com/sponsors/sindresorhus"
+      }
+    }
+  }
+}

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "matterbridge-valetudo",
+  "version": "1.0.2",
+  "description": "Matterbridge plugin for Valetudo-enabled robot vacuums",
+  "author": "JGtHb",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/JGtHb/matterbridge-valetudo.git"
+  },
+  "bugs": {
+    "url": "https://github.com/JGtHb/matterbridge-valetudo/issues"
+  },
+  "homepage": "https://github.com/JGtHb/matterbridge-valetudo",
+  "type": "module",
+  "main": "dist/module.js",
+  "engines": {
+    "node": ">=20.0.0 <21.0.0 || >=22.0.0 <23.0.0 || >=24.0.0 <25.0.0"
+  },
+  "keywords": [
+    "matterbridge",
+    "plugin",
+    "valetudo",
+    "robot-vacuum",
+    "vacuum-cleaner",
+    "matter.js",
+    "matter-node.js",
+    "matter",
+    "matterprotocol",
+    "iot",
+    "smarthome",
+    "connectedthings",
+    "hap",
+    "homekit",
+    "siri",
+    "google-home",
+    "alexa",
+    "homeassistant",
+    "smartthings"
+  ],
+  "dependencies": {
+    "multicast-dns": "^7.2.5",
+    "node-ansi-logger": "3.1.1",
+    "node-persist-manager": "2.0.0"
+  }
+}