-
Notifications
You must be signed in to change notification settings - Fork 11
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feature: add 0x8060 Report Rate #13
base: master
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great job! And sorry for me being so annoying. We have plans to use this to generate a website, everything should be following the same structure.
- None | ||
|
||
Returns | ||
- [8bits] reportRateList |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This can be removed.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This can be removed.
- None | ||
|
||
Returns | ||
- [8bits] reportRate The current report rate in ms. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No tab here.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same comments as the function above.
- None | ||
|
||
Errors | ||
- InvalidArgument (2) Invalid reportRate, not in host mode |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Description in the next line.
Oh, I forgot. Please put the tables under a |
No description provided.