Principais arquivos de layout

Os principais arquivos de layout (arquivos .kl) mapeiam os códigos de teclas e os eixos do Linux a códigos de teclas e de eixo do Android e especificar sinalizações de políticas associadas. Os arquivos de layout de chave específicos do dispositivo são:

  • Obrigatório para dispositivos de entrada internos (integrados) com chaves, incluindo: teclas especiais, como de volume, liga/desliga e de mídia para fone de ouvido.
  • Opcional para outros dispositivos de entrada, mas recomendado para teclados e joysticks especiais.

Se nenhum arquivo de layout de chave específico do dispositivo estiver disponível, o sistema escolherá uma padrão.

Local

Os arquivos de layout principal são localizados por fornecedor de USB, produto (e, opcionalmente, versão) ou pelo nome do dispositivo de entrada. Os caminhos a seguir são consultados em ordem:

  • /odm/usr/keylayout/Vendor_XXXX_Product_XXXX_Version_XXXX.kl
  • /vendor/usr/keylayout/Vendor_XXXX_Product_XXXX_Version_XXXX.kl
  • /system/usr/keylayout/Vendor_XXXX_Product_XXXX_Version_XXXX.kl
  • /data/system/devices/keylayout/Vendor_XXXX_Product_XXXX_Version_XXXX.kl
  • /odm/usr/keylayout/Vendor_XXXX_Product_XXXX.kl
  • /vendor/usr/keylayout/Vendor_XXXX_Product_XXXX.kl
  • /system/usr/keylayout/Vendor_XXXX_Product_XXXX.kl
  • /data/system/devices/keylayout/Vendor_XXXX_Product_XXXX.kl
  • /odm/usr/keylayout/DEVICE_NAME.kl
  • /vendor/usr/keylayout/DEVICE_NAME.kl
  • /system/usr/keylayout/DEVICE_NAME.kl
  • /data/system/devices/keylayout/DEVICE_NAME.kl
  • /odm/usr/keylayout/Generic.kl
  • /vendor/usr/keylayout/Generic.kl
  • /system/usr/keylayout/Generic.kl
  • /data/system/devices/keylayout/Generic.kl

Ao construir um caminho de arquivo que contém o nome do dispositivo, todos os caracteres no nome do dispositivo diferente de "0'-'9', 'a'-'z', 'A' a 'Z', '-' ou "_" são substituídas por "_".

Arquivo de layout de chave genérico

O sistema fornece um arquivo de layout de chave genérica especial integrado chamado Generic.kl: Esse layout de chave visa oferecer suporte a vários teclados externos e joysticks padrão. Não modifique a chave genérica no mesmo layout.

Sintaxe

Um arquivo de layout principal é um arquivo de texto simples que consiste em declarações de chave ou eixo e sinalizações.

Declarações de chaves

As declarações de chave consistem na palavra-chave key seguida por uma o número do código da tecla e o nome do código da chave do Android, ou o uso da palavra-chave seguido por um Uso da HID e nome do código da chave do Android. O uso de HID é representado como uma em que os 16 bits altos representam a página de uso do HID e os de 16 bits representam o ID de uso de HID. Qualquer uma dessas declarações pode ser seguida por um caractere opcional de políticas delimitados por espaços em branco.

key 1     ESCAPE
key 114   VOLUME_DOWN
key 16    Q                 VIRTUAL
key usage 0x0c006F          BRIGHTNESS_UP

As seguintes sinalizações de política são reconhecidas:

  • FUNCTION: a chave precisa ser interpretada como se a chave FUNCTION também foram pressionados.
  • GESTURE: a chave gerada por um gesto do usuário, como a palma da mão na tela touchscreen.
  • VIRTUAL: a chave é uma tecla de software virtual (botão capaciativo). ao lado da tela touch principal. Isso faz com que a lógica de dedução especial seja ativado (veja abaixo).

Declarações de eixo

Cada declaração de eixo consiste na palavra-chave axis seguida de Número e qualificadores do código de eixo do Linux que controlam o comportamento do eixo incluindo pelo menos um nome para o código do eixo do Android.

Eixos básicos

Um eixo básico simplesmente mapeia um código de eixo do Linux para um nome de código de eixo do Android. A a seguir mapeia ABS_X (indicado por 0x00) como AXIS_X (indicado por X).

axis 0x00 X

