Skip to content

Commit

Permalink
keypad: add doc that reset() can be used to determine keys held down …
Browse files Browse the repository at this point in the history
…at startup
  • Loading branch information
dhalbert committed Nov 19, 2024
1 parent c5a929e commit d08cecf
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 0 deletions.
3 changes: 3 additions & 0 deletions shared-bindings/keypad/KeyMatrix.c
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,9 @@ static void check_for_deinit(keypad_keymatrix_obj_t *self) {
//| """Reset the internal state of the scanner to assume that all keys are now released.
//| Any key that is already pressed at the time of this call will therefore immediately cause
//| a new key-pressed event to occur.
//| For instance, if you call `reset()` immediately after creating a `KeyMatrix` object
//| at the beginning of your program, the events it generates will let you determine which keys
//| were being held down at program start.
//| """
//| ...

Expand Down
3 changes: 3 additions & 0 deletions shared-bindings/keypad/Keys.c
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,9 @@ static MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(keypad_keys___exit___obj, 4, 4, keypa
//| """Reset the internal state of the scanner to assume that all keys are now released.
//| Any key that is already pressed at the time of this call will therefore immediately cause
//| a new key-pressed event to occur.
//| For instance, if you call `reset()` immediately after creating a `Keys` object
//| at the beginning of your program, the events it generates will let you determine which keys
//| were being held down at program start.
//| """
//| ...

Expand Down
3 changes: 3 additions & 0 deletions shared-bindings/keypad/ShiftRegisterKeys.c
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,9 @@ static MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(keypad_shiftregisterkeys___exit___obj
//| """Reset the internal state of the scanner to assume that all keys are now released.
//| Any key that is already pressed at the time of this call will therefore immediately cause
//| a new key-pressed event to occur.
//| For instance, if you call `reset()` immediately after creating a `ShiftRegisterKeys` object
//| at the beginning of your program, the events it generates will let you determine which keys
//| were being held down at program start.
//| """
//| ...

Expand Down
3 changes: 3 additions & 0 deletions shared-bindings/keypad_demux/DemuxKeyMatrix.c
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,9 @@ static void check_for_deinit(keypad_demux_demuxkeymatrix_obj_t *self) {
//| """Reset the internal state of the scanner to assume that all keys are now released.
//| Any key that is already pressed at the time of this call will therefore immediately cause
//| a new key-pressed event to occur.
//| For instance, if you call `reset()` immediately after creating a `DemuxKeyMatrix` object
//| at the beginning of your program, the events it generates will let you determine which keys
//| were being held down at program start.
//| """
//| ...

Expand Down

0 comments on commit d08cecf

Please sign in to comment.