Variable default
default: (api: API) => void
Type Declaration
- (api: API): void
Parameters
- api: API
Returns void
@homebridge-plugins/homebridge-plugin-update-check
Variables
2 | 
5 |
@homebridge-plugins/homebridge-plugin-update-check
homebridge-plugin-update-check
A Homebridge plugin for checking for updates to Homebridge and plugins.
3 |Installation
-
4 |
- Install Homebridge using the official instructions. 5 |
- Install this plugin using:
sudo npm install -g homebridge-plugin-update-check.
6 | - Update your configuration file. See sample config.json snippet below. 7 |
Configuration
Configuration sample:
9 |"platforms": [
{
"name": "PluginUpdate",
"sensorType": "contact",
"checkHomebridgeUpdates": false,
"checkHomebridgeUIUpdates": false,
"checkPluginUpdates": true,
"checkDockerUpdates": true,
"autoUpdateHomebridge": false,
"autoUpdateHomebridgeUI": false,
"autoUpdatePlugins": false,
"allowDirectNpmUpdates": false,
"autoRestartAfterUpdates": false,
"failureSensorType": "motion",
"platform": "PluginUpdate"
}
]
10 | Fields
-
13 |
- "platform": Must always be "PluginUpdate" (required) 14 |
- "sensorType": What type of sensor will be exposed to HomeKit. Can be
motion,contact,occupancy,humidity,light,air,leak,smoke,dioxide, ormonoxide(Default:motion)
15 | - "checkHomebridgeUpdates": Check if an update is available for the Homebridge server 16 |
- "checkHomebridgeUIUpdates: Check if an update is available for the Homebridge UI 17 |
- "checkPluginUpdates": Check if updates are available for any installed plugins 18 |
- "checkDockerUpdates": If running in Docker, check if newer Docker versions are available. If not running in Docker, does nothing 19 |
- "autoUpdateHomebridge": Automatically install Homebridge updates when available (Default:
false)
20 | - "autoUpdateHomebridgeUI": Automatically install Homebridge Config UI updates when available (Default:
false)
21 | - "autoUpdatePlugins": Automatically install plugin updates when available (Default:
false)
22 | - "allowDirectNpmUpdates": Allow automatic updates using direct npm commands even when homebridge-config-ui-x is not available (Default:
false)
23 | - "autoRestartAfterUpdates": Automatically restart Homebridge after successful automatic updates to apply changes (Default:
false)
24 | - "failureSensorType": What type of sensor will be used for update/restart failure notifications. Can be
motion,contact,occupancy,humidity,light,air,leak,smoke,dioxide, ormonoxide(Default:motion, only shown when auto-updates are enabled)
25 |
Homebridge, Homebridge UI, plugin, and Docker updates can be selected independently. This allows you for example, to ignore available Homebridge, Homebridge UI available updates if you are running Homebridge in a Docker container and wish to only update these components when a new Docker image is available.
27 |Note on Automatic Updates: When automatic updates are enabled, the plugin will:
28 |-
29 |
- Automatically create a backup before performing any updates (when homebridge-config-ui-x is available) 30 |
- Attempt to install updates via npm commands. This requires:
31 |
-
32 |
- homebridge-config-ui-x to be installed and properly configured (unless
allowDirectNpmUpdatesis enabled)
33 | - Sufficient privileges to install global npm packages 34 |
36 | - homebridge-config-ui-x to be installed and properly configured (unless
- Automatically restart Homebridge after successful updates (when
autoRestartAfterUpdatesis enabled)
37 | - Monitor for failures and provide notifications via a configurable failure sensor (type set by
failureSensorType)
38 |
Automatic updates are disabled by default for safety. Enable them only if you trust automatic updates. The plugin will automatically create a backup before any updates are performed when homebridge-config-ui-x is available, eliminating the need for manual backup procedures. However, you should still maintain your own backup procedures as a best practice.
40 |Note on Docker Updates: Docker container updates are intentionally not supported via automatic updates for safety reasons. This is because the process performing the update would be running inside the container itself, which would result in the process killing itself halfway through the update, potentially corrupting the container or leaving it in an unusable state.
41 |When allowDirectNpmUpdates is enabled, automatic updates will work even when homebridge-config-ui-x is not available by using direct npm commands. This provides more flexibility but requires ensuring you have the necessary npm privileges.
${e}
`:""}var ct=["button","checkbox","file","hidden","image","radio","range","reset","submit"];function ut(){let t=document.activeElement;return t?t.isContentEditable||t.tagName==="TEXTAREA"||t.tagName==="SEARCH"?!0:t.tagName==="INPUT"&&!ct.includes(t.type):!1}var D="mousedown",Me="mousemove",$="mouseup",ne={x:0,y:0},Qe=!1,ce=!1,dt=!1,F=!1,Oe=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(Oe?"is-mobile":"not-mobile");Oe&&"ontouchstart"in document.documentElement&&(dt=!0,D="touchstart",Me="touchmove",$="touchend");document.addEventListener(D,t=>{ce=!0,F=!1;let e=D=="touchstart"?t.targetTouches[0]:t;ne.y=e.pageY||0,ne.x=e.pageX||0});document.addEventListener(Me,t=>{if(ce&&!F){let e=D=="touchstart"?t.targetTouches[0]:t,n=ne.x-(e.pageX||0),r=ne.y-(e.pageY||0);F=Math.sqrt(n*n+r*r)>10}});document.addEventListener($,()=>{ce=!1});document.addEventListener("click",t=>{Qe&&(t.preventDefault(),t.stopImmediatePropagation(),Qe=!1)});var re=class extends I{active;className;constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener($,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(D,n=>this.onDocumentPointerDown(n)),document.addEventListener($,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){F||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!F&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var ue=new Map,de=class{open;accordions=[];key;constructor(e,n){this.key=e,this.open=n}add(e){this.accordions.push(e),e.open=this.open,e.addEventListener("toggle",()=>{this.toggle(e.open)})}toggle(e){for(let n of this.accordions)n.open=e;S.setItem(this.key,e.toString())}},ie=class extends I{constructor(e){super(e);let n=this.el.querySelector("summary"),r=n.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)});let i=`tsd-accordion-${n.dataset.key??n.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`,s;if(ue.has(i))s=ue.get(i);else{let o=S.getItem(i),a=o?o==="true":this.el.open;s=new de(i,a),ue.set(i,s)}s.add(this.el)}};function He(t){let e=S.getItem("tsd-theme")||"os";t.value=e,Ae(e),t.addEventListener("change",()=>{S.setItem("tsd-theme",t.value),Ae(t.value)})}function Ae(t){document.documentElement.dataset.theme=t}var se;function Ne(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",Re),Re())}async function Re(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let e=await R(window.navigationData);se=document.documentElement.dataset.base,se.endsWith("/")||(se+="/"),t.innerHTML="";for(let n of e)Be(n,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Be(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-accordion`:"tsd-accordion";let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.dataset.key=i.join("$"),o.innerHTML='',De(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let c=a.appendChild(document.createElement("ul"));c.className="tsd-nested-navigation";for(let l of t.children)Be(l,c,i)}else De(t,r,t.class)}function De(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));if(r.href=se+t.path,n&&(r.className=n),location.pathname===r.pathname&&!r.href.includes("#")&&(r.classList.add("current"),r.ariaCurrent="page"),t.kind){let i=window.translations[`kind_${t.kind}`].replaceAll('"',""");r.innerHTML=``}r.appendChild(Fe(t.text,document.createElement("span")))}else{let r=e.appendChild(document.createElement("span")),i=window.translations.folder.replaceAll('"',""");r.innerHTML=``,r.appendChild(Fe(t.text,document.createElement("span")))}}function Fe(t,e){let n=t.split(/(?<=[^A-Z])(?=[A-Z])|(?<=[A-Z])(?=[A-Z][a-z])|(?<=[_-])(?=[^_-])/);for(let r=0;r