No exemplo acima, se o valor de ABS_X for 5 AXIS_X é definido como 5.

Eixos divididos

Um eixo de divisão mapeia um código de eixo do Linux para dois nomes de código de eixo do Android, de modo que valores menores ou maiores que um limite são divididos em dois eixos diferentes quando mapeados. Esse mapeamento é útil quando um único eixo físico informado pelo dispositivo codifica dois eixos lógicos diferentes e mutuamente exclusivos.

A declaração a seguir mapeia valores do eixo ABS_Y (indicado por 0x01) até AXIS_GAS quando menor que 0x7f ou a AXIS_BRAKE quando maior que 0x7f.

axis 0x01 split 0x7f GAS BRAKE

No exemplo acima, se o valor de ABS_Y for 0x7d então AXIS_GAS é definido como 2 (0x7f - 0x7d) e AXIS_BRAKE é definido como 0. Por outro lado, se o valor de ABS_Y é 0x83, então AXIS_GAS é definido como 0 e AXIS_BRAKE estão definidos como 4 (0x83 - 0x7f). Por fim, se o valor de ABS_Y for igual a o valor dividido de 0x7f e, em seguida, AXIS_GAS e AXIS_BRAKE estão definidos como 0.

Eixos invertidos

Um eixo invertido inverte o sinal do valor do eixo. O seguinte representa ABS_RZ (indicado por 0x05) a AXIS_BRAKE (indicada por BRAKE) e inverte a ao negá-lo.

axis 0x05 invert BRAKE

No exemplo acima, se o valor de ABS_RZ for 2 AXIS_BRAKE é definido como -2.

Opção centralizada

Um joystick pode relatar eventos de entrada mesmo quando o joystick não está sendo usado devido ao ruído. Esse ruído normalmente vem dos analógicos esquerdo e/ou direito e faz com que o motorista informe um valor de posição próximo de 0. O "plano central" value especifica a quantidade de ruído esperada do controlador em repouso.

O protocolo de entrada do Linux permite que drivers de dispositivo de entrada especifiquem o valor fixo central dos eixos do joystick, mas nem todos os motoristas informam isso e alguns fornecem valores incorretos. Para resolver esse problema, uma declaração de eixo pode ser seguida por um A opção flat que especifica a largura da região ao redor do centro posição do eixo que deve ser considerada centralizada.

Por exemplo, se um driver de dispositivo informar valores de AXIS_X entre 0 e 100, então 0 será mapeado para -1 e 100 será mapeado para 1 pelo sistema de entrada do Android. O centro do intervalo será 50 nas coordenadas não dimensionadas e 0 nas coordenadas dimensionadas. Se um valor fixo for igual a 10, os desenvolvedores vão supor que qualquer valor de AXIS_X informado entre -0,1 e 0,1 (entre 40 e 60 em coordenadas não dimensionadas) é um ruído, e trata esses valores de do joystick como zero.

Observação: embora o arquivo de layout da chave especifique o valor para o espaço de coordenadas do motorista, o valor relatado por android.view.InputDevice.MotionRange#getFlat() está no o espaço de coordenadas.

axis 0x03 Z flat 4096

No exemplo acima, o valor plano central é definido como 4096.

Comentários

As linhas de comentários começam com # e continuam até o fim da linha:

# A comment!

As linhas em branco são ignoradas.

Exemplos

Teclado

# This is an example of a key layout file for a keyboard.

key 1     ESCAPE
key 2     1
key 3     2
key 4     3
key 5     4
key 6     5
key 7     6
key 8     7
key 9     8
key 10    9
key 11    0
key 12    MINUS
key 13    EQUALS
key 14    DEL

# etc...

Controles do sistema

# This is an example of a key layout file for basic system controls,
# such as volume and power keys which are typically implemented as GPIO pins
# the device decodes into key presses.

key 114   VOLUME_DOWN
key 115   VOLUME_UP
key 116   POWER

Botões capacitivos

# This is an example of a key layout file for a touch device with capacitive buttons.

key 139    MENU           VIRTUAL
key 172    HOME           VIRTUAL
key 158    BACK           VIRTUAL
key 217    SEARCH         VIRTUAL

Controles de mídia da entrada para fone de ouvido

# This is an example of a key layout file for headset mounted media controls.
# A typical headset jack interface might have special control wires or detect known
# resistive loads as corresponding to media functions or volume controls.
# This file assumes that the driver decodes these signals and reports media
# controls as key presses.

