मुख्य लेआउट फ़ाइलें

बटन लेआउट फ़ाइलें (.kl फ़ाइलें), Linux बटन कोड और ऐक्सिस कोड को Android बटन कोड और ऐक्सिस कोड पर मैप करती हैं. साथ ही, इनसे जुड़े नीति फ़्लैग की जानकारी भी मिलती है. डिवाइस के हिसाब से बटन के लेआउट की फ़ाइलें ये हैं:

  • यह एट्रिब्यूट, बटन वाले इंटरनल (पहले से मौजूद) इनपुट डिवाइसों के लिए ज़रूरी है. इनमें आवाज़, पावर, और हेडसेट के मीडिया बटन जैसी खास बटन भी शामिल हैं.
  • अन्य इनपुट डिवाइसों के लिए ज़रूरी नहीं है, लेकिन खास काम के कीबोर्ड और जॉयस्टिक के लिए सुझाया जाता है.

अगर डिवाइस के हिसाब से कोई की लेआउट फ़ाइल उपलब्ध नहीं है, तो सिस्टम डिफ़ॉल्ट लेआउट चुनता है.

जगह की जानकारी

बटन लेआउट फ़ाइलें, यूएसबी वेंडर, प्रॉडक्ट (और वैकल्पिक रूप से वर्शन) आईडी या इनपुट डिवाइस के नाम से मिलती हैं. इन पाथ को क्रम से देखा जाता है:

  • /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

डिवाइस के नाम वाले फ़ाइल पाथ को बनाते समय, डिवाइस के नाम में मौजूद सभी वर्णों को '_' से बदल दिया जाता है. हालांकि, '0' से '9', 'a' से 'z', 'A' से 'Z', '-' या '_' को बदला नहीं जाता.

सामान्य कुंजी लेआउट फ़ाइल

सिस्टम में पहले से एक खास, सामान्य कुंजी लेआउट फ़ाइल मौजूद होती है, जिसे Generic.kl कहा जाता है. इस की लेआउट का मकसद, अलग-अलग तरह के स्टैंडर्ड बाहरी कीबोर्ड और जॉयस्टिक के साथ काम करना है. सामान्य बटन के लेआउट में बदलाव न करें!

वाक्य-विन्यास

की लेआउट फ़ाइल एक सादा टेक्स्ट फ़ाइल होती है. इसमें कुंजी या अक्ष के एलान और फ़्लैग शामिल होते हैं.

मुख्य एलान

कुंजी के एलान में, कीवर्ड key के बाद Linux कीवर्ड कोड नंबर और Android कीवर्ड कोड का नाम होता है. इसके अलावा, कीवर्ड के इस्तेमाल के बाद, HID के इस्तेमाल और Android कीवर्ड कोड का नाम भी हो सकता है. एचआईडी के इस्तेमाल की जानकारी को 32-बिट पूर्णांक के तौर पर दिखाया जाता है. इसमें, 16 बिट के ऊपरी हिस्से में एचआईडी के इस्तेमाल की जानकारी वाला पेज और 16 बिट के निचले हिस्से में एचआईडी के इस्तेमाल का आईडी होता है. दोनों में से किसी भी एलान के बाद, व्हाइटस्पेस से अलग किए गए नीति फ़्लैग का वैकल्पिक सेट दिया जा सकता है.

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

नीति के उल्लंघन की वजह से, इन फ़्लैग का इस्तेमाल किया जाता है:

  • FUNCTION: बटन को इस तरह समझा जाना चाहिए जैसे कि फ़ंक्शन बटन भी दबाया गया हो.
  • GESTURE: उपयोगकर्ता के जेस्चर से जनरेट की गई कुंजी. जैसे, टचस्क्रीन पर हाथ रखना.
  • VIRTUAL: यह मुख्य टच स्क्रीन के बगल में मौजूद वर्चुअल सॉफ़्ट बटन (कैपेसिटिव बटन) है. इस वजह से, डिबाउन्स करने का खास लॉजिक चालू हो जाता है (नीचे देखें).

ऐक्सिस के एलान

ऐक्सिस डिक्लेरेशन में, कीवर्ड axis के बाद, Linux ऐक्सिस कोड नंबर और ऐसे क्वालिफ़ायर होते हैं जो ऐक्सिस के व्यवहार को कंट्रोल करते हैं. इनमें कम से कम एक Android ऐक्सिस कोड का नाम शामिल होता है.

बुनियादी ऐक्सिस

बुनियादी ऐक्सिस, Linux ऐक्सिस कोड को Android ऐक्सिस कोड के नाम से मैप करता है. यहां दिए गए एलान में, ABS_X (0x00 से दिखाया गया) को AXIS_X (X से दिखाया गया) से मैप किया गया है.

axis 0x00 X

ऊपर दिए गए उदाहरण में, अगर ABS_X की वैल्यू 5 है, तो AXIS_X को 5 पर सेट किया जाता है.

ऐक्सिस को अलग-अलग करना

स्प्लिट ऐक्सिस, Linux ऐक्सिस कोड को Android ऐक्सिस कोड के दो नामों से मैप करता है. ऐसा करने पर, थ्रेशोल्ड से कम या ज़्यादा वैल्यू को मैप करने पर, दो अलग-अलग ऐक्सिस में बांटा जाता है. यह मैपिंग तब काम की होती है, जब डिवाइस से रिपोर्ट किए गए एक फ़िज़िकल ऐक्सिस में, एक-दूसरे से अलग दो लॉजिकल ऐक्सिस कोड किए जाते हैं.

नीचे दिया गया एलान, ABS_Y ऐक्सिस की वैल्यू को AXIS_GAS पर मैप करता है. ऐसा तब होता है, जब वैल्यू 0x7f से कम हो. वहीं, अगर वैल्यू 0x7f से ज़्यादा हो, तो उसे AXIS_BRAKE पर मैप किया जाता है. ABS_Y ऐक्सिस की वैल्यू को 0x01 से दिखाया जाता है.

axis 0x01 split 0x7f GAS BRAKE

ऊपर दिए गए उदाहरण में, अगर ABS_Y की वैल्यू 0x7d है, तो AXIS_GAS को 2 (0x7f - 0x7d) पर सेट किया जाता है और AXIS_BRAKE को 0 पर सेट किया जाता है. इसके उलट, अगर ABS_Y की वैल्यू 0x83 है, तो AXIS_GAS को 0 पर और AXIS_BRAKE को 4 (0x83 - 0x7f) पर सेट किया जाता है. आखिर में, अगर ABS_Y की वैल्यू 0x7f की स्प्लिट वैल्यू के बराबर है, तो AXIS_GAS और AXIS_BRAKE, दोनों को 0 पर सेट किया जाता है.

ऐक्सिस को उलटा करना

इनवर्ट किए गए ऐक्सिस से, ऐक्सिस की वैल्यू का साइन बदल जाता है. यहां दिया गया एलान, ABS_RZ (0x05 से दिखाया गया) को AXIS_BRAKE (BRAKE से दिखाया गया) पर मैप करता है. साथ ही, नतीजे को नेगेटिव करके उसे उलट देता है.

axis 0x05 invert BRAKE

ऊपर दिए गए उदाहरण में, अगर ABS_RZ की वैल्यू 2 है, तो AXIS_BRAKE को -2 पर सेट किया जाता है.

फ़्लैट को बीच में रखने का विकल्प

गड़बड़ी की वजह से, जॉयस्टिक डिवाइस तब भी इनपुट इवेंट की रिपोर्ट कर सकता है, जब जॉयस्टिक का इस्तेमाल न किया जा रहा हो. आम तौर पर, यह गड़बड़ी बाईं और/या दाईं स्टिक से होती है. इसकी वजह से, ड्राइवर को पोज़िशन की वैल्यू 0 के आस-पास दिखती है. "सेंटर फ़्लैट" वैल्यू से पता चलता है कि कंट्रोलर के बंद होने पर, उसमें कितनी ग़ैर-ज़रूरी आवाज़ आ सकती है.

Linux इनपुट प्रोटोकॉल, इनपुट डिवाइस ड्राइवर को जॉयस्टिक ऐक्सिस की सेंटर फ़्लैट वैल्यू तय करने का तरीका उपलब्ध कराता है. हालांकि, सभी ड्राइवर इसकी रिपोर्ट नहीं करते और कुछ ड्राइवर गलत वैल्यू देते हैं. इस समस्या को हल करने के लिए, ऐक्सिस के एलान के बाद flat विकल्प दिया जा सकता है. यह विकल्प, ऐक्सिस की सेंटर पोज़िशन के आस-पास के इलाके की चौड़ाई बताता है. इसे सेंटर के तौर पर माना जाना चाहिए.

उदाहरण के लिए, अगर कोई डिवाइस ड्राइवर AXIS_X के लिए 0 से 100 के बीच की वैल्यू रिपोर्ट करता है, तो Android इनपुट सिस्टम, 0 को -1 पर और 100 को 1 पर मैप करेगा. स्केल न किए गए निर्देशांक में रेंज का सेंटर 50 होगा और स्केल किए गए निर्देशांक में 0 होगा. अगर फ़्लैट वैल्यू 10 है, तो डेवलपर को यह मान लेना चाहिए कि -0.1 से 0.1 के बीच (स्केल न किए गए निर्देशांक में 40 से 60 के बीच) बताई गई कोई भी AXIS_X वैल्यू गड़बड़ी है. साथ ही, जॉयस्टिक से मिलने वाली वैल्यू को शून्य मानना चाहिए.

ध्यान दें: मुख्य लेआउट फ़ाइल में ड्राइवर कोऑर्डिनेट स्पेस के लिए वैल्यू दी जाती है, जबकि android.view.InputDevice.MotionRange#getFlat() की दी गई वैल्यू, Android कोऑर्डिनेट स्पेस में होती है.

axis 0x03 Z flat 4096

ऊपर दिए गए उदाहरण में, सेंटर फ़्लैट वैल्यू को 4096 पर सेट किया गया है.

टिप्पणियां

