Skip to content

Added resetAutoReleaseOnDetection property to sensors #169

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Added resetAutoReleaseOnDetection property to sensors #169

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9623675
Added resetAutoReleaseOnDetection property to sensors
Kellojo Oct 2, 2022
8678e32
Added missing config entries
Kellojo Oct 2, 2022
c2cbdb8
Cleaned up timeout handling
Kellojo Oct 2, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,8 @@ Example config.json:
"name": "Sensor name 1",
"type": "contact",
"autoRelease": false, // (optional)
"autoReleaseTime": 7500 // (optional, in ms)
"autoReleaseTime": 7500, // (optional, in ms)
"resetAutoReleaseOnDetection": true // (optional)
},
{
"id": "sensor2",
Expand Down
8 changes: 7 additions & 1 deletion config.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,11 @@
"type": "integer",
"placeholder": "7500",
"required": false
},
"resetAutoReleaseOnDetection": {
"title": "Reset Auto Release on Detection",
"type": "boolean",
"required": false
}
}
}
Expand Down Expand Up @@ -1369,7 +1374,8 @@
"sensors[].name",
"sensors[].type",
"sensors[].autoRelease",
"sensors[].autoReleaseTime"
"sensors[].autoReleaseTime",
"sensors[].resetAutoReleaseOnDetection"
]
}
]
Expand Down
47 changes: 29 additions & 18 deletions src/homekit/accessories/HttpWebHookSensorAccessory.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ function HttpWebHookSensorAccessory(ServiceParam, CharacteristicParam, platform,
this.type = sensorConfig["type"];
this.autoRelease = sensorConfig["autoRelease"];
this.autoReleaseTime = sensorConfig["autoReleaseTime"] || Constants.DEFAULT_SENSOR_TIMEOUT;
this.resetAutoReleaseOnDetection = sensorConfig["resetAutoReleaseOnDetection"];

this.informationService = new Service.AccessoryInformation();
this.informationService.setCharacteristic(Characteristic.Manufacturer, "HttpWebHooksPlatform");
Expand Down Expand Up @@ -79,35 +80,19 @@ HttpWebHookSensorAccessory.prototype.changeFromServer = function(urlParams) {
this.storage.setItemSync("http-webhook-" + this.id, urlValue);
this.log.debug("cached: "+ cached);
this.log.debug("cached !== urlValue: "+ (cached !== urlValue));


if (cached !== urlValue) {
this.log("Change HomeKit value for " + this.type + " sensor to '%s'.", urlValue);

if (this.type === "contact") {
this.service.getCharacteristic(Characteristic.ContactSensorState).updateValue(urlValue ? Characteristic.ContactSensorState.CONTACT_DETECTED : Characteristic.ContactSensorState.CONTACT_NOT_DETECTED, undefined, Constants.CONTEXT_FROM_WEBHOOK);
if (this.autoRelease) {
setTimeout(function() {
this.storage.setItemSync("http-webhook-" + this.id, true);
this.service.getCharacteristic(Characteristic.ContactSensorState).updateValue(Characteristic.ContactSensorState.CONTACT_DETECTED, undefined, Constants.CONTEXT_FROM_TIMEOUTCALL);
}.bind(this), this.autoReleaseTime);
}
}
else if (this.type === "motion") {
this.service.getCharacteristic(Characteristic.MotionDetected).updateValue(urlValue, undefined, Constants.CONTEXT_FROM_WEBHOOK);
if (this.autoRelease) {
setTimeout(function() {
this.storage.setItemSync("http-webhook-" + this.id, false);
this.service.getCharacteristic(Characteristic.MotionDetected).updateValue(false, undefined, Constants.CONTEXT_FROM_TIMEOUTCALL);
}.bind(this), this.autoReleaseTime);
}
}
else if (this.type === "occupancy") {
this.service.getCharacteristic(Characteristic.OccupancyDetected).updateValue(urlValue ? Characteristic.OccupancyDetected.OCCUPANCY_DETECTED : Characteristic.OccupancyDetected.OCCUPANCY_NOT_DETECTED, undefined, Constants.CONTEXT_FROM_WEBHOOK);
if (this.autoRelease) {
setTimeout(function() {
this.storage.setItemSync("http-webhook-" + this.id, false);
this.service.getCharacteristic(Characteristic.OccupancyDetected).updateValue(Characteristic.OccupancyDetected.OCCUPANCY_NOT_DETECTED, undefined, Constants.CONTEXT_FROM_TIMEOUTCALL);
}.bind(this), this.autoReleaseTime);
}
}
else if (this.type === "smoke") {
this.service.getCharacteristic(Characteristic.SmokeDetected).updateValue(urlValue ? Characteristic.SmokeDetected.SMOKE_DETECTED : Characteristic.SmokeDetected.SMOKE_NOT_DETECTED, undefined, Constants.CONTEXT_FROM_WEBHOOK);
Expand All @@ -130,6 +115,9 @@ HttpWebHookSensorAccessory.prototype.changeFromServer = function(urlParams) {
}

}

this.setAutoReleaseTimeout();

return {
"success" : true
};
Expand Down Expand Up @@ -163,4 +151,27 @@ HttpWebHookSensorAccessory.prototype.getServices = function() {
return [ this.service, this.informationService ];
};

HttpWebHookSensorAccessory.prototype.resetToInitialState = function () {
if (this.type === "contact") {
this.storage.setItemSync("http-webhook-" + this.id, true);
this.service.getCharacteristic(Characteristic.ContactSensorState).updateValue(Characteristic.ContactSensorState.CONTACT_DETECTED, undefined, Constants.CONTEXT_FROM_TIMEOUTCALL);
} else if (this.type === "motion") {
this.storage.setItemSync("http-webhook-" + this.id, false);
this.service.getCharacteristic(Characteristic.MotionDetected).updateValue(false, undefined, Constants.CONTEXT_FROM_TIMEOUTCALL);
} else if (this.type === "occupancy") {
this.storage.setItemSync("http-webhook-" + this.id, false);
this.service.getCharacteristic(Characteristic.OccupancyDetected).updateValue(Characteristic.OccupancyDetected.OCCUPANCY_NOT_DETECTED, undefined, Constants.CONTEXT_FROM_TIMEOUTCALL);
}
}

HttpWebHookSensorAccessory.prototype.setAutoReleaseTimeout = function () {
if (!this.autoRelease || !this.resetAutoReleaseOnDetection) return;
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This prevents autoreleases if not resetAutoReleaseOnDetection is set. The flag resetAutoReleaseOnDetection should be handled as optional.

clearTimeout(this[this.getTimeoutKey()]);
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Clearing and resetting timeout should only be done if resetAutoReleaseOnDetection is true. Otherwise it should always add the timeout as before, so nothing break.

this[this.getTimeoutKey()] = setTimeout(this.resetToInitialState.bind(this), this.autoReleaseTime);
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See comment above.

}

HttpWebHookSensorAccessory.prototype.getTimeoutKey = function() {
return `autoReleaseTimeout-${this.type}-${this.id}`;
}

module.exports = HttpWebHookSensorAccessory;