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)
bme280 (2 examples)
bq27441 (2 examples)
daplink_flash (6 examples)
hts221 (1 example)
ism330dl (5 examples)
lis2mdl (11 examples)
mcp23009e (11 examples)
ssd1327 (15 examples)
steami_config (6 examples)
steami_screen (8 examples)
vl53l1x (3 examples)
wsen-hids (8 examples)
wsen-pads (11 examples)
Activity sheet template
Each wiki page should include:
- Title — example name and one-line description
- Learning objectives — what the student will learn (sensor concepts, programming patterns, etc.)
- Prerequisites — which drivers, hardware, and prior knowledge are needed
- Step-by-step instructions — how to run and use the example
- Expected behavior — what the student should see/hear
- How it works — brief explanation of the key code sections
- Extension ideas — suggestions for going further
Notes
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.pycolor_lamp.pygesture.pylight_theremin.pyproximity.pybme280 (2 examples)
basic_reader.pyweather_station.pybq27441 (2 examples)
fuel_gauge.pytamagotchi.pydaplink_flash (6 examples)
config_zone.pyerase_flash.pyflash_info.pyread_file.pysensor_log.pywrite_csv.pyhts221 (1 example)
humidity.pyism330dl (5 examples)
basic_read.pymaze_game.pymotion_orientation.pyspirit_level.pystatic_orientation.pylis2mdl (11 examples)
basic_read.pycalibrate_2d.pycompass_display.pydoor_sensor.pyfield_logger.pyfield_map.pylow_power_one_shot.pymagnet_compass.pymagnet_fieldForce.pymetal_detector.pytilt_compensated_heading.pymcp23009e (11 examples)
binary_counter.pybuttons.pycombination_lock.pydpad_counter.pydpad_piano.pyi2c_scan.pymenu_navigation.pymorse_code.pyreaction_timer.pysimon.pysleep_on_button.pyssd1327 (15 examples)
bitmap.pyframebuf_lines.pyframebuf_pixels.pyframebuf_rects.pyframebuf_scroll.pyframebuf_text.pyhello_world.pyillusion.pyinvert.pylookup_table.pymicropython_logo.pyrandom_pixels.pyrotating_3d_cube.pyrotation.pyshades.pysteami_config (6 examples)
boot_counter.pycalibrate_accelerometer.pycalibrate_magnetometer.pycalibrate_temperature.pypopulate_demo_config.pyshow_config.pysteami_screen (8 examples)
comfort_bar_demo.pycompass_demo.pyddap_menu.pyface_gallery.pygauge_demo.pygraph_demo.pyhello_world.pywatch.pyvl53l1x (3 examples)
distance.pyproximity_alert.pyradar_screen.pywsen-hids (8 examples)
comfort_monitor.pycontinuous_mode.pydata_logger.pydew_point.pyheater_demo.pyhumidity_temperature.pylow_power_sampling.pyone_shot_mode.pywsen-pads (11 examples)
altitude.pyaltitude_calibration.pybasic_reader.pycontinuous_reader.pyfloor_detector.pyone_shot_reader.pypressure_trend.pystation_env.pytemp_pressure_display.pythreshold_alert.pyweather_station.pyActivity sheet template
Each wiki page should include:
Notes