टिप्पणी वाली लाइनें # से शुरू होती हैं और लाइन के आखिर तक चलती हैं:

# A comment!

खाली लाइनों को अनदेखा किया जाता है.

उदाहरण

कीबोर्ड

# 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...

सिस्टम से जुड़े कंट्रोल

# 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

कैपेसिटिव बटन

# 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

हेडसेट जैक से मीडिया कंट्रोल करना

# 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

जॉयस्टिक

# 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

वर्चुअल सॉफ़्ट बटन

इनपुट सिस्टम, वर्चुअल सॉफ़्ट बटन को लागू करने के लिए खास सुविधाएं देता है. इन सुविधाओं का इस्तेमाल इन मामलों में किया जा सकता है:

  1. अगर वर्चुअल सॉफ़्ट बटन, स्क्रीन पर ग्राफ़िक के तौर पर दिखाए जाते हैं (जैसे कि Galaxy Nexus पर), तो उन्हें सिस्टम यूज़र इंटरफ़ेस (यूआई) पैकेज में नेविगेशन बार कॉम्पोनेंट से लागू किया जाता है. ग्राफ़िकल वर्चुअल सॉफ़्ट बटन, सिस्टम में सबसे ऊपर लेयर पर लागू किए जाते हैं. इसलिए, इनमें की लेआउट फ़ाइलें शामिल नहीं होती हैं और यहां दी गई जानकारी लागू नहीं होती.
  2. अगर वर्चुअल सॉफ़्ट बटन, मुख्य टच स्क्रीन (जैसे, Nexus One) का हिस्सा होने वाले बड़े टच किए जा सकने वाले हिस्से के तौर पर लागू किए जाते हैं, तो इनपुट सिस्टम, X/Y टच निर्देशांक को Linux कीबोर्ड कोड में बदलने के लिए वर्चुअल की मैप फ़ाइल का इस्तेमाल करता है. इसके बाद, Linux कीबोर्ड कोड को Android कीबोर्ड कोड में बदलने के लिए, कीबोर्ड लेआउट फ़ाइल का इस्तेमाल करता है. वर्चुअल की मैप फ़ाइलों के बारे में ज़्यादा जानने के लिए, टच डिवाइस देखें. टच स्क्रीन इनपुट डिवाइस के लिए, की लेआउट फ़ाइल में सही की मैपिंग की जानकारी होनी चाहिए. साथ ही, इसमें हर बटन के लिए VIRTUAL फ़्लैग शामिल होना चाहिए.
  3. अगर वर्चुअल सॉफ़्ट बटन, मुख्य टच स्क्रीन (जैसे कि Nexus S पर) से अलग कैपेसिटिव बटन के तौर पर लागू किए जाते हैं, तो टच को Linux की-कोड में बदलने की ज़िम्मेदारी, कर्नेल डिवाइस ड्राइवर या फ़र्मवेयर की होती है. इसके बाद, इनपुट सिस्टम, की लेआउट फ़ाइल का इस्तेमाल करके, इन की-कोड को Android की-कोड में बदल देता है. कैपेसिटिव बटन इनपुट डिवाइस के लिए, बटन लेआउट फ़ाइल में सही बटन मैपिंग की जानकारी होनी चाहिए. साथ ही, इसमें हर बटन के लिए VIRTUAL फ़्लैग शामिल होना चाहिए.

जब वर्चुअल सॉफ़्ट बटन, टच स्क्रीन के अंदर या उसके आस-पास होते हैं, तो उपयोगकर्ताओं को स्क्रीन के सबसे नीचे या स्क्रीन पर ऊपर से नीचे या नीचे से ऊपर की ओर उंगली स्लाइड करते समय, गलती से बटन दबाने की संभावना बढ़ जाती है. इस समस्या से बचने के लिए, इनपुट सिस्टम थोड़ा डेबाउंस लागू करता है. इससे टच स्क्रीन पर हाल ही में किए गए टच के बाद, वर्चुअल सॉफ़्ट बटन को कुछ समय के लिए अनदेखा कर दिया जाता है. इस देरी को वर्चुअल बटन के शांत रहने का समय कहा जाता है.

वर्चुअल सॉफ़्ट बटन की डेबाउंसिंग की सुविधा चालू करने के लिए:

  1. टच स्क्रीन या कैपेसिटिव बटन वाले इनपुट डिवाइस के लिए, हर बटन के लिए VIRTUAL फ़्लैग सेट की गई एक बटन लेआउट फ़ाइल दें.
    key 139    MENU           VIRTUAL
    key 172    HOME           VIRTUAL
    key 158    BACK           VIRTUAL
    key 217    SEARCH         VIRTUAL
    
  2. फ़्रेमवर्क config.xml रिसॉर्स के लिए, रिसॉर्स ओवरले में वर्चुअल बटन के 'शांत समय' की वैल्यू सेट करें.
    <!-- 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>
    

पुष्टि करें

आपको कीमैप की पुष्टि करें टूल का इस्तेमाल करके, अपनी मुख्य लेआउट फ़ाइलों की पुष्टि करनी चाहिए.