mirror of
https://github.com/qmk/qmk_firmware.git
synced 2024-11-25 12:46:41 +00:00
Merge branch 'qmk:master' into dev_branch
This commit is contained in:
Mrinal Singh Tak
GitHub
commit
e0651ba501
123
.github/workflows/ci_build_major_branch.yml
vendored
Normal file
123
.github/workflows/ci_build_major_branch.yml
vendored
Normal file
@ -0,0 +1,123 @@
|
|||||||
|
name: CI Build Major Branch
|
||||||
|
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
actions: write
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches: [master, develop]
|
||||||
|
workflow_dispatch:
|
||||||
|
inputs:
|
||||||
|
branch:
|
||||||
|
type: choice
|
||||||
|
description: "Branch to build"
|
||||||
|
options: [master, develop]
|
||||||
|
|
||||||
|
env:
|
||||||
|
# https://docs.github.com/en/actions/learn-github-actions/usage-limits-billing-and-administration#usage-limits
|
||||||
|
# We've decreased it from 20 to 15 to allow for other GHA to run unimpeded
|
||||||
|
CONCURRENT_JOBS: 15
|
||||||
|
|
||||||
|
# Ensure we only have one build running at a time, cancelling any active builds if a new commit is pushed to the respective branch
|
||||||
|
concurrency:
|
||||||
|
group: ci_build-${{ github.event.inputs.branch || github.ref_name }}
|
||||||
|
cancel-in-progress: true
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
determine_concurrency:
|
||||||
|
name: "Determine concurrency"
|
||||||
|
if: github.repository == 'qmk/qmk_firmware'
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
container: ghcr.io/qmk/qmk_cli
|
||||||
|
|
||||||
|
outputs:
|
||||||
|
slice_length: ${{ steps.generate_slice_length.outputs.slice_length }}
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Install prerequisites
|
||||||
|
run: |
|
||||||
|
apt-get update
|
||||||
|
apt-get install -y jq
|
||||||
|
|
||||||
|
- name: Disable safe.directory check
|
||||||
|
run: |
|
||||||
|
git config --global --add safe.directory '*'
|
||||||
|
|
||||||
|
- name: Checkout QMK Firmware
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- name: Determine concurrency
|
||||||
|
id: generate_slice_length
|
||||||
|
run: |
|
||||||
|
target_count=$( {
|
||||||
|
qmk find -km default 2>/dev/null
|
||||||
|
qmk find -km via 2>/dev/null
|
||||||
|
} | sort | uniq | wc -l)
|
||||||
|
slice_length=$((target_count / ($CONCURRENT_JOBS - 1))) # Err on the side of caution as we're splitting default and via
|
||||||
|
echo "slice_length=$slice_length" >> $GITHUB_OUTPUT
|
||||||
|
|
||||||
|
build_targets:
|
||||||
|
name: "Compile keymap ${{ matrix.keymap }}"
|
||||||
|
needs: determine_concurrency
|
||||||
|
strategy:
|
||||||
|
fail-fast: false
|
||||||
|
matrix:
|
||||||
|
keymap: [default, via]
|
||||||
|
uses: ./.github/workflows/ci_build_major_branch_keymap.yml
|
||||||
|
with:
|
||||||
|
branch: ${{ inputs.branch || github.ref_name }}
|
||||||
|
keymap: ${{ matrix.keymap }}
|
||||||
|
slice_length: ${{ needs.determine_concurrency.outputs.slice_length }}
|
||||||
|
secrets: inherit
|
||||||
|
|
||||||
|
rollup_tasks:
|
||||||
|
name: "Consolidation"
|
||||||
|
needs: build_targets
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Download firmwares
|
||||||
|
uses: actions/download-artifact@v4
|
||||||
|
with:
|
||||||
|
pattern: firmware-*
|
||||||
|
path: firmwares
|
||||||
|
merge-multiple: true
|
||||||
|
|
||||||
|
- name: Upload to https://ci.qmk.fm/${{ inputs.branch || github.ref_name }}/${{ github.sha }}
|
||||||
|
uses: jakejarvis/s3-sync-action@master
|
||||||
|
with:
|
||||||
|
args: --acl public-read --follow-symlinks --delete
|
||||||
|
env:
|
||||||
|
AWS_S3_BUCKET: ${{ vars.CI_QMK_FM_SPACES_BUCKET }}
|
||||||
|
AWS_ACCESS_KEY_ID: ${{ secrets.CI_QMK_FM_SPACES_KEY }}
|
||||||
|
AWS_SECRET_ACCESS_KEY: ${{ secrets.CI_QMK_FM_SPACES_SECRET }}
|
||||||
|
AWS_REGION: ${{ vars.CI_QMK_FM_SPACES_REGION }}
|
||||||
|
AWS_S3_ENDPOINT: ${{ vars.CI_QMK_FM_SPACES_ENDPOINT }}
|
||||||
|
SOURCE_DIR: firmwares
|
||||||
|
DEST_DIR: ${{ inputs.branch || github.ref_name }}/${{ github.sha }}
|
||||||
|
|
||||||
|
- name: Upload to https://ci.qmk.fm/${{ inputs.branch || github.ref_name }}/latest
|
||||||
|
uses: jakejarvis/s3-sync-action@master
|
||||||
|
with:
|
||||||
|
args: --acl public-read --follow-symlinks --delete
|
||||||
|
env:
|
||||||
|
AWS_S3_BUCKET: ${{ vars.CI_QMK_FM_SPACES_BUCKET }}
|
||||||
|
AWS_ACCESS_KEY_ID: ${{ secrets.CI_QMK_FM_SPACES_KEY }}
|
||||||
|
AWS_SECRET_ACCESS_KEY: ${{ secrets.CI_QMK_FM_SPACES_SECRET }}
|
||||||
|
AWS_REGION: ${{ vars.CI_QMK_FM_SPACES_REGION }}
|
||||||
|
AWS_S3_ENDPOINT: ${{ vars.CI_QMK_FM_SPACES_ENDPOINT }}
|
||||||
|
SOURCE_DIR: firmwares
|
||||||
|
DEST_DIR: ${{ inputs.branch || github.ref_name }}/latest
|
||||||
|
|
||||||
|
- name: Check if failure marker file exists
|
||||||
|
id: check_failure_marker
|
||||||
|
uses: andstor/file-existence-action@v3
|
||||||
|
with:
|
||||||
|
files: firmwares/.failed
|
||||||
|
|
||||||
|
- name: Fail build if needed
|
||||||
|
if: steps.check_failure_marker.outputs.files_exists == 'true'
|
||||||
|
run: |
|
||||||
|
# Exit with failure if the compilation stage failed
|
||||||
|
exit 1
|
||||||
181
.github/workflows/ci_build_major_branch_keymap.yml
vendored
Normal file
181
.github/workflows/ci_build_major_branch_keymap.yml
vendored
Normal file
@ -0,0 +1,181 @@
|
|||||||
|
name: CI Build Major Branch Keymap
|
||||||
|
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
actions: write
|
||||||
|
|
||||||
|
on:
|
||||||
|
workflow_call:
|
||||||
|
inputs:
|
||||||
|
branch:
|
||||||
|
type: string
|
||||||
|
required: true
|
||||||
|
keymap:
|
||||||
|
type: string
|
||||||
|
required: true
|
||||||
|
slice_length:
|
||||||
|
type: string
|
||||||
|
required: true
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
generate_targets:
|
||||||
|
name: "Generate targets (${{ inputs.keymap }})"
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
container: ghcr.io/qmk/qmk_cli
|
||||||
|
|
||||||
|
outputs:
|
||||||
|
targets: ${{ steps.generate_targets.outputs.targets }}
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Install prerequisites
|
||||||
|
run: |
|
||||||
|
apt-get update
|
||||||
|
apt-get install -y jq
|
||||||
|
|
||||||
|
- name: Disable safe.directory check
|
||||||
|
run: |
|
||||||
|
git config --global --add safe.directory '*'
|
||||||
|
|
||||||
|
- name: Checkout QMK Firmware
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- name: Generate build targets
|
||||||
|
id: generate_targets
|
||||||
|
run: |
|
||||||
|
{ # Intentionally use `shuf` here so that we share manufacturers across all build groups -- some have a lot of ARM-based boards which inherently take longer
|
||||||
|
counter=0
|
||||||
|
echo -n '{'
|
||||||
|
qmk find -km ${{ inputs.keymap }} 2>/dev/null | sort | uniq | shuf | xargs -L${{ inputs.slice_length }} | while IFS=$'\n' read target ; do
|
||||||
|
if [ $counter -gt 0 ]; then
|
||||||
|
echo -n ','
|
||||||
|
fi
|
||||||
|
counter=$((counter+1))
|
||||||
|
printf "\"group %02d\":{" $counter
|
||||||
|
echo -n '"targets":"'
|
||||||
|
echo $target | tr ' ' '\n' | sort | uniq | xargs echo -n
|
||||||
|
echo -n '"}'
|
||||||
|
done
|
||||||
|
echo -n '}'
|
||||||
|
} | sed -e 's@\n@@g' > targets.json
|
||||||
|
|
||||||
|
# Output the target keys as a variable
|
||||||
|
echo "targets=$(jq -c 'keys' targets.json)" >> $GITHUB_OUTPUT
|
||||||
|
|
||||||
|
- name: Upload targets json
|
||||||
|
uses: actions/upload-artifact@v4
|
||||||
|
with:
|
||||||
|
name: targets-${{ inputs.keymap }}
|
||||||
|
path: targets.json
|
||||||
|
|
||||||
|
build_targets:
|
||||||
|
name: "Compile ${{ matrix.target }} (${{ inputs.keymap }})"
|
||||||
|
needs: generate_targets
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
container: ghcr.io/qmk/qmk_cli
|
||||||
|
continue-on-error: true
|
||||||
|
|
||||||
|
strategy:
|
||||||
|
matrix:
|
||||||
|
target: ${{ fromJson(needs.generate_targets.outputs.targets) }}
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Install prerequisites
|
||||||
|
run: |
|
||||||
|
apt-get update
|
||||||
|
apt-get install -y jq
|
||||||
|
|
||||||
|
- name: Disable safe.directory check
|
||||||
|
run: |
|
||||||
|
git config --global --add safe.directory '*'
|
||||||
|
|
||||||
|
- name: Checkout QMK Firmware
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- name: Get target definitions
|
||||||
|
uses: actions/download-artifact@v4
|
||||||
|
with:
|
||||||
|
name: targets-${{ inputs.keymap }}
|
||||||
|
path: .
|
||||||
|
|
||||||
|
- name: Deploy submodules
|
||||||
|
run: |
|
||||||
|
qmk git-submodule -f
|
||||||
|
|
||||||
|
- name: Dump targets
|
||||||
|
run: |
|
||||||
|
jq -r '.["${{ matrix.target }}"].targets' targets.json | tr ' ' '\n' | sort
|
||||||
|
|
||||||
|
- name: Build targets
|
||||||
|
continue-on-error: true
|
||||||
|
run: |
|
||||||
|
export NCPUS=$(nproc 2>/dev/null || sysctl -n hw.ncpu 2>/dev/null || getconf _NPROCESSORS_ONLN 2>/dev/null)
|
||||||
|
qmk mass-compile -t -j $NCPUS -e DUMP_CI_METADATA=yes $(jq -r '.["${{ matrix.target }}"].targets' targets.json) || touch .failed
|
||||||
|
|
||||||
|
- name: Upload binaries
|
||||||
|
uses: actions/upload-artifact@v4
|
||||||
|
with:
|
||||||
|
name: firmware-${{ inputs.keymap }}-${{ matrix.target }}
|
||||||
|
if-no-files-found: ignore
|
||||||
|
path: |
|
||||||
|
*.bin
|
||||||
|
*.hex
|
||||||
|
*.uf2
|
||||||
|
.build/failed.*
|
||||||
|
.failed
|
||||||
|
|
||||||
|
- name: Fail build if any group failed
|
||||||
|
run: |
|
||||||
|
# Exit with failure if the compilation stage failed
|
||||||
|
[ ! -f .failed ] || exit 1
|
||||||
|
|
||||||
|
repack_firmware:
|
||||||
|
if: always()
|
||||||
|
name: "Repack artifacts"
|
||||||
|
needs: build_targets
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Checkout QMK Firmware
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- name: Download firmwares
|
||||||
|
uses: actions/download-artifact@v4
|
||||||
|
with:
|
||||||
|
pattern: firmware-${{ inputs.keymap }}-*
|
||||||
|
path: .
|
||||||
|
merge-multiple: true
|
||||||
|
|
||||||
|
- name: Upload all firmwares
|
||||||
|
uses: actions/upload-artifact@v4
|
||||||
|
with:
|
||||||
|
name: firmware-${{ inputs.keymap }}
|
||||||
|
if-no-files-found: ignore
|
||||||
|
path: |
|
||||||
|
*.bin
|
||||||
|
*.hex
|
||||||
|
*.uf2
|
||||||
|
.build/failed.*
|
||||||
|
.failed
|
||||||
|
|
||||||
|
- name: Generate output logs
|
||||||
|
run: |
|
||||||
|
# Generate the step summary markdown
|
||||||
|
./util/ci/generate_failure_markdown.sh > $GITHUB_STEP_SUMMARY || true
|
||||||
|
# Truncate to a maximum of 1MB to deal with GitHub workflow limit
|
||||||
|
truncate --size='<960K' $GITHUB_STEP_SUMMARY || true
|
||||||
|
|
||||||
|
- name: Delete temporary build artifacts
|
||||||
|
uses: geekyeggo/delete-artifact@v5
|
||||||
|
with:
|
||||||
|
name: |
|
||||||
|
firmware-${{ inputs.keymap }}-*
|
||||||
|
targets-${{ inputs.keymap }}
|
||||||
|
|
||||||
|
- name: 'CI Discord Notification'
|
||||||
|
if: always()
|
||||||
|
working-directory: util/ci/
|
||||||
|
env:
|
||||||
|
DISCORD_WEBHOOK: ${{ secrets.CI_DISCORD_WEBHOOK }}
|
||||||
|
run: |
|
||||||
|
python3 -m pip install -r requirements.txt
|
||||||
|
python3 ./discord-results.py --branch ${{ inputs.branch || github.ref_name }} --keymap ${{ inputs.keymap }} --url ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
|
||||||
257
docs/__capabilities.md
Normal file
257
docs/__capabilities.md
Normal file
@ -0,0 +1,257 @@
|
|||||||
|
# Documentation Capabilities
|
||||||
|
|
||||||
|
This page lays out the capabilities used by the QMK Firmware documentation, in order to aid future transitions to other page generators. Focuses mainly on things other than normal Markdown, as it's assumed that markdown generators should still function accordingly.
|
||||||
|
|
||||||
|
## Overall capabilities
|
||||||
|
|
||||||
|
Unrelated to styling, high-level tech.
|
||||||
|
|
||||||
|
* I18n -- translations to other languages: [_langs.md](_langs.md)
|
||||||
|
* Sidebar -- listing of pages by category: [_summary.md](_summary.md)
|
||||||
|
* Title anchors -- `:id=some-anchor-name`, used for direct linking to sections
|
||||||
|
* Links to anchors:
|
||||||
|
* Style 1: [early initialization](platformdev_chibios_earlyinit.md?id=board-init)
|
||||||
|
* Style 2: [early initialization](platformdev_chibios_earlyinit.md#board-init)
|
||||||
|
* Links to anchors on the same page, i.e. [Emoji](#emoji)
|
||||||
|
* Specifying CNAME for root domain -- `docs.qmk.fm`
|
||||||
|
* Moved pages, see `index.html`
|
||||||
|
* Text search
|
||||||
|
* Footnotes [like this][1]
|
||||||
|
|
||||||
|
<!-- Comments should not show up -->
|
||||||
|
|
||||||
|
<!-- Nor should
|
||||||
|
multiline
|
||||||
|
|
||||||
|
comments with
|
||||||
|
|
||||||
|
newlines show up -->
|
||||||
|
|
||||||
|
|
||||||
|
### Dividing lines
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
### Images
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<img src="gitbook/images/color-wheel.svg" alt="HSV Color Wheel" width="250"/>
|
||||||
|
|
||||||
|
### Lists
|
||||||
|
|
||||||
|
Newlines with `<br>`:
|
||||||
|
|
||||||
|
Line one<br>
|
||||||
|
Line two<br/>
|
||||||
|
Line three
|
||||||
|
|
||||||
|
Nested dotted:
|
||||||
|
|
||||||
|
* The PR is complete and ready to merge
|
||||||
|
* GitHub checks for the PR are green whenever possible
|
||||||
|
* A "red" check may be disregarded by maintainers if the items flagged are unrelated to the change proposed in the PR
|
||||||
|
* Modifications to existing files should not need to add license headers to pass lint, for instance.
|
||||||
|
* If it's not directly related to your PR's functionality, prefer avoiding making a change.
|
||||||
|
|
||||||
|
Nested dashed:
|
||||||
|
|
||||||
|
- The PR is complete and ready to merge
|
||||||
|
- GitHub checks for the PR are green whenever possible
|
||||||
|
- A "red" check may be disregarded by maintainers if the items flagged are unrelated to the change proposed in the PR
|
||||||
|
- Modifications to existing files should not need to add license headers to pass lint, for instance.
|
||||||
|
- If it's not directly related to your PR's functionality, prefer avoiding making a change.
|
||||||
|
|
||||||
|
Nested numbered:
|
||||||
|
|
||||||
|
1. The PR is complete and ready to merge
|
||||||
|
1. GitHub checks for the PR are green whenever possible
|
||||||
|
1. A "red" check may be disregarded by maintainers if the items flagged are unrelated to the change proposed in the PR
|
||||||
|
1. Modifications to existing files should not need to add license headers to pass lint, for instance.
|
||||||
|
1. If it's not directly related to your PR's functionality, prefer avoiding making a change.
|
||||||
|
|
||||||
|
Nested mixed:
|
||||||
|
|
||||||
|
1. Add it to the schema in `data/schemas/keyboards.jsonschema`
|
||||||
|
1. Add a mapping in `data/maps`
|
||||||
|
1. (optional and discouraged) Add code to extract/generate it to:
|
||||||
|
* `lib/python/qmk/info.py`
|
||||||
|
* `lib/python/qmk/cli/generate/config_h.py`
|
||||||
|
* `lib/python/qmk/cli/generate/rules_mk.py`
|
||||||
|
|
||||||
|
### Emoji :id=emoji
|
||||||
|
|
||||||
|
#### Direct:
|
||||||
|
|
||||||
|
👍🎉 First off, thanks for taking the time to read this and contribute! 🎉👍
|
||||||
|
|
||||||
|
#### As colon-name-colon:
|
||||||
|
|
||||||
|
:heavy_check_mark: : works and was tested
|
||||||
|
|
||||||
|
:o: : does not apply
|
||||||
|
|
||||||
|
:x: : not supported by MCU
|
||||||
|
|
||||||
|
### XML Entities
|
||||||
|
|
||||||
|
[`clueboard`](https://github.com/qmk/qmk_firmware/tree/master/keyboards/clueboard) ← This is the organization folder, there's no `rules.mk` file
|
||||||
|
|
||||||
|
1–4
|
||||||
|
|
||||||
|
Command+<code>`</code>
|
||||||
|
|
||||||
|
## Styling
|
||||||
|
|
||||||
|
### CSS-ish
|
||||||
|
|
||||||
|
<b style="font-size:150%">This is 150% of normal sizing, and bold!</b>
|
||||||
|
|
||||||
|
|
||||||
|
### Tables
|
||||||
|
|
||||||
|
| Column A | Column B |
|
||||||
|
|----------|----------|
|
||||||
|
| Left | Right |
|
||||||
|
|
||||||
|
### Indented sections
|
||||||
|
|
||||||
|
> Indent without any sort of marker
|
||||||
|
|
||||||
|
?> Query, this?
|
||||||
|
|
||||||
|
!> Notification, damnit!
|
||||||
|
|
||||||
|
### Keyboard keys
|
||||||
|
|
||||||
|
<kbd>,</kbd>
|
||||||
|
|
||||||
|
<kbd>Right Alt</kbd>+<kbd>Right Shift</kbd>
|
||||||
|
|
||||||
|
1. Click <kbd>File</kbd> > <kbd>New</kbd> > <kbd>Makefile Project with Existing Code</kbd>
|
||||||
|
|
||||||
|
1. Click <kbd><kbd>File</kbd> > <kbd>Preferences ></kbd> > <kbd>Settings</kbd> </kbd>
|
||||||
|
|
||||||
|
1. Hit Ctrl-<code>`</code> (Grave) to bring up the terminal or go to <kbd><kbd>View</kbd> > <kbd>Terminal</kbd></kbd> (command `workbench.action.terminal.toggleTerminal`). A new terminal will be opened if there isn‘t one already.
|
||||||
|
|
||||||
|
This should start the terminal in the workspace's folder (so the `qmk_firmware` folder), and then you can compile your keyboard.
|
||||||
|
|
||||||
|
|
||||||
|
### Code Blocks
|
||||||
|
|
||||||
|
Inline code with tag: <code>test</code>
|
||||||
|
|
||||||
|
Inline code with backticks: `test`
|
||||||
|
|
||||||
|
This is preformatted
|
||||||
|
Indented by 4 spaces
|
||||||
|
The letters lined up
|
||||||
|
|
||||||
|
```c
|
||||||
|
int c_code(void) {
|
||||||
|
return -1;
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
```makefile
|
||||||
|
ifeq ($(BUILD),)
|
||||||
|
CHUNDER_REQUIRED = yes
|
||||||
|
endif
|
||||||
|
```
|
||||||
|
|
||||||
|
```python
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
p = Path('/path/to/qmk_firmware')
|
||||||
|
```
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"a": "b",
|
||||||
|
"c": 4,
|
||||||
|
"d": {
|
||||||
|
"e": [
|
||||||
|
0, 1, 2, 3
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
```diff
|
||||||
|
#undef RGBLIGHT_LED_COUNT
|
||||||
|
+#undef RGBLIGHT_EFFECT_STATIC_GRADIENT
|
||||||
|
+#undef RGBLIGHT_EFFECT_RAINBOW_SWIRL
|
||||||
|
#define RGBLIGHT_LED_COUNT 12
|
||||||
|
#define RGBLIGHT_HUE_STEP 8
|
||||||
|
#define RGBLIGHT_SAT_STEP 8
|
||||||
|
```
|
||||||
|
|
||||||
|
Indented code as part of a list:
|
||||||
|
|
||||||
|
* [QMK Toolbox](https://github.com/qmk/qmk_toolbox/releases) (recommended GUI)
|
||||||
|
* [Teensy Loader](https://www.pjrc.com/teensy/loader.html)
|
||||||
|
* [Teensy Loader Command Line](https://www.pjrc.com/teensy/loader_cli.html) / `:teensy` target in QMK (recommended command line)
|
||||||
|
```
|
||||||
|
teensy_loader_cli -v -mmcu=<mcu> <filename>
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### Sub/Superscript
|
||||||
|
|
||||||
|
<sub>This is subscripted, apparently.</sub>
|
||||||
|
|
||||||
|
<sup>This is superscripted, apparently.</sup>
|
||||||
|
|
||||||
|
I<sup>2</sup>C
|
||||||
|
|
||||||
|
T<sub>0H</sub>, T<sub>0L</sub>
|
||||||
|
|
||||||
|
### Tabs
|
||||||
|
|
||||||
|
Tabs are based on section headers, with `**` enclosing the tab title.
|
||||||
|
|
||||||
|
<!-- tabs:start -->
|
||||||
|
|
||||||
|
#### ** Tab one **
|
||||||
|
|
||||||
|
Content one
|
||||||
|
|
||||||
|
<!-- tabs:start -->
|
||||||
|
|
||||||
|
##### ** Nested one **
|
||||||
|
|
||||||
|
Nested content one
|
||||||
|
|
||||||
|
##### ** Nested two **
|
||||||
|
|
||||||
|
Nested content two
|
||||||
|
|
||||||
|
<!-- tabs:end -->
|
||||||
|
|
||||||
|
#### ** Tab two **
|
||||||
|
|
||||||
|
Content two
|
||||||
|
|
||||||
|
#### ** Tab three **
|
||||||
|
|
||||||
|
Content three
|
||||||
|
|
||||||
|
<!-- tabs:end -->
|
||||||
|
|
||||||
|
## Details sections
|
||||||
|
|
||||||
|
Expandable:
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>Some summary text that shows up before expanding</summary>
|
||||||
|
|
||||||
|
!> Embedded notification!
|
||||||
|
|
||||||
|
This is some inner content.
|
||||||
|
</details>
|
||||||
|
|
||||||
|
[1]: https://en.wikipedia.org/wiki/Eclipse_(software)
|
||||||
@ -322,6 +322,18 @@ Creates a keymap.json from a keymap.c.
|
|||||||
qmk c2json -km KEYMAP -kb KEYBOARD [-q] [--no-cpp] [-o OUTPUT] filename
|
qmk c2json -km KEYMAP -kb KEYBOARD [-q] [--no-cpp] [-o OUTPUT] filename
|
||||||
```
|
```
|
||||||
|
|
||||||
|
**Examples**:
|
||||||
|
|
||||||
|
```
|
||||||
|
qmk c2json -km default -kb handwired/dactyl_promicro
|
||||||
|
```
|
||||||
|
|
||||||
|
or with filename:
|
||||||
|
|
||||||
|
```
|
||||||
|
qmk c2json keyboards/handwired/dactyl_promicro/keymaps/default/keymap.c
|
||||||
|
```
|
||||||
|
|
||||||
## `qmk lint`
|
## `qmk lint`
|
||||||
|
|
||||||
Checks over a keyboard and/or keymap and highlights common errors, problems, and anti-patterns.
|
Checks over a keyboard and/or keymap and highlights common errors, problems, and anti-patterns.
|
||||||
|
|||||||
@ -236,7 +236,7 @@ Flashing sequence:
|
|||||||
|
|
||||||
## STM32/APM32 DFU
|
## STM32/APM32 DFU
|
||||||
|
|
||||||
All STM32 and APM32 MCUs, except for F103 (see the [STM32duino section](#stm32duino)) come preloaded with a factory bootloader that cannot be modified nor deleted.
|
All USB-capable STM32 and APM32 MCUs, except for a small handful (such as STM32F103 -- see the [STM32duino section](#stm32duino)) come preloaded with a factory bootloader that cannot be modified nor deleted.
|
||||||
|
|
||||||
To ensure compatibility with the STM32-DFU bootloader, make sure this block is present in your `rules.mk` (optionally with `apm32-dfu` instead):
|
To ensure compatibility with the STM32-DFU bootloader, make sure this block is present in your `rules.mk` (optionally with `apm32-dfu` instead):
|
||||||
|
|
||||||
|
|||||||
@ -7,7 +7,7 @@ QMK tries to put a lot of power into your hands by making easy things easy, and
|
|||||||
Not sure if your keyboard can run QMK? If it's a mechanical keyboard you built yourself chances are good it can. We support a [large number of hobbyist boards](https://qmk.fm/keyboards/). If your current keyboard can't run QMK there are a lot of choices out there for boards that do.
|
Not sure if your keyboard can run QMK? If it's a mechanical keyboard you built yourself chances are good it can. We support a [large number of hobbyist boards](https://qmk.fm/keyboards/). If your current keyboard can't run QMK there are a lot of choices out there for boards that do.
|
||||||
|
|
||||||
?> **Is This Guide For Me?**<br>
|
?> **Is This Guide For Me?**<br>
|
||||||
If the thought of programming intimidates you, please [take a look at our online GUI](newbs_building_firmware_configurator.md) instead.</div>
|
If the thought of programming intimidates you, please [take a look at our online GUI](newbs_building_firmware_configurator.md) instead.
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
|
|||||||
328
keyboards/smart68/info.json
Normal file
328
keyboards/smart68/info.json
Normal file
@ -0,0 +1,328 @@
|
|||||||
|
{
|
||||||
|
"manufacturer": "DeeLonG",
|
||||||
|
"keyboard_name": "Smart 68",
|
||||||
|
"maintainer": "Shados",
|
||||||
|
"backlight": {
|
||||||
|
"pin": "B7"
|
||||||
|
},
|
||||||
|
"bootloader": "atmel-dfu",
|
||||||
|
"bootmagic": {
|
||||||
|
"matrix": [3, 5]
|
||||||
|
},
|
||||||
|
"diode_direction": "COL2ROW",
|
||||||
|
"features": {
|
||||||
|
"backlight": true,
|
||||||
|
"bootmagic": true,
|
||||||
|
"extrakey": true,
|
||||||
|
"mousekey": true,
|
||||||
|
"nkro": true
|
||||||
|
},
|
||||||
|
"indicators": {
|
||||||
|
"caps_lock": "B2",
|
||||||
|
"on_state": 0
|
||||||
|
},
|
||||||
|
"matrix_pins": {
|
||||||
|
"cols": ["F0", "F1", "E6", "C7", "C6", "B6", "D4", "B1", "B0", "B5", "B4", "D7", "D6", "B3", "F7"],
|
||||||
|
"rows": ["D0", "D1", "D2", "D3", "D5"]
|
||||||
|
},
|
||||||
|
"processor": "atmega32u4",
|
||||||
|
"url": "https://web.archive.org/web/20180703134842/https://geekhack.org/index.php?topic=83442.0",
|
||||||
|
"usb": {
|
||||||
|
"device_version": "1.0.0",
|
||||||
|
"pid": "0x6868",
|
||||||
|
"vid": "0x444C"
|
||||||
|
},
|
||||||
|
"layout_aliases": {
|
||||||
|
"LAYOUT": "LAYOUT_all",
|
||||||
|
"LAYOUT_v1_a": "LAYOUT_all"
|
||||||
|
},
|
||||||
|
"layouts": {
|
||||||
|
"LAYOUT_all": {
|
||||||
|
"layout": [
|
||||||
|
{"matrix": [0, 0], "x": 0, "y": 0},
|
||||||
|
{"matrix": [0, 1], "x": 1, "y": 0},
|
||||||
|
{"matrix": [0, 2], "x": 2, "y": 0},
|
||||||
|
{"matrix": [0, 3], "x": 3, "y": 0},
|
||||||
|
{"matrix": [0, 4], "x": 4, "y": 0},
|
||||||
|
{"matrix": [0, 5], "x": 5, "y": 0},
|
||||||
|
{"matrix": [0, 6], "x": 6, "y": 0},
|
||||||
|
{"matrix": [0, 7], "x": 7, "y": 0},
|
||||||
|
{"matrix": [0, 8], "x": 8, "y": 0},
|
||||||
|
{"matrix": [0, 9], "x": 9, "y": 0},
|
||||||
|
{"matrix": [0, 10], "x": 10, "y": 0},
|
||||||
|
{"matrix": [0, 11], "x": 11, "y": 0},
|
||||||
|
{"matrix": [0, 12], "x": 12, "y": 0},
|
||||||
|
{"matrix": [0, 13], "x": 13, "y": 0, "w": 2},
|
||||||
|
{"matrix": [0, 14], "x": 15, "y": 0},
|
||||||
|
{"matrix": [1, 0], "x": 0, "y": 1, "w": 1.5},
|
||||||
|
{"matrix": [1, 1], "x": 1.5, "y": 1},
|
||||||
|
{"matrix": [1, 2], "x": 2.5, "y": 1},
|
||||||
|
{"matrix": [1, 3], "x": 3.5, "y": 1},
|
||||||
|
{"matrix": [1, 4], "x": 4.5, "y": 1},
|
||||||
|
{"matrix": [1, 5], "x": 5.5, "y": 1},
|
||||||
|
{"matrix": [1, 6], "x": 6.5, "y": 1},
|
||||||
|
{"matrix": [1, 7], "x": 7.5, "y": 1},
|
||||||
|
{"matrix": [1, 8], "x": 8.5, "y": 1},
|
||||||
|
{"matrix": [1, 9], "x": 9.5, "y": 1},
|
||||||
|
{"matrix": [1, 10], "x": 10.5, "y": 1},
|
||||||
|
{"matrix": [1, 11], "x": 11.5, "y": 1},
|
||||||
|
{"matrix": [1, 12], "x": 12.5, "y": 1},
|
||||||
|
{"matrix": [1, 13], "x": 13.5, "y": 1, "w": 1.5},
|
||||||
|
{"matrix": [1, 14], "x": 15, "y": 1},
|
||||||
|
{"matrix": [2, 0], "x": 0, "y": 2, "w": 1.75},
|
||||||
|
{"matrix": [2, 1], "x": 1.75, "y": 2},
|
||||||
|
{"matrix": [2, 2], "x": 2.75, "y": 2},
|
||||||
|
{"matrix": [2, 3], "x": 3.75, "y": 2},
|
||||||
|
{"matrix": [2, 4], "x": 4.75, "y": 2},
|
||||||
|
{"matrix": [2, 5], "x": 5.75, "y": 2},
|
||||||
|
{"matrix": [2, 6], "x": 6.75, "y": 2},
|
||||||
|
{"matrix": [2, 7], "x": 7.75, "y": 2},
|
||||||
|
{"matrix": [2, 8], "x": 8.75, "y": 2},
|
||||||
|
{"matrix": [2, 9], "x": 9.75, "y": 2},
|
||||||
|
{"matrix": [2, 10], "x": 10.75, "y": 2},
|
||||||
|
{"matrix": [2, 11], "x": 11.75, "y": 2},
|
||||||
|
{"matrix": [2, 12], "x": 12.75, "y": 2, "w": 2.25},
|
||||||
|
{"matrix": [2, 13], "x": 15, "y": 2},
|
||||||
|
{"matrix": [3, 0], "x": 0, "y": 3, "w": 2.25},
|
||||||
|
{"matrix": [3, 1], "x": 2.25, "y": 3},
|
||||||
|
{"matrix": [3, 2], "x": 3.25, "y": 3},
|
||||||
|
{"matrix": [3, 3], "x": 4.25, "y": 3},
|
||||||
|
{"matrix": [3, 4], "x": 5.25, "y": 3},
|
||||||
|
{"matrix": [3, 5], "x": 6.25, "y": 3},
|
||||||
|
{"matrix": [3, 6], "x": 7.25, "y": 3},
|
||||||
|
{"matrix": [3, 7], "x": 8.25, "y": 3},
|
||||||
|
{"matrix": [3, 8], "x": 9.25, "y": 3},
|
||||||
|
{"matrix": [3, 9], "x": 10.25, "y": 3},
|
||||||
|
{"matrix": [3, 10], "x": 11.25, "y": 3},
|
||||||
|
{"matrix": [3, 11], "x": 12.25, "y": 3, "w": 1.75},
|
||||||
|
{"matrix": [3, 12], "x": 14, "y": 3},
|
||||||
|
{"matrix": [3, 13], "x": 15, "y": 3},
|
||||||
|
{"matrix": [4, 0], "x": 0, "y": 4, "w": 1.5},
|
||||||
|
{"matrix": [4, 1], "x": 1.5, "y": 4, "w": 1.25},
|
||||||
|
{"matrix": [4, 2], "x": 2.75, "y": 4, "w": 1.5},
|
||||||
|
{"matrix": [4, 5], "x": 4.25, "y": 4, "w": 6.25},
|
||||||
|
{"matrix": [4, 10], "x": 10.5, "y": 4, "w": 1.25},
|
||||||
|
{"matrix": [4, 11], "x": 11.75, "y": 4, "w": 1.25},
|
||||||
|
{"matrix": [4, 12], "x": 13, "y": 4},
|
||||||
|
{"matrix": [4, 13], "x": 14, "y": 4},
|
||||||
|
{"matrix": [4, 14], "x": 15, "y": 4},
|
||||||
|
{"matrix": [4, 6], "x": 5.5, "y": 5, "w": 5, "h": 0.5}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"LAYOUT_v1_b": {
|
||||||
|
"layout": [
|
||||||
|
{"matrix": [0, 0], "x": 0, "y": 0},
|
||||||
|
{"matrix": [0, 1], "x": 1, "y": 0},
|
||||||
|
{"matrix": [0, 2], "x": 2, "y": 0},
|
||||||
|
{"matrix": [0, 3], "x": 3, "y": 0},
|
||||||
|
{"matrix": [0, 4], "x": 4, "y": 0},
|
||||||
|
{"matrix": [0, 5], "x": 5, "y": 0},
|
||||||
|
{"matrix": [0, 6], "x": 6, "y": 0},
|
||||||
|
{"matrix": [0, 7], "x": 7, "y": 0},
|
||||||
|
{"matrix": [0, 8], "x": 8, "y": 0},
|
||||||
|
{"matrix": [0, 9], "x": 9, "y": 0},
|
||||||
|
{"matrix": [0, 10], "x": 10, "y": 0},
|
||||||
|
{"matrix": [0, 11], "x": 11, "y": 0},
|
||||||
|
{"matrix": [0, 12], "x": 12, "y": 0},
|
||||||
|
{"matrix": [0, 13], "x": 13, "y": 0},
|
||||||
|
{"matrix": [0, 14], "x": 14, "y": 0, "w": 2},
|
||||||
|
{"matrix": [1, 0], "x": 0, "y": 1, "w": 1.5},
|
||||||
|
{"matrix": [1, 1], "x": 1.5, "y": 1},
|
||||||
|
{"matrix": [1, 2], "x": 2.5, "y": 1},
|
||||||
|
{"matrix": [1, 3], "x": 3.5, "y": 1},
|
||||||
|
{"matrix": [1, 4], "x": 4.5, "y": 1},
|
||||||
|
{"matrix": [1, 5], "x": 5.5, "y": 1},
|
||||||
|
{"matrix": [1, 6], "x": 6.5, "y": 1},
|
||||||
|
{"matrix": [1, 7], "x": 7.5, "y": 1},
|
||||||
|
{"matrix": [1, 8], "x": 8.5, "y": 1},
|
||||||
|
{"matrix": [1, 9], "x": 9.5, "y": 1},
|
||||||
|
{"matrix": [1, 10], "x": 10.5, "y": 1},
|
||||||
|
{"matrix": [1, 11], "x": 11.5, "y": 1},
|
||||||
|
{"matrix": [1, 12], "x": 12.5, "y": 1},
|
||||||
|
{"matrix": [1, 13], "x": 13.5, "y": 1, "w": 1.5},
|
||||||
|
{"matrix": [1, 14], "x": 15, "y": 1},
|
||||||
|
{"matrix": [2, 0], "x": 0, "y": 2, "w": 1.75},
|
||||||
|
{"matrix": [2, 1], "x": 1.75, "y": 2},
|
||||||
|
{"matrix": [2, 2], "x": 2.75, "y": 2},
|
||||||
|
{"matrix": [2, 3], "x": 3.75, "y": 2},
|
||||||
|
{"matrix": [2, 4], "x": 4.75, "y": 2},
|
||||||
|
{"matrix": [2, 5], "x": 5.75, "y": 2},
|
||||||
|
{"matrix": [2, 6], "x": 6.75, "y": 2},
|
||||||
|
{"matrix": [2, 7], "x": 7.75, "y": 2},
|
||||||
|
{"matrix": [2, 8], "x": 8.75, "y": 2},
|
||||||
|
{"matrix": [2, 9], "x": 9.75, "y": 2},
|
||||||
|
{"matrix": [2, 10], "x": 10.75, "y": 2},
|
||||||
|
{"matrix": [2, 11], "x": 11.75, "y": 2},
|
||||||
|
{"matrix": [2, 12], "x": 12.75, "y": 2, "w": 2.25},
|
||||||
|
{"matrix": [2, 13], "x": 15, "y": 2},
|
||||||
|
{"matrix": [3, 0], "x": 0, "y": 3, "w": 2.25},
|
||||||
|
{"matrix": [3, 1], "x": 2.25, "y": 3},
|
||||||
|
{"matrix": [3, 2], "x": 3.25, "y": 3},
|
||||||
|
{"matrix": [3, 3], "x": 4.25, "y": 3},
|
||||||
|
{"matrix": [3, 4], "x": 5.25, "y": 3},
|
||||||
|
{"matrix": [3, 5], "x": 6.25, "y": 3},
|
||||||
|
{"matrix": [3, 6], "x": 7.25, "y": 3},
|
||||||
|
{"matrix": [3, 7], "x": 8.25, "y": 3},
|
||||||
|
{"matrix": [3, 8], "x": 9.25, "y": 3},
|
||||||
|
{"matrix": [3, 9], "x": 10.25, "y": 3},
|
||||||
|
{"matrix": [3, 10], "x": 11.25, "y": 3},
|
||||||
|
{"matrix": [3, 11], "x": 12.25, "y": 3, "w": 1.75},
|
||||||
|
{"matrix": [3, 12], "x": 14, "y": 3},
|
||||||
|
{"matrix": [3, 13], "x": 15, "y": 3},
|
||||||
|
{"matrix": [4, 0], "x": 0, "y": 4, "w": 1.5},
|
||||||
|
{"matrix": [4, 1], "x": 1.5, "y": 4, "w": 1.25},
|
||||||
|
{"matrix": [4, 2], "x": 2.75, "y": 4, "w": 1.5},
|
||||||
|
{"matrix": [4, 5], "x": 4.25, "y": 4, "w": 6.25},
|
||||||
|
{"matrix": [4, 10], "x": 10.5, "y": 4, "w": 1.25},
|
||||||
|
{"matrix": [4, 11], "x": 11.75, "y": 4, "w": 1.25},
|
||||||
|
{"matrix": [4, 12], "x": 13, "y": 4},
|
||||||
|
{"matrix": [4, 13], "x": 14, "y": 4},
|
||||||
|
{"matrix": [4, 14], "x": 15, "y": 4},
|
||||||
|
{"matrix": [4, 6], "x": 5.5, "y": 5, "w": 5, "h": 0.5}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"LAYOUT_v2_a": {
|
||||||
|
"layout": [
|
||||||
|
{"matrix": [0, 0], "x": 0, "y": 0},
|
||||||
|
{"matrix": [0, 1], "x": 1, "y": 0},
|
||||||
|
{"matrix": [0, 2], "x": 2, "y": 0},
|
||||||
|
{"matrix": [0, 3], "x": 3, "y": 0},
|
||||||
|
{"matrix": [0, 4], "x": 4, "y": 0},
|
||||||
|
{"matrix": [0, 5], "x": 5, "y": 0},
|
||||||
|
{"matrix": [0, 6], "x": 6, "y": 0},
|
||||||
|
{"matrix": [0, 7], "x": 7, "y": 0},
|
||||||
|
{"matrix": [0, 8], "x": 8, "y": 0},
|
||||||
|
{"matrix": [0, 9], "x": 9, "y": 0},
|
||||||
|
{"matrix": [0, 10], "x": 10, "y": 0},
|
||||||
|
{"matrix": [0, 11], "x": 11, "y": 0},
|
||||||
|
{"matrix": [0, 12], "x": 12, "y": 0},
|
||||||
|
{"matrix": [0, 13], "x": 13, "y": 0, "w": 2},
|
||||||
|
{"matrix": [0, 14], "x": 15, "y": 0},
|
||||||
|
{"matrix": [1, 0], "x": 0, "y": 1, "w": 1.5},
|
||||||
|
{"matrix": [1, 1], "x": 1.5, "y": 1},
|
||||||
|
{"matrix": [1, 2], "x": 2.5, "y": 1},
|
||||||
|
{"matrix": [1, 3], "x": 3.5, "y": 1},
|
||||||
|
{"matrix": [1, 4], "x": 4.5, "y": 1},
|
||||||
|
{"matrix": [1, 5], "x": 5.5, "y": 1},
|
||||||
|
{"matrix": [1, 6], "x": 6.5, "y": 1},
|
||||||
|
{"matrix": [1, 7], "x": 7.5, "y": 1},
|
||||||
|
{"matrix": [1, 8], "x": 8.5, "y": 1},
|
||||||
|
{"matrix": [1, 9], "x": 9.5, "y": 1},
|
||||||
|
{"matrix": [1, 10], "x": 10.5, "y": 1},
|
||||||
|
{"matrix": [1, 11], "x": 11.5, "y": 1},
|
||||||
|
{"matrix": [1, 12], "x": 12.5, "y": 1},
|
||||||
|
{"matrix": [1, 13], "x": 13.5, "y": 1, "w": 1.5},
|
||||||
|
{"matrix": [1, 14], "x": 15, "y": 1},
|
||||||
|
{"matrix": [2, 0], "x": 0, "y": 2, "w": 1.75},
|
||||||
|
{"matrix": [2, 1], "x": 1.75, "y": 2},
|
||||||
|
{"matrix": [2, 2], "x": 2.75, "y": 2},
|
||||||
|
{"matrix": [2, 3], "x": 3.75, "y": 2},
|
||||||
|
{"matrix": [2, 4], "x": 4.75, "y": 2},
|
||||||
|
{"matrix": [2, 5], "x": 5.75, "y": 2},
|
||||||
|
{"matrix": [2, 6], "x": 6.75, "y": 2},
|
||||||
|
{"matrix": [2, 7], "x": 7.75, "y": 2},
|
||||||
|
{"matrix": [2, 8], "x": 8.75, "y": 2},
|
||||||
|
{"matrix": [2, 9], "x": 9.75, "y": 2},
|
||||||
|
{"matrix": [2, 10], "x": 10.75, "y": 2},
|
||||||
|
{"matrix": [2, 11], "x": 11.75, "y": 2},
|
||||||
|
{"matrix": [2, 12], "x": 12.75, "y": 2, "w": 2.25},
|
||||||
|
{"matrix": [2, 13], "x": 15, "y": 2},
|
||||||
|
{"matrix": [3, 0], "x": 0, "y": 3, "w": 2.25},
|
||||||
|
{"matrix": [3, 1], "x": 2.25, "y": 3},
|
||||||
|
{"matrix": [3, 2], "x": 3.25, "y": 3},
|
||||||
|
{"matrix": [3, 3], "x": 4.25, "y": 3},
|
||||||
|
{"matrix": [3, 4], "x": 5.25, "y": 3},
|
||||||
|
{"matrix": [3, 5], "x": 6.25, "y": 3},
|
||||||
|
{"matrix": [3, 6], "x": 7.25, "y": 3},
|
||||||
|
{"matrix": [3, 7], "x": 8.25, "y": 3},
|
||||||
|
{"matrix": [3, 8], "x": 9.25, "y": 3},
|
||||||
|
{"matrix": [3, 9], "x": 10.25, "y": 3},
|
||||||
|
{"matrix": [3, 10], "x": 11.25, "y": 3},
|
||||||
|
{"matrix": [3, 11], "x": 12.25, "y": 3, "w": 1.75},
|
||||||
|
{"matrix": [3, 12], "x": 14, "y": 3},
|
||||||
|
{"matrix": [3, 13], "x": 15, "y": 3},
|
||||||
|
{"matrix": [4, 0], "x": 0, "y": 4, "w": 1.25},
|
||||||
|
{"matrix": [4, 1], "x": 1.25, "y": 4, "w": 1.25},
|
||||||
|
{"matrix": [4, 2], "x": 2.5, "y": 4, "w": 1.25},
|
||||||
|
{"matrix": [4, 5], "x": 3.75, "y": 4, "w": 6.25},
|
||||||
|
{"matrix": [4, 10], "x": 10, "y": 4, "w": 1.5},
|
||||||
|
{"matrix": [4, 11], "x": 11.5, "y": 4, "w": 1.5},
|
||||||
|
{"matrix": [4, 12], "x": 13, "y": 4},
|
||||||
|
{"matrix": [4, 13], "x": 14, "y": 4},
|
||||||
|
{"matrix": [4, 14], "x": 15, "y": 4},
|
||||||
|
{"matrix": [4, 6], "x": 5.5, "y": 5, "w": 5, "h": 0.5}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"LAYOUT_v2_b": {
|
||||||
|
"layout": [
|
||||||
|
{"matrix": [0, 0], "x": 0, "y": 0},
|
||||||
|
{"matrix": [0, 1], "x": 1, "y": 0},
|
||||||
|
{"matrix": [0, 2], "x": 2, "y": 0},
|
||||||
|
{"matrix": [0, 3], "x": 3, "y": 0},
|
||||||
|
{"matrix": [0, 4], "x": 4, "y": 0},
|
||||||
|
{"matrix": [0, 5], "x": 5, "y": 0},
|
||||||
|
{"matrix": [0, 6], "x": 6, "y": 0},
|
||||||
|
{"matrix": [0, 7], "x": 7, "y": 0},
|
||||||
|
{"matrix": [0, 8], "x": 8, "y": 0},
|
||||||
|
{"matrix": [0, 9], "x": 9, "y": 0},
|
||||||
|
{"matrix": [0, 10], "x": 10, "y": 0},
|
||||||
|
{"matrix": [0, 11], "x": 11, "y": 0},
|
||||||
|
{"matrix": [0, 12], "x": 12, "y": 0},
|
||||||
|
{"matrix": [0, 13], "x": 13, "y": 0, "w": 2},
|
||||||
|
{"matrix": [0, 14], "x": 15, "y": 0},
|
||||||
|
{"matrix": [1, 0], "x": 0, "y": 1, "w": 1.5},
|
||||||
|
{"matrix": [1, 1], "x": 1.5, "y": 1},
|
||||||
|
{"matrix": [1, 2], "x": 2.5, "y": 1},
|
||||||
|
{"matrix": [1, 3], "x": 3.5, "y": 1},
|
||||||
|
{"matrix": [1, 4], "x": 4.5, "y": 1},
|
||||||
|
{"matrix": [1, 5], "x": 5.5, "y": 1},
|
||||||
|
{"matrix": [1, 6], "x": 6.5, "y": 1},
|
||||||
|
{"matrix": [1, 7], "x": 7.5, "y": 1},
|
||||||
|
{"matrix": [1, 8], "x": 8.5, "y": 1},
|
||||||
|
{"matrix": [1, 9], "x": 9.5, "y": 1},
|
||||||
|
{"matrix": [1, 10], "x": 10.5, "y": 1},
|
||||||
|
{"matrix": [1, 11], "x": 11.5, "y": 1},
|
||||||
|
{"matrix": [1, 12], "x": 12.5, "y": 1},
|
||||||
|
{"matrix": [1, 13], "x": 13.5, "y": 1, "w": 1.5},
|
||||||
|
{"matrix": [1, 14], "x": 15, "y": 1},
|
||||||
|
{"matrix": [2, 0], "x": 0, "y": 2, "w": 1.75},
|
||||||
|
{"matrix": [2, 1], "x": 1.75, "y": 2},
|
||||||
|
{"matrix": [2, 2], "x": 2.75, "y": 2},
|
||||||
|
{"matrix": [2, 3], "x": 3.75, "y": 2},
|
||||||
|
{"matrix": [2, 4], "x": 4.75, "y": 2},
|
||||||
|
{"matrix": [2, 5], "x": 5.75, "y": 2},
|
||||||
|
{"matrix": [2, 6], "x": 6.75, "y": 2},
|
||||||
|
{"matrix": [2, 7], "x": 7.75, "y": 2},
|
||||||
|
{"matrix": [2, 8], "x": 8.75, "y": 2},
|
||||||
|
{"matrix": [2, 9], "x": 9.75, "y": 2},
|
||||||
|
{"matrix": [2, 10], "x": 10.75, "y": 2},
|
||||||
|
{"matrix": [2, 11], "x": 11.75, "y": 2},
|
||||||
|
{"matrix": [2, 12], "x": 12.75, "y": 2, "w": 2.25},
|
||||||
|
{"matrix": [2, 13], "x": 15, "y": 2},
|
||||||
|
{"matrix": [3, 0], "x": 0, "y": 3, "w": 2.25},
|
||||||
|
{"matrix": [3, 1], "x": 2.25, "y": 3},
|
||||||
|
{"matrix": [3, 2], "x": 3.25, "y": 3},
|
||||||
|
{"matrix": [3, 3], "x": 4.25, "y": 3},
|
||||||
|
{"matrix": [3, 4], "x": 5.25, "y": 3},
|
||||||
|
{"matrix": [3, 5], "x": 6.25, "y": 3},
|
||||||
|
{"matrix": [3, 6], "x": 7.25, "y": 3},
|
||||||
|
{"matrix": [3, 7], "x": 8.25, "y": 3},
|
||||||
|
{"matrix": [3, 8], "x": 9.25, "y": 3},
|
||||||
|
{"matrix": [3, 9], "x": 10.25, "y": 3},
|
||||||
|
{"matrix": [3, 10], "x": 11.25, "y": 3},
|
||||||
|
{"matrix": [3, 11], "x": 12.25, "y": 3, "w": 1.75},
|
||||||
|
{"matrix": [3, 12], "x": 14, "y": 3},
|
||||||
|
{"matrix": [3, 13], "x": 15, "y": 3},
|
||||||
|
{"matrix": [4, 0], "x": 0, "y": 4, "w": 1.5},
|
||||||
|
{"matrix": [4, 1], "x": 1.5, "y": 4, "w": 1.5},
|
||||||
|
{"matrix": [4, 5], "x": 3, "y": 4, "w": 7},
|
||||||
|
{"matrix": [4, 10], "x": 10, "y": 4, "w": 1.5},
|
||||||
|
{"matrix": [4, 11], "x": 11.5, "y": 4, "w": 1.5},
|
||||||
|
{"matrix": [4, 12], "x": 13, "y": 4},
|
||||||
|
{"matrix": [4, 13], "x": 14, "y": 4},
|
||||||
|
{"matrix": [4, 14], "x": 15, "y": 4},
|
||||||
|
{"matrix": [4, 6], "x": 5.5, "y": 5, "w": 5, "h": 0.5}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
55
keyboards/smart68/keymaps/default/keymap.c
Normal file
55
keyboards/smart68/keymaps/default/keymap.c
Normal file
@ -0,0 +1,55 @@
|
|||||||
|
// Copyright 2024 Alexei Robyn (@Shados)
|
||||||
|
// SPDX-License-Identifier: GPL-2.0-or-later
|
||||||
|
|
||||||
|
#include QMK_KEYBOARD_H
|
||||||
|
|
||||||
|
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
|
||||||
|
/*
|
||||||
|
* ┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───────┬───┐
|
||||||
|
* │Esc│ 1 │ 2 │ 3 │ 4 │ 5 │ 6 │ 7 │ 8 │ 9 │ 0 │ - │ = │Backspc│` │
|
||||||
|
* ├───┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─────┼───┤
|
||||||
|
* │ Tab │ Q │ W │ E │ R │ T │ Y │ U │ I │ O │ P │ [ │ ] │ \ │Del│
|
||||||
|
* ├─────┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴─────┼───┤
|
||||||
|
* │ Caps │ A │ S │ D │ F │ G │ H │ J │ K │ L │ ; │ ' │ Enter │PgU│
|
||||||
|
* ├──────┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴────┬───┼───┤
|
||||||
|
* │ Shift │ Z │ X │ C │ V │ B │ N │ M │ , │ . │ / │Shift │ ↑ │PgD│
|
||||||
|
* ├─────┬──┴─┬─┴───┼───┴───┴───┴───┴───┴───┴┬──┴─┬─┴──┬───┼───┼───┤
|
||||||
|
* │Ctrl │GUI │Alt │ │Alt │Ctrl│ ← │ ↓ │ → │
|
||||||
|
* └─────┴────┴─────┴────────────────────────┴────┴────┴───┴───┴───┘
|
||||||
|
* ┌───────────────────┐
|
||||||
|
* │ Fn │
|
||||||
|
* └───────────────────┘
|
||||||
|
*/
|
||||||
|
[0] = LAYOUT(
|
||||||
|
KC_ESC, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_MINS, KC_EQL, KC_BSPC, KC_GRV,
|
||||||
|
KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC, KC_RBRC, KC_BSLS, KC_DEL,
|
||||||
|
KC_CAPS, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT, KC_ENT, KC_PGUP,
|
||||||
|
KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_RSFT, KC_UP, KC_PGDN,
|
||||||
|
KC_LCTL, KC_LGUI, KC_LALT, KC_SPC, KC_RALT, KC_RCTL, KC_LEFT, KC_DOWN, KC_RIGHT,
|
||||||
|
MO(1)
|
||||||
|
),
|
||||||
|
/* FN Layer
|
||||||
|
* ┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───────┬───┐
|
||||||
|
* │Mut│F1 │F2 │F3 │F4 │F5 │F6 │F7 │F8 │F9 │F10│F11│F12│QK_BOOT│ │
|
||||||
|
* ├───┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─────┼───┤
|
||||||
|
* │ │ │ ↑ │ │ │ │ │ │ │ │Psc│Slk│Pau│ Ins │ │
|
||||||
|
* ├─────┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴─────┼───┤
|
||||||
|
* │ │ ← │ ↓ │ → │ │ │ │ │ │ │ │ │BL_TOGG │Hom│
|
||||||
|
* ├──────┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴────┬───┼───┤
|
||||||
|
* │ │ │ │ │ │ │ │ │ │ │ │ │VoU│End│
|
||||||
|
* ├─────┬──┴─┬─┴───┼───┴───┴───┴───┴───┴───┴┬──┴─┬─┴──┬───┼───┼───┤
|
||||||
|
* │ │ │ │ │ │ │BL-│VoD│BL+│
|
||||||
|
* └─────┴────┴─────┴────────────────────────┴────┴────┴───┴───┴───┘
|
||||||
|
* ┌───────────────────┐
|
||||||
|
* │ │
|
||||||
|
* └───────────────────┘
|
||||||
|
*/
|
||||||
|
[1] = LAYOUT(
|
||||||
|
KC_MUTE, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, QK_BOOT, _______,
|
||||||
|
_______, _______, KC_UP, _______, _______, _______, _______, _______, _______, _______, KC_PSCR, KC_SCRL, KC_PAUS, KC_INS, _______,
|
||||||
|
_______, KC_LEFT, KC_DOWN, KC_RGHT, _______, _______, _______, _______, _______, _______, _______, _______, BL_TOGG, KC_HOME,
|
||||||
|
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_VOLU, KC_END,
|
||||||
|
_______, _______, _______, _______, _______, _______, BL_DOWN, KC_VOLD, BL_UP,
|
||||||
|
_______
|
||||||
|
),
|
||||||
|
};
|
||||||
1
keyboards/smart68/keymaps/default/rules.mk
Normal file
1
keyboards/smart68/keymaps/default/rules.mk
Normal file
@ -0,0 +1 @@
|
|||||||
|
COMMAND_ENABLE = yes
|
||||||
34
keyboards/smart68/readme.md
Normal file
34
keyboards/smart68/readme.md
Normal file
@ -0,0 +1,34 @@
|
|||||||
|
# Smart 68
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
A 68% keyboard with hot-swappable switches & backlight LEDs, and a
|
||||||
|
front-mounted Fn key/bar using an Omron switch.
|
||||||
|
|
||||||
|
* Keyboard Maintainer: [Shados](https://github.com/Shados)
|
||||||
|
* Hardware Supported: Smart 68 PCB
|
||||||
|
* Hardware Availability: [A 2016 Geekhack group buy](https://web.archive.org/web/20180703134842/https://geekhack.org/index.php?topic=83442.0)
|
||||||
|
|
||||||
|
Make example for this keyboard (after setting up your build environment):
|
||||||
|
|
||||||
|
make smart68:default
|
||||||
|
|
||||||
|
Flashing example for this keyboard:
|
||||||
|
|
||||||
|
make smart68:default:flash
|
||||||
|
|
||||||
|
See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
|
||||||
|
|
||||||
|
## Bootloader
|
||||||
|
|
||||||
|
You can enter the bootloader in three different ways:
|
||||||
|
|
||||||
|
1. **Bootmagic reset**: Hold down the key at (3,5) in the matrix (the 'B' key
|
||||||
|
in qwerty layouts) and plug in the keyboard. This will also work if the
|
||||||
|
board is still running its original TMK firmware.
|
||||||
|
2. **Physical reset button**: Briefly press the button on the back of the PCB.
|
||||||
|
This will also work if the board is still running its original TMK firmware.
|
||||||
|
3. **Keycode in layout**: Press the key mapped to `QK_BOOT` (Fn + Backspace, in
|
||||||
|
the default layout). This will *not* work if the board is still running its
|
||||||
|
original TMK firmware.
|
||||||
1
keyboards/smart68/rules.mk
Normal file
1
keyboards/smart68/rules.mk
Normal file
@ -0,0 +1 @@
|
|||||||
|
# This file intentionally left blank
|
||||||
Loading…
Reference in New Issue
Block a user