Como usar o ZMK Studio para remapear as teclas do seu teclado
O ZMK Studio é uma interface gráfica que permite alterar o que as teclas fazem em teclados compatíveis com ZMK.
Você pode mover uma tecla de lugar, alterar atalhos, reorganizar camadas e testar novas configurações diretamente pelo computador. Para a maioria dessas mudanças, basta clicar na tecla que quer alterar, escolher a nova função e pronto.
Isso é especialmente útil em teclados compactos e ergonômicos, onde encontrar a posição ideal para cada função costuma fazer parte do processo de adaptação.
TL;DR
Se o seu teclado tem suporte ao ZMK Studio, o processo básico é:
-
abra o ZMK Studio;
-
selecione o teclado;
-
desbloqueie a edição usando a tecla ou combinação configurada como Studio Unlock;
-
escolha a camada que deseja editar;
-
clique na tecla;
-
escolha a nova função;
-
salve as alterações.
A mudança acontece imediatamente. Você não precisa reiniciar o teclado, o computador ou qualquer outro dispositivo.
Depois de salvar, a configuração fica armazenada no próprio teclado e continua valendo depois de desligá-lo ou conectá-lo a outro computador, celular, tablet ou dispositivo.
Por que usar o ZMK Studio?
Um teclado programável possui um firmware, que é o software interno responsável pelo funcionamento do teclado.
Dentro da configuração desse firmware existe o mapa de teclas, também chamado de keymap. Ele determina o que cada posição física faz.
Sem uma ferramenta como o ZMK Studio, alterar esse mapa normalmente envolve um processo mais técnico: é necessário editar os arquivos de configuração do teclado, gerar uma nova versão do firmware e instalá-la no teclado.
Essa forma continua sendo muito útil quando queremos alterar recursos mais profundos do teclado, mas é trabalho demais quando a mudança é simplesmente:
“Quero colocar o Backspace no outro polegar.”
ou:
“Quero testar o Delete nesta tecla.”
Com o ZMK Studio, você não precisa passar por todo esse processo.
Você abre o programa, vê seu teclado na tela, clica na posição desejada e escolhe a nova função.
Para quem está se adaptando a um teclado ergonômico, isso faz bastante diferença. É comum montar um mapa de teclas que parece perfeito no começo e, depois de alguns dias de uso, perceber que uma função ficaria mais confortável em outro lugar.
Com o ZMK Studio, testar essas mudanças leva segundos.
O que você pode alterar?
O ZMK Studio permite modificar o mapa de teclas enquanto o teclado está funcionando.
É possível trocar teclas de lugar, editar as diferentes camadas, atribuir outros comportamentos às teclas, usar combinações com Ctrl, Shift e Alt, renomear camadas e habilitar camadas extras que já tenham sido previstas na configuração do teclado.
Existem configurações mais avançadas que ainda precisam ser feitas diretamente no firmware. O ZMK Studio não substitui toda a configuração do ZMK, mas cobre muito bem as mudanças que normalmente queremos fazer durante o uso cotidiano.
Antes de começar: o teclado precisa ter suporte ao ZMK Studio
Um teclado usar ZMK não significa automaticamente que ele funciona com o ZMK Studio.
O suporte precisa ter sido habilitado na configuração do firmware.
Se você comprou um teclado pronto, consulte a documentação do fabricante ou de quem construiu o teclado.
Nos teclados wireless da MagnusKeyboards que utilizam ZMK, o suporte ao ZMK Studio é habilitado por padrão.
Neste artigo vou usar um Magnus44 como exemplo.
Os screenshots foram feitos no aplicativo do ZMK Studio para Windows. A interface pode apresentar pequenas diferenças dependendo da versão utilizada, do sistema operacional ou se você estiver usando a versão web.
Abrindo o ZMK Studio
Você pode acessar o ZMK Studio Web diretamente pelo navegador.
Também existe um aplicativo próprio para Windows, Linux e macOS, disponível na página de download do ZMK Studio.
Neste guia vou usar o aplicativo para Windows.
Uma vantagem do aplicativo é poder utilizar o ZMK Studio por Bluetooth em teclados wireless compatíveis. Neste exemplo, o Magnus44 está conectado sem cabo.
Ao abrir o programa, os teclados disponíveis aparecem na tela inicial.
Clique no nome do teclado para conectar.
No caso de um teclado split, você não precisa configurar cada metade separadamente. O ZMK Studio apresenta o teclado completo e as alterações são feitas no mapa de teclas como um todo.
Desbloqueando o teclado
Depois da conexão, você pode encontrar a mensagem Unlock To Continue.
Isso é normal.
Por segurança, conectar ao teclado não é suficiente para começar a alterar sua configuração. É necessário executar fisicamente no teclado uma função chamada Studio Unlock.
A posição dessa função depende de como o teclado foi configurado.
Onde fica o Studio Unlock nos teclados MagnusKeyboards?
Nos teclados MagnusKeyboards, normalmente deixamos o Studio Unlock na camada Lower, na quarta tecla da esquerda para a direita da fileira mais baixa da metade esquerda.
Depois de pressionar essa tecla, a edição é liberada e você pode começar a alterar o mapa de teclas.
O ZMK Studio pode voltar a bloquear quando você desconecta o teclado ou depois de algum tempo sem atividade. Isso também é normal.
Cuidado ao alterar essa tecla
É possível mudar a própria tecla que executa o Studio Unlock.
Evite apagar sua única forma de desbloquear o ZMK Studio sem antes configurar outra.
Enquanto a sessão atual estiver desbloqueada, tudo pode parecer normal. O problema aparece depois que o ZMK Studio volta a bloquear e você percebe que não existe mais uma tecla para liberá-lo.
Entendendo a tela principal
Depois do desbloqueio, você verá o desenho do teclado e suas diferentes camadas.
No centro da tela estão as posições físicas das teclas.
À esquerda estão as camadas disponíveis. Neste Magnus44 temos:
Def, a camada principal.
Lower, uma camada secundária.
Raise, outra camada secundária.
O que é uma camada/layer?
Uma forma simples de entender camadas é pensar nelas como mais teclas Shift.
Você já usa esse conceito em um teclado convencional.
Por exemplo, pressionar 3 produz um resultado. Pressionar Shift + 3 produz outro.
A tecla física continua sendo a mesma. O Shift apenas muda temporariamente a função dela.
As camadas de um teclado programável seguem uma ideia parecida, só que podem alterar praticamente o teclado inteiro ao mesmo tempo.
Ao segurar uma tecla que ativa a camada Lower, por exemplo, várias posições podem mudar de função. Letras podem virar números, controles de mídia, símbolos ou outras funções.
A camada Raise pode trazer outro conjunto completamente diferente.
Isso permite colocar muitas funções em um teclado pequeno sem precisar de uma tecla física dedicada para cada uma delas.
Em um teclado compacto, por exemplo, você pode não ter uma fileira física exclusiva para F1 até F12. Essas funções podem simplesmente ficar em outra camada.
Como fazemos isso nos teclados MagnusKeyboards
Por padrão, configuramos três camadas prontas para uso nos teclados MagnusKeyboards:
Def, Lower e Raise.
Essa configuração pode ser diferente caso o cliente queira outra organização.
Além dessas três, deixamos mais três camadas reservadas no firmware.
Elas não precisam ficar ocupando espaço no mapa de teclas inicial, mas podem ser habilitadas posteriormente pelo próprio ZMK Studio caso o usuário queira expandir sua configuração.
Assim, um teclado MagnusKeyboards normalmente chega com três camadas já configuradas e ainda permite adicionar outras três pelo ZMK Studio sem precisar alterar o firmware.
Como alterar uma tecla
Vamos fazer a alteração mais simples possível.
No exemplo abaixo, uma posição do Magnus44 está configurada como V e vamos transformá-la em E.
Primeiro, selecione a camada desejada e clique na tecla.
Na parte inferior aparecem os campos usados para configurar aquela posição.
Como o aplicativo está em inglês, você verá o campo Behavior. Neste artigo vou chamá-lo simplesmente de comportamento.
O comportamento determina o que aquela posição faz.
Logo abaixo aparece o campo Key, ou seja, a tecla associada àquele comportamento.
Neste caso temos:
Comportamento: Key Press
Tecla: Keyboard V
Isso significa simplesmente: quando esta posição for pressionada, envie a tecla V.
Para trocar, abra o campo de seleção da tecla.
Você pode digitar no próprio campo para pesquisar. Não é necessário percorrer a lista inteira manualmente.
Selecione Keyboard E.
E aqui existe um detalhe importante:
a mudança já aconteceu.
No momento em que você troca V por E, o teclado passa a reconhecer aquela posição como E.
Não é necessário:
reiniciar o teclado;
desconectar e conectar novamente;
reiniciar o computador;
reiniciar o ZMK Studio.
Você pode abrir um editor de texto naquele mesmo instante, pressionar a tecla e testar o resultado.
Essa possibilidade de fazer uma mudança e experimentá-la imediatamente é uma das partes mais úteis do ZMK Studio.
Se não gostou, volte e troque novamente.
Quando estiver satisfeito com as alterações, use o botão de salvar, no canto superior direito. Isso grava a configuração para que ela continue valendo depois que o teclado for desligado.
Uma tecla pode fazer muito mais do que escrever uma letra
Até agora usamos o comportamento Key Press, que representa uma tecla comum.
Mas uma posição física pode fazer muito mais do que enviar uma letra, número ou símbolo.
Ao abrir o campo Behavior da interface, você verá os diferentes comportamentos disponíveis.
Key Press
É o caso mais simples.
A posição envia uma tecla normal, como A, Enter, Backspace, F5, uma seta ou um comando de mídia.
Foi o comportamento que usamos para transformar V em E.
Momentary Layer
Ativa outra camada enquanto você mantém a tecla pressionada.
É justamente uma das formas de criar aquela ideia de “mais um Shift” que vimos anteriormente.
Enquanto a tecla está pressionada, as posições assumem as funções da outra camada. Quando você solta, volta para a camada anterior.
Layer-Tap
Permite que a mesma posição faça duas coisas diferentes.
Por exemplo, ela pode funcionar como Space quando você apenas toca e ativar outra camada quando você mantém a tecla pressionada.
Mod-Tap
Segue uma ideia parecida, mas combina uma tecla comum com um modificador.
Por exemplo, uma posição pode produzir A quando tocada e funcionar como Ctrl quando segurada.
Bluetooth
Permite atribuir ações relacionadas aos perfis Bluetooth do teclado.
Isso pode ser usado para selecionar dispositivos, limpar pareamentos e executar outras funções de conexão.
Perfis Bluetooth têm alguns detalhes próprios, então vamos abordar esse assunto separadamente em outro artigo.
Transparent
Faz aquela posição utilizar a função existente em uma camada abaixo.
Isso é útil quando você quer que uma camada modifique apenas algumas teclas e deixe todo o restante funcionando normalmente.
None
A posição não executa nenhuma ação.
Studio Unlock
É a função que usamos no início do artigo para permitir que o ZMK Studio altere o teclado.
Os comportamentos disponíveis podem variar
Nem todo teclado apresenta exatamente a mesma lista.
O ZMK Studio consegue usar comportamentos que já foram disponibilizados pelo firmware do teclado, mas não consegue criar qualquer tipo de comportamento novo do zero.
Por isso, dois teclados diferentes podem mostrar opções diferentes mesmo utilizando a mesma versão do ZMK Studio.
Para mudanças comuns de mapa de teclas, isso normalmente não é um problema. As principais funções já podem ser deixadas disponíveis na configuração do teclado.
Usando Ctrl, Shift, Alt e outros modificadores
Ao configurar uma tecla comum, o ZMK Studio também pode oferecer modificadores como L Ctrl, L Shift, L Alt, L GUI e suas versões do lado direito.
Eles permitem criar combinações simples diretamente pela interface.
Você pode, por exemplo, configurar uma posição para enviar Ctrl + C.
Ou configurar outra para Shift + 3.
Isso é particularmente útil em teclados compactos, onde uma combinação muito utilizada pode ganhar uma posição própria.
Alterando outras camadas
O processo é exatamente o mesmo em qualquer camada.
Selecione Lower, Raise ou outra camada disponível, clique na posição desejada e escolha sua nova função.
No Magnus44 deste artigo, por exemplo, as camadas secundárias contêm números, teclas F, navegação e controles de mídia.
Mas isso é apenas a configuração que escolhemos para esse teclado.
Uma das principais vantagens de um teclado programável é justamente poder organizar essas funções de acordo com seu uso.
Se você usa setas constantemente, pode deixá-las em posições muito fáceis de alcançar.
Se nunca usa determinadas funções, pode substituí-las.
Se depois de uma semana perceber que sua organização não ficou boa, pode abrir o ZMK Studio e mudar de novo.
Adicionando novas camadas
O ZMK Studio também permite habilitar camadas adicionais, desde que elas já tenham sido reservadas no firmware.
Isso significa que não é possível criar uma quantidade ilimitada de novas camadas apenas pela interface.
O limite é definido quando o firmware do teclado é preparado.
Como mencionei anteriormente, nos teclados MagnusKeyboards configuramos normalmente três camadas de uso imediato e outras três camadas reservadas.
Se você quiser uma quarta camada, pode habilitá-la no ZMK Studio, dar um nome a ela e começar a configurá-la.
O mesmo vale para a quinta e a sexta.
Dessa forma existe espaço para personalização futura sem deixar o mapa inicial desnecessariamente complexo.
O que acontece se eu quiser voltar ao layout original?
As alterações salvas pelo ZMK Studio ficam armazenadas no teclado.
Isso é justamente o que permite levar seu mapa de teclas junto com o teclado quando você troca de computador ou usa outro dispositivo.
Mas também significa que essas mudanças continuam ativas até que você decida removê-las.
Se quiser voltar ao mapa de teclas original fornecido pelo firmware atualmente instalado, abra o menu do teclado no topo da interface e selecione Restore Stock Settings.
É uma opção útil se você fez vários testes e quer simplesmente começar novamente.
E se eu atualizar o firmware do teclado?
Aqui existe uma diferença importante entre o mapa de teclas base do firmware e as alterações feitas pelo ZMK Studio.
As personalizações salvas pelo ZMK Studio ficam armazenadas separadamente na memória do teclado e, normalmente, não são apagadas simplesmente porque uma nova versão comum do firmware foi instalada.
Por isso, atualizar o firmware não significa necessariamente que seu mapa personalizado será substituído.
Por outro lado, uma atualização pode trazer uma nova configuração base ou exigir procedimentos específicos dependendo do que mudou.
Por isso, ao atualizar o firmware de um teclado pronto, vale seguir as instruções fornecidas junto daquela atualização.
Se a intenção for abandonar suas alterações do ZMK Studio e utilizar o novo mapa de teclas base fornecido pelo firmware instalado, use Restore Stock Settings.
Posso usar o ZMK Studio por Bluetooth?
Sim.
O ZMK Studio pode trabalhar por USB e também por Bluetooth em ambientes compatíveis.
Neste artigo, por exemplo, o Magnus44 foi configurado utilizando o aplicativo para Windows e uma conexão Bluetooth. Nenhum cabo foi necessário.
Isso combina muito bem com um teclado wireless.
Você pode estar usando o teclado normalmente, perceber que quer mudar uma função, abrir o ZMK Studio, fazer a alteração e testar imediatamente.
Também existe a versão web, embora as opções de conexão disponíveis possam variar conforme navegador, sistema operacional e versão do ZMK Studio.
Problemas comuns
Meu teclado não aparece no ZMK Studio
Primeiro confirme se o teclado realmente possui suporte ao ZMK Studio.
Usar ZMK não é suficiente por si só: o recurso precisa ter sido habilitado no firmware.
Nos teclados wireless da MagnusKeyboards que utilizam ZMK, ele já é habilitado por padrão.
Se estiver tentando conectar por USB, verifique também se o cabo utilizado transmite dados. Existem cabos USB feitos apenas para alimentação.
O teclado aparece, mas fica em “Unlock To Continue”
Isso é esperado.
Execute no próprio teclado a tecla ou combinação configurada como Studio Unlock.
Nos teclados MagnusKeyboards, normalmente ela fica na camada Lower, na quarta posição da esquerda para a direita da fileira mais baixa da metade esquerda.
Alterei uma tecla e depois ela voltou ao valor anterior
A alteração acontece imediatamente enquanto você está editando, mas é necessário usar o botão salvar para mantê-la armazenada no teclado.
Se você fizer uma mudança, testar e depois sair sem salvar, ela não ficará gravada permanentemente.
Preciso saber programar para usar o ZMK Studio?
Não.
Se o teclado já foi preparado com suporte ao ZMK Studio, todas as alterações mostradas neste artigo podem ser feitas pela interface gráfica.
Você não precisa conhecer a estrutura interna do ZMK nem usar ferramentas de desenvolvimento para trocar uma tecla de lugar.
Vale a pena usar o ZMK Studio?
Em um teclado convencional, é comum passar anos sem pensar em mudar a posição de uma única tecla.
Em teclados compactos e ergonômicos, isso muda bastante.
O mapa de teclas faz parte da adaptação.
Você pode começar achando que Backspace deveria ficar no polegar direito e, depois de alguns dias, perceber que prefere no esquerdo.
Pode descobrir que uma combinação que parecia importante quase nunca é usada.
Ou que uma função escondida em uma camada deveria estar muito mais acessível.
Não existe motivo para acertar tudo na primeira tentativa.
É justamente aí que o ZMK Studio é tão útil.
Você muda uma tecla, testa imediatamente e continua usando o teclado.
Não gostou? Muda de novo.
Gostou? Salva.
Com o tempo, o teclado deixa de ser apenas um layout que alguém escolheu para você e passa a refletir a maneira como você realmente trabalha e digita.
Nos teclados wireless da MagnusKeyboards que utilizam ZMK, deixamos o ZMK Studio habilitado justamente por isso. O teclado já chega com três camadas configuradas para uso, mas você continua livre para alterar essas funções e ainda tem outras três camadas disponíveis para expandir o mapa depois.
Ficou alguma dúvida?
Se este artigo te ajudou, pode me chamar para conversar sobre teclados ergonômicos, ZMK, ZMK Studio ou sobre alguma configuração específica que você esteja tentando montar.
E se não gostou do artigo, pode me chamar também. Nesse caso, me diz o que ficou ruim ou o que poderia estar mais claro. Esse tipo de feedback ajuda bastante a melhorar os próximos guias.
Você pode entrar em contato pelo formulário da MagnusKeyboards ou falar diretamente comigo pelo Instagram @magnuskeyboards.