Repository files navigation

Home Assistant uses Bundler, Homebrew and Cocoapods to manage build dependencies. You'll need Xcode 15.3 (or later) which you can download from theApp Store. You can get the app running using the following commands:

git clone https://github.com/home-assistant/iOS.gitcd iOS# you must do one of the following, but you do not need to do all of them:## install cocoapods via homebrew, use thatbrew install cocoapods$(brew --prefix)/opt/ruby/bin/gem install cocoapods-acknowledgementspod install --repo-update## install ruby via homebrew, use thatbrew install ruby@3.1$(brew --prefix)/opt/ruby@3.1/bin/bundle install$(brew --prefix)/opt/ruby@3.1/bin/bundleexec pod install --repo-update## install ruby via rbenv, use thatbrew install rbenv ruby-buildrbenv installbundle installbundleexec pod install --repo-update

Once this completes, you can launchHomeAssistant.xcworkspace and run theApp-Debug scheme onto your simulator or iOS device.

To just test thefrontend, you can use a simulator version built by our GitHub actions.

1. Install Xcode from theApp Store making sure it's at least the version noted above. You do not need to install or run anything else.
2. Launch the simulator at/Applications/Xcode.app/Contents/Developer/Applications/Simulator.app or in Xcode under the Xcode menu > Open Developer Tool.
3. Open a simulator under File > Open Simulator. You can install older versions of iOS in Xcode's Components preferences.
4. Download a simulator build from thethe GitHub action under "Artifacts."
5. Drag the result.app on drop it on top of the simulator.
6. Locate the app on the home screen and click it to launch.

The simulator behaves different than you might expect:

You can now debug the WebView in this simulator build using Safari's Web Inspector:

1. Make sure "Show Develop menu in menu bar" is enabled in Safari's Advanced preferences.
2. Under the Develop menu, expand the "Simulator" menu for the simulator you've opened.
3. Choose the WebView you want to inspect. A new window will open.

Although the app is set up to use Automatic provisioning for Debug builds, you'll need to customize a few of the options. This is because the app makes heavy use of entitlements that require code signing, even for simulator builds.

Edit the fileConfiguration/HomeAssistant.overrides.xcconfig (which will not exist by default and is ignored by git) and add the following:

DEVELOPMENT_TEAM = YourTeamIDBUNDLE_ID_PREFIX = some.bundle.prefix

Xcode should generate provisioning profiles in your Team ID and our configuration will disable features your team doesn't have like Critical Alerts. You can find your Team ID on Apple'sdeveloper portal; it looks something likeABCDEFG123.

Linters run as part of Pull Request checks. Additionally, some linting requirements can be autocorrected.

# checks for linting problems, doesn't fixbundleexec fastlane lint# checks for linting problems and fixes thembundleexec fastlane autocorrect

In the Xcode project, the autocorrectable linters will not modify your source code but will provide warnings. This project uses several linters:

• SwiftFormat
• SwiftLint (for things SwiftFormat doesn't automate)
• Rubocop (largely for Fastlane)
• YamlLint (largely for GitHub Actions)

We useGithub Actions alongsideFastlane to perform continuous integration both by unit testing and deploying toApp Store Connect. Mac Developer ID builds are available as an artifact on every build of master.

Fastlane scripts read from the environment or.env file for configuration like team IDs. See.env.sample for available values.

Although all the deployment is done through Github Actions, you can do it manually throughFastlane:

# creates the builds and uploads to the app store# each save their artifacts to build/bundleexec fastlane mac buildbundleexec fastlane ios build

SeeCONTRIBUTING.md

Apache-2.0

The format and some content of this README.md comes from theSwipeIt project.