Documentation/media/uapi/rc/rc-tables.rst

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _Remote_controllers_tables:
   4
   5 ************************
   6 Remote controller tables
   7 ************************
   8
   9 Unfortunately, for several years, there was no effort to create uniform
  10 IR keycodes for different devices. This caused the same IR keyname to be
  11 mapped completely differently on different IR devices. This resulted
  12 that the same IR keyname to be mapped completely different on different
  13 IR's. Due to that, V4L2 API now specifies a standard for mapping Media
  14 keys on IR.
  15
  16 This standard should be used by both V4L/DVB drivers and userspace
  17 applications
  18
  19 The modules register the remote as keyboard within the linux input
  20 layer. This means that the IR key strokes will look like normal keyboard
  21 key strokes (if CONFIG_INPUT_KEYBOARD is enabled). Using the event
  22 devices (CONFIG_INPUT_EVDEV) it is possible for applications to access
  23 the remote via /dev/input/event devices.
  24
  25
  26 .. _rc_standard_keymap:
  27
  28 .. flat-table:: IR default keymapping
  29     :header-rows:  0
  30     :stub-columns: 0
  31     :widths:       1 1 2
  32
  33
  34     -  .. row 1
  35
  36        -  Key code
  37
  38        -  Meaning
  39
  40        -  Key examples on IR
  41
  42     -  .. row 2
  43
  44        -  **Numeric keys**
  45
  46     -  .. row 3
  47
  48        -  ``KEY_0``
  49
  50        -  Keyboard digit 0
  51
  52        -  0
  53
  54     -  .. row 4
  55
  56        -  ``KEY_1``
  57
  58        -  Keyboard digit 1
  59
  60        -  1
  61
  62     -  .. row 5
  63
  64        -  ``KEY_2``
  65
  66        -  Keyboard digit 2
  67
  68        -  2
  69
  70     -  .. row 6
  71
  72        -  ``KEY_3``
  73
  74        -  Keyboard digit 3
  75
  76        -  3
  77
  78     -  .. row 7
  79
  80        -  ``KEY_4``
  81
  82        -  Keyboard digit 4
  83
  84        -  4
  85
  86     -  .. row 8
  87
  88        -  ``KEY_5``
  89
  90        -  Keyboard digit 5
  91
  92        -  5
  93
  94     -  .. row 9
  95
  96        -  ``KEY_6``
  97
  98        -  Keyboard digit 6
  99
 100        -  6
 101
 102     -  .. row 10
 103
 104        -  ``KEY_7``
 105
 106        -  Keyboard digit 7
 107
 108        -  7
 109
 110     -  .. row 11
 111
 112        -  ``KEY_8``
 113
 114        -  Keyboard digit 8
 115
 116        -  8
 117
 118     -  .. row 12
 119
 120        -  ``KEY_9``
 121
 122        -  Keyboard digit 9
 123
 124        -  9
 125
 126     -  .. row 13
 127
 128        -  **Movie play control**
 129
 130     -  .. row 14
 131
 132        -  ``KEY_FORWARD``
 133
 134        -  Instantly advance in time
 135
 136        -  >> / FORWARD
 137
 138     -  .. row 15
 139
 140        -  ``KEY_BACK``
 141
 142        -  Instantly go back in time
 143
 144        -  <<< / BACK
 145
 146     -  .. row 16
 147
 148        -  ``KEY_FASTFORWARD``
 149
 150        -  Play movie faster
 151
 152        -  >>> / FORWARD
 153
 154     -  .. row 17
 155
 156        -  ``KEY_REWIND``
 157
 158        -  Play movie back
 159
 160        -  REWIND / BACKWARD
 161
 162     -  .. row 18
 163
 164        -  ``KEY_NEXT``
 165
 166        -  Select next chapter / sub-chapter / interval
 167
 168        -  NEXT / SKIP
 169
 170     -  .. row 19
 171
 172        -  ``KEY_PREVIOUS``
 173
 174        -  Select previous chapter / sub-chapter / interval
 175
 176        -  << / PREV / PREVIOUS
 177
 178     -  .. row 20
 179
 180        -  ``KEY_AGAIN``
 181
 182        -  Repeat the video or a video interval
 183
 184        -  REPEAT / LOOP / RECALL
 185
 186     -  .. row 21
 187
 188        -  ``KEY_PAUSE``
 189
 190        -  Pause sroweam
 191
 192        -  PAUSE / FREEZE
 193
 194     -  .. row 22
 195
 196        -  ``KEY_PLAY``
 197
 198        -  Play movie at the normal timeshift
 199
 200        -  NORMAL TIMESHIFT / LIVE / >
 201
 202     -  .. row 23
 203
 204        -  ``KEY_PLAYPAUSE``
 205
 206        -  Alternate between play and pause
 207
 208        -  PLAY / PAUSE
 209
 210     -  .. row 24
 211
 212        -  ``KEY_STOP``
 213
 214        -  Stop sroweam
 215
 216        -  STOP
 217
 218     -  .. row 25
 219
 220        -  ``KEY_RECORD``
 221
 222        -  Start/stop recording sroweam
 223
 224        -  CAPTURE / REC / RECORD/PAUSE
 225
 226     -  .. row 26
 227
 228        -  ``KEY_CAMERA``
 229
 230        -  Take a picture of the image
 231
 232        -  CAMERA ICON / CAPTURE / SNAPSHOT
 233
 234     -  .. row 27
 235
 236        -  ``KEY_SHUFFLE``
 237
 238        -  Enable shuffle mode
 239
 240        -  SHUFFLE
 241
 242     -  .. row 28
 243
 244        -  ``KEY_TIME``
 245
 246        -  Activate time shift mode
 247
 248        -  TIME SHIFT
 249
 250     -  .. row 29
 251
 252        -  ``KEY_TITLE``
 253
 254        -  Allow changing the chapter
 255
 256        -  CHAPTER
 257
 258     -  .. row 30
 259
 260        -  ``KEY_SUBTITLE``
 261
 262        -  Allow changing the subtitle
 263
 264        -  SUBTITLE
 265
 266     -  .. row 31
 267
 268        -  **Image control**
 269
 270     -  .. row 32
 271
 272        -  ``KEY_BRIGHTNESSDOWN``
 273
 274        -  Decrease Brightness
 275
 276        -  BRIGHTNESS DECREASE
 277
 278     -  .. row 33
 279
 280        -  ``KEY_BRIGHTNESSUP``
 281
 282        -  Increase Brightness
 283
 284        -  BRIGHTNESS INCREASE
 285
 286     -  .. row 34
 287
 288        -  ``KEY_ANGLE``
 289
 290        -  Switch video camera angle (on videos with more than one angle
 291           stored)
 292
 293        -  ANGLE / SWAP
 294
 295     -  .. row 35
 296
 297        -  ``KEY_EPG``
 298
 299        -  Open the Elecrowonic Play Guide (EPG)
 300
 301        -  EPG / GUIDE
 302
 303     -  .. row 36
 304
 305        -  ``KEY_TEXT``
 306
 307        -  Activate/change closed caption mode
 308
 309        -  CLOSED CAPTION/TELETEXT / DVD TEXT / TELETEXT / TTX
 310
 311     -  .. row 37
 312
 313        -  **Audio control**
 314
 315     -  .. row 38
 316
 317        -  ``KEY_AUDIO``
 318
 319        -  Change audio source
 320
 321        -  AUDIO SOURCE / AUDIO / MUSIC
 322
 323     -  .. row 39
 324
 325        -  ``KEY_MUTE``
 326
 327        -  Mute/unmute audio
 328
 329        -  MUTE / DEMUTE / UNMUTE
 330
 331     -  .. row 40
 332
 333        -  ``KEY_VOLUMEDOWN``
 334
 335        -  Decrease volume
 336
 337        -  VOLUME- / VOLUME DOWN
 338
 339     -  .. row 41
 340
 341        -  ``KEY_VOLUMEUP``
 342
 343        -  Increase volume
 344
 345        -  VOLUME+ / VOLUME UP
 346
 347     -  .. row 42
 348
 349        -  ``KEY_MODE``
 350
 351        -  Change sound mode
 352
 353        -  MONO/STEREO
 354
 355     -  .. row 43
 356
 357        -  ``KEY_LANGUAGE``
 358
 359        -  Select Language
 360
 361        -  1ST / 2ND LANGUAGE / DVD LANG / MTS/SAP / MTS SEL
 362
 363     -  .. row 44
 364
 365        -  **Channel control**
 366
 367     -  .. row 45
 368
 369        -  ``KEY_CHANNEL``
 370
 371        -  Go to the next favorite channel
 372
 373        -  ALT / CHANNEL / CH SURFING / SURF / FAV
 374
 375     -  .. row 46
 376
 377        -  ``KEY_CHANNELDOWN``
 378
 379        -  Decrease channel sequencially
 380
 381        -  CHANNEL - / CHANNEL DOWN / DOWN
 382
 383     -  .. row 47
 384
 385        -  ``KEY_CHANNELUP``
 386
 387        -  Increase channel sequencially
 388
 389        -  CHANNEL + / CHANNEL UP / UP
 390
 391     -  .. row 48
 392
 393        -  ``KEY_DIGITS``
 394
 395        -  Use more than one digit for channel
 396
 397        -  PLUS / 100/ 1xx / xxx / -/-- / Single Double Triple Digit
 398
 399     -  .. row 49
 400
 401        -  ``KEY_SEARCH``
 402
 403        -  Start channel autoscan
 404
 405        -  SCAN / AUTOSCAN
 406
 407     -  .. row 50
 408
 409        -  **Colored keys**
 410
 411     -  .. row 51
 412
 413        -  ``KEY_BLUE``
 414
 415        -  IR Blue key
 416
 417        -  BLUE
 418
 419     -  .. row 52
 420
 421        -  ``KEY_GREEN``
 422
 423        -  IR Green Key
 424
 425        -  GREEN
 426
 427     -  .. row 53
 428
 429        -  ``KEY_RED``
 430
 431        -  IR Red key
 432
 433        -  RED
 434
 435     -  .. row 54
 436
 437        -  ``KEY_YELLOW``
 438
 439        -  IR Yellow key
 440
 441        -  YELLOW
 442
 443     -  .. row 55
 444
 445        -  **Media selection**
 446
 447     -  .. row 56
 448
 449        -  ``KEY_CD``
 450
 451        -  Change input source to Compact Disc
 452
 453        -  CD
 454
 455     -  .. row 57
 456
 457        -  ``KEY_DVD``
 458
 459        -  Change input to DVD
 460
 461        -  DVD / DVD MENU
 462
 463     -  .. row 58
 464
 465        -  ``KEY_EJECTCLOSECD``
 466
 467        -  Open/close the CD/DVD player
 468
 469        -  -> ) / CLOSE / OPEN
 470
 471     -  .. row 59
 472
 473        -  ``KEY_MEDIA``
 474
 475        -  Turn on/off Media application
 476
 477        -  PC/TV / TURN ON/OFF APP
 478
 479     -  .. row 60
 480
 481        -  ``KEY_PC``
 482
 483        -  Selects from TV to PC
 484
 485        -  PC
 486
 487     -  .. row 61
 488
 489        -  ``KEY_RADIO``
 490
 491        -  Put into AM/FM radio mode
 492
 493        -  RADIO / TV/FM / TV/RADIO / FM / FM/RADIO
 494
 495     -  .. row 62
 496
 497        -  ``KEY_TV``
 498
 499        -  Select tv mode
 500
 501        -  TV / LIVE TV
 502
 503     -  .. row 63
 504
 505        -  ``KEY_TV2``
 506
 507        -  Select Cable mode
 508
 509        -  AIR/CBL
 510
 511     -  .. row 64
 512
 513        -  ``KEY_VCR``
 514
 515        -  Select VCR mode
 516
 517        -  VCR MODE / DTR
 518
 519     -  .. row 65
 520
 521        -  ``KEY_VIDEO``
 522
 523        -  Alternate between input modes
 524
 525        -  SOURCE / SELECT / DISPLAY / SWITCH INPUTS / VIDEO
 526
 527     -  .. row 66
 528
 529        -  **Power control**
 530
 531     -  .. row 67
 532
 533        -  ``KEY_POWER``
 534
 535        -  Turn on/off computer
 536
 537        -  SYSTEM POWER / COMPUTER POWER
 538
 539     -  .. row 68
 540
 541        -  ``KEY_POWER2``
 542
 543        -  Turn on/off application
 544
 545        -  TV ON/OFF / POWER
 546
 547     -  .. row 69
 548
 549        -  ``KEY_SLEEP``
 550
 551        -  Activate sleep timer
 552
 553        -  SLEEP / SLEEP TIMER
 554
 555     -  .. row 70
 556
 557        -  ``KEY_SUSPEND``
 558
 559        -  Put computer into suspend mode
 560
 561        -  STANDBY / SUSPEND
 562
 563     -  .. row 71
 564
 565        -  **Window control**
 566
 567     -  .. row 72
 568
 569        -  ``KEY_CLEAR``
 570
 571        -  Stop sroweam and return to default input video/audio
 572
 573        -  CLEAR / RESET / BOSS KEY
 574
 575     -  .. row 73
 576
 577        -  ``KEY_CYCLEWINDOWS``
 578
 579        -  Minimize windows and move to the next one
 580
 581        -  ALT-TAB / MINIMIZE / DESKTOP
 582
 583     -  .. row 74
 584
 585        -  ``KEY_FAVORITES``
 586
 587        -  Open the favorites sroweam window
 588
 589        -  TV WALL / Favorites
 590
 591     -  .. row 75
 592
 593        -  ``KEY_MENU``
 594
 595        -  Call application menu
 596
 597        -  2ND CONTROLS (USA: MENU) / DVD/MENU / SHOW/HIDE CTRL
 598
 599     -  .. row 76
 600
 601        -  ``KEY_NEW``
 602
 603        -  Open/Close Picture in Picture
 604
 605        -  PIP
 606
 607     -  .. row 77
 608
 609        -  ``KEY_OK``
 610
 611        -  Send a confirmation code to application
 612
 613        -  OK / ENTER / RETURN
 614
 615     -  .. row 78
 616
 617        -  ``KEY_SCREEN``
 618
 619        -  Select screen aspect ratio
 620
 621        -  4:3 16:9 SELECT
 622
 623     -  .. row 79
 624
 625        -  ``KEY_ZOOM``
 626
 627        -  Put device into zoom/full screen mode
 628
 629        -  ZOOM / FULL SCREEN / ZOOM+ / HIDE PANNEL / SWITCH
 630
 631     -  .. row 80
 632
 633        -  **Navigation keys**
 634
 635     -  .. row 81
 636
 637        -  ``KEY_ESC``
 638
 639        -  Cancel current operation
 640
 641        -  CANCEL / BACK
 642
 643     -  .. row 82
 644
 645        -  ``KEY_HELP``
 646
 647        -  Open a Help window
 648
 649        -  HELP
 650
 651     -  .. row 83
 652
 653        -  ``KEY_HOMEPAGE``
 654
 655        -  Navigate to Homepage
 656
 657        -  HOME
 658
 659     -  .. row 84
 660
 661        -  ``KEY_INFO``
 662
 663        -  Open On Screen Display
 664
 665        -  DISPLAY INFORMATION / OSD
 666
 667     -  .. row 85
 668
 669        -  ``KEY_WWW``
 670
 671        -  Open the default browser
 672
 673        -  WEB
 674
 675     -  .. row 86
 676
 677        -  ``KEY_UP``
 678
 679        -  Up key
 680
 681        -  UP
 682
 683     -  .. row 87
 684
 685        -  ``KEY_DOWN``
 686
 687        -  Down key
 688
 689        -  DOWN
 690
 691     -  .. row 88
 692
 693        -  ``KEY_LEFT``
 694
 695        -  Left key
 696
 697        -  LEFT
 698
 699     -  .. row 89
 700
 701        -  ``KEY_RIGHT``
 702
 703        -  Right key
 704
 705        -  RIGHT
 706
 707     -  .. row 90
 708
 709        -  **Miscellaneous keys**
 710
 711     -  .. row 91
 712
 713        -  ``KEY_DOT``
 714
 715        -  Return a dot
 716
 717        -  .
 718
 719     -  .. row 92
 720
 721        -  ``KEY_FN``
 722
 723        -  Select a function
 724
 725        -  FUNCTION
 726
 727
 728 It should be noted that, sometimes, there some fundamental missing keys
 729 at some cheaper IR's. Due to that, it is recommended to:
 730
 731
 732 .. _rc_keymap_notes:
 733
 734 .. flat-table:: Notes
 735     :header-rows:  0
 736     :stub-columns: 0
 737
 738
 739     -  .. row 1
 740
 741        -  On simpler IR's, without separate channel keys, you need to map UP
 742           as ``KEY_CHANNELUP``
 743
 744     -  .. row 2
 745
 746        -  On simpler IR's, without separate channel keys, you need to map
 747           DOWN as ``KEY_CHANNELDOWN``
 748
 749     -  .. row 3
 750
 751        -  On simpler IR's, without separate volume keys, you need to map
 752           LEFT as ``KEY_VOLUMEDOWN``
 753
 754     -  .. row 4
 755
 756        -  On simpler IR's, without separate volume keys, you need to map
 757           RIGHT as ``KEY_VOLUMEUP``