{
    "info": {
        "author": "Stijn Van Campenhout",
        "author_email": "subutux@gmail.com",
        "bugtrack_url": null,
        "classifiers": [],
        "description": "# Homeassistant UI Display\nThis is a UI for [home-assistant](http://home-assistant.io) i've \nwritten for own use. It's main purpose is to be able to control\nhome-assistant from a pi with a touchscreen mounted on the wall.\n\nThis project uses [pygame](http://pygame.org) as backed & the awesome\n[pgu](https://github.com/parogers/pgu) for the GUI. Using a custom theme\n& UI elements, I've tried to mimmick the web ui of home-assistant.\n\n## Screenshot\n![images/screencast.png](images/screencast.gif)\n![images/touchscreen.gif](images/touchscreen.gif)\n\n## features\n* displaying group items\n* switching on/off of lights\n* displaying sensor data\n* Uses EventStream (`/api/stream`) for streaming updates\n* Using `icon_font_to_png` to use the Material Design Icon font on the fly.\n* Cool\n\n## Install\n```bash\n# install the pygame dependencies for compilation.\nsudo apt install python3-pip python3-dev libsdl-image1.2-dev libsdl-mixer1.2-dev  libsdl-ttf2.0-dev libsdl1.2-dev libsmpeg-dev\n# Clone the repo\ngit clone https://github.com/subutux/HUD\n# Install using pip\nsudo pip3 install --process-dependency-links .\n\n# run the help\nhud --help\n```\n### Why `--process-dependency-links`\n\nTo my knowledge, there are no packages for `pygame` and `pgu` in PyPi for\npython3.\n\nThis option uses the `dependency_links` in `setup.py` for getting the tar.gz\nfiles from their repos. It's nasty, I know. Can't help it!\n\n\nSide note: The raspberry pi repos contain a pygame package for python3!\n\n## Configuration\n\nHUD needs a configuration file, ini-style. For Example:\n\n```ini\n[HomeAssistant]\nHost = localhost\nPort = 8123\nKey = my-secret-password\nSSL = False\n[lights]\ngroup=lichten_living\n```\n\nThe first one speaks for itself, home assistant configuration.\n\nThe second one is a group definition. it needs an group entity name\n(for ex. if you have `group.lichten_living` enter `lichten_living`)\nThere can be as many sections as you want, if you have at least one\nHomeAssistant section.\n\n## Auto start\n\nWhen running on a pi, you probably want to auto start hud.\nWhen installing hud, there are some extra files installed:\n\n- /etc/systemd/system/hud.service\n \n  A systemd service for starting up HUD\n- /etc/default/hud.opts\n\n  Your command line parameters for HUD\n- /usr/local/sbin/hud.init\n \n  a workaround for a problem with sseclient in systemd\n\nAbout that last one,This is a work around for a nasty problem with\nSSEClient/requests. The problem was that the requests with\n'stream=True' would'nt initialize when hud is run directly from\nsystemd.\n\nFor some weird reason running hud from this bash'wrapper' fixes\nthe annoyance.\n\nIf someone has any idea why this is, let me know. I'm eager to know.\n\n\n### Enabling service\n\nTo enable the service, run:\n\n```bash\nsudo systemctl enable hud.service\nsudo systemctl daemon-reload\n```\n\n## Arguments\n```\nusage: hud [-h] -c CONFIG [-f /dev/fbX] [-t /dev/input/eventX] [-n]\n           [-H host.name] [-p PORT] [-k KEY] [-s] [-v]\n           [-L {INFO,WARNING,ERROR,CRITICAL,DEBUG}] [-l LOGFILE]\n\nA pygame GUI for Home Assistant.\n\noptional arguments:\n  -h, --help            show this help message and exit\n\nConfiguration:\n  -c CONFIG, --config CONFIG\n                        config file to use\n  -f /dev/fbX, --framebuffer /dev/fbX\n                        Use this framebuffer as output for the UI (defaults to\n                        window mode)\n  -t /dev/input/eventX, --touchscreen /dev/input/eventX\n                        Enable touchscreen integration. Use this as event\n                        input\n  -n, --no-display      We don't have a display. Sets the SDL_VIDEODRIVER to\n                        \"dummy\". Usefull for testing\n\nHomeAssistant:\n  (optional) Parameters to override the config file\n\n  -H host.name, --homeassistant host.name\n                        The location of home-assistant\n  -p PORT, --port PORT  the port to use for home-assistant (default: 8123)\n  -k KEY, --key KEY     The api password to use (default: None)\n  -s, --ssl             Use ssl (default false)\n\nLogging:\n  (optional) Logging settings\n\n  -v, --verbose         Log output\n  -L {INFO,WARNING,ERROR,CRITICAL,DEBUG}, --logLevel {INFO,WARNING,ERROR,CRITICAL,DEBUG}\n                        Log level to use (default: ERROR)\n  -l LOGFILE, --logfile LOGFILE\n                        Instead of logging to stdout, log to this file\n```\n## Disclamer\n\nDon't look at the code, it's ugly! You're always welcome to post a pull request\nto make the code cleaner, or just give me some pointers. I love to learn more!",
        "description_content_type": null,
        "docs_url": null,
        "download_url": "https://github.com/subutux/HUD/tarball/0.3b2",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/subutux/HUD",
        "keywords": "pygame,rpi,ui,touchscreen,homeassistant",
        "license": "MIT",
        "maintainer": null,
        "maintainer_email": null,
        "name": "hud",
        "package_url": "https://pypi.org/project/hud/",
        "platform": "UNKNOWN",
        "project_url": "https://pypi.org/project/hud/",
        "project_urls": {
            "Download": "https://github.com/subutux/HUD/tarball/0.3b2",
            "Homepage": "https://github.com/subutux/HUD"
        },
        "release_url": "https://pypi.org/project/hud/0.3b2/",
        "requires_dist": null,
        "requires_python": null,
        "summary": "Home Assistant UI Display",
        "version": "0.3b2"
    },
    "last_serial": 2430968,
    "releases": {
        "0.3b2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "fa9dc768155ae6f93ad3440fbeec521a",
                    "sha256": "a351bfa132c44c7ac4a1de7275c08613a317a1d68eb4c7ee3482bbc4a6e1b28b"
                },
                "downloads": -1,
                "filename": "hud-0.3b2.tar.gz",
                "has_sig": false,
                "md5_digest": "fa9dc768155ae6f93ad3440fbeec521a",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 293835,
                "upload_time": "2016-10-29T23:43:59",
                "url": "https://files.pythonhosted.org/packages/bd/7b/ec70921b202ae4b15ff9282fa27d6f4ef9860625031f303cf6414d855bfe/hud-0.3b2.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "fa9dc768155ae6f93ad3440fbeec521a",
                "sha256": "a351bfa132c44c7ac4a1de7275c08613a317a1d68eb4c7ee3482bbc4a6e1b28b"
            },
            "downloads": -1,
            "filename": "hud-0.3b2.tar.gz",
            "has_sig": false,
            "md5_digest": "fa9dc768155ae6f93ad3440fbeec521a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 293835,
            "upload_time": "2016-10-29T23:43:59",
            "url": "https://files.pythonhosted.org/packages/bd/7b/ec70921b202ae4b15ff9282fa27d6f4ef9860625031f303cf6414d855bfe/hud-0.3b2.tar.gz"
        }
    ]
}