feat(behavior) Add &sleep behavior #649

mcrosson · 2021-01-30T05:56:31Z

Add a new behavior that'll allow users to put their keyboard to sleep ahead of timeouts. This is meant to be used as a binding on a keymap.

Nicell · 2021-02-01T03:08:15Z

app/include/zmk/activity.h

+enum zmk_activity_state zmk_activity_get_state();
+int activity_set_state(enum zmk_activity_state state);


Suggested change

int activity_set_state(enum zmk_activity_state state);

int zmk_activity_set_state(enum zmk_activity_state state);

To keep in line with the rest of our shared functions, I'm thinking this should be prefixed with zmk_.

Nicell · 2021-02-01T03:13:02Z

app/src/activity.c

+    // Second half of || statement is to ensure a user using &sleep doesn't lose sleep state when
+    // the idle or sleep timers expire
+    if (inactive_time > MAX_SLEEP_MS || activity_state == ZMK_ACTIVITY_SLEEP) {


I'm wondering if this handler is even called when ZMK is in deep sleep. I'd imagine it shouldn't, but if it does, why don't we just clear the timer? Seems unnecessary to run this while we're in sleep.

I didn't see a great spot to reset the timer and if the timer code does run at all in sleep mode... we're still going to need the 2nd half of the condition to ensure it's never going to wake up when asleep.

What I'm thinking is this handler shouldn't even be called once you're in deep sleep. Have you tested it without this additional conditional? From my understanding when we go into deep sleep, timer-based handlers are no longer run since we don't set up any timer wakeups and therefore don't have any timers running.

Nicell · 2021-02-01T03:15:17Z

app/src/behaviors/behavior_sleep.c

+static const struct behavior_driver_api behavior_sleep_driver_api = {
+    .binding_released = on_keymap_binding_released,
+};


.binding_pressed should be defined so you don't get an error in logs when pressing this key. You can have a function that just returns an opaque response like this: https://github.com/zmkfirmware/zmk/blob/main/app/src/behaviors/behavior_rgb_underglow.c#L54

Nicell · 2021-02-01T03:17:15Z

app/src/behaviors/behavior_sleep.c

+
+static int on_keymap_binding_released(struct zmk_behavior_binding *binding,
+                                      struct zmk_behavior_binding_event event) {
+    return activity_set_state(ZMK_ACTIVITY_SLEEP);


Suggested change

return activity_set_state(ZMK_ACTIVITY_SLEEP);

#if IS_ENABLED(CONFIG_ZMK_SLEEP)

return activity_set_state(ZMK_ACTIVITY_SLEEP);

#endif

return ZMK_BEHAVIOR_OPAQUE;

This is so we don't sleep when sleep isn't turned on and we press this key.

petejohanson

Few additional tweaks needed.

petejohanson · 2021-02-04T12:49:54Z

app/dts/behaviors/sleep.dtsi

+
+/ {
+	behaviors {
+		sleep: behavior_sleep {


Please add the /omit-if-no-ref/ here like other behaviors were updated to include.

petejohanson · 2021-02-04T12:51:27Z

app/src/behaviors/behavior_sleep.c

+
+LOG_MODULE_DECLARE(zmk, CONFIG_ZMK_LOG_LEVEL);
+
+static int behavior_sleep_init(const struct device *dev) { return 0; };


Add a wrapper #if HAS_DEVICE_STATUS_OKAY(DT_DRV_COMPAT) like other drivers do now, so this doesn't compile if the DT is omitted.

petejohanson · 2021-03-12T23:10:55Z

@mcrosson did you see the review items on this?

mcrosson · 2021-03-12T23:12:39Z

@mcrosson did you see the review items on this?

Yes, I thought it was agreed this was 'on hold' until after locality landed? I was planning on working on any necessary changes once locality landed.

…o sleep prior to timeout

mcrosson · 2021-03-13T19:25:59Z

Had some spare brain cycles and time ; updated according to the above feedback

Nicell · 2021-03-13T20:14:03Z

app/src/activity.c

@@ -34,7 +34,8 @@ int raise_event() {
        (struct zmk_activity_state_changed){.state = activity_state}));
 }

-int set_state(enum zmk_activity_state state) {
+int activity_set_state(enum zmk_activity_state state) {


I think you have to rename all of these activity_set_states to zmk_activity_set_state.

Nicell · 2021-03-13T20:19:11Z

app/src/activity.c

+    // Second half of || statement is to ensure a user using &sleep doesn't lose sleep state when
+    // the idle or sleep timers expire
+    if (inactive_time > MAX_SLEEP_MS || activity_state == ZMK_ACTIVITY_SLEEP) {


What I'm thinking is this handler shouldn't even be called once you're in deep sleep. Have you tested it without this additional conditional? From my understanding when we go into deep sleep, timer-based handlers are no longer run since we don't set up any timer wakeups and therefore don't have any timers running.

petejohanson

A few follow ups.

petejohanson · 2022-02-17T04:26:03Z

app/src/behaviors/behavior_sleep.c

+
+static const struct behavior_driver_api behavior_sleep_driver_api = {
+    .binding_released = on_keymap_binding_released,
+    .binding_pressed = on_keymap_binding_pressed,


This should have a .locality set:

Suggested change

.binding_pressed = on_keymap_binding_pressed,

.binding_pressed = on_keymap_binding_pressed,

.locality = BEHAVIOR_LOCALITY_GLOBAL,

petejohanson · 2022-02-17T04:27:19Z

docs/docs/behaviors/misc.md

+
+```
+&sleep
+```


Please document this as being a global behavior, that will affect all components of a split. See other global behaviors, e.g. RGB, for an example docs.

petejohanson · 2022-09-28T02:17:51Z

@mcrosson Any plans to wrap this up, fix current conflicts, etc?

hyx0329 · 2023-05-09T09:23:14Z

I was trying to implement soft power off/lockout in the application code, happened to almost reimplement this.

However, regardless of whether I called set_state, I can not wake up my keyboard through typing. This works great for my "power off" purpose, but not for the "sleep" here. When the keyboard is put to sleep by activity_work_handler in activity.c, I can wake the keyboard up by typing. So I wonder which part of code make it possible to wake up the keyboard by typing.

Edit: Oh I think I just found it, first introduced by pr 211 at app/drivers/kscan/kscan_gpio_matrix.c, documented. I think I have the idea to implement both.

In my code, the behavior is triggered upon pressing the key. My code is based on current latest main branch (94789a0).

lesshonor · 2024-07-07T14:21:14Z

Arguably obsoleted by #2085 and related PRs.

Nick-Munnich · 2024-07-18T08:49:41Z

I recall someone requesting a &sleep behaviour in addition to &soft_off, to use &sleep for power conserving and &soft_off for transportation. For that reason I would say that it's not obsolete yet.

Nicell added behaviors enhancement New feature or request labels Feb 1, 2021

Nicell requested changes Feb 1, 2021

View reviewed changes

petejohanson requested changes Feb 4, 2021

View reviewed changes

mcrosson mentioned this pull request Feb 9, 2021

Invoke behaviors with different "locality" #547

Merged

KemoNine added 3 commits March 13, 2021 19:04

feat(behaviors): implement a &sleep behavior that'll put a keyboard t…

471d693

…o sleep prior to timeout

feat(docs): add documentation on &sleep behavior

8e5e5b9

chore(&sleep): misc code updates from PR #649

f9699eb

mcrosson force-pushed the feat-behavior-sleep branch from 0550b30 to f9699eb Compare March 13, 2021 19:24

Nicell requested changes Mar 13, 2021

View reviewed changes

petejohanson requested changes Feb 17, 2022

View reviewed changes

hyx0329 mentioned this pull request May 10, 2023

feat(behaviors): add soft power-off #1795

Closed

mcrosson closed this by deleting the head repository Jan 16, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(behavior) Add &sleep behavior #649

feat(behavior) Add &sleep behavior #649

mcrosson commented Jan 30, 2021

Nicell Feb 1, 2021

mcrosson Mar 13, 2021

Nicell Feb 1, 2021

mcrosson Mar 13, 2021

Nicell Mar 13, 2021

Nicell Feb 1, 2021

mcrosson Mar 13, 2021

Nicell Feb 1, 2021

mcrosson Mar 13, 2021

petejohanson left a comment

petejohanson Feb 4, 2021

mcrosson Mar 13, 2021

petejohanson Feb 4, 2021

mcrosson Mar 13, 2021

petejohanson commented Mar 12, 2021

mcrosson commented Mar 12, 2021

mcrosson commented Mar 13, 2021

Nicell Mar 13, 2021

Nicell Mar 13, 2021

petejohanson left a comment

petejohanson Feb 17, 2022

petejohanson Feb 17, 2022

petejohanson commented Sep 28, 2022

hyx0329 commented May 9, 2023 •

edited

Loading

lesshonor commented Jul 7, 2024 •

edited

Loading

Nick-Munnich commented Jul 18, 2024

		enum zmk_activity_state zmk_activity_get_state();
		int activity_set_state(enum zmk_activity_state state);

	int activity_set_state(enum zmk_activity_state state);
	int zmk_activity_set_state(enum zmk_activity_state state);


		LOG_MODULE_DECLARE(zmk, CONFIG_ZMK_LOG_LEVEL);

		static int behavior_sleep_init(const struct device *dev) { return 0; };

	.binding_pressed = on_keymap_binding_pressed,
	.binding_pressed = on_keymap_binding_pressed,
	.locality = BEHAVIOR_LOCALITY_GLOBAL,

feat(behavior) Add &sleep behavior #649

feat(behavior) Add &sleep behavior #649

Conversation

mcrosson commented Jan 30, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

petejohanson left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

petejohanson commented Mar 12, 2021

mcrosson commented Mar 12, 2021

mcrosson commented Mar 13, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

petejohanson left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

petejohanson commented Sep 28, 2022

hyx0329 commented May 9, 2023 • edited Loading

lesshonor commented Jul 7, 2024 • edited Loading

Nick-Munnich commented Jul 18, 2024

hyx0329 commented May 9, 2023 •

edited

Loading

lesshonor commented Jul 7, 2024 •

edited

Loading