add-sensor-component-v1

Guide adding I2C sensor components to WipperSnapper v1 firmware and components repos.

54|56|Updated Aug 19, 2020
One-click install
npx skills add https://github.com/adafruit/Adafruit_Wippersnapper_Arduino --skill add-sensor-component-v1
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: add-sensor-component-v1
Source: https://github.com/adafruit/Adafruit_Wippersnapper_Arduino/tree/main/.agents/skills/add-sensor-component-v1
Command: npx skills add https://github.com/adafruit/Adafruit_Wippersnapper_Arduino --skill add-sensor-component-v1

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Guides developers through adding a new I2C sensor component to Adafruit IO WipperSnapper v1 firmware and the Wippersnapper_Components repository, providing a repeatable workflow from driver creation to PR submission.

Core Features & Use Cases

  • Driver scaffolding for a new I2C sensor
  • Registration in WipperSnapper_I2C and component definition in Wippersnapper_Components
  • Automatic validation steps including build verification and code formatting checks
  • Multi-repo PR workflow guidance for both firmware and components
  • PostRun automation to enforce formatting and documentation blocks

Quick Start

Provide the sensor name to generate a complete WipperSnapper I2C driver workflow from research to PRs.

Frequently Asked Questions about add-sensor-component-v1

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I add a new I2C sensor to Adafruit IO WipperSnapper firmware?

Adding a new I2C sensor to WipperSnapper requires scaffolding a driver, registering the I2C device, creating a component JSON definition, verifying the build, and submitting pull requests to both the firmware and components repositories.

What is the process for creating a WipperSnapper driver for an I2C component?

Creating a WipperSnapper driver involves writing the driver code, defining the component in the Wippersnapper_Components repository, adding library dependencies, and running automated validation steps like clang-format checks before creating pull requests.

Do I need to update both the WipperSnapper firmware and components repositories to register an I2C sensor?

Yes, registering an I2C sensor requires a multi-repo workflow where you submit pull requests to both the Adafruit IO WipperSnapper v1 firmware repository and the Wippersnapper_Components definition repository.

How does WipperSnapper handle code formatting and build verification for new sensor drivers?

WipperSnapper uses PostRun automation to enforce clang-format code formatting and documentation blocks, while also guiding build verification steps to ensure new sensor drivers compile correctly before pull request submission.

Can I use this workflow to add any I2C sensor component to WipperSnapper?

Yes, the workflow applies to any process that adds a new I2C sensor, creates a WipperSnapper driver, registers an I2C device, or contributes a component definition to the WipperSnapper ecosystem.

What steps are required to contribute a component definition to Wippersnapper_Components?

Contributing a component definition requires creating a component JSON file, ensuring library dependencies are listed, passing automated formatting and build verification checks, and submitting a pull request to the Wippersnapper_Components repository.