home-assistant.github.io/source/_ecosystem/ios/component.markdown
2016-10-26 17:38:58 -07:00

1.8 KiB

layout title description release_date sidebar comments sharing footer
page Home Assistant for iOS Documentation about the Home Assistant iOS app. 2016-10-24 15:00:00 -0700 true false true true

The ios component is the companion component for the Home Assistant iOS app. While not required, adding the ios component to your setup will greatly enhance the iOS app with new notification, location and sensor functions not possible with a standalone app.

Loading the ios component will also load the device_tracker and zeroconf components. It also provides functionality required for the iOS notify platform but will not automatically load the notify component or platform as of 0.31.1. You must manually load it. See the iOS notify platform for more information.

{% linkable_title Setup %}

Automated Setup

The ios component will automatically be loaded under the following circumstances:

  1. The discovery component is enabled.
  2. You have just installed the app and are at the getting started screen.

Automated discovery and component loaded can only happen at first install of the app. You may need to wait a few minutes for the iOS component to load as the discovery component only scans the network every 5 minutes.

Manual Setup

You may also manually load the ios component by adding the following to your configuration:

# Example configuration.yaml entry
ios:

Configuration variables:

  • push (Optional): Push notification configuration. See the iOS notify platform for more information.