Skip to content
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.

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

[Bug] Docs incorrect about units for "interval" #139

Closed
chrisjshull opened this issue Jun 4, 2023 · 4 comments
Closed

[Bug] Docs incorrect about units for "interval" #139

chrisjshull opened this issue Jun 4, 2023 · 4 comments
Assignees
Labels

Comments

@chrisjshull
Copy link

https://ztalbot2000.github.io/homebridge-cmd4/autoGenerated/CMD4_AccessoryDescriptions.html#interval_D and https://ztalbot2000.github.io/homebridge-cmd4/autoGenerated/CMD4_AccessoryDescriptions.html#interval both claim that "interval" is in seconds. Is it actually in milliseconds?

@chrisjshull
Copy link
Author

also, apparently the docs deep linking doesn't work - those are supposed to be the links to the Directive and Accessory Directive pages on "interval"

@ztalbot2000
Copy link
Owner

ztalbot2000 commented Jun 4, 2023 via email

@ztalbot2000
Copy link
Owner

Hi,

Sorry, I don't have much time lately. The interval is actually in seconds. If you look at Cmd4Accessory.js under the parseConfig procedure in the current release on line 1581 you will see the line:

case constants.INTERVAL:
// Intervals are in seconds
this.interval = parseInt( value, 10 ) * 1000;

As for the deep link. Under Directives interval does link to:
https://ztalbot2000.github.io/homebridge-cmd4/autoGenerated/CMD4_AccessoryDescriptions.html#interval_D
For whatever reason on Safari, I have to scroll up one line to see the header.
I did add link checks to V7.0.1 and while it did not find anything related to your bug, it did find two for tags that were moved to the Developers documentation. So Thanks for making me double check it all.
I'll be releasing 7.0.1 momentarily. The documentation has already been submitted.

John

@ztalbot2000
Copy link
Owner

If you have see anything else, please let me know.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants