Logic error in validateUserInput function causes 'out of compliance' HomeKit errors #1077
Comments
|
Thanks Adrian - great catch. Want to submit a PR for it? Otherwise, I'll address over the holiday season. |
|
@hjdhjd - I'm away for the next couple of weeks and don't have access to my usual machinery to do testing prior to submitting a PR. So if you are able to do this, that would be great. |
This was referenced Mar 1, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Summary: HAP-NodeJS has a logic error / oversight in
validateUserInputinCharacteristic.tswhich can cause accessories to fail to add to HomeKit with 'out of compliance' errors.To reproduce, create a service with a characteristic e.g. HeatingThresholdTemperature, set up
minValue,maxValueandminStepprops such that themaxValueis not a multiple of theminStep, e.g.{ minValue: 0, maxValue: 25, minStep: 2 }. CallupdateValueon that characteristic to25. Try to add accessory to HomeKit. Observe Apple Home produce 'out of compliance' error and accessory fails to add. If accessory is already added, it will go to 'no response' when this happens.The cause is that
validateUserInputfirst quantizes to the step, and then truncates tominValueandmaxValue. But this isn't the logic that HK uses: instead, ifmaxValue - minValueisn't a multiple of the step,maxValueis adjusted as follows:adjustedMaxValue := stepValue * Math.floor((maxValue - minValue) / stepValue) + minValueSo in the example case, if we set
{ minValue: 0, maxValue: 25, minStep: 2 }HK will adjust themaxValueinternally to24, and give OOC errors if larger values are sent.So HAP-NodeJS needs to do the same adjustment, otherwise HAP-NodeJS can produce invalid characteristic updates which cause HK to fail the bounds check, even when submitted characteristic values are within the
minValuetomaxValuerange. Search Github and you will see people reporting plug-in issues which are caused by this bug.The text was updated successfully, but these errors were encountered: