xref: /linux/Documentation/ABI/obsolete/sysfs-driver-hid-roccat-pyra (revision cdd38c5f1ce4398ec58fec95904b75824daab7b5)
1What:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/pyra/roccatpyra<minor>/actual_cpi
2Date:		August 2010
3Contact:	Stefan Achatz <erazor_de@users.sourceforge.net>
4Description:	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:
9
10		===== ====
11		VALUE DPI
12		===== ====
13		1     400
14		2     800
15		4     1600
16		===== ====
17
18		This file is readonly.
19		Has never been used. If bookkeeping is done, it's done in userland tools.
20Users:		http://roccat.sourceforge.net
21
22What:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/pyra/roccatpyra<minor>/actual_profile
23Date:		August 2010
24Contact:	Stefan Achatz <erazor_de@users.sourceforge.net>
25Description:	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.
29Users:		http://roccat.sourceforge.net
30
31What:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/pyra/roccatpyra<minor>/firmware_version
32Date:		August 2010
33Contact:	Stefan Achatz <erazor_de@users.sourceforge.net>
34Description:	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.
41Users:		http://roccat.sourceforge.net
42
43What:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/pyra/roccatpyra<minor>/info
44Date:		November 2012
45Contact:	Stefan Achatz <erazor_de@users.sourceforge.net>
46Description:	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.
49Users:		http://roccat.sourceforge.net
50
51What:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/pyra/roccatpyra<minor>/profile_buttons
52Date:		August 2010
53Contact:	Stefan Achatz <erazor_de@users.sourceforge.net>
54Description:	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.
64Users:		http://roccat.sourceforge.net
65
66What:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/pyra/roccatpyra<minor>/profile[1-5]_buttons
67Date:		August 2010
68Contact:	Stefan Achatz <erazor_de@users.sourceforge.net>
69Description:	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.
76Users:		http://roccat.sourceforge.net
77
78What:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/pyra/roccatpyra<minor>/profile_settings
79Date:		August 2010
80Contact:	Stefan Achatz <erazor_de@users.sourceforge.net>
81Description:	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.
92Users:		http://roccat.sourceforge.net
93
94What:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/pyra/roccatpyra<minor>/profile[1-5]_settings
95Date:		August 2010
96Contact:	Stefan Achatz <erazor_de@users.sourceforge.net>
97Description:	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.
105Users:		http://roccat.sourceforge.net
106
107What:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/pyra/roccatpyra<minor>/settings
108Date:		August 2010
109Contact:	Stefan Achatz <erazor_de@users.sourceforge.net>
110Description:	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.
116Users:		http://roccat.sourceforge.net
117
118What:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/pyra/roccatpyra<minor>/startup_profile
119Date:		August 2010
120Contact:	Stefan Achatz <erazor_de@users.sourceforge.net>
121Description:	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.
126Users:		http://roccat.sourceforge.net
127