Skip to content
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.

Sign up for GitHub

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 0x4521 DisableKeys #12

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

feature: add 0x4521 DisableKeys #12

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0338587
feature: add 0x4521 DisableKeys
pfps Jun 18, 2020
55977ab
feature: update 0x4521 DisableKeys to match form of 0x0000
pfps Jun 18, 2020
9bd729e
feature: fix formatting in 0x4521 DisableKeys
pfps Jun 20, 2020
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
99 changes: 99 additions & 0 deletions hidpp20/features/0x4521-DisableKeys_2.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
*********************
0x4521 - Disable Keys
*********************
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please adjust the decorators size.


Interface
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This can be removed.


[0x4521] DisableKeys
====================

disableableKeys = [0]GetCapabilities()

disabledKeys = [1]GetDisabledKeys()

disabledKeys = [2]SetDisabledKeys(keysToDisable)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Replace this with a function table, you can copy it fro IRoot:

.. table:: Table 1 - Functions

    == ====================== =======================================================
    ID          Name                               Description
    == ====================== =======================================================
     0 ``GetFeature``         Returns the feature index from a desired feature ID
     1 ``GetProtocolVersion`` Returns the protocol version / Replies to a ping action
    == ====================== ======================================================



This comment was marked as resolved.

Sign in to view

DisableKeys
~~~~~~~~~~~

Define the presence of the keys which the SW allows the user to disable, and allow SW to disable them.
A unifying device containing this feature should adopt HID++ reset policy #3 and implement the 0x0020
configuration change feature.
Comment on lines +21 to +23
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This description can go above the functions table. I would also reword it a bit.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This continues, there isn't supposed to be a DisabledKeys section. Move it above the functions table, right below the main title.


GetCapabilities
~~~~~~~~~~~~~~~

Summary

Returns keys which the SW allows the user to disable

Parameters

None

Returns

- disableableKeys [8bits] keys which the SW allows the user to disable

+---+---+---+---------+--------+------------+---------+----------+
| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 |
+===+===+===+=========+========+============+=========+==========+
| | | | Windows | Insert | ScrollLock | NumLock | CAPSLock |
| | | | (Start) | | | | |
+---+---+---+---------+--------+------------+---------+----------+
Comment on lines +40 to +45
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tables should be under a table directive. This is not the correct structure for tables, for one, we use the reverse order for showing bytes.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This also hasn't changed.


GetDisabledKeys
~~~~~~~~~~~~~~~

Summary

Returns list of keys the SW has disabled

Parameters

None

Returns

- disabledKeys [8bits] keys which the SW has disabled

+---+---+---+---------+--------+------------+---------+----------+
| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 |
+===+===+===+=========+========+============+=========+==========+
| | | | Windows | Insert | ScrollLock | NumLock | CAPSLock |
| | | | (Start) | | | | |
+---+---+---+---------+--------+------------+---------+----------+


SetDisabledKeys
~~~~~~~~~~~~~~~

Summary

Selects which keys to disable

Parameters

- keysToDisable [8bits] keys to disable


+---+---+---+---------+--------+------------+---------+----------+
| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 |
+===+===+===+=========+========+============+=========+==========+
| | | | Windows | Insert | ScrollLock | NumLock | CAPSLock |
| | | | (Start) | | | | |
+---+---+---+---------+--------+------------+---------+----------+


Returns

- disabledKeys [8bits] echo of the keysToDisable parameter


+---+---+---+---------+--------+------------+---------+----------+
| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 |
+===+===+===+=========+========+============+=========+==========+
| | | | Windows | Insert | ScrollLock | NumLock | CAPSLock |
| | | | (Start) | | | | |
+---+---+---+---------+--------+------------+---------+----------+