zmkfirmware
/
zmk
mirror of https://github.com/zmkfirmware/zmk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
2,900 Commits 23 Branches 7 Tags 108 MiB
Commit Graph

1115 Commits

Author SHA1 Message Date
dependabot[bot] 87cea76c93
chore(deps): bump react-toastify from 10.0.5 to 10.0.6 in /docs (#2589) 
Bumps [react-toastify](https://github.com/fkhadra/react-toastify) from 10.0.5 to 10.0.6.
- [Release notes](https://github.com/fkhadra/react-toastify/releases)
- [Commits](https://github.com/fkhadra/react-toastify/compare/v10.0.5...v10.0.6)

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

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
 2024-10-23 13:10:34 +02:00
dependabot[bot] 9a68b2eeb7
chore(deps-dev): bump @types/react from 18.3.5 to 18.3.12 in /docs (#2587) 
Bumps [@types/react](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/react) from 18.3.5 to 18.3.12.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/react)

---
updated-dependencies:
- dependency-name: "@types/react"
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
 2024-10-23 13:07:45 +02:00
dependabot[bot] 428c36bc59
chore(deps-dev): bump eslint-plugin-react from 7.37.1 to 7.37.2 in /docs (#2588) 
Bumps [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) from 7.37.1 to 7.37.2.
- [Release notes](https://github.com/jsx-eslint/eslint-plugin-react/releases)
- [Changelog](https://github.com/jsx-eslint/eslint-plugin-react/blob/master/CHANGELOG.md)
- [Commits](https://github.com/jsx-eslint/eslint-plugin-react/compare/v7.37.1...v7.37.2)

---
updated-dependencies:
- dependency-name: eslint-plugin-react
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
 2024-10-23 13:05:51 +02:00
Nicolas Munnich 5487b108d5
docs: fixing some more broken anchors (#2586) 2024-10-23 02:16:59 +02:00
dependabot[bot] 55c67804eb
chore(deps): bump http-proxy-middleware from 2.0.6 to 2.0.7 in /docs (#2585) 
Bumps [http-proxy-middleware](https://github.com/chimurai/http-proxy-middleware) from 2.0.6 to 2.0.7.
- [Release notes](https://github.com/chimurai/http-proxy-middleware/releases)
- [Changelog](https://github.com/chimurai/http-proxy-middleware/blob/v2.0.7/CHANGELOG.md)
- [Commits](https://github.com/chimurai/http-proxy-middleware/compare/v2.0.6...v2.0.7)

---
updated-dependencies:
- dependency-name: http-proxy-middleware
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
 2024-10-23 01:52:19 +02:00
dependabot[bot] 0d8b23fccb
chore(deps): bump mermaid from 10.9.1 to 10.9.3 in /docs (#2584) 
Bumps [mermaid](https://github.com/mermaid-js/mermaid) from 10.9.1 to 10.9.3.
- [Release notes](https://github.com/mermaid-js/mermaid/releases)
- [Changelog](https://github.com/mermaid-js/mermaid/blob/develop/CHANGELOG.md)
- [Commits](https://github.com/mermaid-js/mermaid/compare/v10.9.1...v10.9.3)

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

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
 2024-10-23 01:49:45 +02:00
dependabot[bot] e9681270d3
chore(deps): bump @mdx-js/react from 3.0.1 to 3.1.0 in /docs (#2580) 
Bumps [@mdx-js/react](https://github.com/mdx-js/mdx/tree/HEAD/packages/react) from 3.0.1 to 3.1.0.
- [Release notes](https://github.com/mdx-js/mdx/releases)
- [Changelog](https://github.com/mdx-js/mdx/blob/main/changelog.md)
- [Commits](https://github.com/mdx-js/mdx/commits/3.1.0/packages/react)

---
updated-dependencies:
- dependency-name: "@mdx-js/react"
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
 2024-10-23 01:48:09 +02:00
dependabot[bot] 4c47d67e63
chore(deps-dev): bump typescript from 5.5.4 to 5.6.3 in /docs (#2581) 
Bumps [typescript](https://github.com/microsoft/TypeScript) from 5.5.4 to 5.6.3.
- [Release notes](https://github.com/microsoft/TypeScript/releases)
- [Changelog](https://github.com/microsoft/TypeScript/blob/main/azure-pipelines.release.yml)
- [Commits](https://github.com/microsoft/TypeScript/compare/v5.5.4...v5.6.3)

---
updated-dependencies:
- dependency-name: typescript
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
 2024-10-23 01:39:19 +02:00
dependabot[bot] 8756a064d1
chore(deps-dev): bump webpack from 5.94.0 to 5.95.0 in /docs (#2578) 
Bumps [webpack](https://github.com/webpack/webpack) from 5.94.0 to 5.95.0.
- [Release notes](https://github.com/webpack/webpack/releases)
- [Commits](https://github.com/webpack/webpack/compare/v5.94.0...v5.95.0)

---
updated-dependencies:
- dependency-name: webpack
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
 2024-10-21 09:01:53 +02:00
KingCoinless 7293037f18
docs(codes): Android Support: Basic Controls and Input + Display (#603) 
* docs(codes): Android Support: Basic Controls and Input + Display
---------

Co-authored-by: Nicolas Munnich <98408764+Nick-Munnich@users.noreply.github.com>
 2024-10-20 23:57:00 +02:00
dependabot[bot] a057e4c89d
chore(deps-dev): bump json-schema-to-typescript from 13.1.2 to 15.0.2 in /docs (#2454) 
* chore(deps-dev): bump json-schema-to-typescript in /docs

Bumps [json-schema-to-typescript](https://github.com/bcherny/json-schema-to-typescript) from 13.1.2 to 15.0.2.
- [Changelog](https://github.com/bcherny/json-schema-to-typescript/blob/master/CHANGELOG.md)
- [Commits](https://github.com/bcherny/json-schema-to-typescript/commits)

---
updated-dependencies:
- dependency-name: json-schema-to-typescript
  dependency-type: direct:development
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>

* fix: glob types missing

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Nicolas Munnich <nickmunnich@gmail.com>
 2024-10-20 18:38:11 +02:00
dependabot[bot] 7f1ee320ab
chore(deps): bump cookie and express in /docs (#2570) 
Bumps [cookie](https://github.com/jshttp/cookie) and [express](https://github.com/expressjs/express). These dependencies needed to be updated together.

Updates `cookie` from 0.6.0 to 0.7.1
- [Release notes](https://github.com/jshttp/cookie/releases)
- [Commits](https://github.com/jshttp/cookie/compare/v0.6.0...v0.7.1)

Updates `express` from 4.19.2 to 4.21.1
- [Release notes](https://github.com/expressjs/express/releases)
- [Changelog](https://github.com/expressjs/express/blob/4.21.1/History.md)
- [Commits](https://github.com/expressjs/express/compare/4.19.2...4.21.1)

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

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
 2024-10-19 20:01:01 +02:00
dependabot[bot] b67f8bbe9f
chore(deps-dev): bump eslint-plugin-react from 7.35.0 to 7.37.1 in /docs (#2524) 
Bumps [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) from 7.35.0 to 7.37.1.
- [Release notes](https://github.com/jsx-eslint/eslint-plugin-react/releases)
- [Changelog](https://github.com/jsx-eslint/eslint-plugin-react/blob/master/CHANGELOG.md)
- [Commits](https://github.com/jsx-eslint/eslint-plugin-react/compare/v7.35.0...v7.37.1)

---
updated-dependencies:
- dependency-name: eslint-plugin-react
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
 2024-10-19 19:52:54 +02:00
dependabot[bot] 548fe7f6bd
chore(deps): bump serve-static and express in /docs (#2483) 
Bumps [serve-static](https://github.com/expressjs/serve-static) and [express](https://github.com/expressjs/express). These dependencies needed to be updated together.

Updates `serve-static` from 1.15.0 to 1.16.2
- [Release notes](https://github.com/expressjs/serve-static/releases)
- [Changelog](https://github.com/expressjs/serve-static/blob/v1.16.2/HISTORY.md)
- [Commits](https://github.com/expressjs/serve-static/compare/v1.15.0...v1.16.2)

Updates `express` from 4.19.2 to 4.21.0
- [Release notes](https://github.com/expressjs/express/releases)
- [Changelog](https://github.com/expressjs/express/blob/4.21.0/History.md)
- [Commits](https://github.com/expressjs/express/compare/4.19.2...4.21.0)

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

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
 2024-10-19 19:39:26 +02:00
dependabot[bot] 94100e307b
chore(deps-dev): bump eslint-config-prettier in /docs (#2127) 
Bumps [eslint-config-prettier](https://github.com/prettier/eslint-config-prettier) from 8.10.0 to 9.1.0.
- [Changelog](https://github.com/prettier/eslint-config-prettier/blob/main/CHANGELOG.md)
- [Commits](https://github.com/prettier/eslint-config-prettier/compare/v8.10.0...v9.1.0)

---
updated-dependencies:
- dependency-name: eslint-config-prettier
  dependency-type: direct:development
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
 2024-10-19 14:52:13 +02:00
dependabot[bot] 2e9d72ba6b
chore(deps-dev): bump prettier from 2.8.8 to 3.3.3 in /docs (#2374) 
Bumps [prettier](https://github.com/prettier/prettier) from 2.8.8 to 3.3.3.
- [Release notes](https://github.com/prettier/prettier/releases)
- [Changelog](https://github.com/prettier/prettier/blob/main/CHANGELOG.md)
- [Commits](https://github.com/prettier/prettier/compare/2.8.8...3.3.3)

---
updated-dependencies:
- dependency-name: prettier
  dependency-type: direct:development
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
 2024-10-19 14:47:00 +02:00
Nicolas Munnich a6d09f8c00 docs: Added mastodon link in footer 2024-10-17 15:01:30 -06:00
Peter Johanson 64c1e1e3ff feat: Add `studio` as a feature option in metadata 
* Allow boards/shields to indicate ZMK Studio support in the `features` list.
 2024-10-17 10:20:30 -06:00
Peter Johanson c8841c4119 docs: Add note about .keymap changes when using Studio 2024-10-16 13:09:51 -06:00
Peter Johanson 993a64d5b3 docs: Better document the layer `display-name` prop. 2024-10-16 11:57:27 -06:00
Peter Johanson 6cbf25f04a docs: Update Studio status warnings to beta. 
Co-authored-by: Nicolas Munnich <98408764+Nick-Munnich@users.noreply.github.com>
 2024-10-14 09:42:06 -06:00
Peter Johanson 0abc1eaf23 docs: Add ZMK Studio links. 
* Add a toplevel ZMK Studio link in our header.
* Add link to the web and app releases to the feature page.
 2024-10-14 09:42:06 -06:00
Nicolas Munnich a72327bdff
docs: Physical layout docs improvements (#2533) 
* docs: Added layout configuration reference page
* docs: Refactored and revamped physical layout creation information
* docs: Added note in studio features page
* docs: added studio_unlock note in features section
---------

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
Co-authored-by: Joel Spadin <joelspadin@gmail.com>
Co-authored-by: Peter Johanson <peter@peterjohanson.com>
 2024-10-12 21:25:45 +02:00
Cem Aksoylar 022ede9d1e docs: Remove download for settings_reset and note local build 2024-10-08 17:04:36 -07:00
Cem Aksoylar 16976db58c docs: Fix columns names in kscan config 2024-10-08 14:58:04 -07:00
Cem Aksoylar 6e2d30d589 docs: Add missing hold-trigger-on-release to config 2024-10-08 14:58:04 -07:00
Peter Johanson 6cac781ada feat: Add basic metadata info to new behavior guide. 
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
Co-authored-by: Nicolas Munnich <98408764+Nick-Munnich@users.noreply.github.com>
 2024-10-08 00:45:37 -06:00
LostQuasar 90d6285d98
blog: Remove reference to spaceman (#2520) 2024-09-30 19:43:58 -07:00
Nicolas Munnich e195822559 docs: fixed broken anchors 2024-09-30 16:43:47 -07:00
Nicolas Munnich 99b424bb4b
docs: Streamlined the new shield guide (#2515) 
* docs: Streamlined the new shield guide

---------

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
 2024-10-01 00:00:55 +02:00
Nicolas Munnich a314128ea8
docs: Pull encoders from new shield guide to its own page (#2510) 
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
 2024-09-30 10:06:00 -07:00
Nicolas Munnich 1f900bfc9c
docs: Added a note on bluetooth profiles under "unable to connect to device" (#2509) 
* docs: Added a note on bluetooth profiles under "unable to connect to device"

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>

---------

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
 2024-09-26 19:49:13 +02:00
Cem Aksoylar 8166527ea3 fix(docs): Remove split locality issue note 2024-09-23 10:17:29 -06:00
Jim Aho 6e03a0bb67
fix(docs): Fix wording in layers section in keymaps (#2474) 2024-09-12 13:57:19 -07:00
Nicolas Munnich 1c48f64730
fix(docs): Fix broken anchor in Studio setup (#2465) 2024-09-07 09:26:24 -07:00
Nicolas Munnich f0319fde94
docs(feat): Added a page on shift registers (#2452) 
Added a page on shift registers
---------

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
 2024-09-07 13:19:01 +02:00
Grazfather 58207fdb2c
fix(docs): Mention display-name property in layer docs (#2460) 2024-09-06 20:03:23 -07:00
Peter Johanson 3975d2fdaf feat: Add studio related documentation. 
* Document setting up studio for a new keyboard definition.
* Document how to enable ZMK Studio for a build, adding reserved layers,
  and controlling which behaviors are built into a studio firmware.
* Document `&studio_unlock` behavior.
* Document studio configuration options.

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
 2024-09-05 12:22:08 -06:00
dependabot[bot] 0f972f1cc3 chore(deps): bump web-tree-sitter from 0.20.8 to 0.23.0 in /docs 
Bumps [web-tree-sitter](https://github.com/tree-sitter/tree-sitter) from 0.20.8 to 0.23.0.
- [Release notes](https://github.com/tree-sitter/tree-sitter/releases)
- [Changelog](https://github.com/tree-sitter/tree-sitter/blob/master/CHANGELOG.md)
- [Commits](https://github.com/tree-sitter/tree-sitter/compare/v0.20.8...v0.23.0)

---
updated-dependencies:
- dependency-name: web-tree-sitter
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
 2024-09-01 22:57:37 -07:00
Nicolas Munnich 266227b580
refactor(docs): Refactor the development section (#2438) 2024-09-01 21:54:19 -07:00
Cem Aksoylar aae4feeda8 chore(deps): npm update on docs 2024-09-01 21:37:47 -07:00
Cem Aksoylar b74cd39ab5 chore(blog): Use truncate markers 2024-09-01 00:15:23 -07:00
Cem Aksoylar 0120156002 refactor(blog): Use global authors 2024-09-01 00:15:23 -07:00
Cem Aksoylar 745b960593 fix(docs): Fix broken anchors 2024-09-01 00:13:46 -07:00
dependabot[bot] 882226e261 chore(deps-dev): bump webpack from 5.89.0 to 5.94.0 in /docs 
Bumps [webpack](https://github.com/webpack/webpack) from 5.89.0 to 5.94.0.
- [Release notes](https://github.com/webpack/webpack/releases)
- [Commits](https://github.com/webpack/webpack/compare/v5.89.0...v5.94.0)

---
updated-dependencies:
- dependency-name: webpack
  dependency-type: direct:development
...

Signed-off-by: dependabot[bot] <support@github.com>
 2024-08-31 17:13:32 -07:00
dependabot[bot] d74896d780 chore(deps): bump micromatch from 4.0.5 to 4.0.8 in /docs 
Bumps [micromatch](https://github.com/micromatch/micromatch) from 4.0.5 to 4.0.8.
- [Release notes](https://github.com/micromatch/micromatch/releases)
- [Changelog](https://github.com/micromatch/micromatch/blob/master/CHANGELOG.md)
- [Commits](https://github.com/micromatch/micromatch/compare/4.0.5...4.0.8)

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

Signed-off-by: dependabot[bot] <support@github.com>
 2024-08-31 17:06:43 -07:00
Anant Thazhemadam 6946ca8b07
fix(docs): minor corrections and fix typo (#2443) 
* docs(faq): minor corrections

* docs: fix typo - `s/Alterative/Alternative`

* docs(faq): use Lily58 as an example instead of Corne with revision

Co-authored-by: Nicolas Munnich <98408764+Nick-Munnich@users.noreply.github.com>

---------

Co-authored-by: Nicolas Munnich <98408764+Nick-Munnich@users.noreply.github.com>
 2024-08-27 16:23:15 +02:00
William Brockhus b866ec031f
fix(docs): Fixing wording in the split keyboards feature page (#2440) 2024-08-25 09:31:21 +02:00
Nicolas Munnich 5f056f7199
refactor(docs): Convert the keymaps section into a base folder (#2430) 
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
 2024-08-21 10:39:18 -07:00
Nicolas Munnich 503f6c8e58
feat(docs): Add and modify docs to point users to the experimental zmk-cli (#2431) 
Co-authored-by: Joel Spadin <joelspadin@gmail.com>
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
 2024-08-21 10:36:23 -07:00
Peter Johanson b735a051ce fix(docs): Admonition formatting fix. 2024-08-15 12:51:38 -06:00
Peter Johanson feda96eb40 feat(studio): Initial RPC infrastructure and subsystems. 
* UART and BLE/GATT transports for a protobuf encoded RPC
  request/response protocol.
* Custom framing protocol is used to frame a give message.
* Requests/responses are divided into major "subsystems" which
  handle requests and create response messages.
* Notification support, including mapping local events to RPC
  notifications by a given subsystem.
* Meta responses for "no response" and "unlock needed".
* Initial basic lock state support in a new core section, and allow specifying
  if a given RPC callback requires unlocked state or not.
* Add behavior subsystem with full metadata support and examples of
  using callback to serialize a repeated field without extra stack space needed.

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
 2024-08-15 11:45:18 -06:00
Cem Aksoylar ea64fcaf71 fix(docs): Note direct pin use in matrix transform 2024-08-15 10:38:10 -07:00
dependabot[bot] 6fe13c9565
chore(deps-dev): bump eslint-plugin-mdx from 2.3.3 to 3.1.5 in /docs (#2128) 
Bumps [eslint-plugin-mdx](https://github.com/mdx-js/eslint-mdx) from 2.3.3 to 3.1.5.
- [Release notes](https://github.com/mdx-js/eslint-mdx/releases)
- [Changelog](https://github.com/mdx-js/eslint-mdx/blob/master/CHANGELOG.md)
- [Commits](https://github.com/mdx-js/eslint-mdx/compare/eslint-plugin-mdx@2.3.3...eslint-plugin-mdx@3.1.5)

---
updated-dependencies:
- dependency-name: eslint-plugin-mdx
  dependency-type: direct:development
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
 2024-08-15 16:15:39 +02:00
dependabot[bot] 08988ec7da
chore(deps): bump braces from 3.0.2 to 3.0.3 in /docs (#2337) 
Bumps [braces](https://github.com/micromatch/braces) from 3.0.2 to 3.0.3.
- [Changelog](https://github.com/micromatch/braces/blob/master/CHANGELOG.md)
- [Commits](https://github.com/micromatch/braces/compare/3.0.2...3.0.3)

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

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
 2024-08-15 16:14:45 +02:00
Cem Aksoylar 96cd3a1ce2 refactor(docs): Remove unnecessary jsx includes 2024-08-13 23:03:15 -07:00
Cem Aksoylar 4faeb365b1 feat(docs): Add keyboard vs consumer variants note 2024-08-13 23:03:15 -07:00
Cem Aksoylar ba0dee088f feat(docs): Add section on nesting mod-morphs 
Co-authored-by: Nicolas Munnich <98408764+Nick-Munnich@users.noreply.github.com>
 2024-08-13 14:56:07 -07:00
Cem Aksoylar 0d15ae84f4 fix(docs): Fix mod-morph terms from keycodes to bindings 2024-08-13 14:56:07 -07:00
Cem Aksoylar 8b909acdcf refactor(docs): Add subheaders for devicetree error types 2024-08-13 11:11:27 -07:00
Cem Aksoylar 3de8a56fcb feat(docs): Add a note on column numbers for DTS errors 2024-08-13 11:11:27 -07:00
Cem Aksoylar 00e4818094 fix(docs): Fix broken anchor in reset behaviors 2024-08-13 10:51:40 -07:00
Nicolas Munnich 049c070b3a
feat(docs): Minor improvements to the docs (#2411) 2024-08-13 10:47:45 -07:00
Pete Johanson 6d50ba5553 chore: Docs review tweaks. 
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
 2024-08-12 16:57:54 -07:00
Peter Johanson 3fec690def feat: Add config settings for sticky keys/hold-tap 
* Add new Kconfig symbols to config max held sticky-keys/hold-taps
  and for max captured events during hold-tap resolution.
 2024-08-12 16:57:54 -07:00
Cem Aksoylar 2eff266f5b feat(docs): Add battery life remark for split keyboards 2024-08-07 23:57:58 -07:00
Cem Aksoylar 2a0708d1fc feat(docs): Add locality warning for nested behaviors 2024-08-07 23:57:58 -07:00
Cem Aksoylar 2501f1f548 feat(docs): Add references to new split keyboards page 2024-08-07 23:57:58 -07:00
Cem Aksoylar d75e388593 feat(docs): Add split keyboards feature page 
Co-authored-by: Nicolas Munnich <98408764+Nick-Munnich@users.noreply.github.com>
 2024-08-07 23:57:58 -07:00
Cem Aksoylar 47a6715aa6 fix(docs): Fix toggle layer docs 2024-08-02 11:17:10 -07:00
Cem Aksoylar b9a025c76e
fix(docs): Document number of peripherals Kconfig (#2389) 
Fixes #2373
 2024-08-02 18:57:15 +02:00
Cem Aksoylar b080befebb fix(docs): Fix link for matrix transform 2024-08-02 09:55:20 -07:00
Nicolas Munnich 9e7fcde868
feat(docs): Improve the layers-related documentation (#2390) 
Fixes #1284
 2024-07-31 20:53:36 -07:00
Nicolas Munnich f92dce43e9
feat(docs): Add modules feature page (#2380) 
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
 2024-07-25 12:08:08 -07:00
Nicolas Munnich fd152baff0
feat(docs): Add troubleshooting notes on experimental bluetooth options (#2387) 
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
 2024-07-25 12:00:22 -07:00
Cem Aksoylar 7bd74a6b0f fix(docs): Add required display-name in physical layout examples 2024-07-14 16:59:15 -07:00
Peter Johanson b4f9081b09 docs: Updated new shield documentation for physical layouts. 
* Document how to define one or more physical layouts and assign
  the chosen one.

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
 2024-07-03 16:52:05 -06:00
Peter Johanson 0438cb0ee5 feat(kscan): More complete PM support to drivers. 
* Update our GPIO kscan drivers to more completely support PM device,
  by doing proper hardare init/deinit in the PM action hook.
 2024-07-03 16:52:05 -06:00
Timoyoungster 29599e8b0a docs: hopefully more clear description of the new setting 2024-06-24 14:26:14 -06:00
Timoyoungster 10d03ca46c fix: adding option to separate implicit mod release from key release 
This adds a new config value `ZMK_HID_SEPARATE_MOD_RELEASE_REPORT`
where, if enabled, the report for a key release is sent separately to
the accompanying modifier release signals, which are then sent in a
second report.

This fixes an issue where certain applications are unable to work with
implicitly modified keys (e.g. colon) due to them registering the
modifier release prior to the actual key release.

Have tested this on my personal keyboard and `wev` now shows the signals
in the correct order.

=> **Previously:** ```LSHIFT (pressed) -> colon (pressed) -> LSHIFT
(released) -> **semi**colon (released)```

=> **Now:** ```LSHIFT (pressed) -> colon (pressed) -> colon (released)
-> LSHIFT (released)```

(This time without accidental files)
 2024-06-24 14:26:14 -06:00
honorless 4dce096161 docs: improve settings_reset link 2024-06-24 13:18:56 -07:00
Peter Johanson a080b5287f refactor: Remove static CDC ACM logging nodes. 
* To avoid spurious CDC ACM instances when usint CDC ACM for something
  other than logging, move to the approach used by Zephyr of using a
  snippet to redirect console output to a CDC ACM node added by the
  snippet. Remove all the existing static CDC ACM nodes.
* Add new `zmk-usb-logging` snippet that mirrors the upstream
  `cdc-acm-logging` snippet, but still does our extra USB logging
  configuration.
* Updated logging docs accordingly.

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
 2024-06-20 12:06:13 -06: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
Joel Spadin 5826b80374 chore: Fix formatting 
Fixed the formatting in a file that wasn't passing pre-commit checks.
 2024-02-03 21:56:20 -08:00
Joel Spadin 3a4cf185a1 feat(keymap-upgrader): Upgrade encoder resolution 
Added an upgrade function to the keymap upgrader to replace the encoder
"resolution" property with "steps" and (if it is not already present)
"triggers-per-rotation".
 2024-02-03 18:45:21 -06:00
Joel Spadin be75da096c fix(keymap-upgrader): Fix highlight on last line 
Fixed an issue where a text edit at the very end of a file would cause
it to highlight from the start of the edit to the start of the file
instead of to the end of the file.
 2024-02-03 18:45:21 -06:00
Johan Friis aab09d504c
feat(docs): Document Karabiner interference with Mod-Morphs (#2146) 2024-01-30 00:07:48 -08:00
Dhruvin Shah 5685074835 docs: correcting file path in config.md 2024-01-27 11:40:12 -06:00
Joel Spadin 1dbd6910cb chore(docs): Update tree-sitter-devicetree to 0.9.0 2024-01-25 18:03:37 -06:00
Joel Spadin 08d9391a8a feat(keymap-upgrader): Upgrade renamed nodes 
Added an upgrade function to fix renamed behavior nodes in the unlikely
event that someone was changing behavior settings this way instead of
using references.
 2024-01-25 18:03:37 -06:00
Joel Spadin bf5284b3b9 fix(keymap-upgrader): Note that changed lines are highlighted 2024-01-25 18:03:37 -06:00
Joel Spadin d4be70587d fix(keymap-upgrader): Filter key codes to bindings 
Changed the key code upgrader to only replace codes that appear in
"bindings" properties. Modifier flags such as MOD_LCTL are no longer
valid as key codes, but they are still used in "mods" properties and
should not be replaced there.
 2024-01-25 18:03:37 -06:00
Joel Spadin 37fcf190e6 feat(keymap-upgrader): Highlight changes 
Updated the keymap upgrader to highlight which lines it changed as well
as indicate when nothing needed to be upgraded.

Also adjusted the line highlight colors to be more readable in both
light and dark color schemes.
 2024-01-25 18:03:37 -06:00
Joel Spadin 84e056793b fix(docs): Fix links to keymap upgrader 2024-01-25 18:03:37 -06:00
Joel Spadin a0465391be refactor: Improve keymap upgrader 
Moved the keymap upgrader to a top-level page like the power profiler
to make it more discoverable. It upgrades more things than key codes
now, so putting it in the codes category doesn't make much sense.

Converted the upgrader code to TypeScript and split it up into smaller
files to make it easier to add new upgrade functions.

Added upgrade functions to remove/replace "label" properties and rename
matrix-transform.h to matrix_transform.h.
 2024-01-25 18:03:37 -06:00
honorless a3fbc2a5ba docs: suggest zmk,matrix-transform over zmk,matrix_transform 
* While functionally equivalent, the hyphenated form of this property
  is more consistent with other ZMK properties and adheres to DTS style
  guidelines.

* Additionally, update links to use Zephyr 3.2 documentation instead
  of 2.5 where appropriate.
 2024-01-23 23:02:35 -06:00
Cem Aksoylar 19613128b9 fix(docs): Fix extra line issue in hardware headers 
Need to make prettier ignore these, because otherwise it splits
them to separate lines and reverts the whole change
 2024-01-20 22:28:41 -08:00
Cem Aksoylar 0dc04df09c fix(docs): Fix eslint-plugin-react errors 
Remove unused components, and disable proptype checking for children
in OsTabs custom component since I can't figure out a way to assign
propTypes to it in an mdx file.
 2024-01-20 22:28:41 -08:00
Cem Aksoylar 7196f9f075 ci(docs): Disable eslint rule for unescaped entities 
eslint-plugin-react is emitting a lot of react/no-unescaped-entities
errors in mdx files, primarily due to apostrophes. It seems not ideal
to have to escape every apostrophe in all mdx text, so this commit
disables the check.

There might be a better way to handle this issue, but I am not aware
of one right now.
 2024-01-20 22:28:41 -08:00
Cem Aksoylar fa91648cce ci(docs): Use eslint plugin for automatic JSX runtime 
Ref: https://docusaurus.io/docs/migration/v3#automatic-jsx-runtime
and https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/react-in-jsx-scope.md#when-not-to-use-it
 2024-01-20 22:28:41 -08:00
Cem Aksoylar e3f458e539 ci(docs): Fix tsc config for docusaurus 3 2024-01-20 22:28:41 -08:00
Cem Aksoylar 57684f8a66 fix(docs): Fix broken anchors in docs (but not blog) 2024-01-20 22:28:41 -08:00
Cem Aksoylar 5cbffd6625 fix(docs): Work around docusaurus bug causing broken links 
Some links ended up broken after docusaurus 3 upgrade,
especially if they are the second on the same line and have anchors.
Likely due to https://github.com/facebook/docusaurus/issues/9518
 2024-01-20 22:28:41 -08:00
Cem Aksoylar 1b326ff856 fix(docs): Fix relative links with trailing slashes 2024-01-20 22:28:41 -08:00
Cem Aksoylar dcfe07d9f6 refactor(docs): Use new admonition title syntax and disable mdx v1 compat 2024-01-20 22:28:41 -08:00
Cem Aksoylar ee855de349 fix(docs): Fix incorrect admonition title 2024-01-20 22:28:41 -08:00
Cem Aksoylar f014eb45a7 refactor(docs): Use .mdx for docs with mdx features 
Also applies prettier changes in touched files due to precommit
 2024-01-20 22:28:41 -08:00
Cem Aksoylar 00962a7255 refactor(docs): Remove no longer necessary React imports 2024-01-20 22:28:41 -08:00
Cem Aksoylar a0a952413a fix(docs): Fix deprecated admonition types 2024-01-20 22:28:41 -08:00
Cem Aksoylar 13c856d1d3 fix(docs): Fix mdx 3 incompatibility 2024-01-20 22:28:41 -08:00
Cem Aksoylar 0827ff245f chore(docs): Update docusaurus to 3 
Following https://docusaurus.io/docs/migration/v3#upgrading-dependencies
and `npm update`
 2024-01-20 22:28:41 -08:00
crides 8c14b155e8 docs: confirm some consumer codes on iOS 
Tested on iOS 16.6
 2024-01-15 18:07:48 -08:00
typorian 466cf92029
fix(docs): Document `CONFIG_ZMK_USB_BOOT` 2024-01-12 11:02:47 -08:00
dependabot[bot] 2829185a94 chore(deps): bump follow-redirects from 1.15.2 to 1.15.4 in /docs 
Bumps [follow-redirects](https://github.com/follow-redirects/follow-redirects) from 1.15.2 to 1.15.4.
- [Release notes](https://github.com/follow-redirects/follow-redirects/releases)
- [Commits](https://github.com/follow-redirects/follow-redirects/compare/v1.15.2...v1.15.4)

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

Signed-off-by: dependabot[bot] <support@github.com>
 2024-01-12 10:42:52 -08:00
Chris Andreae 7d1c1ae8fd fixup! docs 
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
 2024-01-05 12:16:38 -08:00
Chris Andreae 7b9466c7dc fixup! add documentation for BT_CLR_ALL 2024-01-05 12:16:38 -08:00
Cem Aksoylar b3146e665e
feat(blog): Add post for joelspadin projects for spotlight series (#2092) 
Co-authored-by: Joel Spadin <joelspadin@gmail.com>
 2024-01-05 10:42:04 -08:00
Gabor Hornyak 0e2f94b73b feat(ble): Support perhipheral battery levels. 
* Add ability to fetch and report peripheral battery levels
  on split centrals.
* Add additional support for adding a new Battery Level
  service to split centrals that exposes fetched peripheral
  battery levels to connected hosts.

Co-authored-by: Peter Johanson <peter@peterjohanson.com>
 2024-01-03 09:26:51 -08:00
Cem Aksoylar 12d73ba4f9 fix(docs): Fix remark on &bt parameter #2 2023-12-17 17:38:07 -08:00
Cem Aksoylar 78fa1e77c4 feat(blog): Add nodefree-config post for spotlight series 
Co-authored-by: Robert U <978080+urob@users.noreply.github.com>
 2023-12-16 21:55:45 -08:00
Peter Johanson 9b3a98691c refactor(bt): Split security and conn exp. Kconfig 
* Split connection and security experimental changes into dedicated
  Kconfig flags for easier testing of only connection related fixes.

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
 2023-12-15 08:59:03 -08:00
Hooky 2c50cff891
feat(kscan): Add charlieplex keyscan driver 
* Supports matrixes with and without additional interrupt pin use.

Co-authored-by: Peter Johanson <peter@peterjohanson.com>
 2023-12-09 17:10:05 -05:00
Peter Johanson 63c8c5700a feat(bt): Add more experimental tweaks. 
* Support auto security upgrade for splits properly.
* Disable 2M and legacy LLCP if the experimental
  Kconfig flag is selected.
 2023-12-08 14:57:23 -08:00
Cem Aksoylar 384637ae6c fix(docs): Fix text blurb about split Kconfig.defconfig 2023-12-06 22:50:06 -08:00
Cem Aksoylar 09d47d8117 refactor(docs): Convert breaks to unordered lists in tables 
Co-authored-by: Joel Spadin <joelspadin@gmail.com>
 2023-12-06 22:46:03 -08:00
Cem Aksoylar 55bf7cae7e feat(docs): Note how parameters are forwarded for behaviors 2023-12-06 22:46:03 -08:00
Cem Aksoylar 56d863cba6 feat(docs): Document sensor-rotate in behaviors config 2023-12-06 22:46:03 -08:00
Cem Aksoylar 2bab81a304 fix(docs): Note -var definition files for macros 2023-12-06 22:46:03 -08:00
Cem Aksoylar 76a209c728 fix(docs): Fix sticky key #binding-cells 2023-12-06 22:46:03 -08:00
Cem Aksoylar f3ad08b619 fix(docs): Add missing page pointers in behaviors config 2023-12-06 22:46:03 -08:00
Peter Johanson 291bbc2257 refactor(docs): New shield guide to suggest modules 
* Update the new shield guide to position Zephyr module location
  as the default when creating new shields, with a note about
  using ZMK repository itself as a last resort.
* Document building with additional Zephyr modules.

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
 2023-12-06 09:36:37 -08:00
Peter Johanson 0ab6a0ad11 feat(bt): Add new experimental Kconfig setting. 
* In order to have an easy way to test and phase in BT changes, add a
  new `ZMK_BLE_EXPERIMENTAL_FEATURES` Kconfig setting.
 2023-12-06 09:22:50 -08:00
Joel Spadin 0fd8e25807 docs: Document behavior name length limit 
Added a section to the new behavior guide to document that the names of
behaviors invoked on the peripheral side of a split must be at most 8
characters long.
 2023-12-04 20:06:54 -06:00
Joel Spadin 36eda571b7 refactor(behaviors): Create a list to lookup behaviors 
Added BEHAVIOR_DT_DEFINE() and BEHAVIOR_DT_INST_DEFINE(), which work
exactly like the DEVICE_*_DEFINE() macros, except they also register the
device as a behavior by adding a pointer to it to a memory section.

Added zmk_behavior_get_binding(), which works like device_get_binding()
except that it only searches the devices that have been registered as
behaviors. This ensures that behaviors cannot have name collisions with
other devices defined by the SoC, which will be important when we remove
the label property from behaviors so they are given their node names.

As an added benefit, this is faster since it searches a smaller list.
Some basic benchmark code I wrote indicates it takes 30-70% as long,
depending on where the behavior is in the list and whether the name
string is an exact pointer match.

From now on, behaviors should use BEHAVIOR_*_DEFINe() instead of
DEVICE_*_DEFINE(), and any code that looks up a behavior by name should
use zmk_behavior_get_binding() instead of device_get_binding().
 2023-12-04 20:06:54 -06:00
Joel Spadin 5ecd3521f5 docs: Remove label property from documentation 2023-12-04 20:06:54 -06:00
Joel Spadin d4e8dee444 refactor(keymaps): Rename layer label to "display-name" 
Changed the property used to define a layer name for displays from
"label" (which affects other things in Zephyr and is deprecated) to
"display-name". (It cannot be named simply "name", because that has
special meaning in newer versions of the devicetree compiler.)

"label" is still supported as a fallback, so no changes need to be made
to existing keymaps.
 2023-12-04 20:06:54 -06:00
ReFil 9bacaffe62
feat(hid): Add KConfig option for higher NKRO usages 
By default the maximum NKRO usage is set to maximise compatibility, but some keys dont work, this adds the ability to use those extended keys, at the cost of compatibiltity

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
Co-authored-by: Pete Johanson <peter@peterjohanson.com>
 2023-12-04 18:24:05 -05:00
Cem Aksoylar 8ee3467adf fix(docs): Update outdated information in the hardware page 2023-12-04 15:22:49 -08:00
Cem Aksoylar 042e5209b3 fix(docs): Fix table for BT_DISC 2023-12-04 09:24:53 -08:00
ReFil ecefd6d24b
fix(docs): Update backlight docs (#1894) 
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
Co-authored-by: Less/Rikki <86894501+lesshonor@users.noreply.github.com>
 2023-12-04 09:21:49 -08:00
Alessandro Bortolin 4e55c5f6e9 feat: handle LED indicators report 2023-11-27 16:03:18 -08:00
ReFil 84b93350b8
feat(docs): Document adding USB logging to a standalone board (#2039) 
Currently this is only documented in the zephyr 3.0 upgrade blog. This explicitly documents it as well as when it doesn't need to be applied (i.e. when a mcu board is already in use).
 2023-11-27 09:12:33 -08:00
Chris Andreae 0a4b1a6533
feat(ble): add behavior to disconnect from BLE profile 
Adds new functionality and a behavior to disconnect an active BLE connection.
The motivation for this is that for some devices like phones, the presence of an
active BLE connection results in the onscreen keyboard being selected.
 2023-11-20 15:00:10 -05:00
Alexander Krikun d7d9eed317 feat(mouse): Initial mouse keys support. 
* Add HID report/descriptor for a new report with mouse buttons,
  and x/y/wheel deltas.
* New mouse key press behavior for press/release of mouse keys.
* Add constants for HID main item values (e.g. data/array/absolute)
* Define and use constants for our HID report IDs.
 2023-11-15 11:16:59 -08:00
ReFil 8776911da5
feat(ble): Allow disabling BLE BAS reporting 
The battery reporting has been known to cause macOS computers to wakeup repeatedly. In some cases (e.g. display or custom lighting implementation) one might want to collect battery SOC without broadcasting over BLE

* Update docs/docs/config/battery.md

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
 2023-11-15 13:03:30 -05:00
Cem Aksoylar 7b4b5d4ff2 fix(docs): Fix debouncing driver support note 2023-11-13 12:37:09 -08:00
Cem Aksoylar a5c3edd51b refactor(docs): Remove local build section in customization 2023-11-13 12:34:44 -08:00
Cem Aksoylar 2554b5c88f fix(docs): Update boards in build examples to common+uf2 ones 2023-11-13 12:34:44 -08:00
Cem Aksoylar b80c0be0ce feat(blog): Add keymap editor post for spotlight series 
Co-authored-by: Nick Coutsos <nick@coutsos.com>
 2023-11-08 23:00:26 -08:00
Cem Aksoylar 5b49bc10cd feat(blog): Show all posts on sidebar 2023-11-08 23:00:26 -08:00
Peter Johanson 8d09809ef0 fix(docs): Updated encoder config docs. 
* Update new shield guide for new sensor/encoder settings.
* Add DTS section to encoder config docs.

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
 2023-11-03 12:35:25 -07:00
Nick Coutsos 9e8ee86842
chore(docs): Fix links to relocated files (#1975) 2023-10-22 09:05:49 -07:00