mirror of
https://github.com/home-assistant/iOS.git
synced 2026-06-17 17:49:07 -05:00
f46d317c56
<!-- Thank you for submitting a Pull Request and helping to improve Home Assistant. Please complete the following sections to help the processing and review of your changes. Please do not delete anything from this template. --> ## Summary <!-- Provide a brief summary of the changes you have made and most importantly what they aim to achieve --> Adds the OHF badge to the README ## Screenshots <!-- If this is a user-facing change not in the frontend, please include screenshots in light and dark mode. --> ## Link to pull request in Documentation repository <!-- Pull requests that add, change or remove functionality must have a corresponding pull request in the Companion App Documentation repository (https://github.com/home-assistant/companion.home-assistant). Please add the number of this pull request after the "#" --> Documentation: home-assistant/companion.home-assistant# ## Any other notes <!-- If there is any other information of note, like if this Pull Request is part of a bigger change, please include it here. -->
133 lines
5.9 KiB
Markdown
133 lines
5.9 KiB
Markdown
Home Assistant for Apple Platforms
|
|
=================
|
|
|
|
[](https://www.home-assistant.io/ios/beta/)
|
|
[](https://itunes.apple.com/app/home-assistant-open-source-home-automation/id1099568401)
|
|
[](https://github.com/home-assistant/iOS/issues)
|
|
[](https://github.com/home-assistant/iOS/blob/master/LICENSE)
|
|
|
|
## Getting Started
|
|
|
|
Home Assistant uses Bundler, Homebrew and Cocoapods to manage build dependencies. You'll need Xcode 15.3 (or later) which you can download from the [App Store](https://developer.apple.com/download/). You can get the app running using the following commands:
|
|
|
|
```bash
|
|
git clone https://github.com/home-assistant/iOS.git
|
|
cd iOS
|
|
|
|
# you must do one of the following, but you do not need to do all of them:
|
|
|
|
## install cocoapods via homebrew, use that
|
|
brew install cocoapods
|
|
$(brew --prefix)/opt/ruby/bin/gem install cocoapods-acknowledgements
|
|
pod install --repo-update
|
|
|
|
## install ruby via homebrew, use that
|
|
brew install ruby@3.1
|
|
$(brew --prefix)/opt/ruby@3.1/bin/bundle install
|
|
$(brew --prefix)/opt/ruby@3.1/bin/bundle exec pod install --repo-update
|
|
|
|
## install ruby via rbenv, use that
|
|
brew install rbenv ruby-build
|
|
rbenv install
|
|
bundle install
|
|
bundle exec pod install --repo-update
|
|
```
|
|
|
|
Once this completes, you can launch `HomeAssistant.xcworkspace` and run the `App-Debug` scheme onto your simulator or iOS device.
|
|
|
|
## Testing just the frontend
|
|
|
|
To just test the [frontend](https://github.com/home-assistant/frontend), you can use a simulator version built by our GitHub actions.
|
|
|
|
1. Install Xcode from the [App Store](https://developer.apple.com/download/) 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 the [the GitHub action](https://github.com/home-assistant/iOS/actions/workflows/ci.yml?query=branch%3Amaster) 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:
|
|
|
|
| Action | Effect |
|
|
| -- | -- |
|
|
| Click | Tap |
|
|
| Click & drag | Scroll |
|
|
| Hold ⌥ | Add a second touch point |
|
|
| Hold ⇧⌥ | Move both touch points |
|
|
| ⌘←, ⌘→ | Rotate |
|
|
| ⌘S | Take screenshot |
|
|
| ⌘R | Record video |
|
|
| ⌘K | Toggle software keyboard |
|
|
|
|
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.
|
|
|
|
## Code Signing
|
|
|
|
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 file `Configuration/HomeAssistant.overrides.xcconfig` (which will not exist by default and is ignored by git) and add the following:
|
|
|
|
```bash
|
|
DEVELOPMENT_TEAM = YourTeamID
|
|
BUNDLE_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's [developer portal](https://developer.apple.com/account); it looks something like `ABCDEFG123`.
|
|
|
|
## Code style
|
|
|
|
Linters run as part of Pull Request checks. Additionally, some linting requirements can be autocorrected.
|
|
|
|
```bash
|
|
# checks for linting problems, doesn't fix
|
|
bundle exec fastlane lint
|
|
# checks for linting problems and fixes them
|
|
bundle exec 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](https://github.com/nicklockwood/SwiftFormat)
|
|
- [SwiftLint](https://github.com/realm/swiftlint) (for things SwiftFormat doesn't automate)
|
|
- [Rubocop](https://rubocop.org) (largely for Fastlane)
|
|
- [YamlLint](https://yamllint.readthedocs.io/en/stable/index.html) (largely for GitHub Actions)
|
|
|
|
## Continuous Integration
|
|
|
|
We use [Github Actions](https://github.com/home-assistant/iOS/actions) alongside [Fastlane](https://fastlane.tools/) to perform continuous integration both by unit testing and deploying to [App Store Connect](https://appstoreconnect.apple.com). Mac Developer ID builds are available as an artifact on every build of master.
|
|
|
|
### Environment variables
|
|
|
|
Fastlane scripts read from the environment or `.env` file for configuration like team IDs. See [`.env.sample`](https://github.com/home-assistant/iOS/blob/master/.env.sample) for available values.
|
|
|
|
### Deployment
|
|
|
|
Although all the deployment is done through Github Actions, you can do it manually through [Fastlane](https://github.com/home-assistant/iOS/blob/master/fastlane/README.md):
|
|
|
|
### Deployment to App Store Connect
|
|
|
|
```bash
|
|
# creates the builds and uploads to the app store
|
|
# each save their artifacts to build/
|
|
bundle exec fastlane mac build
|
|
bundle exec fastlane ios build
|
|
```
|
|
|
|
## Contributing
|
|
|
|
See [CONTRIBUTING.md](CONTRIBUTING.md)
|
|
|
|
## LICENSE
|
|
|
|
Apache-2.0
|
|
|
|
## Credits
|
|
|
|
The format and some content of this README.md comes from the [SwipeIt](https://github.com/ivanbruel/SwipeIt) project.
|
|
|
|
[](https://www.openhomefoundation.org/)
|