Skip to content

feat: add initial Arduino software documentation#135

Open
Charly-sketch wants to merge 1 commit into
mainfrom
feat/software-arduino
Open

feat: add initial Arduino software documentation#135
Charly-sketch wants to merge 1 commit into
mainfrom
feat/software-arduino

Conversation

@Charly-sketch

Copy link
Copy Markdown

Summary

This PR adds the first Arduino documentation pages to the STeaMi wiki.

The new pages introduce the Arduino driver library, document the common API conventions shared by all drivers, and explain how to install the development environment and build or upload the firmware.

Closes #23

Added pages

  • docs/software/arduino/index.md

    • Overview of the Arduino ecosystem on STeaMi
    • List of available drivers
    • Links to the Arduino documentation
  • docs/software/arduino/conventions.md

    • Common Arduino driver API conventions
    • Initialization, measurements, power management
    • Continuous and one-shot acquisition modes
    • Calibration
    • Internal I²C bus usage
  • docs/software/arduino/install.md

    • Development environment setup
    • Firmware build and upload
    • Example discovery and flashing
    • Basic troubleshooting

Type

  • Contenu (docs)
  • Configuration (config, CI)
  • Composant (src/)
  • Assets (images, PDFs)

Test plan

  • npm run build passe sans erreur
  • Liens vérifiés

Add the first Arduino wiki pages covering the library overview,
installation, and common API conventions.

The new documentation introduces the available drivers, explains the
recommended development workflow with PlatformIO, describes firmware
build and upload commands, and documents the shared Arduino driver API
used across the project.

Related to #23
@Charly-sketch Charly-sketch self-assigned this Jul 16, 2026
@Charly-sketch
Charly-sketch requested a review from nedseb as a code owner July 16, 2026 08:58
@Charly-sketch Charly-sketch added the documentation Improvements or additions to documentation label Jul 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feat: Software Arduino/STM32duino — état du support et roadmap

2 participants