@homebridge-plugins/homebridge-noip
Version:
The No-IP plugin allows you to update your No-IP hostname(s) for your homebridge instance.
81 lines (80 loc) • 11.1 kB
HTML
<html class="default" lang="en" data-base="./"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@homebridge-plugins/homebridge-noip</title><meta name="description" content="Documentation for @homebridge-plugins/homebridge-noip"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="index.html" class="title">@homebridge-plugins/homebridge-noip</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h1>@homebridge-plugins/homebridge-noip</h1></div><div class="tsd-panel tsd-typography"><span align="center">
<p><a href="https://github.com/homebridge/verified/blob/master/verified-plugins.json"><img alt="homebridge-verified" src="https://raw.githubusercontent.com/homebridge-plugins/homebridge-noip/latest/branding/Homebridge_x_No-IP.svg?sanitize=true" width="350px"></a></p>
<h1 id="homebridge-no-ip" class="tsd-anchor-link">Homebridge No-IP<a href="#homebridge-no-ip" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h1>
<p><a href="https://www.npmjs.com/package/@homebridge-plugins/homebridge-noip"><img title="npm version" src="https://badgen.net/npm/v/@homebridge-plugins/homebridge-noip?icon=npm&label" ></a>
<a href="https://www.npmjs.com/package/@homebridge-plugins/homebridge-noip"><img title="npm downloads" src="https://badgen.net/npm/dt/@homebridge-plugins/homebridge-noip?label=downloads" ></a>
<a href="https://discord.gg/8fpZA4S"><img title="discord-noip" src="https://badgen.net/discord/online-members/8fpZA4S?icon=discord&label=discord" ></a>
<a href="https://paypal.me/donavanbecker"><img title="donate" src="https://badgen.net/badge/donate/paypal/yellow" ></a></p>
<p>The Homebridge <a href="https://noip.com">No-IP</a>
plugin allows you update your <a href="https://noip.com">No-IP</a> hostnames from the IP that your
<a href="https://homebridge.io">Homebridge</a> instance is on.
</p>
</span>
<h2 id="installation" class="tsd-anchor-link">Installation<a href="#installation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2>
<ol>
<li>Search for "No-IP" on the plugin screen of <a href="https://github.com/oznu/homebridge-config-ui-x">Homebridge Config UI X</a>.</li>
<li>Click <strong>Install</strong>.</li>
</ol>
<h2 id="configuration" class="tsd-anchor-link">Configuration<a href="#configuration" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2>
<ol>
<li>Login / create an account at <a href="https://noip.com/">https://noip.com/</a>
<ul>
<li>If you haven't already you can also create your No-IP hostname here as well.</li>
</ul>
</li>
</ol>
<p align="center">
<img src="https://user-images.githubusercontent.com/9875439/133934622-05a9c19e-c5ba-46ee-b0db-0748420813d7.png" width="450px">
</p>
<ol start="2">
<li>Type in your NoIP Username, Password, and Hostname into the Plugin Setting UI</li>
<li>Click Save</li>
<li>Restart Homebridge</li>
</ol>
<h2 id="supported-no-ip-features" class="tsd-anchor-link">Supported No-IP Features<a href="#supported-no-ip-features" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2>
<ul>
<li>IPv4 Update.</li>
<li>IPv6 Update.</li>
</ul>
<h2 id="homebridge-matter-support-hap-fallback" class="tsd-anchor-link">Homebridge Matter Support & HAP Fallback<a href="#homebridge-matter-support-hap-fallback" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2>
<p>This plugin supports Homebridge v2.0+ with Matter API integration. When running on a Homebridge version that provides the Matter API and Matter is enabled in your config, the plugin will register devices using Matter. If Matter is unavailable or disabled, the plugin will automatically fall back to standard HAP (HomeKit Accessory Protocol) registration.</p>
<p><strong>Key Points:</strong></p>
<ul>
<li><strong>Automatic Selection:</strong> The plugin chooses Matter or HAP at runtime based on your Homebridge environment and config options.</li>
<li><strong>Config Options:</strong> You can control Matter preference and enable/disable via the plugin config (<code>preferMatter</code>, <code>enableMatter</code>).</li>
<li><strong>No Manual Changes Needed:</strong> If you upgrade/downgrade Homebridge or change your config, the plugin will always select the best available platform.</li>
<li><strong>Tested Fallback:</strong> The fallback logic is fully tested to ensure reliability.</li>
</ul>
<p>See the <a href="media/CHANGELOG.md">Changelog</a> for details on Matter support and fallback improvements.</p>
<h2 id="contributing" class="tsd-anchor-link">Contributing<a href="#contributing" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2>
<p>This project uses GitHub Copilot to help manage contributions. Before submitting issues or requesting features, please follow these guidelines:</p>
<h3 id="issue-guidelines" class="tsd-anchor-link">Issue Guidelines<a href="#issue-guidelines" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3>
<ol>
<li>
<p><strong>Label Requirements</strong>: All issues must have one semantic versioning label before assignment to Copilot:</p>
<ul>
<li><code>patch</code>: Bug fixes (backward compatible)</li>
<li><code>minor</code>: New features (backward compatible)</li>
<li><code>major</code>: Breaking changes</li>
</ul>
</li>
<li>
<p><strong>Branch Strategy</strong>: All pull requests must target beta branches first:</p>
<ul>
<li><code>beta-X.Y.Z</code> for specific version releases</li>
<li><code>beta</code> as a fallback if no version-specific branch exists</li>
<li>Only after beta testing should changes be merged to <code>latest</code></li>
</ul>
</li>
</ol>
<h3 id="workflow" class="tsd-anchor-link">Workflow<a href="#workflow" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3>
<ol>
<li>Create an issue using the provided templates</li>
<li>The issue will automatically be labeled based on the version impact you select</li>
<li>Assign the issue to <code>@copilot</code></li>
<li>Copilot will create the appropriate beta branch if needed</li>
<li>Copilot will create a pull request targeting the beta branch</li>
<li>After review and testing, changes will be merged to the beta branch</li>
<li>Once ready, beta changes will be promoted to the <code>latest</code> branch for release</li>
</ol>
</div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#homebridge-no-ip"><span>Homebridge <wbr/>No-<wbr/>IP</span></a><ul><li><a href="#installation"><span>Installation</span></a></li><li><a href="#configuration"><span>Configuration</span></a></li><li><a href="#supported-no-ip-features"><span>Supported <wbr/>No-<wbr/>IP <wbr/>Features</span></a></li><li><a href="#homebridge-matter-support-hap-fallback"><span>Homebridge <wbr/>Matter <wbr/>Support & <wbr/>HAP <wbr/>Fallback</span></a></li><li><a href="#contributing"><span>Contributing</span></a></li><li><ul><li><a href="#issue-guidelines"><span>Issue <wbr/>Guidelines</span></a></li><li><a href="#workflow"><span>Workflow</span></a></li></ul></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html">@homebridge-plugins/homebridge-noip</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer></footer><div class="overlay"></div></body></html>