I want to share my developments of the Custom Component stc3100 ft5436

[fermiums22]

I want to share my developments of the Custom Component stc3100 ft5436

Thanks for suggesting an enhancement to our builder / dashboard! ❤️

⚠️ Before you submit
This form is for requesting new builder / dashboard features or visual enhancements.

This is NOT for:

• 🆘 Support using the builder / dashboard? → Community Forum or join our Discord chat server. You are more likely to get the answer you are looking for in those places.
• 🐛 Reporting install / compilation issues → Report an issue
• 🐛 Reporting bugs in the builder / dashboard → Report an issue

---

Describe the enhancement

I propose an enhancement to the ESPHome Builder/Dashboard to streamline the process for community-contributed custom components. My stc3100 gas gauge and ft5436 touchscreen drivers serve as examples of such components. Currently, integrating custom components often involves manual file management and configuration outside the main dashboard interface, which can be cumbersome for users.

---

Use cases

This improvement would significantly benefit users and developers. It would:

• Simplify Custom Component Integration: Users could more easily discover, install, and manage custom components directly within the dashboard, reducing the need for manual file copying or complex YAML configurations.
• Promote Community Contributions: A more accessible integration path would encourage more developers to share their work, enriching the ESPHome ecosystem.
• Improve User Experience: New users, in particular, would find it much easier to leverage the full power of ESPHome with specialized hardware without deep diving into file systems.
• Standardize Best Practices: The dashboard could guide developers on how to package their components for easy integration, ensuring consistency and quality.

For example, a "Community Components" section or an "Add Custom Component" wizard could allow users to:

• Specify a GitHub repository URL for a custom component.
• Automatically download and place the component files in the correct directory.
• Provide a simple interface to enable and configure the component in their YAML.

---

Visual examples

• Concept 1: "Community Components" Browser
  • Imagine a new tab or section in the dashboard, similar to Home Assistant's HACS (Home Assistant Community Store), where users can browse and install community-contributed components.
  • Each component could feature a brief description, author, and a button to "Install" or "Add to Project".
• Concept 2: "Add External Component" Wizard
  • A wizard that prompts for a GitHub repository URL or a local folder path.
  • It then guides the user through selecting which components from that source to add to their project.
  • (No specific mockups are available at this moment, but these are common patterns in other open-source ecosystems.)

---

Anything else?

• Similar Implementations: Home Assistant's HACS (Home Assistant Community Store) provides an excellent example of how a community store can simplify the management of custom integrations: https://hacs.xyz/
• My custom components for reference:
  • stc3100 Gas Gauge: This component provides voltage, current, temperature, charge (mAh), conversion counter, and input pin state readings for the STC3100 gas gauge IC.
  • ft5436 Touchscreen: This component enables touch input for displays using the FT5436 controller, supporting single-touch detection and interrupt-driven updates.
• I have already searched for similar discussions and did not find a direct proposal for this type of dashboard enhancement.
• Hardware Context:
  • Display: KD015QVFMN002-C001B
  • MCU: ESP32-S3
• Component Files:
  • custom_components.zip (This archive contains the source code for both stc3100 and ft5436 custom components.)

---

Discussion options

Helpful resources

• Code of conduct
• Security policy
• GitHub Community Guidelines

👋

It looks like this is your first time starting a discussion in this repository!

This is a community we build together. Please be welcoming and open minded.

Reporting a security vulnerability?
Check out the repository's