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