WIP FPC-III support
[linux/fpc-iii.git] / Documentation / ABI / obsolete / sysfs-driver-hid-roccat-pyra
blob66545c587a64a8335ffe2cf939943de0e47d6d43
1 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/pyra/roccatpyra<minor>/actual_cpi
2 Date:           August 2010
3 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
4 Description:    It is possible to switch the cpi setting of the mouse with the
5                 press of a button.
6                 When read, this file returns the raw number of the actual cpi
7                 setting reported by the mouse. This number has to be further
8                 processed to receive the real dpi value:
10                 ===== ====
11                 VALUE DPI
12                 ===== ====
13                 1     400
14                 2     800
15                 4     1600
16                 ===== ====
18                 This file is readonly.
19                 Has never been used. If bookkeeping is done, it's done in userland tools.
20 Users:          http://roccat.sourceforge.net
22 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/pyra/roccatpyra<minor>/actual_profile
23 Date:           August 2010
24 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
25 Description:    When read, this file returns the number of the actual profile in
26                 range 0-4.
27                 This file is readonly.
28                 Please use binary attribute "settings" which provides this information.
29 Users:          http://roccat.sourceforge.net
31 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/pyra/roccatpyra<minor>/firmware_version
32 Date:           August 2010
33 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
34 Description:    When read, this file returns the raw integer version number of the
35                 firmware reported by the mouse. Using the integer value eases
36                 further usage in other programs. To receive the real version
37                 number the decimal point has to be shifted 2 positions to the
38                 left. E.g. a returned value of 138 means 1.38
39                 This file is readonly.
40                 Please use binary attribute "info" which provides this information.
41 Users:          http://roccat.sourceforge.net
43 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/pyra/roccatpyra<minor>/info
44 Date:           November 2012
45 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
46 Description:    When read, this file returns general data like firmware version.
47                 When written, the device can be reset.
48                 The data is 6 bytes long.
49 Users:          http://roccat.sourceforge.net
51 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/pyra/roccatpyra<minor>/profile_buttons
52 Date:           August 2010
53 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
54 Description:    The mouse can store 5 profiles which can be switched by the
55                 press of a button. A profile is split in settings and buttons.
56                 profile_buttons holds information about button layout.
57                 When written, this file lets one write the respective profile
58                 buttons back to the mouse. The data has to be 19 bytes long.
59                 The mouse will reject invalid data.
60                 Which profile to write is determined by the profile number
61                 contained in the data.
62                 Before reading this file, control has to be written to select
63                 which profile to read.
64 Users:          http://roccat.sourceforge.net
66 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/pyra/roccatpyra<minor>/profile[1-5]_buttons
67 Date:           August 2010
68 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
69 Description:    The mouse can store 5 profiles which can be switched by the
70                 press of a button. A profile is split in settings and buttons.
71                 profile_buttons holds information about button layout.
72                 When read, these files return the respective profile buttons.
73                 The returned data is 19 bytes in size.
74                 This file is readonly.
75                 Write control to select profile and read profile_buttons instead.
76 Users:          http://roccat.sourceforge.net
78 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/pyra/roccatpyra<minor>/profile_settings
79 Date:           August 2010
80 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
81 Description:    The mouse can store 5 profiles which can be switched by the
82                 press of a button. A profile is split in settings and buttons.
83                 profile_settings holds information like resolution, sensitivity
84                 and light effects.
85                 When written, this file lets one write the respective profile
86                 settings back to the mouse. The data has to be 13 bytes long.
87                 The mouse will reject invalid data.
88                 Which profile to write is determined by the profile number
89                 contained in the data.
90                 Before reading this file, control has to be written to select
91                 which profile to read.
92 Users:          http://roccat.sourceforge.net
94 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/pyra/roccatpyra<minor>/profile[1-5]_settings
95 Date:           August 2010
96 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
97 Description:    The mouse can store 5 profiles which can be switched by the
98                 press of a button. A profile is split in settings and buttons.
99                 profile_settings holds information like resolution, sensitivity
100                 and light effects.
101                 When read, these files return the respective profile settings.
102                 The returned data is 13 bytes in size.
103                 This file is readonly.
104                 Write control to select profile and read profile_settings instead.
105 Users:          http://roccat.sourceforge.net
107 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/pyra/roccatpyra<minor>/settings
108 Date:           August 2010
109 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
110 Description:    When read, this file returns the settings stored in the mouse.
111                 The size of the data is 3 bytes and holds information on the
112                 startup_profile.
113                 When written, this file lets write settings back to the mouse.
114                 The data has to be 3 bytes long. The mouse will reject invalid
115                 data.
116 Users:          http://roccat.sourceforge.net
118 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/pyra/roccatpyra<minor>/startup_profile
119 Date:           August 2010
120 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
121 Description:    The integer value of this attribute ranges from 0-4.
122                 When read, this attribute returns the number of the profile
123                 that's active when the mouse is powered on.
124                 This file is readonly.
125                 Please use binary attribute "settings" which provides this information.
126 Users:          http://roccat.sourceforge.net