Add Events page to development section. WIP

This commit is contained in:
Ally Parker 2020-12-29 13:50:17 +00:00
parent 43f6d798be
commit 058d7f1b13
2 changed files with 38 additions and 0 deletions

View file

@ -0,0 +1,37 @@
---
title: Events
---
## Overview
ZMK uses events to decouple behaviours and to allow new functionality to be added to existing events.
## `activity_state_changed`
Fired by the activity monitor when the state changes. The monitor subscribes to `position_state_changed` and `sensor_event` events to keep track of activity.
* `ZMK_ACTIVITY_ACTIVE`
* `ZMK_ACTIVITY_IDLE` - When idle time is greater than `CONFIG_ZMK_IDLE_TIMEOUT `
* `ZMK_ACTIVITY_SLEEP` - When `CONFIG_ZMK_SLEEP` is enabled and idle time is greater than `CONFIG_ZMK_IDLE_SLEEP_TIMEOUT`
## `battery_state_changed`
todo
## `ble_active_profile_changed`
todo
## `keycode_state_changed`
todo
## `layer_state_changed`
todo
## `modifiers_state_changed`
todo
## `position_state_changed`
todo
## `sensor_event`
todo
## `usb_conn_state_changed`
todo

View file

@ -45,6 +45,7 @@ module.exports = {
"development/posix-board",
"development/tests",
"development/usb-logging",
"development/events",
{
type: "category",
label: "Guides",