mobile/home-assistant-android
mobile/home-assistant-android
1
0
Fork 0
mirror of https://github.com/home-assistant/android synced 2024-10-15 12:32:54 +00:00
Code Issues Packages Projects Releases Wiki Activity
119 commits 4 branches 1496 tags 88 MiB
Kotlin 99.9%
Ruby 0.1%
Find a file
Kevin T. Berstene 4f6b93ea4c
Reworked widget appearance and added resizability. (#401)
2020-02-13 00:58:48 -05:00
.github Add note to check companion docs (#361) 2020-02-10 13:00:09 -08:00
.travis Don't need to create debug directory anymore. (#294) 2020-01-23 08:26:54 -05:00
app Reworked widget appearance and added resizability. (#401) 2020-02-13 00:58:48 -05:00
common Added dynamic auto-complete fields for widget configuration (#339) 2020-02-07 20:47:26 -05:00
data Make sure registration is required. (#370) 2020-02-11 08:55:26 -08:00
domain Sensor Support (#336) 2020-02-10 23:49:39 -05:00
gradle Update jackson dependency (#69) 2019-11-26 09:34:04 +01:00
.gitignore Alpha application (#4) 2019-11-02 06:38:40 -07:00
.travis.yml The version code is stuck at 50 (#179) 2019-12-19 14:02:59 -05:00
build.gradle Reload UI url more proactively (#275) 2020-01-19 13:51:10 -08:00
CLA.md Add required documents 2019-04-01 22:52:24 -07:00
CODE_OF_CONDUCT.md Add required documents 2019-04-01 22:52:24 -07:00
gradle.properties Initial commit 2019-04-01 22:52:08 -07:00
gradlew Initial commit 2019-04-01 22:52:08 -07:00
gradlew.bat Initial commit 2019-04-01 22:52:08 -07:00
LICENSE.md Add required documents 2019-04-01 22:52:24 -07:00
README.md Add note about the google-services.json needing both client IDs 2020-02-12 14:57:34 -08:00
settings.gradle [ARCHITECTURE] Let's do some quality (#15) 2019-11-10 13:07:38 -08:00

README.md

📱 Home Assistant Companion for Android Build Status

Documentation

If you are looking for documentation around the companion applications check out the Home Assistant Companion Documentation. This will give you instructions on using the applications.

Setup Development Environment

  • Download and install Android Studio

  • Create a Firebase project at Firebase Console

  • Add an Android app to your Firebase project, follow the on screen instruction download the google-services.json to your home-assistant-Android/app folder.

    The file should contain client IDs for io.homeassistant.companion.android and io.homeassistant.companion.android.debug for debugging to work properly.

    You can use the mock services file instead of generating your own.

  • Use Android Studio open your source code folder and click Run -> Run 'app'

  • Connect your phone or create a new virtual device following on screen instruction

  • 🎉

Testing Dev Releases

We are using Travis to perform continuous integration both by unit testing, deploying dev releases to Firebase App Distribution and final releases to the Play Store when we add a git tag.

Quality

We are using ktlint as our linter. You can run a check locally on your machine with:

./gradlew ktlintCheck

This commands runs on our CI to check if your PR passes all tests. So we strongly recommend running it before committing.

To run a check with an auto-format:

./gradlew ktlintFormat

Translating

The project currently uses lokalise to translate the application. If you are interested in helping translate go the the link and click start translating!