key 163   MEDIA_NEXT
key 165   MEDIA_PREVIOUS
key 226   HEADSETHOOK

Joystick

# This is an example of a key layout file for a joystick.

# These are the buttons that the joystick supports, represented as keys.
key 304   BUTTON_A
key 305   BUTTON_B
key 307   BUTTON_X
key 308   BUTTON_Y
key 310   BUTTON_L1
key 311   BUTTON_R1
key 314   BUTTON_SELECT
key 315   BUTTON_START
key 316   BUTTON_MODE
key 317   BUTTON_THUMBL
key 318   BUTTON_THUMBR

# Left and right stick.
# The reported value for flat is 128 in a range of -32767 to 32768, which is absurd.
# This confuses applications that rely on the flat value because the joystick
# actually settles in a flat range of +/- 4096 or so. We override it here.
axis 0x00 X flat 4096
axis 0x01 Y flat 4096
axis 0x03 Z flat 4096
axis 0x04 RZ flat 4096

# Triggers.
axis 0x02 LTRIGGER
axis 0x05 RTRIGGER

# Hat.
axis 0x10 HAT_X
axis 0x11 HAT_Y

Teclas virtuais

O sistema de entrada fornece recursos especiais para implementar teclas virtuais nos seguintes casos de uso:

  1. Se as teclas virtuais forem exibidas graficamente na tela (como no Galaxy Nexus), elas são implementadas pelo componente da barra de navegação no do pacote da interface do sistema. Como as teclas virtuais gráficas são implementadas em um nível alto camada no sistema, os arquivos de layout de chave não estão envolvidos e os seguintes não se aplicam.
  2. Se as teclas virtuais forem implementadas como uma região de toque estendida que faz parte da tela sensível ao toque principal (como no Nexus One), a entrada sistema usa um arquivo de mapa de teclas virtuais para traduzir coordenadas de toque X/Y para os códigos de tecla do Linux e, em seguida, usa o arquivo de layout de chave para converter os códigos de tecla do Linux em Códigos de chave do Android (para detalhes sobre arquivos de mapa de chave virtual, consulte dispositivos touchscreen). O arquivo de layout principal da dispositivo de entrada touchscreen deve especificar o mapeamento de tecla apropriado e incluir a sinalização VIRTUAL para cada chave.
  3. Se as teclas virtuais forem implementadas como botões capacitivos separados na tela sensível ao toque principal (como no Nexus S), o driver de dispositivo do kernel ou é responsável por traduzir toques em códigos de tecla do Linux que o o sistema de entrada converte em códigos de tecla do Android usando o arquivo de layout de tecla. O arquivo de layout de chave para o dispositivo de entrada com botão capacitivo precisa especificar o o mapeamento de teclas apropriado e inclua a sinalização VIRTUAL para cada chave.

Quando as teclas de software virtuais estão localizadas ou próximas fisicamente na tela sensível ao toque, é fácil para os usuários pressionarem acidentalmente um botão quando tocar perto da parte de baixo da tela ou ao deslizar um dedo de cima para baixo ou de baixo para cima na tela. Para evitar isso, o sistema de entrada aplica um pouco devolvendo de forma que pressionamentos de teclas virtuais sejam ignorados por um breve período de depois do toque mais recente na tela (esse atraso é chamado tempo de silêncio da chave virtual).

Para ativar a devolução de teclas virtuais:

  1. Forneça um arquivo de layout principal para a tela sensível ao toque ou o botão capacitivo dispositivo de entrada com a flag VIRTUAL definida para cada chave.
    key 139    MENU           VIRTUAL
    key 172    HOME           VIRTUAL
    key 158    BACK           VIRTUAL
    key 217    SEARCH         VIRTUAL
    
  2. Defina o valor do tempo de silenciamento da chave virtual em uma sobreposição de recursos para o recurso config.xml do framework.
    <!-- Specifies the amount of time to disable virtual keys after the screen
    is touched to filter out accidental virtual key presses due to swiping gestures
    or taps near the edge of the display. May be 0 to disable the feature.
    It is recommended that this value be no more than 250 ms.
    This feature should be disabled for most devices. -->
    
    <integer name="config_virtualKeyQuietTimeMillis">250</integer>
    

Validação

Você deve validar seus arquivos de layout de chave usando o Ferramenta Validate Keymaps.