Skip to content

docs: Ensure every example has a pedagogical activity sheet on the wiki. #419

@nedseb

Description

@nedseb

What

Verify that every example file in lib/*/examples/ has a corresponding pedagogical activity sheet on the STeaMi wiki, and create the missing ones.

Why

Examples serve as validation for drivers, but they are also the primary learning resource for students. Without a wiki page explaining the learning objectives, setup instructions, expected behavior and extension ideas, an example is just code — not a teaching tool.

Current inventory

94 example files across 15 drivers. Each needs a wiki activity sheet.

apds9960 (5 examples)

  • ambient_light.py
  • color_lamp.py
  • gesture.py
  • light_theremin.py
  • proximity.py

bme280 (2 examples)

  • basic_reader.py
  • weather_station.py

bq27441 (2 examples)

  • fuel_gauge.py
  • tamagotchi.py

daplink_flash (6 examples)

  • config_zone.py
  • erase_flash.py
  • flash_info.py
  • read_file.py
  • sensor_log.py
  • write_csv.py

hts221 (1 example)

  • humidity.py

ism330dl (5 examples)

  • basic_read.py
  • maze_game.py
  • motion_orientation.py
  • spirit_level.py
  • static_orientation.py

lis2mdl (11 examples)

  • basic_read.py
  • calibrate_2d.py
  • compass_display.py
  • door_sensor.py
  • field_logger.py
  • field_map.py
  • low_power_one_shot.py
  • magnet_compass.py
  • magnet_fieldForce.py
  • metal_detector.py
  • tilt_compensated_heading.py

mcp23009e (11 examples)

  • binary_counter.py
  • buttons.py
  • combination_lock.py
  • dpad_counter.py
  • dpad_piano.py
  • i2c_scan.py
  • menu_navigation.py
  • morse_code.py
  • reaction_timer.py
  • simon.py
  • sleep_on_button.py

ssd1327 (15 examples)

  • bitmap.py
  • framebuf_lines.py
  • framebuf_pixels.py
  • framebuf_rects.py
  • framebuf_scroll.py
  • framebuf_text.py
  • hello_world.py
  • illusion.py
  • invert.py
  • lookup_table.py
  • micropython_logo.py
  • random_pixels.py
  • rotating_3d_cube.py
  • rotation.py
  • shades.py

steami_config (6 examples)

  • boot_counter.py
  • calibrate_accelerometer.py
  • calibrate_magnetometer.py
  • calibrate_temperature.py
  • populate_demo_config.py
  • show_config.py

steami_screen (8 examples)

  • comfort_bar_demo.py
  • compass_demo.py
  • ddap_menu.py
  • face_gallery.py
  • gauge_demo.py
  • graph_demo.py
  • hello_world.py
  • watch.py

vl53l1x (3 examples)

  • distance.py
  • proximity_alert.py
  • radar_screen.py

wsen-hids (8 examples)

  • comfort_monitor.py
  • continuous_mode.py
  • data_logger.py
  • dew_point.py
  • heater_demo.py
  • humidity_temperature.py
  • low_power_sampling.py
  • one_shot_mode.py

wsen-pads (11 examples)

  • altitude.py
  • altitude_calibration.py
  • basic_reader.py
  • continuous_reader.py
  • floor_detector.py
  • one_shot_reader.py
  • pressure_trend.py
  • station_env.py
  • temp_pressure_display.py
  • threshold_alert.py
  • weather_station.py

Activity sheet template

Each wiki page should include:

  1. Title — example name and one-line description
  2. Learning objectives — what the student will learn (sensor concepts, programming patterns, etc.)
  3. Prerequisites — which drivers, hardware, and prior knowledge are needed
  4. Step-by-step instructions — how to run and use the example
  5. Expected behavior — what the student should see/hear
  6. How it works — brief explanation of the key code sections
  7. Extension ideas — suggestions for going further

Notes

Metadata

Metadata

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions