Skip to content

add link to Report rate page #1

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

Open
wants to merge 2 commits into
base: ReportRate
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion hidpp20/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ Feature List
- ``0x8020`` Gaming M-keys
- ``0x8030`` MacroRecord, MR Key
- ``0x8040`` Brightness control
- ``0x8060`` Adjustable Report Rate
- ``0x8060`` `Adjustable Report Rate <features/0x8060-ReportRate.rst>`_
- ``0x8070`` Color LED Effects
- ``0x8071`` RGB Effects
- ``0x8080`` Per Key Lighting
Expand Down
72 changes: 72 additions & 0 deletions hidpp20/features/0x8060-ReportRate.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
************************
Report Rate (``0x8060``)
************************

Feature to change the device report rate

.. table:: Table 1 - Functions

== ====================== =========================================================
ID Name Description
== ====================== =========================================================
0 ``GetReportRateList`` Retrieve the various report rates supported by the device
1 ``GetReportRate`` Return the current report rate in ms
2 ``SetReportRate`` Set the report rate in ms
== ====================== =========================================================


Functions
=========


``GetReportRateList``
~~~~~~~~~~~~~~~~~~~~~

Retrieve the various report rates supported by the device.
Standard report rates are 1, 2, 4 and 8ms.

Arguments
- None

Returns
- [8bits] reportRateList

+-----+-----+-----+-----+----+-----+-----+-----+
| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 |
+=====+=====+=====+=====+====+=====+=====+=====+
| 8ms | 7ms | 6ms | 5ms |4ms | 3ms | 2ms | 1ms |
+-----+-----+-----+-----+----+-----+-----+-----+

0 = rate not supported, 1 supported

Errors
- None


``GetReportRate``
~~~~~~~~~~~~~~~~~

Arguments
- None

Returns
- [8bits] reportRate The current report rate in ms.

Errors
- None


``SetReportRate``
~~~~~~~~~~~~~~~~~

This function can be called only in host mode

Parameters
- [8bits] reportRate The new report rate in ms

Returns
- None

Errors
- InvalidArgument (2) Invalid reportRate, not in host mode