Lovelace Migration - Community Hass.io Add-on for Home Assistant
Switch branches/tags
Clone or download

README.md

Community Hass.io Add-ons: Lovelace Migration

GitHub Release Project Stage License

GitLab CI Project Maintenance GitHub Activity

Bountysource Discord Community Forum

Buy me a coffee

This add-on automatically converts your existing UI to the new Lovelace UI.

About

The new Lovelace UI for Home Assistant is here, and it is extremely fast, extremely customizable and extremely extensible.

Building the Lovelace UI configuration from scratch can be a bit of a daunting task, so this add-on helps create a starting point to work from. In most cases you will only need to run this add-on once, but if ever you do you need to run it again, backups of your existing ui-lovelace.yaml file are automatically created and maintained.

Click here to read more about Lovelace UI

Installation

The installation of this add-on is pretty straightforward and not different in comparison to installing any other Hass.io add-on.

  1. Add our Hass.io add-ons repository to your Hass.io instance.
  2. Install the "Lovelace Migration" add-on
  3. Start the "Lovelace Migration" add-on
  4. Navigate to http://your.domain.com:8123/lovelace to see the new UI.

NOTE: Do not add this repository to Hass.io, please use: https://github.com/hassio-addons/repository.

Docker status

Supports armhf Architecture Supports aarch64 Architecture Supports amd64 Architecture Supports i386 Architecture

Docker Version Docker Layers Docker Pulls

Configuration

Even though this add-on is just a basic add-on, it does come with some configuration options to play around with.

Note: Remember to restart the add-on when the configuration is changed.

Lovelace Migration add-on configuration:

{
  "log_level": "info",
  "output": "/config/ui-lovelace.yaml",
  "auto_backups": true,
  "init_commands": [],
  "post_commands": []
}

Option: log_level

The log_level option controls the level of log output by the addon and can be changed to be more or less verbose, which might be useful when you are dealing with an unknown issue. Possible values are:

  • trace: Show every detail, like all called internal functions.
  • debug: Shows detailed debug information.
  • info: Normal (usually) interesting events.
  • warning: Exceptional occurrences that are not errors.
  • error: Runtime errors that do not require immediate action.
  • fatal: Something went terribly wrong. Add-on becomes unusable.

Please note that each level automatically includes log messages from a more severe level, e.g., debug also shows info messages. By default, the log_level is set to info, which is the recommended setting unless you are troubleshooting.

Option: output

Sets the output file location of the Lovelace config. If the file exists, it will automatically be backed up. This value is set to /config/ui-lovelace.yaml by default.

Option: auto_backups

This option allows you to enable/disable automated backups. Each time the add-on runs, it will ensure your existing Lovelace configuration is stored safely in the /backups/lovelace-migration folder.

Option: init_commands

These commands are executed before the Lovelace config file is generated. This is useful if you want to keep the backup files in a separate location.

Option: post_commands

These commands are executed after the Lovelace config file is generated. This is useful if you want to keep the backup files in a separate location.

Changelog & Releases

This repository keeps a change log using GitHub's releases functionality. The format of the log is based on Keep a Changelog.

Releases are based on Semantic Versioning, and use the format of MAJOR.MINOR.PATCH. In a nutshell, the version will be incremented based on the following:

  • MAJOR: Incompatible or major changes.
  • MINOR: Backwards-compatible new features and enhancements.
  • PATCH: Backwards-compatible bugfixes and package updates.

Support

Got questions?

You have several options to get them answered:

You could also open an issue here GitHub.

Contributing

This is an active open-source project. We are always open to people who want to use the code or contribute to it.

We have set up a separate document containing our contribution guidelines.

Thank you for being involved! 😍

Authors & contributors

The original setup of this repository is by Dale Higgs.

For a full list of all authors and contributors, check the contributor's page.

We have got some Hass.io add-ons for you

Want some more functionality to your Hass.io Home Assistant instance?

We have created multiple add-ons for Hass.io. For a full list, check out our GitHub Repository.

License

MIT License

Copyright (c) 2018 Dale Higgs

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.