Skip to content

docs: add I2C environmental sensor HAT tutorial#655

Closed
MolhamHamwi wants to merge 1 commit into
tscircuit:mainfrom
MolhamHamwi:bounty-602-i2c-environmental-sensor-hat
Closed

docs: add I2C environmental sensor HAT tutorial#655
MolhamHamwi wants to merge 1 commit into
tscircuit:mainfrom
MolhamHamwi:bounty-602-i2c-environmental-sensor-hat

Conversation

@MolhamHamwi
Copy link
Copy Markdown

Closes #602

/claim #602

Summary

  • Adds an I2C Environmental Sensor HAT tutorial under docs/tutorials/pi-hats/
  • Covers BME280 wiring, I2C pull-ups, optional OLED/external headers, BOM, PCB layout guidance, Raspberry Pi setup, and Python readout code

Test Plan

  • bun run typecheck
  • bun run build

Copilot AI review requested due to automatic review settings May 23, 2026 08:24
@vercel
Copy link
Copy Markdown

vercel Bot commented May 23, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment May 23, 2026 8:25am

Request Review

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a new Raspberry Pi HAT tutorial documenting an I2C environmental sensor design (BME280 + pull-ups + optional OLED/external headers) and updates the Bun lockfile metadata accordingly.

Changes:

  • Added a new MDX tutorial under docs/tutorials/pi-hats/ for an I2C environmental sensor HAT.
  • Included wiring guidance, BOM/layout notes, Raspberry Pi I2C bring-up steps, and a Python readout example.
  • Updated bun.lock with a configVersion field.

Reviewed changes

Copilot reviewed 1 out of 2 changed files in this pull request and generated 3 comments.

File Description
docs/tutorials/pi-hats/i2c-environmental-sensor-hat.mdx New end-to-end tutorial for building an I2C BME280-based Raspberry Pi HAT (schematic/PCB guidance + setup + sample code).
bun.lock Adds Bun lockfile configVersion metadata.
Comments suppressed due to low confidence (1)

docs/tutorials/pi-hats/i2c-environmental-sensor-hat.mdx:130

  • Same as above: this Step 1 snippet still uses footprint="soic8" for the BME280. If you update the sensor footprint/package choice, make sure this example stays consistent with the overview circuit and BOM.
    <chip
      name="U1"
      footprint="soic8"
      manufacturerPartNumber="BME280"

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

<RaspberryPiHatBoard name="HAT1">
<chip
name="U1"
footprint="soic8"
Comment on lines +213 to +219
## Python Example

Install the CircuitPython BME280 driver:

```bash
python3 -m pip install adafruit-circuitpython-bme280
```
Comment on lines +148 to +154
## Step 2: Wire the I2C Bus

Connect Raspberry Pi `GPIO_2` to BME280 `SDI` for SDA, and `GPIO_3` to `SCK` for SCL. Add one pull-up resistor from each line to 3.3V.

```tsx
<trace from=".HAT1_chip .GPIO_2" to=".U1 .SDI" />
<trace from=".HAT1_chip .GPIO_3" to=".U1 .SCK" />
@MolhamHamwi
Copy link
Copy Markdown
Author

Closing this duplicate to keep review focused on #656, which has the updated tutorial revision and passing checks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Bounty: Add I2C Environmental Sensor Module tutorial

2 participants