Merge pull request #376 from balloob/launchd

launchd Script for Starting at Boot and Backgrounding on OS X

homeassistant/__main__.py

@@ -95,6 +95,14 @@ def get_arguments():
         type=int,
         default=None,
         help='Enables daily log rotation and keeps up to the specified days')
+    parser.add_argument(
+        '--install-osx',
+        action='store_true',
+        help='Installs as a service on OS X and loads on boot.')
+    parser.add_argument(
+        '--uninstall-osx',
+        action='store_true',
+        help='Uninstalls from OS X.')
     if os.name != "nt":
         parser.add_argument(
             '--daemon',
@@ -152,6 +160,46 @@ def write_pid(pid_file):
         sys.exit(1)
 
 
+def install_osx():
+    """ Setup to run via launchd on OS X """
+    with os.popen('which hass') as inp:
+        hass_path = inp.read().strip()
+
+    with os.popen('whoami') as inp:
+        user = inp.read().strip()
+
+    cwd = os.path.dirname(__file__)
+    template_path = os.path.join(cwd, 'startup', 'launchd.plist')
+
+    with open(template_path, 'r', encoding='utf-8') as inp:
+        plist = inp.read()
+
+    plist = plist.replace("$HASS_PATH$", hass_path)
+    plist = plist.replace("$USER$", user)
+
+    path = os.path.expanduser("~/Library/LaunchAgents/org.homeassistant.plist")
+
+    try:
+        with open(path, 'w', encoding='utf-8') as outp:
+            outp.write(plist)
+    except IOError as err:
+        print('Unable to write to ' + path, err)
+        return
+
+    os.popen('launchctl load -w -F ' + path)
+
+    print("Home Assistant has been installed. \
+        Open it here: http://localhost:8123")
+
+
+def uninstall_osx():
+    """ Unload from launchd on OS X """
+    path = os.path.expanduser("~/Library/LaunchAgents/org.homeassistant.plist")
+    os.popen('launchctl unload ' + path)
+
+    print("Home Assistant has been uninstalled.")
+
+
 def main():
     """ Starts Home Assistant. """
     validate_python()
@@ -161,6 +209,14 @@ def main():
     config_dir = os.path.join(os.getcwd(), args.config)
     ensure_config_path(config_dir)
 
+    # os x launchd functions
+    if args.install_osx:
+        install_osx()
+        return
+    if args.uninstall_osx:
+        uninstall_osx()
+        return
+
     # daemon functions
     if args.pid_file:
         check_pid(args.pid_file)

homeassistant/startup/launchd.plist

@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+  <dict>
+    <key>Label</key>
+    <string>org.homeassitant</string>
+
+    <key>EnvironmentVariables</key>
+    <dict>
+      <key>PATH</key>
+      <string>/usr/local/bin/:/usr/bin:$PATH</string>
+    </dict>
+
+    <key>Program</key>
+    <string>$HASS_PATH$</string>
+
+    <key>AbandonProcessGroup</key>
+    <false/>
+
+    <key>RunAtLoad</key>
+    <true/>
+
+    <key>KeepAlive</key>
+    <dict>
+      <key>SuccessfulExit</key>
+      <false/>
+    </dict>
+
+    <key>StandardErrorPath</key>
+    <string>/Users/$USER$/Library/Logs/homeassitant.log</string>
+
+    <key>StandardOutPath</key>
+    <string>/Users/$USER$/Library/Logs/homeassitant.log</string>
+
+  </dict>
+</plist>

setup.py

@@ -12,7 +12,8 @@ PACKAGES = find_packages(exclude=['tests', 'tests.*'])
 PACKAGE_DATA = \
     {'homeassistant.components.frontend': ['index.html.template'],
      'homeassistant.components.frontend.www_static': ['*.*'],
-     'homeassistant.components.frontend.www_static.images': ['*.*']}
+     'homeassistant.components.frontend.www_static.images': ['*.*'],
+     'homeassistant.startup': ['*.*']}
 
 REQUIRES = [
     'requests>=2,<3',