Skip to content

Latest commit

 

History

History
37 lines (23 loc) · 1.91 KB

README.md

File metadata and controls

37 lines (23 loc) · 1.91 KB
Raw

📘 Description

Welcome to the Synapse custom component for Home Assistant!

This library works with @digital-alchemy/synapse to allow Typescript based applications to create custom entities.

📦 Via HACS (Recommended)

  1. Ensure you have HACS installed in Home Assistant.
  2. Open HACS from the Home Assistant sidebar.
  3. Navigate to "Integrations" > "+ Explore & add repositories."
  4. Search for "Digital Alchemy Synapse" and select it from the list.
  5. Click "Install this repository in HACS."
  6. Restart Home Assistant to apply the changes.

📁 Manual Installation

If you prefer or need to install the integration manually:

  1. Clone or download this repository.
  2. Copy the custom_components/synapse/ directory from the repository into the <config_dir>/custom_components/ directory of your Home Assistant installation.
  3. Restart Home Assistant.

📖 Usage

Once enabled, the Synapse integration automatically coordinates with the connected Node.js application to manage entities. This includes generating unique IDs, tracking history, and ensuring entities appear on dashboards and persist across Home Assistant restarts.

Switches can be manipulated via the Lovelace UI or service domain calls, just like native Home Assistant switches. Sensors follow a push model, with updates sent from the Node.js application to Home Assistant.

For more advanced automation and entity grouping, refer to @digital-alchemy/automation, which provides tools for creating "rooms" and managing entity states and scene activation.

📚 Documentation and Support

For more detailed documentation and support, visit the GitHub repository. Please report any issues or feature requests there.