Skip to content

Add example sketches for classes that lack them (also gives them CI coverage) #5

Description

@jonfroehlich

Problem

Several public classes ship with no example sketch, even though Arduino surfaces examples prominently (File → Examples → Makeability Lab) and they're the primary way students discover a class. The bundled examples only cover shapes/joystick/games.

Classes with no example:

  • Button
  • MovingAverageFilter
  • ColorName
  • FileUtils
  • ScrollingLineGraph
  • ScrollingLineGraphMultiValue

As a side effect, these classes are never compiled by CI (the Compile Examples workflow only builds examples/), so regressions in them won't be caught.

Proposed work

Add a minimal example sketch per class. This also gives each one free CI coverage. Good candidates:

  • Button/ButtonBasic
  • MovingAverageFilter/SmoothAnalogInput
  • ColorName/ClosestColorMatch
  • FileUtils/ListSdFiles
  • ScrollingLineGraph/GraphAnalogInput
  • ScrollingLineGraphMultiValue/GraphTwoInputs

Notes

  • The README already has usable code snippets for most of these — they can seed the examples.
  • Several existing arduino-repo sketches already exercise ScrollingLineGraphMultiValue and can be adapted.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions