Add iterable touchpad functionality #114

tekktrik · 2022-02-18T21:44:31Z

Based off of comments from #113, resolves #103

I had to fiddle with the inner working in order to be able to return Pin objects. Doesn't look like touchio.TouchIn objects store their Pin, and you can't use Pins as dictionary keys either. This adds the functionality described in the aforementioned PR, but with all the necessary tweaks to make it happen. Tested before the final pre-commit run by building as a UF2 and running the now modified example for touching all pads (which doesn't touch ALL of them anymore, for what it's worth).

Now return board.XX!

kattni · 2022-02-18T23:04:47Z

@dhalbert Please take a look at your convenience!

tekktrik · 2022-02-18T23:18:15Z

If this works I can add it to the CLUE as well. Is it worth doing for the Crickit? I added an issue there as well, but can remove it if it isn't worth doing for that one.

tekktrik · 2022-02-19T00:12:13Z

I realize this is a good fit for namedtuple I can refactory it to use that. Not sure how that affects memory. Would revert the _touch() based functions to use index again. Not sure how memory usage is between dict and namedtuple

tekktrik · 2022-03-12T19:15:41Z

Just checking in on this PR, let me know if anything else is needed!

FoamyGuy

I tested this out successfully today.

I have a few small suggestions about the example code, but things are looking good to me beyond these.

I also made a build with this updated library for CPX Russian language. I believe this is one of the more space restricted ones. I did get a successful build with it.

@dhalbert you have any other thoughts on these changes?

examples/circuitplayground_touch_all.py

dhalbert

I apologize for missing the fact you reworked the original PR.

Ideally, as you mention, the way to do this would be to use board.<pin_name> as a key in a dictionary of TouchIns. Unfortunately, as you found, microcontroller.Pin is not hashable (does not implement __hash__()), so we can't do that. That would eliminate the need to use strings, and would save some getattr() calls. But I think it is fine as is.

I defer to @FoamyGuy's comments on the example.

FoamyGuy · 2022-03-21T20:09:30Z

I did another round of build testing for firmware size and found that the circuitplayground_express_displayio board with ru language is too large with this configuration:

Building circuitplayground_express_displayio ru

254008 bytes used, -568 bytes free in flash firmware space out of 253440 bytes (247.5kB).
12156 bytes used, 20612 bytes free in ram for stack and heap out of 32768 bytes (32.0kB).

Too little flash!!!

I'm not sure what could be removed to make room. @dhalbert or @kattni do either of you have any ideas? Does the bluefruit.py file from this repo end up getting frozen into the CPX builds? If so maybe there would be some way to leave it out as I don't think it would get used under normal circumstances on CPX.

kattni · 2022-03-21T20:14:12Z

We've discussed multiple times putting in a mechanism to not freeze an entire library, and this was the use case for that option. However, it has been vetoed in the end every time it has come up. I feel like it will need to be considered eventually as there are almost certainly going to be new Circuit Playgrounds. I assume the suggestion will be create a new library for the new Playgrounds. That doesn't help here as this is far too widely used to factor bluefruit into a separate library at this point.

bluefruit.py is not, in fact, used by CPX, so the concept would work. But we don't have any way to freeze partial libraries at this time. If it does not build as-is, we may need to put this on ice for now.

dhalbert · 2022-03-21T21:38:18Z

The library could be refactored into a base library and separate CPX/CPB libraries. Or the CPX part could be left in the base library, since we don't freeze it into CPB.

kattni · 2022-03-21T21:41:50Z

Unless we can guarantee backwards compatibility, refactoring would be a bit of a nightmare. There would be so much code to update. Even if we left CPX alone.

dhalbert · 2022-03-21T22:45:08Z

Changed to draft to avoid accidental merge.

tekktrik · 2022-05-03T20:03:52Z

Tagging adafruit/circuitpython#6342 since it's somewhat related, though it doesn't seem to be the main issue, if I understand correctly.

tekktrik · 2022-05-11T14:05:31Z

Sounds like the builds may soon have more room if their counterpart isn't frozen with them. @kattni, @dhalbert - is this worth revisiting at that point?

dhalbert · 2022-05-11T14:18:45Z

