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

Update soft-off.md #2299

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Update soft-off.md #2299

wants to merge 4 commits into from

Conversation

GermanG
Copy link
Contributor

@GermanG GermanG commented May 9, 2024

Adding Split Peripheral Off On Press basic documentation.

GermanG and others added 2 commits May 9, 2024 12:20
Adding Split Peripheral Off On Press
@caksoylar
Copy link
Contributor

I'd like to understand why this setting was implemented and defaulted to first, before encouraging people to turn them off. @petejohanson can you elaborate?

@caksoylar caksoylar added the documentation Improvements or additions to documentation label May 9, 2024
@GermanG
Copy link
Contributor Author

GermanG commented May 9, 2024

I think it's related to the issue I reported today #2300

@petejohanson
Copy link
Contributor

I guess I'm confused when you'd ever want to only put the central side into soft off, that you'd need this documented?

@petejohanson petejohanson self-assigned this May 13, 2024
@GermanG
Copy link
Contributor Author

GermanG commented May 14, 2024

While fixing the peripheral soft_off issue, I noted that the peripheral turned off as soon as I pressed the key, despite the hold-time-ms setting. Upon investigation, I discovered an undocumented option (possibly a workaround for the issue I reported in #2300). After disabling it, I encountered the aforementioned issue. I am unsure of the original author's intent with this option and can only speculate; therefore, I refrained from modifying it. Instead, I documented it and demonstrated what can be done if you prefer to disable it.

docs/docs/behaviors/soft-off.md Outdated Show resolved Hide resolved
docs/docs/behaviors/soft-off.md Outdated Show resolved Hide resolved
@lesshonor
Copy link
Contributor

lesshonor commented Jul 10, 2024

I guess I'm confused when you'd ever want to only put the central side into soft off, that you'd need this documented?

The way the docs for hold-time-ms read indicate that the keyboard only goes into soft-off mode if you hold down a button for X ms.

From what I'm reading here, how it actually works is that when you press the button, part of the keyboard totally ignores your settings and goes into soft-off immediately.

My presumption was (is) that the primary reason hold-time-ms exists is to delay soft-off so it can't be immediately triggered—so if (part of) the device is going to do the exact thing the user is trying to prevent, that seems counterintuitive enough to be noteworthy.

@caksoylar
Copy link
Contributor

caksoylar commented Jul 10, 2024

From what I'm reading here, how it actually works is that when you press the button, part of the keyboard totally ignores your settings and goes into soft-off immediately.

My presumption was (is) that the primary reason hold-time-ms exists is to delay soft-off so it can't be immediately triggered—so if (part of) the device is going to do the exact thing the user is trying to prevent, that seems counterintuitive enough to be noteworthy.

I agree with this part, but I still haven't figured out why split-peripheral-off-on-press was defaulted to in the first place. If it is needed for robust operation (e.g. to make sure peripheral receives the command before central sleeps), what happens when soft-off doesn't have a hold-time-ms? If it isn't needed for technical reasons, why default to it?

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

Successfully merging this pull request may close these issues.

None yet

4 participants