[{"_1":2,"_153":-5,"_154":-5},"loaderData",{"_3":4,"_13":14,"_21":22,"_132":133},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","routes/_layout",{"_15":-5,"_16":17,"_18":17,"_19":11,"_20":11},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_23":24,"_25":-5,"_26":11,"_27":11,"_28":29,"_30":31,"_32":-5,"_33":11,"_34":35,"_84":-5,"_85":86,"_125":-5,"_126":11,"_127":17,"_128":11,"_129":-5,"_130":131},"canonicalUrl","https://hub.docker.com/r/mezz64/appdaemon-testing/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","mezz64","reponame","appdaemon-testing","cloudBuildSource","isAutobuildsAvailable","repo",{"_36":37,"_38":39,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":51,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":58,"_65":66,"_67":11,"_68":29,"_69":70,"_75":17,"_76":77,"_81":29,"_82":83},"categories",[],"content_types",[40],"image","date_registered","2017-07-12T03:41:08.42448Z","description","Testing repository for appdaemon modifications.","is_private","last_updated","2017-07-22T05:02:29.607564Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[52],"application/vnd.docker.container.image.v1+json","name","pull_count",124,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","Description\n===========\n\nAppDaemon is a loosely coupled, multithreaded, sandboxed python\nexecution environment for writing automation apps for `Home\nAssistant `__ home automation software. As\nof release 2,0,0 it also provides a configurable dashboard (HADashboard)\nsuitable for wall mounted tablets.\n\nInstallation\n============\n\nInstallation is either by pip3 or Docker.\n\nInstall and Run using Docker\n============================\n\nFollow the instructions in `DOCKER\\_TURORIAL.md `__\n\nInstall Using pip3\n==================\n\n\nBefore running ``AppDaemon`` you will need to install the package:\n\n.. code:: bash\n\n $ sudo pip3 install appdaemon\n\nConfiguration\n=============\n\nWhen you have appdaemon installed by either method you are ready to start working on the appdaemon.yaml file. For docker users, you will already have a skeleton to work with. For pip users, you need to create a configuration directory somewhere (e.g. ``/home/homeassistant/conf``) and create a file in there called ``appdaemon.yaml``.\n\nYour initial file should look something like this:\n\n.. code:: yaml\n\n\n AppDaemon:\n logfile: STDOUT\n errorfile: STDERR\n threads: 10\n cert_path: \n cert_verify: True\n time_zone: \n HASS:\n ha_url: \n ha_key: \n\n # Apps\n hello_world:\n module: hello\n class: HelloWorld\n\n- ``ha_url`` is a reference to your home assistant installation and\n must include the correct port number and scheme (``http://`` or\n ``https://`` as appropriate)\n- ``ha_key`` should be set to your key if you have one, otherwise it\n can be removed.\n- ``logfile`` (optional) is the path to where you want ``AppDaemon`` to\n keep its main log. When run from the command line this is not used -\n log messages come out on the terminal. When running as a daemon this\n is where the log information will go. In the example above I created\n a directory specifically for AppDaemon to run from, although there is\n no reason you can't keep it in the ``appdaemon`` directory of the\n cloned repository. If ``logfile = STDOUT``, output will be sent to\n stdout instead of stderr when running in the foreground, if not\n specified, output will be sent to STDOUT.\n- ``errorfile`` (optional) is the name of the logfile for errors - this\n will usually be errors during compilation and execution of the apps.\n If ``errorfile = STDERR`` errors will be sent to stderr instead of a\n file, if not specified, output will be sent to STDERR.\n- ``threads`` - the number of dedicated worker threads to create for\n running the apps. Note, this will bear no resembelance to the number\n of apps you have, the threads are re-used and only active for as long\n as required to tun a particular callback or initialization, leave\n this set to 10 unless you experience thread starvation\n- ``cert_path`` (optional) - path to root CA cert directory - use only\n if you are using self signed certs.\n- ``cert_verify`` (optional) - flag for cert verification - set to\n ``False`` to disable verification on self signed certs.\n- ``time_zone`` (optional) - timezone for AppDaemon to use. If not\n specified, AppDaemon will query the timezone from Home Assistant\n\nOptionally, you can place your apps in a directory other than under the\nconfig directory using the ``app_dir`` directive.\n\ne.g.:\n\n.. code:: ini\n\n app_dir = /etc/appdaemon/apps\n\nConfiguring a Test App\n----------------------\n\nThe ``#Apps`` section is the configuration for the Hello World program\nand should be left in place for initial testing but can be removed later\nif desired, as other Apps are added, App configuration is fully described in\nthe `API doc `__.\n\nTo add an initial test app to match the configuration above, we need to first create an ``apps`` subdirectory under the conf directory. Then create a file in the `apps` directory called ``hello.py``, and paste the followinginto it using your favorite text editor:\n\n.. code:: python\n\n import appdaemon.appapi as appapi\n\n #\n # Hello World App\n #\n # Args:\n #\n\n class HelloWorld(appapi.AppDaemon):\n\n def initialize(self):\n self.log(\"Hello from AppDaemon\")\n self.log(\"You are now ready to run Apps!\")\n\nWith this app in place we will be able to test the App part of AppDaemon when we first run it.\n\nConfiguring the Dashboard\n-------------------------\n\nConfiguration of the dashboard component (HADashboard) is described\nseparately in the `Dashboard doc `__\n\n\nExample Apps\n============\n\nThere are a number of example apps under ``conf/examples`` in the git repository, and the\n``conf/examples.yaml`` file gives sample parameters for them.\n\nRunning\n=======\n\nDocker\n------\n\nAssuming you have set the config up as described in the tutotial for Docker, you should see the logs output as follows:\n\n.. code:: bash\n\n $ docker logs appdaemon\n 2016-08-22 10:08:16,575 INFO Got initial state\n 2016-08-22 10:08:16,576 INFO Loading Module: /export/hass/appdaemon_test/conf/apps/hello.py\n 2016-08-22 10:08:16,578 INFO Loading Object hello_world using class HelloWorld from module hello\n 2016-08-22 10:08:16,580 INFO Hello from AppDaemon\n 2016-08-22 10:08:16,584 INFO You are now ready to run Apps!\n\nNote that for Docker, the error and regular logs are combined.\n\nPIP3\n----\n\nYou can run AppDaemon from the command line as follows:\n\n.. code:: bash\n\n $ appdaemon -c /home/homeassistant/conf\n\nIf all is well, you should see something like the following:\n\n::\n\n $ appdaemon -c /home/homeassistant/conf\n 2016-08-22 10:08:16,575 INFO Got initial state\n 2016-08-22 10:08:16,576 INFO Loading Module: /home/homeassistant/conf/apps/hello.py\n 2016-08-22 10:08:16,578 INFO Loading Object hello_world using class HelloWorld from module hello\n 2016-08-22 10:08:16,580 INFO Hello from AppDaemon\n 2016-08-22 10:08:16,584 INFO You are now ready to run Apps!\n\nAppDaemon arguments\n===================\n\n::\n\n usage: appdaemon [-h] [-c CONFIG] [-p PIDFILE] [-t TICK] [-s STARTTIME]\n [-e ENDTIME] [-i INTERVAL]\n [-D {DEBUG,INFO,WARNING,ERROR,CRITICAL}] [-v] [-d]\n\n optional arguments:\n -h, --help show this help message and exit\n -c CONFIG, --config CONFIG\n full path to config diectory\n -p PIDFILE, --pidfile PIDFILE\n full path to PID File\n -t TICK, --tick TICK time in seconds that a tick in the schedular lasts\n -s STARTTIME, --starttime STARTTIME\n start time for scheduler \n -e ENDTIME, --endtime ENDTIME\n end time for scheduler \n -i INTERVAL, --interval INTERVAL\n multiplier for scheduler tick\n -D {DEBUG,INFO,WARNING,ERROR,CRITICAL}, --debug {DEBUG,INFO,WARNING,ERROR,CRITICAL}\n debug level\n -v, --version show program's version number and exit\n -d, --daemon run as a background process\n\n-c is the path to the configuration directory. If not specified,\nAppDaemon will look for a file named ``appdaemon.cfg`` first in\n``~/.homeassistant`` then in ``/etc/appdaemon``. If the directory is not\nspecified and it is not found in either location, AppDaemon will raise\nan exception. In addition, AppDaemon expects to find a dir named\n``apps`` immediately subordinate to the config directory.\n\n-d and -p are used by the init file to start the process as a daemon and\nare not required if running from the command line.\n\n-D can be used to increase the debug level for internal AppDaemon\noperations as well as apps using the logging function.\n\nThe -s, -i, -t and -s options are for the Time Travel feature and should\nonly be used for testing. They are described in more detail in the API\ndocumentation.\n\nLegacy Configuration\n====================\n\nAppDaemon also currently supports a legacy ``ini`` style of\nconfiguration and it is shown here for backward compatibility. It is\nrecommended that you move to the YAML format using the provided tool.\nWhen using the legacy configuration style, there are no ``HASS`` or\n``HADashboard`` sections - the associated directives all go in the\n``AppDaemon`` section.\n\n.. code:: ini\n\n [AppDaemon]\n ha_url = \n ha_key = \n logfile = STDOUT\n errorfile = STDERR\n threads = 10\n cert_path = \n cert_verify = True\n # Apps\n [hello_world]\n module = hello\n class = HelloWorld\n\nIf you want to move from the legacy ``ini`` style of configuration to\nYAML, AppDaemon is able to do this for you. From the command line run:\n\n.. code:: bash\n\n $ appdaemon -c CONFIG --convertcfg\n Converting /etc/appdaemon/appdaemon.cfg to /etc/appdaemon/appdaemon.yaml\n $\n\nAppDaemon should correctly figure out where the file is to convert form\nyour existing configuration. After conversion, the new YAML file will be\nused in preference to the old ini file, which can then be removed if\ndesired.\n\nNote: any lines in the ini file that are commented out, whether actual\ncomments of lines that are not active, will not be converted. Note 2:\nDocker users will unfortunately need to perform the conversion manually.\n\nStarting At Reboot\n==================\n\nTo run ``AppDaemon`` at reboot, you can set it up to run as a systemd\nservice as follows.\n\nAdd Systemd Service (appdaemon@appdaemon.service)\n-------------------------------------------------\n\nFirst, create a new file using vi:\n\n::\n\n $ sudo vi /etc/systemd/system/appdaemon@appdaemon.service\n\nAdd the following, making sure to use the correct full path for your\nconfig directory. Also make sure you edit the ``User`` to a valid user\nto run AppDaemon, usually the same user as you are running Home\nAssistant with is a good choice.\n\n::\n\n [Unit]\n Description=AppDaemon\n After=home-assistant@homeassistant.service\n [Service]\n Type=simple\n User=hass\n ExecStart=/usr/local/bin/appdaemon -c \n [Install]\n WantedBy=multi-user.target\n\n- The above should work for hasbian, but if your homeassistant service\n is named something different you may need to change the ``After=``\n lines to reflect the actual name.\n\nActivate Systemd Service\n------------------------\n\n::\n\n $ sudo systemctl daemon-reload\n $ sudo systemctl enable appdaemon@appdaemon.service --now\n\nNow AppDaemon should be up and running and good to go.\n\nOperation\n=========\n\nSince AppDaemon under the covers uses the exact same APIs as the\nfrontend UI, you typically see it react at about the same time to a\ngiven event. Calling back to Home Assistant is also pretty fast\nespecially if they are running on the same machine. In action, observed\nlatency above the built in automation component is usually sub-second.\n\nUpdating AppDaemon\n==================\n\nTo update AppDaemon after new code has been released, just run the\nfollowing command to update your copy:\n\n.. code:: bash\n\n $ sudo pip3 install --upgrade appdaemon\n\nIf you are using docker, refer to the steps in the tutorial.\n\nWindows Support\n===============\n\nAppDaemon runs under windows and has been tested with the official 3.5.2\nrelease. There are a couple of caveats however:\n\n- The ``-d`` or ``--daemonize`` option is not supported owing to\n limitations in the Windows implementation of Python.\n- Some internal diagnostics are disabled. This is not user visible but\n may hamper troubleshooting of internal issues if any crop up\n\nAppDaemon can be installed exactly as per the instructions for every\nother version using pip3.\n\nWindows Under the Linux Subsystem\n=================================\n\nWindows 10 now supports a full Linux bash environment that is capable of\nrunning Python. This is essentially an Ubuntu distribution and works\nextremely well. It is possible to run AppDaemon in exactly the same way\nas for Linux distributions, and none of the above Windows Caveats apply\nto this version. This is the reccomended way to run AppDaemon in a\nWindows 10 and later environment.","has_starred","hub_user","immutable_tags_settings",{"_71":11,"_72":73},"enabled","rules",[74],".*","is_automated","permissions",{"_78":17,"_79":11,"_80":11},"read","write","admin","user","storage_size",360979439,"orgData","recentTags",[87],{"_88":40,"_89":90,"_91":92,"_93":94,"_95":96,"_46":114,"_115":90,"_116":29,"_117":52,"_53":118,"_119":120,"_121":105,"_122":114,"_123":62,"_124":17},"content_type","creator",99977,"full_size",293900573,"id",12840272,"images",[97],{"_98":99,"_100":101,"_102":103,"_104":105,"_106":107,"_108":109,"_110":103,"_111":-5,"_112":92,"_59":62,"_113":-5},"architecture","amd64","digest","sha256:82f16b942735d48a8dd6c8b0bf6d8a1e18f95e7398235ac61b8d30ee8462c5fb","features","","last_pulled","2026-09-02T17:03:11.039043026Z","last_pushed","2017-07-22T05:02:30Z","os","linux","os_features","os_version","size","variant","2017-07-22T05:02:29.149359Z","last_updater","last_updater_username","media_type","rss","repository",1643947,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"routes/_layout.r.$namespace.$reponame.tags",{"_34":134,"_141":142,"_130":151,"_152":11},{"_36":135,"_38":136,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":137,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":58,"_65":66,"_67":11,"_68":29,"_69":138,"_75":17,"_76":140,"_81":29,"_82":83},[],[40],[52],{"_71":11,"_72":139},[74],{"_78":17,"_79":11,"_80":11},"tags",{"_143":60,"_144":-5,"_145":-5,"_146":147},"count","next","previous","results",[148],{"_88":40,"_89":90,"_91":92,"_93":94,"_95":149,"_46":114,"_115":90,"_116":29,"_117":52,"_53":118,"_119":120,"_121":105,"_122":114,"_123":62,"_124":17},[150],{"_98":99,"_100":101,"_102":103,"_104":105,"_106":107,"_108":109,"_110":103,"_111":-5,"_112":92,"_59":62,"_113":-5},[],"canDeleteTags","actionData","errors"]

mezz64/appdaemon-testing

Tags for mezz64/appdaemon-testing