Skip to content

Latest commit

 

History

History
97 lines (61 loc) · 3.91 KB

README.md

File metadata and controls

97 lines (61 loc) · 3.91 KB
Raw

EffortlessHome Add-ons

Welcome to the EffortlessHome Add-ons repository! This repository contains custom add-ons for use with Home Assistant to enhance your smart home experience.

Overview

EffortlessHome provides a suite of powerful add-ons designed to streamline and extend your home automation system. These add-ons integrate seamlessly with Home Assistant, enabling advanced functionality, simplifying automation tasks, and providing specialized tools for enhanced control.

Key Features

  • Custom integrations to automate and manage your home environment
  • Tools for managing security, energy, and comfort
  • Real-time data processing and reporting
  • Simplified automation for everyday tasks

Add-ons List

  1. Backup Manager

    • Description: Automates and schedules Home Assistant snapshot backups.
    • Usage: Automatically manage snapshots, store them locally or upload to cloud storage, and delete old backups.

  2. Remote Access

    • Description: Provides secure, remote access to your Home Assistant Instance.
    • Usage: Requires an EffortlessHome account, free trial available.

Sections:

  • Overview: A general introduction to the repository and what it offers.
  • Add-ons List: A description of the key add-ons provided in the repository.
  • Installation: Instructions for installing the add-ons via Home Assistant.
  • Configuration: Directions on configuring the add-ons.
  • Development: Information for developers who want to contribute or modify the add-ons.
  • License: Licensing information.

EffortlessHome Options:

  • System Restore: Includes all of the EffortlessHome capabilities below (and other must have components) in one simple sytem restore file. Get up and running quickly and easily.
  • Add-Ons: Add-ons for cloud backups and remote access
  • Integration: The Core EffortlessHome Native Integration
  • Blueprints: A large set of easy to use automation and script blueprints
  • Theme: A stylish theme to get the EffortlessHome look and feel

Installation

To install the add-ons from this repository:

  1. Go to your Home Assistant dashboard.
  2. Navigate to Supervisor > Add-on Store.
  3. Click on the three dots in the upper right corner and select Repositories.
  4. Add this repository using the URL:

Installation

To install the add-ons from this repository:

  1. Go to your Home Assistant dashboard.
  2. Navigate to Supervisor > Add-on Store.
  3. Click on the three dots in the upper right corner and select Repositories.
  4. Add this repository using the URL:

https://github.com/EffortlessHome/addons

  1. Once the repository is added, you will see the EffortlessHome Add-ons in your store.
  2. Install the desired add-ons from the store.

Configuration

Each add-on includes specific configuration options to customize its behavior. Please refer to the individual documentation for each add-on in the /docs directory for detailed configuration instructions.

To configure an add-on:

  1. Install the add-on from the Add-on Store.
  2. Click on Configuration in the add-on settings.
  3. Add your custom configuration options.
  4. Save and start the add-on.

Development

Running Locally

You can test and develop new add-ons locally by cloning this repository. Navigate to the individual add-on folder and make any necessary changes. You can run the add-ons within Home Assistant using the local development tools.

Contributing

We welcome contributions from the community! Please submit a pull request with your changes or open an issue to discuss new features, bugs, or improvements.

License

This project is licensed under the Apache 2.0 License. See the LICENSE file for more details.

Support

For any issues, questions, or suggestions, feel free to open an issue in this repository or contact us at support@effortlesshome.co.

Thanks for using EffortlessHome Add-ons! We’re constantly working to improve your home automation experience.