<commit_before>Remote configuration file checklist.
====================================

MUST:

    - Device must not be present in http://lirc.sourceforge.net/remotes/

    - All data supplied?

          + Kernel revision (uname -r)

          + irrecord --driver and --device option used.

          + Name of remote device, the thing you hold in your hand.

          + Does remote device has a bundled capture device e. g., a usb
            dongle?

          + For bundled USB capture  devices: usb vendor id, product id and
            device string (using dmesg or lsusb).

          + Type of device controlled (TV, VCR, Audio, DVD, Satellite, Cable,
            PVR, HTPC, ...)

          + Device(s) controlled.

          + Remote layout (ascii art showing symbol for each button).

    - Config file should use proper name symbols from namespace where
      applicable (use generate-lircrc -sc to check status).

    - Files with raw data should if possible be converted using
      irrecord -a

    - The toggle_bit_mask should be non-zero if RC5, RC6 or RCMM is in flags.
      If not try with the default values:
          + 0x800 for RC5 protocol.
          + 0x8000 or 0x10000 for RC6 and RCMM protocol.


SHOULD:

    - Is there any known kernel configuration e. g., blacklisted kernel
      modules or specific kernel drivers?

    - URL with device information.

    - Photo of remote (scale to ~100 kb).

    - Ascii art or a sketch of device showing key symbol for each button.



NOTES:

    Key symbols
    -----------
       + Use key symbols from namespace when there's a reasonable alternative.
       + When using non-standard symbols, do *not* use the KEY_ prefix. A
         symbol prefixed with KEY_ is supposed to be a standard symbol.
       + For mouse clicks use BTN_LEFT, BTN_RIGHT
       + For mouse movements use MOUSE_N, MOUSE_S, MOUSE_NW, MOUSE_SE, etc.
       + KEY_RED..KEY_BLUE is preferred to KEY_A..KEY_D.

    generate-lircrc -sc scans file for "bad" symbols. generate-lircrc -uc can
    update many ad-hoc symbols using heuristics - results must be checked!
<commit_msg>contrib: remotes-checklist update.<commit_after>Remote configuration file checklist.
====================================

MUST:

    - Device must not be present in http://lirc.sourceforge.net/remotes/

    - All data supplied?

          + Kernel revision (uname -r)

          + irrecord --driver and --device option used.

          + Name of remote device, the thing you hold in your hand.

          + Does remote device has a bundled capture device e. g., a usb
            dongle?

          + For bundled USB capture  devices: usb vendor id, product id and
            device string (using dmesg or lsusb).

          + Type of device controlled (TV, VCR, Audio, DVD, Satellite, Cable,
            PVR, HTPC, ...)

          + Device(s) controlled.

          + Remote layout (ascii art showing symbol for each button).

    - Config file should use proper name symbols from namespace where
      applicable (use generate-lircrc -sc to check status).

    - Files with raw data should if possible be converted using
      irrecord -a

    - The toggle_bit_mask should be non-zero if RC5, RC6 or RCMM is in flags.
      If not try with the default values:
          + 0x800 for RC5 protocol.
          + 0x8000 or 0x10000 for RC6 and RCMM protocol.


SHOULD:

    - Is there any known kernel configuration e. g., blacklisted kernel
      modules or specific kernel drivers?

    - URL with remote device information.

    - Photo of remote (scale to ~100 kb).



NOTES:

    Key symbols
    -----------
       + Use key symbols from namespace when there's a reasonable alternative.
       + When using non-standard symbols, do *not* use the KEY_ prefix. A
         symbol prefixed with KEY_ is supposed to be a standard symbol.
       + For mouse clicks use BTN_LEFT, BTN_RIGHT
       + For mouse movements use MOUSE_N, MOUSE_S, MOUSE_NW, MOUSE_SE, etc.
       + KEY_RED..KEY_BLUE is preferred to KEY_A..KEY_D.

    generate-lircrc -sc scans file for "bad" symbols. generate-lircrc -uc can
    update many ad-hoc symbols using heuristics - results must be checked!

    Remote sketch
    -------------

    Can be done like this:


    # +---------------------------------+
    # |                                 |
    # |  VIDEO   AUDIO   MUTE   (POWER) |
    # |                                 |
    # |  LNB     RADIO   MONO/   EXT    |
    # |                   ST            |
    # | (  1  ) (  2  ) (  3  )  STATUS |
    # |                                 |
    # | (  4  ) (  5  ) (  6  )  STORE  |
    # |                                 |
    # | (  7  ) (  8  ) (  9  )  RECALL |
    # |                                 |
    # |         (  0  ) (+100 )  LIST   |
    # |                                 |
    # |  SLEEP   AFC     1_UP    10_UP  |
    # |                                 |
    # |  TIMER   HEAD    1_DN    10_DN  |
    # |          PHONE                  |
    # |                                 |
    # +---------------------------------+

    Or this:

    #    ---------------------------------
    #   / X                               \  POWER
    #   |                                 |
    #   | X                            X  |  BACK, MENU
    #   |                                 |
    #   |                X                |  UP
    #   |                                 |
    #   |         X      X     X          |  LEFT, OK, RIGHT
    #   |                                 |
    #   |                X                |  DOWN
    #   |                                 |
    #   | X                            X  |  SEARCH, Fullscreen
    #   |                                 |
    #   |        X   X   X   X   X        |  ORANGE, YELLOW, GREEN, BLUE, Purple
    #   |                                 |
    #   |                X                |  HOME
    #   \                                 /
    #    ---------------------------------


    Examples made according to new standards:
    -----------------------------------------

        - http://lirc.sourceforge.net/remotes/samsung/AA59-00600A.conf
{'fraction_non_alphanumeric': 0.11247774720828613, 'fraction_numerical': 0.011328693963424502, 'mean_word_length': 1.2079314040728832, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 31, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2948554', 'n_tokens_mistral': 1769, 'n_tokens_neox': 1618, 'n_words': 601}