/ adafruit_hid / consumer_control_code.py
consumer_control_code.py
 1  # The MIT License (MIT)
 2  #
 3  # Copyright (c) 2018 Dan Halbert for Adafruit Industries
 4  #
 5  # Permission is hereby granted, free of charge, to any person obtaining a copy
 6  # of this software and associated documentation files (the "Software"), to deal
 7  # in the Software without restriction, including without limitation the rights
 8  # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9  # copies of the Software, and to permit persons to whom the Software is
10  # furnished to do so, subject to the following conditions:
11  #
12  # The above copyright notice and this permission notice shall be included in
13  # all copies or substantial portions of the Software.
14  #
15  # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16  # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17  # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18  # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19  # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20  # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21  # THE SOFTWARE.
22  #
23  
24  """
25  `adafruit_hid.consumer_control_code.ConsumerControlCode`
26  ========================================================
27  
28  * Author(s): Dan Halbert
29  """
30  
31  
32  class ConsumerControlCode:
33      """USB HID Consumer Control Device constants.
34  
35      This list includes a few common consumer control codes from
36      http://www.usb.org/developers/hidpage/Hut1_12v2.pdf#page=75.
37  
38      *New in CircuitPython 3.0.*
39      """
40  
41      # pylint: disable-msg=too-few-public-methods
42  
43      RECORD = 0xB2
44      """Record"""
45      FAST_FORWARD = 0xB3
46      """Fast Forward"""
47      REWIND = 0xB4
48      """Rewind"""
49      SCAN_NEXT_TRACK = 0xB5
50      """Skip to next track"""
51      SCAN_PREVIOUS_TRACK = 0xB6
52      """Go back to previous track"""
53      STOP = 0xB7
54      """Stop"""
55      EJECT = 0xB8
56      """Eject"""
57      PLAY_PAUSE = 0xCD
58      """Play/Pause toggle"""
59      MUTE = 0xE2
60      """Mute"""
61      VOLUME_DECREMENT = 0xEA
62      """Decrease volume"""
63      VOLUME_INCREMENT = 0xE9
64      """Increase volume"""