* update modtap to holdtap
* Update links
* Revert "Update links"
This reverts commit 8d0cda7c5a
.
* updated docs links
update links in docs
* Update docs/en/Getting_Started.md
Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>
* Update docs/en/Getting_Started.md
Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>
* rename modtap.md to holdtap.md
* Update Getting_Started.md
* Update main.py
* Update modtap.py
* Update modtap.py and add notice
* Update docs/en/porting_to_kmk.md
Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>
* Update docs/en/handwiring.md
Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>
* Update docs/en/contributing.md
Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>
* Update docs/en/contributing.md
Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>
* Update docs/en/ble_hid.md
Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>
* Update docs/en/Getting_Started.md
Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>
* Update docs/en/Getting_Started.md
Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>
* Update docs/en/kmkpython_vs_circuitpython.md
Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>
* Rename modtap.md to holdtap.md
* fixup
---------
Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>
4.9 KiB
Começando
A vida era como uma caixa de chocolates. Você nunca saberia o que iria encontrar.
KMK é uma camada focada em teclados que assenta-se em cima de CircuitPython. Como tal, ela deve funcionar com a maior parte das placas que suportam CircuitPython. É melhor usar a última versão estável (>5.0). Dispositivos funcionais e recomendados podem ser encontrados aqui
Também fornecemos uma versão de CircuitPython otimizada para teclados (simplificada para lidar com os limites de certas placas e com a seleção dos módulos relevantes pré-instalados). Se você estiver se perguntando por que usar
Guia Rápido
Ao Infinito e Além!
- Installe CircuitPython na tua placa. Com a maioria das placas, deve ser algo tão fácil quanto copiar e colar o firmware no drive.
- Obtenha uma cópia do KMK a partir do ramo master.
- Descompacte e cole o diretório KMK e o arquivo boot.py na raiz do drive USB correspondente à tua placa (geralmente aparecendo como CIRCUITPY).
- Crie um novo arquivo code.py ou main.py no mesmo diretório raiz (no mesmo nível de boot.py) com o exemplo contido abaixo:
IMPORTANTE: adapte os pinos GP0 / GP1 para a tua placa específica!
print("Starting")
import board
from kmk.kmk_keyboard import KMKKeyboard
from kmk.keys import KC
from kmk.scanners import DiodeOrientation
keyboard = KMKKeyboard()
keyboard.col_pins = (board.GP0,)
keyboard.row_pins = (board.GP1,)
keyboard.diode_orientation = DiodeOrientation.COL2ROW
keyboard.keymap = [
[KC.A,]
]
if __name__ == '__main__':
keyboard.go()
-
Usando um fio, um clipe de papel ou o que seja, conecte o GPIO 0 e o GPIO 1 (ou os pinos que você escolheu para tua placa).
-
Se ela imprimir um "A" (ou um "Q" ou o que depender do teu layout de teclado), você conseguiu!
Agora que tudo está no seu lugar, você pode querer ir além...
Esta é tua última chance. Após isso Esta é sua última chance. Depois não há como voltar. Se tomar a pílula azul a história acaba, e você acordará na sua cama acreditando no que quiser. Se tomar a pílula vermelha ficará no País das Maravilhas e eu te mostrarei até onde vai a toca do coelho. Lembre-se: tudo o que estou te oferecendo é a verdade. Nada mais.
Você é extremamente sortudo e tem um teclado totalmente suportado
Se seu teclado e micro-controlador são suportados oficialmente, simplesmente
visite a webpage com os seus arquivos e coloque-os na raiz do "flash drive".
Estas webpages podem ser vistas aqui. Você
precisará dos arquivos kb.py
e main.py
. Instruções mais avançadas podem ser
vistas aqui.
Você obteve outro teclado, possivelmente artesanal, e quer customizar o KMK para ele
Primeiro, certifique-se de entender como o seu teclado funciona, e em particular sua configuração matricial específica. Você pode observar aqui ou ler o guia feito pelo time da QMK para teclados artesanais.
Uma vez que você compreendeu a essência da coisa:
- Você pode dar uma olhada aqui e aqui para começar a customizar seu arquivo code.py / main.py.
- Eis uma referência dos códigos de teclas (keycodes) disponíveis.
- A extensão internacional acrescenta teclas para layouts não-americanos, e as teclas de mídia acrecentam teclas para... mídia.
E para ir mais além:
- Sequências são usadas para enviar múltiplas teclas em uma ação só.
- Camadas podem transformar totalmente como seu teclado age com um simples toque.
- HoldTap te permite customizar a maneira que uma tecla age quando é pressionada ou "segurada"; e o
- TapDance dependendo do número de vezes que ela é pressionada.
Você quer extensões divertidas como RGB, teclados repartidos ao meio e mais? Confira o que os módulos e extensões podem fazer!
Você também pode obter ideias dos vários exemplos de usuários que fornecemos e fuce nossa documentação.
Ajuda e Suporte Adicionais
Estradas? Para onde vamos, estradas são desnecessárias.
Caso precise, ajuda para depuração pode ser encontrada aqui.
Se você precisa de suporte com o KMK ou quer somente dizer oi, encontre-nos no canal kmkfw no Zulip. Se você precisa de ajuda ou pretende abrir um bug report, se possível se possível, verifique se sua cópia do KMK está atualizada.