* docs: Added a dedicated page on ZMK events
* docs: Apply suggestions from code review
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
* docs: Apply suggestions from code review
Bring the code snipper in new-behavior back, touchups on the page
* docs: clarify "calling" hold tap
Adjustment after feedback from code review
---------
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
* Suggest using cu for USB log viewing on macOS
It may not be as friendly, but cu should be available while tio could be hard to install.
* Polish wording
Co-authored-by: Nicolas Munnich <98408764+nmunnich@users.noreply.github.com>
* Suggest "man cu" for how to use this tool
---------
Co-authored-by: Nicolas Munnich <98408764+nmunnich@users.noreply.github.com>
Solves issue #3019 (incorrect putty link)
- putty.org is not affiliated with the putty software
- the site now hosts links to interviews about a recent pandemic
- this pull request updates the link to the actual project page
Co-authored-by: Léon Hagenaars-Keus <lhagenaars@sogyo.nl>
* docs: Document requirements-extra.txt for Studio builds
* docs: Note endpoint selection requirement for Studio
* docs: Fix indents in list items in native setup page
Add this file to .prettierignore because it messes all the additional indents.
There is also no way to make prettier ignore a range of lines in MDX files AFAICT.
* Revert "docs: Fix indents in list items in native setup page"
This reverts commit 6d8aeba801fc6507f8767aeadbcc96874d315879.
feat(split): Runtime selection of split transport
Allow building multiple split transports, and select an active
one based on the transport availability. Wired split availability
depends on additional `detect-gpios` which must be a GPIO pin
that goes active when a wired connection is present.
feat(split): Suspend/resume wired UART devices.
To better support runtime split support, suspend/resume the UART
as necessary to save power when not using the UART.
docs(split): Document adjusting nRF52 UART interrupt priorities
For wired split on nRF52, you may need to adjust the priority for UART
interrupts lower, to ensure the interrupts used for timing sensitive
BT operations can run when needed, so document this in our pinctrl docs.
refactor(split): Restore use of aync UART on nRF52.
With fixes for Zephyr UART driver, re-enable using async API on nRF52.
fix(split): Minor wired split fixes.
Various minor fixes for wired split to avoid spurious TX in half duplex,
etc.
fix: Unconditionally define HID payloads to avoid error.
Don't conditionally define HID indicator payload, to avoid compilation
errors.
docs(split): Expand on details of split transports.
Expand the split keyboard documentation with a more fleshed out section
on the available split trasnports, and what is and isn't supported by
each, including the runtime selection functionality.
---------
Co-authored-by: Nicolas Munnich <98408764+nmunnich@users.noreply.github.com>
refactor(split): Refactor split code for extension
Extract central/peripheral code to allow for plugging in alternate
transports, instead of tying all split logic to BT.
feat(split): Add full-duplex wired split support
* Depends on full-duplex hardware UART for communication.
* Supports all existing central commands/peripheral events, including
sensors/inputs from peripherals.
* Only one wired split peripheral supported (for now)
* Relies on chosen `zmk,split-uart` referencing the UART device.
docs: Add wired split config docs.
Migrate split to its own dedicated config file, and add details
on wired split config.
Co-authored-by: Nicolas Munnich <98408764+Nick-Munnich@users.noreply.github.com>
fix: Properly override stack size on RP2040
Move the system work queue stack size override on RP2040 ouf of
a `ZMK_BLE` conditional so it is properly applied generally for that
SoC.
---------
Co-authored-by: Nicolas Munnich <98408764+Nick-Munnich@users.noreply.github.com>
docs: Inline simple physical layouts in new shield guide
docs: Fix broken anchor in module creation
docs: Make physical layout transform label consistent and comment
docs: Move battery sensing hardware integration to new page
docs: Refactor lighting hardware integrations to new category
docs: Link to pin control page from lighting pages
docs: Consolidate lighting feature pages
docs: Remove incorrect redirect
docs: Consolidate lighting config pages
docs: Add missing code fence languages in pointing
docs: Fix default msc exponent in example
docs: Make pointing hardware integration follow semantic structure
* Add VERSION file that Zephyr will pick up
* Add release-please automation
* Updated docs on commits messages, and PR process
* Updated PR template to match.
---
Release-As: 0.1.0
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
* docs(feat): Adding some additional clarity around low power states, with guide portion moved to hardware integration
---------
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
* docs: Split local toolchain setup for Docker in two separated approaches.
This includes adding a new dropdown for Docker which lists overall steps
that have to be done when setting up the environment. Furthermore, the
previous documentation is no listed under VSCode and new documentation
for the Devcontainer CLI has been added.
Since the described approaches for VS Code and Dev Container CLI varied
quiet a bit a more unified way of setting them up was added. Due to
that, the documentation for building and flashing could be simplified as
well.
* docs: Update documentation for building and flashing for devcontainers.
Moved information about creating volumes for Docker containers into the
overall Docker setup documentation. Add warning for changing build
directory or adding options for building at the top of the page.
* feat(devcontainers): Add new volume for mounting modules.
---------
Co-authored-by: Nicolas Munnich <98408764+Nick-Munnich@users.noreply.github.com>
* docs(feat): Added a page on pin control for ZMK
* Added note on HAL modules
* docs: Added images of boards
---------
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
* 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>
