Documentation/ABI/testing/sysfs-driver-hid-roccat-kone

   1 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/kone/roccatkone<minor>/actual_dpi
   2 Date:           March 2010
   3 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
   4 Description:    It is possible to switch the dpi setting of the mouse with the
   5                 press of a button.
   6                 When read, this file returns the raw number of the actual dpi
   7                 setting reported by the mouse. This number has to be further
   8                 processed to receive the real dpi value.
   9
  10                 VALUE DPI
  11                 1     800
  12                 2     1200
  13                 3     1600
  14                 4     2000
  15                 5     2400
  16                 6     3200
  17
  18                 This file is readonly.
  19
  20 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/kone/roccatkone<minor>/actual_profile
  21 Date:           March 2010
  22 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
  23 Description:    When read, this file returns the number of the actual profile.
  24                 This file is readonly.
  25
  26 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/kone/roccatkone<minor>/firmware_version
  27 Date:           March 2010
  28 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
  29 Description:    When read, this file returns the raw integer version number of the
  30                 firmware reported by the mouse. Using the integer value eases
  31                 further usage in other programs. To receive the real version
  32                 number the decimal point has to be shifted 2 positions to the
  33                 left. E.g. a returned value of 138 means 1.38
  34                 This file is readonly.
  35
  36 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/kone/roccatkone<minor>/profile[1-5]
  37 Date:           March 2010
  38 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
  39 Description:    The mouse can store 5 profiles which can be switched by the
  40                 press of a button. A profile holds informations like button
  41                 mappings, sensitivity, the colors of the 5 leds and light
  42                 effects.
  43                 When read, these files return the respective profile. The
  44                 returned data is 975 bytes in size.
  45                 When written, this file lets one write the respective profile
  46                 data back to the mouse. The data has to be 975 bytes long.
  47                 The mouse will reject invalid data, whereas the profile number
  48                 stored in the profile doesn't need to fit the number of the
  49                 store.
  50
  51 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/kone/roccatkone<minor>/settings
  52 Date:           March 2010
  53 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
  54 Description:    When read, this file returns the settings stored in the mouse.
  55                 The size of the data is 36 bytes and holds information like the
  56                 startup_profile, tcu state and calibration_data.
  57                 When written, this file lets write settings back to the mouse.
  58                 The data has to be 36 bytes long. The mouse will reject invalid
  59                 data.
  60
  61 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/kone/roccatkone<minor>/startup_profile
  62 Date:           March 2010
  63 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
  64 Description:    The integer value of this attribute ranges from 1 to 5.
  65                 When read, this attribute returns the number of the profile
  66                 that's active when the mouse is powered on.
  67                 When written, this file sets the number of the startup profile
  68                 and the mouse activates this profile immediately.
  69
  70 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/kone/roccatkone<minor>/tcu
  71 Date:           March 2010
  72 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
  73 Description:    The mouse has a "Tracking Control Unit" which lets the user
  74                 calibrate the laser power to fit the mousepad surface.
  75                 When read, this file returns the current state of the TCU,
  76                 where 0 means off and 1 means on.
  77                 Writing 0 in this file will switch the TCU off.
  78                 Writing 1 in this file will start the calibration which takes
  79                 around 6 seconds to complete and activates the TCU.
  80
  81 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/kone/roccatkone<minor>/weight
  82 Date:           March 2010
  83 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
  84 Description:    The mouse can be equipped with one of four supplied weights
  85                 ranging from 5 to 20 grams which are recognized by the mouse
  86                 and its value can be read out. When read, this file returns the
  87                 raw value returned by the mouse which eases further processing
  88                 in other software.
  89                 The values map to the weights as follows:
  90
  91                 VALUE WEIGHT
  92                 0     none
  93                 1     5g
  94                 2     10g
  95                 3     15g
  96                 4     20g
  97
  98                 This file is readonly.