aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/input/iforce-protocol.txt
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/input/iforce-protocol.txt')
-rw-r--r--Documentation/input/iforce-protocol.txt20
1 files changed, 12 insertions, 8 deletions
diff --git a/Documentation/input/iforce-protocol.txt b/Documentation/input/iforce-protocol.txt
index 8777d2d321e3..3ac92413c874 100644
--- a/Documentation/input/iforce-protocol.txt
+++ b/Documentation/input/iforce-protocol.txt
@@ -4,10 +4,10 @@ specify force effects to I-Force 2.0 devices. None of this information comes
4from Immerse. That's why you should not trust what is written in this 4from Immerse. That's why you should not trust what is written in this
5document. This document is intended to help understanding the protocol. 5document. This document is intended to help understanding the protocol.
6This is not a reference. Comments and corrections are welcome. To contact me, 6This is not a reference. Comments and corrections are welcome. To contact me,
7send an email to: deneux@ifrance.com 7send an email to: johann.deneux@gmail.com
8 8
9** WARNING ** 9** WARNING **
10I may not be held responsible for any dammage or harm caused if you try to 10I shall not be held responsible for any damage or harm caused if you try to
11send data to your I-Force device based on what you read in this document. 11send data to your I-Force device based on what you read in this document.
12 12
13** Preliminary Notes: 13** Preliminary Notes:
@@ -151,13 +151,13 @@ OP= ff
151Query command. Length varies according to the query type. 151Query command. Length varies according to the query type.
152The general format of this packet is: 152The general format of this packet is:
153ff 01 QUERY [INDEX] CHECKSUM 153ff 01 QUERY [INDEX] CHECKSUM
154reponses are of the same form: 154responses are of the same form:
155FF LEN QUERY VALUE_QUERIED CHECKSUM2 155FF LEN QUERY VALUE_QUERIED CHECKSUM2
156where LEN = 1 + length(VALUE_QUERIED) 156where LEN = 1 + length(VALUE_QUERIED)
157 157
158**** Query ram size **** 158**** Query ram size ****
159QUERY = 42 ('B'uffer size) 159QUERY = 42 ('B'uffer size)
160The device should reply with the same packet plus two additionnal bytes 160The device should reply with the same packet plus two additional bytes
161containing the size of the memory: 161containing the size of the memory:
162ff 03 42 03 e8 CS would mean that the device has 1000 bytes of ram available. 162ff 03 42 03 e8 CS would mean that the device has 1000 bytes of ram available.
163 163
@@ -234,19 +234,23 @@ is the amount of memory apparently needed for every set of parameters:
234 234
235** Appendix: How to study the protocol ? ** 235** Appendix: How to study the protocol ? **
236 236
2371. Generate effects using the force editor provided with the DirectX SDK, or use Immersion Studio (freely available at their web site in the developer section: www.immersion.com) 2371. Generate effects using the force editor provided with the DirectX SDK, or
2382. Start a soft spying RS232 or USB (depending on where you connected your joystick/wheel). I used ComPortSpy from fCoder (alpha version!) 238use Immersion Studio (freely available at their web site in the developer section:
239www.immersion.com)
2402. Start a soft spying RS232 or USB (depending on where you connected your
241joystick/wheel). I used ComPortSpy from fCoder (alpha version!)
2393. Play the effect, and watch what happens on the spy screen. 2423. Play the effect, and watch what happens on the spy screen.
240 243
241A few words about ComPortSpy: 244A few words about ComPortSpy:
242At first glance, this soft seems, hum, well... buggy. In fact, data appear with a few seconds latency. Personnaly, I restart it every time I play an effect. 245At first glance, this software seems, hum, well... buggy. In fact, data appear with a
246few seconds latency. Personally, I restart it every time I play an effect.
243Remember it's free (as in free beer) and alpha! 247Remember it's free (as in free beer) and alpha!
244 248
245** URLS ** 249** URLS **
246Check www.immerse.com for Immersion Studio, and www.fcoder.com for ComPortSpy. 250Check www.immerse.com for Immersion Studio, and www.fcoder.com for ComPortSpy.
247 251
248** Author of this document ** 252** Author of this document **
249Johann Deneux <deneux@ifrance.com> 253Johann Deneux <johann.deneux@gmail.com>
250Home page at http://www.esil.univ-mrs.fr/~jdeneux/projects/ff/ 254Home page at http://www.esil.univ-mrs.fr/~jdeneux/projects/ff/
251 255
252Additions by Vojtech Pavlik. 256Additions by Vojtech Pavlik.