xref: /linux/Documentation/ABI/obsolete/sysfs-driver-hid-roccat-ryos (revision 71e2f4dd5a65bd8dbca0b77661e75eea471168f8)
1What:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/ryos/roccatryos<minor>/control
2Date:		October 2013
3Contact:	Stefan Achatz <erazor_de@users.sourceforge.net>
4Description:	When written, this file lets one select which data from which
5		profile will be	read next. The data has to be 3 bytes long.
6		This file is writeonly.
7Users:		http://roccat.sourceforge.net
8
9What:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/ryos/roccatryos<minor>/profile
10Date:		October 2013
11Contact:	Stefan Achatz <erazor_de@users.sourceforge.net>
12Description:	The mouse can store 5 profiles which can be switched by the
13		press of a button. profile holds index of actual profile.
14		This value is persistent, so its value determines the profile
15		that's active when the device is powered on next time.
16		When written, the device activates the set profile immediately.
17		The data has to be 3 bytes long.
18		The device will reject invalid data.
19Users:		http://roccat.sourceforge.net
20
21What:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/ryos/roccatryos<minor>/keys_primary
22Date:		October 2013
23Contact:	Stefan Achatz <erazor_de@users.sourceforge.net>
24Description:	When written, this file lets one set the default of all keys for
25		a specific profile. Profile index is included in written data.
26		The data has to be 125 bytes long.
27		Before reading this file, control has to be written to select
28		which profile to read.
29Users:		http://roccat.sourceforge.net
30
31What:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/ryos/roccatryos<minor>/keys_function
32Date:		October 2013
33Contact:	Stefan Achatz <erazor_de@users.sourceforge.net>
34Description:	When written, this file lets one set the function of the
35		function keys for a specific profile. Profile index is included
36		in written data. The data has to be 95 bytes long.
37		Before reading this file, control has to be written to select
38		which profile to read.
39Users:		http://roccat.sourceforge.net
40
41What:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/ryos/roccatryos<minor>/keys_macro
42Date:		October 2013
43Contact:	Stefan Achatz <erazor_de@users.sourceforge.net>
44Description:	When written, this file lets one set the function of the macro
45		keys for a specific profile. Profile index is included in
46		written data. The data has to be 35 bytes long.
47		Before reading this file, control has to be written to select
48		which profile to read.
49Users:		http://roccat.sourceforge.net
50
51What:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/ryos/roccatryos<minor>/keys_thumbster
52Date:		October 2013
53Contact:	Stefan Achatz <erazor_de@users.sourceforge.net>
54Description:	When written, this file lets one set the function of the
55		thumbster keys for a specific profile. Profile index is included
56		in written data. The data has to be 23 bytes long.
57		Before reading this file, control has to be written to select
58		which profile to read.
59Users:		http://roccat.sourceforge.net
60
61What:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/ryos/roccatryos<minor>/keys_extra
62Date:		October 2013
63Contact:	Stefan Achatz <erazor_de@users.sourceforge.net>
64Description:	When written, this file lets one set the function of the
65		capslock and function keys for a specific profile. Profile index
66		is included in written data. The data has to be 8 bytes long.
67		Before reading this file, control has to be written to select
68		which profile to read.
69Users:		http://roccat.sourceforge.net
70
71What:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/ryos/roccatryos<minor>/keys_easyzone
72Date:		October 2013
73Contact:	Stefan Achatz <erazor_de@users.sourceforge.net>
74Description:	When written, this file lets one set the function of the
75		easyzone keys for a specific profile. Profile index is included
76		in written data. The data has to be 294 bytes long.
77		Before reading this file, control has to be written to select
78		which profile to read.
79Users:		http://roccat.sourceforge.net
80
81What:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/ryos/roccatryos<minor>/key_mask
82Date:		October 2013
83Contact:	Stefan Achatz <erazor_de@users.sourceforge.net>
84Description:	When written, this file lets one deactivate certain keys like
85		windows and application keys, to prevent accidental presses.
86		Profile index for which this settings occur is included in
87		written data. The data has to be 6 bytes long.
88		Before reading this file, control has to be written to select
89		which profile to read.
90Users:		http://roccat.sourceforge.net
91
92What:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/ryos/roccatryos<minor>/light
93Date:		October 2013
94Contact:	Stefan Achatz <erazor_de@users.sourceforge.net>
95Description:	When written, this file lets one set the backlight intensity for
96		a specific profile. Profile index is included in written data.
97		This attribute is only valid for the glow and pro variant.
98		The data has to be 16 bytes long.
99		Before reading this file, control has to be written to select
100		which profile to read.
101Users:		http://roccat.sourceforge.net
102
103What:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/ryos/roccatryos<minor>/macro
104Date:		October 2013
105Contact:	Stefan Achatz <erazor_de@users.sourceforge.net>
106Description:	When written, this file lets one store macros with max 480
107		keystrokes for a specific button for a specific profile.
108		Button and profile indexes are included in written data.
109		The data has to be 2002 bytes long.
110		Before reading this file, control has to be written to select
111		which profile and key to read.
112Users:		http://roccat.sourceforge.net
113
114What:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/ryos/roccatryos<minor>/info
115Date:		October 2013
116Contact:	Stefan Achatz <erazor_de@users.sourceforge.net>
117Description:	When read, this file returns general data like firmware version.
118		The data is 8 bytes long.
119		This file is readonly.
120Users:		http://roccat.sourceforge.net
121
122What:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/ryos/roccatryos<minor>/reset
123Date:		October 2013
124Contact:	Stefan Achatz <erazor_de@users.sourceforge.net>
125Description:	When written, this file lets one reset the device.
126		The data has to be 3 bytes long.
127		This file is writeonly.
128Users:		http://roccat.sourceforge.net
129
130What:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/ryos/roccatryos<minor>/talk
131Date:		October 2013
132Contact:	Stefan Achatz <erazor_de@users.sourceforge.net>
133Description:	When written, this file lets one trigger easyshift functionality
134		from the host.
135		The data has to be 16 bytes long.
136		This file is writeonly.
137Users:		http://roccat.sourceforge.net
138
139What:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/ryos/roccatryos<minor>/light_control
140Date:		October 2013
141Contact:	Stefan Achatz <erazor_de@users.sourceforge.net>
142Description:	When written, this file lets one switch between stored and custom
143		light settings.
144		This attribute is only valid for the pro variant.
145		The data has to be 8 bytes long.
146		This file is writeonly.
147Users:		http://roccat.sourceforge.net
148
149What:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/ryos/roccatryos<minor>/stored_lights
150Date:		October 2013
151Contact:	Stefan Achatz <erazor_de@users.sourceforge.net>
152Description:	When written, this file lets one set per-key lighting for different
153		layers.
154		This attribute is only valid for the pro variant.
155		The data has to be 1382 bytes long.
156		Before reading this file, control has to be written to select
157		which profile to read.
158Users:		http://roccat.sourceforge.net
159
160What:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/ryos/roccatryos<minor>/custom_lights
161Date:		October 2013
162Contact:	Stefan Achatz <erazor_de@users.sourceforge.net>
163Description:	When written, this file lets one set the actual per-key lighting.
164		This attribute is only valid for the pro variant.
165		The data has to be 20 bytes long.
166		This file is writeonly.
167Users:		http://roccat.sourceforge.net
168
169What:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/ryos/roccatryos<minor>/light_macro
170Date:		October 2013
171Contact:	Stefan Achatz <erazor_de@users.sourceforge.net>
172Description:	When written, this file lets one set a light macro that is looped
173		whenever the device gets in dimness mode.
174		This attribute is only valid for the pro variant.
175		The data has to be 2002 bytes long.
176		Before reading this file, control has to be written to select
177		which profile to read.
178Users:		http://roccat.sourceforge.net
179