Yes, we can revisit this once adafruit/circuitpython#6342 i in a stable release, which would be 7.3.0 final. In addition, the work by @Neradoc here: adafruit/circuitpython#6346 to include only the parts of a frozen library that are useful (e.g. omit bluefruit.py on a CPX)) would help in terms of space.

So we can un-draft this as soon as 7.3.0 final is out.

tekktrik · 2022-06-03T00:56:41Z

Sounds like this can be reopened!

dhalbert

I've suggested a simplification (not tested!) now that it's easier to keep track of pins. The _touches dict can grow as needed: it doesn't need to contain placeholders for all the pins when it starts. Maybe you can touch up my code further.

adafruit_circuitplayground/circuit_playground_base.py

Co-authored-by: Dan Halbert <halbert@halwitz.org>

…Adafruit_CircuitPython_CircuitPlayground into dev/iterable-io-rework

tekktrik · 2022-07-09T17:01:28Z

Great suggestions! I don't immediately see any improvements to your suggestions, I think it's pretty streamlined! The code could change back towards what it was if the Pin of a TouchIn was accessible and the dict could be a list again, but since that's not the case I think this is the best solution.

dhalbert

Couple of simplifications.

adafruit_circuitplayground/circuit_playground_base.py

tekktrik · 2022-07-09T22:18:40Z

Good eye! Changes made.

…thon_CircuitPlayground into dev/iterable-io-rework

tekktrik · 2022-08-19T21:10:08Z

Taking another look at this with CircuitPython 8.0.0 beta out, merged in changes from main to keep it up to date

dhalbert

Two minor doc touchups, but looks very good! Thanks for persevering with this.

adafruit_circuitplayground/circuit_playground_base.py

Co-authored-by: Dan Halbert <halbert@halwitz.org>

tekktrik · 2022-08-24T15:23:46Z

@dhalbert should I go ahead and merge, or is this pending a specific CircuitPython release?

dhalbert · 2022-08-24T15:43:02Z

If this works with 7.x.x, no problem. I wasn't sure whether @FoamyGuy wanted to review again.

FoamyGuy · 2022-08-24T22:56:44Z

examples/circuitplayground_touch_all.py

+        print("Touchpads currently registering a touch:")
+        print(current_touched)
+    else:
+        print("No touchpads are currently regustering a touch.")


Going back to test this again. noticed small typo here, regustering instead of registering

Ha! Good catch.

FoamyGuy

I tested a few variations of this again today, all were successful.

CPX ru language build from current core main branch with this version of the library frozen in
CPX 7.3.2 downloaded from cp.org with this library in the root of CIRCUITPY (to override the frozen one)
CPX 8.0.0-beta.0 downloaded from cp.org with this library in the root of CIRCUITPY

Looks good to me.

tekktrik · 2022-08-24T23:19:39Z

Thanks everyone!

