Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[M4E] Requirements tweak #4031

Merged
merged 2 commits into from
Jul 10, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions guides/made_for_esphome.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,14 @@ For all projects
- Your project is powered by an ESP32 or *supported* ESP32 variant such as the S2, S3, C3, etc.
- Your ESPHome configuration is open source, available for end users to modify/update
- Users should be able to apply updates if your project sells ready-made devices
- Your project supports adoption via the ``dashboard_import`` feature of ESPHome (see :doc:`Sharing </guides/creators>`). In particular:
- Your project supports adoption via the ``dashboard_import`` feature of ESPHome (see
:doc:`Sharing </guides/creators>`). In particular:

- There are **no** references to secrets or passwords
- Network configuration must assume defaults (no static IPs or DNS configured)
- It **must** compile successfully without any user changes after adopting it.
- All configuration is contained within a single YAML file. Fully remote packages are permitted if using ``import_full_config: true``.
- The configuration **must** be valid, compile and run successfully *without any user changes* after adopting it.
- Use of remote packages in the YAML is permitted only if the above criteria are met.

- Your product name cannot contain "**ESPHome**" except in the case of *ending with* "**for ESPHome**"

When your project matches all requirements of the Made for ESPHome program,
Expand Down