README.md

Home Assistant Community Add-on: FlexTV

A super-sexy text and voice interface for Plex.

Deprecation warning

This add-on is in a deprecated state!

Upstream Phlex/FlexTV development seem to be halted, and this add-on is not in a working state.

For that reason investing more time and energy in this add-on seems pointless at this point. Therefore this add-on will no longer receive any updates and is deprecated.

About

The purpose of FlexTV is to provide a natural language interface for Home Theater applications - effectively bridging the current gap between commercial AI Solutions like Google Home and personal web applications like Plex.

Installation

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

NOTE: Before you install this add-on you need to install the FlexTV.bundle Plug-in on your Plex server.

1. Search for the "FlexTV" add-on in the Home Assistant add-on store and install it.
2. Install the "FlexTV" add-on.
3. Start the "FlexTV" add-on
4. Check the logs of the "FlexTV" add-on to see if everything went well.
5. Click "OPEN WEB UI" to open the FlexTV website.
6. When you connect you will be asked to log in with your Plex account, you need to do that.

NOTE: Starting the add-on might take a couple of minutes (especially the first time starting the add-on).

NOTE: FlexTV supports controlling it with voice (Google Home), if you want to use that you will need to expose this add-on to the internet since the process of doing so vary from setup to setup, that part is out of the scope for the documentation of this add-on. You should only pursue this if you really know what you are doing.

Configuration

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

Example add-on configuration:

log_level: info
ssl: true
certfile: fullchain.pem
keyfile: privkey.pem

Note: This is just an example, don't copy and past it! Create your own!

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: ssl

Enables/Disables SSL (HTTPS) on the web interface of FlexTV. Set it true to enable it, false otherwise.

Option: certfile

The certificate file to use for SSL.

Note: The file MUST be stored in /ssl/, which is the default

Option: keyfile

The private key file to use for SSL.

Note: The file MUST be stored in /ssl/, which is the default

Embedding into Home Assistant

It is possible to embed FlexTV directly into Home Assistant, allowing you to access your FlexTV through the Home Assistant frontend.

Home Assistant provides the panel_iframe integration, for these purposes.

Example configuration:

panel_iframe:
  phlex:
    title: FlexTV
    icon: mdi:microphone
    url: http://addres.to.your.home.assistant:1778

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:

• The Home Assistant Community Add-ons Discord chat server for add-on support and feature requests.
• The Home Assistant Discord chat server for general Home Assistant discussions and questions.
• The Home Assistant Community Forum.
• Join the Reddit subreddit in /r/homeassistant

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 Joakim Sørensen.

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

We have got some Home Assistant add-ons for you

Want some more functionality to your Home Assistant instance?

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

License

MIT License

Copyright (c) 2018-2020 Joakim Sørensen

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.