Skip to content

[motion] Document new sensors and event#6732

Open
clydebarrow wants to merge 37 commits into
esphome:nextfrom
clydebarrow:motion-gestures
Open

[motion] Document new sensors and event#6732
clydebarrow wants to merge 37 commits into
esphome:nextfrom
clydebarrow:motion-gestures

Conversation

@clydebarrow
Copy link
Copy Markdown
Contributor

@clydebarrow clydebarrow commented Jun 3, 2026

Description

Related issue (if applicable): fixes

Pull request in esphome with YAML changes (if applicable):

Checklist

  • I am merging into next because this is new documentation that has a matching pull-request in esphome as linked above.
    or

  • I am merging into current because this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature.

  • Link added in /src/content/docs/components/index.mdx when creating new documents for new components or cookbook.

New Component Images

If you are adding a new component to ESPHome, you can automatically generate a standardized black and white component name image for the documentation.

To generate a component image:

  1. Comment on this pull request with the following command, replacing component_name with your component name in lower_case format with underscores (e.g., bme280, sht3x, dallas_temp):

    @esphomebot generate image component_name
    
  2. The ESPHome bot will respond with a downloadable ZIP file containing the SVG image.

  3. Extract the SVG file and place it in the /public/images/ folder of this repository.

  4. Use the image in your component's index table entry in /src/content/docs/components/index.mdx.

Example: For a component called "DHT22 Temperature Sensor", use:

@esphomebot generate image dht22

Note: All images used in ImgTable components must be placed in /public/images/ as the component resolves them to absolute paths.

Copilot AI review requested due to automatic review settings June 3, 2026 23:38
@esphome esphome Bot added the next label Jun 3, 2026
@netlify
Copy link
Copy Markdown

netlify Bot commented Jun 3, 2026

Deploy Preview for esphome ready!

Name Link
🔨 Latest commit 603ec63
🔍 Latest deploy log https://app.netlify.com/projects/esphome/deploys/6a20dd83b4676a00089813d6
😎 Deploy Preview https://deploy-preview-6732--esphome.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

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 documentation for the new motion (IMU) hub component and related sensor platforms, including chip-specific motion platform pages and temperature sensor pages, plus updates to the components index and icon assets.

Changes:

  • Added new Motion Component (IMU) docs, including sensor/binary sensor/event configuration and calibration actions.
  • Added chip-specific motion platform docs (BMI270, LSM6DS3) and their corresponding temperature sensor platform docs.
  • Updated components index to surface the new pages and added a new IMU icon.

Reviewed changes

Copilot reviewed 7 out of 9 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
src/content/docs/components/sensor/motion.mdx Adds docs for the sensor: “motion” platform types (IMU-derived sensor entities).
src/content/docs/components/sensor/lsm6ds3.mdx Adds docs for LSM6DS3 temperature sensor platform requiring the motion hub.
src/content/docs/components/sensor/bmi270.mdx Adds docs for BMI270 temperature sensor platform requiring the motion hub.
src/content/docs/components/motion/index.mdx Adds core Motion (IMU) hub documentation: types, binary sensors, event, and calibration actions.
src/content/docs/components/motion/lsm6ds3.mdx Adds motion platform docs for LSM6DS3 (config + example).
src/content/docs/components/motion/bmi270.mdx Adds motion platform docs for BMI270 (config + example).
src/content/docs/components/index.mdx Adds index entries for the new Motion docs (but currently references a missing image filename).
public/images/imu.svg Adds a monochrome IMU icon for use in component tables.

Comment thread src/content/docs/components/index.mdx
Comment thread src/content/docs/components/motion/index.mdx Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants