Conversation
| - None | ||
|
|
||
| Returns | ||
| - [8bits] reportRateList |
There was a problem hiding this comment.
Please remove the [8bits] and add the byte number to the table instead, this shows where the data is. Also, use we are currently using Return instead of Returns.
+-------------+-----------------------------------------------+
| byte | 0 |
+-------------+-----+-----+-----+-----+-----+-----+-----+-----+
| bit | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 |
+=============+=====+=====+=====+=====+=====+=====+=====+=====+
| | 8ms | 7ms | 6ms | 5ms | 4ms | 3ms | 2ms | 1ms |
| description +-----+-----+-----+-----+-----+-----+-----+-----+
| | reportRateList |
+-------------+-----------------------------------------------+Btw, you can use something like https://www.tablesgenerator.com/text_tables to easily create tables. if you do this, just don't forget to change the main separator line to = instead of -.
|
|
||
| Arguments | ||
| - None |
There was a problem hiding this comment.
There is no place else that says what the arguments are, now that this information is removed from the initial section, so I think that this should stay.
|
|
||
| Errors | ||
| - None |
| - None | ||
|
|
||
| Returns | ||
| - [8bits] reportRate The current report rate in ms. |
There was a problem hiding this comment.
Similarly, please remove the [8bits]. And put the description in the next line.
Please add a table, this shows in which byte the data is.
+-------------+------------+
| byte | 0 |
+=============+============+
| description | reportRate |
+-------------+------------+| Retrieve the various report rates supported by the device. | ||
| Standard report rates are 1, 2, 4 and 8ms. |
| This function can be called only in host mode | ||
|
|
||
| Parameters | ||
| - [8bits] reportRate The new report rate in ms | ||
|
|
||
| Returns | ||
| - None |
There was a problem hiding this comment.
Same comments as the function above.
| - None | ||
|
|
||
| Errors | ||
| - InvalidArgument (2) Invalid reportRate, not in host mode |
There was a problem hiding this comment.
Description in the next line.
|
Oh, I forgot. Please put the tables under a |
2 participants
No description provided.