kb01/zmk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
2456 commits 18 branches 0 tags 93 MiB
Commit graph

884 commits

Author SHA1 Message Date
ReFil
b02bcefb88 feat(docs): Document RGB momentary effect selection 2024-06-18 18:51:00 +01:00
Cem Aksoylar
7c09eb217e refactor(docs): Document and enforce header casing conventions 2024-06-17 11:46:32 -07:00
Cem Aksoylar
e56db304ea refactor(docs): Split up troubleshooting page into a section 2024-06-17 11:46:32 -07:00
Nicolas Munnich
308d6bce6e
feat(docs): Improve the toolchain setup page (#2272) 
Split the toolchain setup into separate docker and native pages
and improve instructions to better refer to Zephyr docs in certain steps.
Also refactor to improve consistency and add virtualenv instructions.

---------

Co-authored-by: KemoNine <mcrosson@kemonine.info>
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
 2024-06-01 21:51:08 -07:00
Nicolas Munnich
2d96f469c8
fix(docs): Removing to-to typos (#2310) 2024-05-25 22:16:33 -07:00
Horu
7d1f84e3eb
chore: fix typos in various places 2024-05-13 16:47:33 -04:00
ReFil
4dfc45d4ab
feat(docs): Document example toggle-mode implementation 
---------

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
 2024-05-03 14:17:09 -04:00
Cem Aksoylar
a9021deef6 fix(docs): Add wakeup-source to split new shield example 2024-04-09 16:27:27 -07:00
Cem Aksoylar
dfc6dc84b8 fix(docs): Make clear the matrix transform example is incomplete 2024-04-09 16:27:27 -07:00
Cem Aksoylar
7a51a46b9f feat(docs): Add pointer to shields folder in new shield docs 2024-04-09 16:27:27 -07:00
フィルターペーパー
7d5aa0c0bf feat(docs): Update section for devicetree_generated error 2024-04-04 18:31:09 -07:00
Tobias Arndt
e7d6519534 fix(docs): Fix and note GPIO flags for charlieplex config 2024-03-30 19:13:39 -07:00
Cem Aksoylar
eb5a6fcfe1 refactor(docs): Split DT props table for sensor rotate variants 2024-03-30 17:03:51 -07:00
Cem Aksoylar
e65a1227d8 fix(docs): Correct property types for behavior bindings 2024-03-30 17:03:51 -07:00
zhiayang
4bef4e98f5
feat(boards): Support board revisions in setup scripts. 
* Make setup.sh/ps1 prompt for board revision for boards that have revisions
 2024-03-30 19:12:37 -04:00
dependabot[bot]
d672b0c705 chore(deps): bump react-toastify from 7.0.4 to 10.0.5 in /docs 
Bumps [react-toastify](https://github.com/fkhadra/react-toastify) from 7.0.4 to 10.0.5.
- [Release notes](https://github.com/fkhadra/react-toastify/releases)
- [Commits](https://github.com/fkhadra/react-toastify/compare/v7.0.4...v10.0.5)

---
updated-dependencies:
- dependency-name: react-toastify
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
 2024-03-28 10:41:56 -07:00
dependabot[bot]
18b86b7720 chore(deps): bump follow-redirects from 1.15.5 to 1.15.6 in /docs 
Bumps [follow-redirects](https://github.com/follow-redirects/follow-redirects) from 1.15.5 to 1.15.6.
- [Release notes](https://github.com/follow-redirects/follow-redirects/releases)
- [Commits](https://github.com/follow-redirects/follow-redirects/compare/v1.15.5...v1.15.6)

---
updated-dependencies:
- dependency-name: follow-redirects
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
 2024-03-28 10:31:21 -07:00
dependabot[bot]
25bb126a11 chore(deps): bump express from 4.18.2 to 4.19.2 in /docs 
Bumps [express](https://github.com/expressjs/express) from 4.18.2 to 4.19.2.
- [Release notes](https://github.com/expressjs/express/releases)
- [Changelog](https://github.com/expressjs/express/blob/master/History.md)
- [Commits](https://github.com/expressjs/express/compare/4.18.2...4.19.2)

---
updated-dependencies:
- dependency-name: express
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
 2024-03-28 10:22:10 -07:00
dependabot[bot]
34910787ff chore(deps): bump webpack-dev-middleware from 5.3.3 to 5.3.4 in /docs 
Bumps [webpack-dev-middleware](https://github.com/webpack/webpack-dev-middleware) from 5.3.3 to 5.3.4.
- [Release notes](https://github.com/webpack/webpack-dev-middleware/releases)
- [Changelog](https://github.com/webpack/webpack-dev-middleware/blob/v5.3.4/CHANGELOG.md)
- [Commits](https://github.com/webpack/webpack-dev-middleware/compare/v5.3.3...v5.3.4)

---
updated-dependencies:
- dependency-name: webpack-dev-middleware
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
 2024-03-28 10:15:51 -07:00
Peter Johanson
f9bb18b676 fix(docs): Add &soft_off to behaviors index. 2024-03-27 22:52:32 -07:00
Peter Johanson
e66f068fb5 fix(docs): Minor soft-off docs tweaks from review. 2024-03-27 20:59:26 -07:00
Peter Johanson
d0e0ecb4e3 refactor: Use kscan directly to wake when we can. 
* When adding a dedicated GPIO pin for soft off/on, use the direct
  kscan as the waker, instead of adding an additional node.
 2024-03-27 20:59:26 -07:00
Pete Johanson
fa9ea9ea8b fix(docs): Fix soft off waker prop name, headers. 
* Use the correct property for extra GPIOs to
  make active for the waker before going into soft
  off state.
* Change header depth for easier navigation of the
  soft off feature page.

Co-authored-by: Pablo Martínez <58857054+elpekenin@users.noreply.github.com>
 2024-03-27 20:59:26 -07:00
Peter Johanson
cac999b1d6 feat: Updated soft-off docs. 
* Document new sideband behavior kscan driver for integrated
  soft-off support.
 2024-03-27 20:59:26 -07:00
Pete Johanson
933fdcd364 refactor(pm): Remove scanned behavior trigger. 
* Remove the painful scanned behavior trigger for now, future enhancement
  will restore this high level functionality using kscan directly.
 2024-03-27 20:59:26 -07:00
Peter Johanson
fceb0351a5 refactor: Fixes for soft-off based on review. 
* Better naming for gpio-key behavior triggers.
* Tweaks to scanned behavior trigger to avoid bad semaphore use,
  and reduce chance of issues with slowly scanned matrixes.
* Various code cleanups of style issues.
 2024-03-27 20:59:26 -07:00
Pete Johanson
96968514e3 fix(docs): Apply suggestions from code review 
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
 2024-03-27 20:59:26 -07:00
Peter Johanson
e78249ee06 fix(bt): Fix BT tests after soft off work. 
* Move to explicit enable of `ZMK_PM_SOFT_OFF` to turn
  on the feature and use the behaviors, which matches
  how other features work, and helps with split and
  testing schemes.
 2024-03-27 20:59:26 -07:00
Peter Johanson
adb3a13dc5 feat: Add soft on/off support. 
Initial work on a soft on/off support for ZMK. Triggering soft off
puts the device into deep sleep with only a specific GPIO pin
configured to wake the device, avoiding waking from other key
presses in the matrix like the normal deep sleep.

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
 2024-03-27 20:59:26 -07:00
Cem Aksoylar
c684cee76f refactor(docs): Refer to overview page for behaviors 2024-03-24 18:29:29 -07:00
Thomas Huber
f2d8b9b0a3 feat(docs): Add Behavior overview page 
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
 2024-03-24 17:50:33 -07:00
Cem Aksoylar
931a36ff4a feat(docs): Add a note on using BT with dual boot systems 2024-03-20 11:49:23 -07:00
フィルターペーパー
1f7cd7a107 feat(docs): Add troubleshooting section for empty_file error 2024-03-19 23:48:57 -07:00
Theo Lemay
828943156a
fix(docs): Fix hold-tap info callout (#2211) 
The hold-while-undecided callout does not properly render in the docs. This fixes it.
 2024-03-18 15:34:45 -07:00
フィルターペーパー
736c5fb46e feat(docs): Add a note on macOS v14.3 file copy error message 2024-03-18 10:38:09 -07:00
Theo Lemay
341534aa15 feat(behaviors): lazy sticky keys 2024-03-18 10:30:14 -07:00
Cem Aksoylar
325e207781 feat(docs): Add pointers to HID descriptor refresh 2024-03-18 09:58:16 -07:00
Cem Aksoylar
aa6cfe250d feat(docs): Document refreshing the HID descriptor 2024-03-18 09:58:16 -07:00
Cem Aksoylar
bddee70b6b refactor(docs): Remove outdated Windows battery advice and unnecessary header 2024-03-18 09:58:16 -07:00
ReFil
388ad71385
feat(build): Explicit missing keymap node error 
* Explicit error if zmk,keymap not set
* Document keymap error

---------

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
 2024-03-18 12:54:47 -04:00
Joel Spadin
14b06a36bf docs: Update settings_reset documentation 
Updated the section for troubleshooting split halves unable to pair now
that the settings_reset shield resets all settings and explicitly
disables CONFIG_ZMK_BLE:

- Added a note that all settings will be reset.
- Removed the section about immediately putting the halves into
  bootloader mode to prevent pairing, as this is not necessary anymore.
- Added a note that you will not be able to see or pair the Bluetooth
  keyboard until you have flashed regular firmware again.
- Added a sentence to clarify that you will need to re-pair the
  keyboard to all host devices.

Also added some text describing common scenarios where this procedure
might be needed.
 2024-03-18 09:48:19 -07:00
Joel Spadin
1dfcfc7d3f feat(shields): Make settings_reset shield reset all settings 
Added a new CONFIG_ZMK_SETTINGS_RESET_ON_START option which enables init
code to call zmk_settings_erase(), and changed the settings_reset shield
to use it instead of CONFIG_ZMK_BLE_CLEAR_BONDS_ON_START, so it now
resets all settings instead of just clearing BLE bonds.

CONFIG_ZMK_BLE_CLEAR_BONDS_ON_START is left in place for now in case
someone still needs it. It may be replaced in the future once we find a
better way to repair a broken split connection.
 2024-03-18 09:48:19 -07:00
Thomas Huber
37af94edde feat(docs): Add warning to new shield docs how Kconfig treats whitspaces 
Added a warning to the shield section explaining that Kconfig does
not ignore whitespaces on function calls and therefore adding whitespaces
after the comma will break functionality.
 2024-03-04 20:08:52 -08:00
Andrew Kannan
db7b197790
fix(docs): Add underglow brightness min/max (#2180) 2024-02-28 10:39:04 -08:00
Theo Lemay
c007d60357 feat(behaviors): hold while undecided 2024-02-20 00:25:53 -08:00
Dennis
604af2ebd3
feat(docs): Add pointers for peripheral battery monitoring (#2177) 
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>

Fixes #2166
 2024-02-17 21:51:09 -08:00
Pete Johanson
f72f415c5b fix(docs): More Zephyr docs link updates. 
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
 2024-02-09 14:32:46 -08:00
Peter Johanson
edc72c1166 chore(docs): Update Zephyr links to 3.5.0 versions. 2024-02-09 14:32:46 -08:00
Peter Johanson
18e5a1a26b feat: Add Zephyr 3.5 blog post. 2024-02-09 14:32:46 -08:00
Peter Johanson
d6de8a3acc refactor: Move to POST_KERNEL phase for behavior inits. 2024-02-09 14:32:46 -08:00