Updating https://github.com/adafruit/Adafruit_CircuitPython_BH1750 to 1.1.5 from 1.1.4: > Merge pull request adafruit/Adafruit_CircuitPython_BH1750#7 from tcfranks/main > Use year duration range for copyright attribution > Keep copyright up to date in documentation Updating https://github.com/adafruit/Adafruit_CircuitPython_BMP3XX to 1.3.15 from 1.3.14: > Merge pull request adafruit/Adafruit_CircuitPython_BMP3XX#22 from tcfranks/main > Use year duration range for copyright attribution > Keep copyright up to date in documentation Updating https://github.com/adafruit/Adafruit_CircuitPython_CircuitPlayground to 5.3.0 from 5.2.8: > Merge pull request adafruit/Adafruit_CircuitPython_CircuitPlayground#114 from tekktrik/dev/iterable-io-rework > Use year duration range for copyright attribution > Keep copyright up to date in documentation Updating https://github.com/adafruit/Adafruit_CircuitPython_IL91874 to 1.2.9 from 1.2.8: > Merge pull request adafruit/Adafruit_CircuitPython_IL91874#16 from tcfranks/main > Use year duration range for copyright attribution > Keep copyright up to date in documentation Updating https://github.com/adafruit/Adafruit_CircuitPython_SSD1322 to 1.3.6 from 1.3.5: > Merge pull request adafruit/Adafruit_CircuitPython_SSD1322#17 from tcfranks/main > Use year duration range for copyright attribution > Keep copyright up to date in documentation Updating https://github.com/adafruit/Adafruit_CircuitPython_SSD1325 to 1.4.7 from 1.4.6: > Merge pull request adafruit/Adafruit_CircuitPython_SSD1325#15 from tcfranks/main > Use year duration range for copyright attribution > Keep copyright up to date in documentation Updating https://github.com/adafruit/Adafruit_CircuitPython_SSD1331 to 1.3.7 from 1.3.6: > Merge pull request adafruit/Adafruit_CircuitPython_SSD1331#16 from tcfranks/main > Use year duration range for copyright attribution > Keep copyright up to date in documentation Updating https://github.com/adafruit/Adafruit_CircuitPython_SSD1351 to 1.3.7 from 1.3.6: > Merge pull request adafruit/Adafruit_CircuitPython_SSD1351#18 from tcfranks/main > Use year duration range for copyright attribution > Keep copyright up to date in documentation Updating https://github.com/adafruit/Adafruit_CircuitPython_SSD1608 to 1.2.17 from 1.2.16: > Merge pull request adafruit/Adafruit_CircuitPython_SSD1608#15 from tcfranks/main > Use year duration range for copyright attribution > Keep copyright up to date in documentation Updating https://github.com/adafruit/Adafruit_CircuitPython_TMP007 to 2.1.12 from 2.1.11: > Merge pull request adafruit/Adafruit_CircuitPython_TMP007#13 from tcfranks/main > Use year duration range for copyright attribution > Keep copyright up to date in documentation Updating https://github.com/adafruit/Adafruit_CircuitPython_BLE_MIDI to 1.0.12 from 1.0.11: > Merge pull request adafruit/Adafruit_CircuitPython_BLE_MIDI#10 from tcfranks/main > Use year duration range for copyright attribution > Keep copyright up to date in documentation

tekktrik added 4 commits February 18, 2022 15:15

Add iterable return touchpad properties

c71fa2c

Fix touch_pins, touched properties

d8c128c

Now return board.XX!

Changed example for touching all pads to updated usage

4d7b492

Reformatted per pre-commit

b68b3d2

tekktrik requested a review from a team February 18, 2022 21:44

tekktrik mentioned this pull request Feb 18, 2022

Add iteration support for touchpads #113

Closed

tekktrik added 2 commits February 18, 2022 16:59

Prevent pointless statements

af87b00

Add new method docstrings

aaa7582

kattni requested a review from dhalbert February 18, 2022 23:04

FoamyGuy requested changes Mar 21, 2022

View reviewed changes

examples/circuitplayground_touch_all.py Outdated Show resolved Hide resolved

examples/circuitplayground_touch_all.py Outdated Show resolved Hide resolved

dhalbert reviewed Mar 21, 2022

View reviewed changes

dhalbert mentioned this pull request Mar 21, 2022

Make microcontroller.Pin hashable, so pins can be used as dictionary keys adafruit/circuitpython#6179

Closed

Refactor example for touch all

25c97ca

tekktrik requested a review from FoamyGuy March 21, 2022 17:29

dhalbert marked this pull request as draft March 21, 2022 22:44

tekktrik marked this pull request as ready for review June 3, 2022 00:55

tekktrik requested a review from dhalbert June 10, 2022 13:54

dhalbert requested changes Jul 6, 2022

View reviewed changes

tekktrik and others added 7 commits July 9, 2022 12:45

Use list of keys instead of list comprehension

3e942fc

Co-authored-by: Dan Halbert <halbert@halwitz.org>

Update comment regard self._touches

266ef58

Initialize self._touches as empty dictionary

0477696

Merge branch 'dev/iterable-io-rework' of https://github.com/tekktrik/…

2213f02

…Adafruit_CircuitPython_CircuitPlayground into dev/iterable-io-rework

Change argument name

9142472

Update _touch() to populate _tocuhes as needed

937a4a5

Update list comprehension

96be262

Reformatted per pre-commit

f4f6942

tekktrik requested a review from dhalbert July 9, 2022 17:02

dhalbert requested changes Jul 9, 2022

