A super-sexy text and voice interface for Plex.
The purpose of Phlex 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.
The installation of this add-on is pretty straightforward and not different in comparison to installing any other Hass.io add-on.
NOTE: Before you install this add-on you need to install the Cast.bundle Plug-in on your Plex server, to get started with that have a look at their documentation here.
- Add our Hass.io add-ons repository to your Hass.io instance.
- Install the "Phlex" add-on.
- Start the "Phlex" add-on
- Check the logs of the "Phlex" add-on to see if everything went well.
- Click "OPEN WEB UI" to open the Phlex website.
- 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: Phlex 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.
NOTE: Do not add this repository to Hass.io, please use:
https://github.com/hassio-addons/repository.
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!
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.
Enables/Disables SSL (HTTPS) on the web interface of Phlex. Set it true
to enable it, false otherwise.
The certificate file to use for SSL.
Note: The file MUST be stored in /ssl/, which is the default for Hass.io
The private key file to use for SSL.
Note: The file MUST be stored in /ssl/, which is the default for Hass.io
It is possible to embed Phlex directly into Home Assistant, allowing you to access your Phlex through the Home Assistant frontend.
Home Assistant provides the panel_iframe component, for these purposes.
Example configuration:
panel_iframe:
phlex:
title: Phlex
icon: mdi:microphone
url: http://addres.to.your.hass.io:1778This 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.
Got questions?
You have several options to get them answered:
- The Community Hass.io 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.
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! 😍
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.
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.
MIT License
Copyright (c) 2018-2019 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.