View reviewed changes

adafruit_circuitplayground/circuit_playground_base.py Outdated Show resolved Hide resolved

adafruit_circuitplayground/circuit_playground_base.py Outdated Show resolved Hide resolved

Simplifications to code

3c707f6

tekktrik requested a review from dhalbert July 9, 2022 22:18

Merge branch 'main' of https://github.com/adafruit/Adafruit_CircuitPy…

108a35d

…thon_CircuitPlayground into dev/iterable-io-rework

dhalbert requested changes Aug 24, 2022

View reviewed changes

adafruit_circuitplayground/circuit_playground_base.py Outdated Show resolved Hide resolved

adafruit_circuitplayground/circuit_playground_base.py Outdated Show resolved Hide resolved

tekktrik and others added 2 commits August 24, 2022 10:22

Update adafruit_circuitplayground/circuit_playground_base.py

4bdba83

Co-authored-by: Dan Halbert <halbert@halwitz.org>

Update adafruit_circuitplayground/circuit_playground_base.py

5eaaac8

Co-authored-by: Dan Halbert <halbert@halwitz.org>

tekktrik requested a review from dhalbert August 24, 2022 14:22

dhalbert approved these changes Aug 24, 2022

View reviewed changes

FoamyGuy reviewed Aug 24, 2022

View reviewed changes

Correct typo in example

dbfa322

FoamyGuy approved these changes Aug 24, 2022

View reviewed changes

FoamyGuy merged commit 47f848f into adafruit:main Aug 24, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add iterable touchpad functionality #114

Add iterable touchpad functionality #114

tekktrik commented Feb 18, 2022

kattni commented Feb 18, 2022

tekktrik commented Feb 18, 2022

tekktrik commented Feb 19, 2022

tekktrik commented Mar 12, 2022

FoamyGuy left a comment

dhalbert left a comment

FoamyGuy commented Mar 21, 2022

kattni commented Mar 21, 2022

dhalbert commented Mar 21, 2022

kattni commented Mar 21, 2022

dhalbert commented Mar 21, 2022

tekktrik commented May 3, 2022

tekktrik commented May 11, 2022

dhalbert commented May 11, 2022

tekktrik commented Jun 3, 2022

dhalbert left a comment

tekktrik commented Jul 9, 2022

dhalbert left a comment

tekktrik commented Jul 9, 2022

tekktrik commented Aug 19, 2022 •

edited

Loading

dhalbert left a comment

tekktrik commented Aug 24, 2022

dhalbert commented Aug 24, 2022

FoamyGuy Aug 24, 2022

tekktrik Aug 24, 2022

FoamyGuy left a comment

tekktrik commented Aug 24, 2022

Add iterable touchpad functionality #114

Add iterable touchpad functionality #114

Conversation

tekktrik commented Feb 18, 2022

kattni commented Feb 18, 2022

tekktrik commented Feb 18, 2022

tekktrik commented Feb 19, 2022

tekktrik commented Mar 12, 2022

FoamyGuy left a comment

Choose a reason for hiding this comment

dhalbert left a comment

Choose a reason for hiding this comment

FoamyGuy commented Mar 21, 2022

kattni commented Mar 21, 2022

dhalbert commented Mar 21, 2022

kattni commented Mar 21, 2022

dhalbert commented Mar 21, 2022

tekktrik commented May 3, 2022

tekktrik commented May 11, 2022

dhalbert commented May 11, 2022

tekktrik commented Jun 3, 2022

dhalbert left a comment

Choose a reason for hiding this comment

tekktrik commented Jul 9, 2022

dhalbert left a comment

Choose a reason for hiding this comment

tekktrik commented Jul 9, 2022

tekktrik commented Aug 19, 2022 • edited Loading

dhalbert left a comment

Choose a reason for hiding this comment

tekktrik commented Aug 24, 2022

dhalbert commented Aug 24, 2022

FoamyGuy Aug 24, 2022

Choose a reason for hiding this comment

tekktrik Aug 24, 2022

Choose a reason for hiding this comment

FoamyGuy left a comment

Choose a reason for hiding this comment

tekktrik commented Aug 24, 2022

tekktrik commented Aug 19, 2022 •

edited

Loading