add badges and update readme

This commit is contained in:
Nitwel 2023-11-25 19:56:20 +01:00
parent 7b67125d3d
commit 01e4213872
5 changed files with 29 additions and 8 deletions

View File

@ -4,7 +4,7 @@
Immersive Home is project to bring Smart Home and Mixed Reality technologies together for an intuitive and immersive experience.
## Features
## Planned Features
- **Fast and Intuitive control over IoT devices**
- **Live overview over your smart home**
@ -12,6 +12,20 @@ Immersive Home is project to bring Smart Home and Mixed Reality technologies tog
- **Comfortable way of consuming virtual media unobstructed**
- **Advanced automations based on position in room**
## Try it out
<a href="https://github.com/Nitwel/Immersive-Home/releases/latest/download/Android.zip">
<img height="32" src="assets/badges/github.svg" alt="Badge linking to GitHub" />
</a>
<a href="https://nitwel.itch.io/immersive-home">
<img height="32" src="assets/badges/itch.svg" alt="Badge linking to itch.io" />
</a>
<a href="https://sidequestvr.com/app/26827/immersive-home">
<img height="32" src="assets/badges/sidequest.svg" alt="Badge linking to sidequest" />
</a>
## Supported Devices
**Smart Home Platforms**
@ -21,13 +35,11 @@ Immersive Home is project to bring Smart Home and Mixed Reality technologies tog
- Meta Quest 2 / Pro / 3
## Connecting to your Home Assistant Instance
Right now, as a temporary solution, the app will use whatever is saved into your clipboard to connect to your Home Assistant instance.
Format: `ws://<ip/url>:<port>/api/websocket <token>`
Example `ws://192.168.0.31:8123/api/websocket eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiIzZjQ0ZGM2N2Y3YzY0MDc1OGZlMWI2ZjJlNmIxZjRkNSIsImlhdCI6MTY5ODAxMDcyOCwiZXhwIjoyMDEzMzcwNzI4fQ.K6ydLUC-4Q7BNIRCU1nWlI2s6sg9UCiOu-Lpedw2zJc`
Go to the settings tab (the gear icon) and enter the url of your Home Assistant instance.
In order to authenticate, you have to generate a long-lived access token in Home Assistant.
To generate a HASS token, login into your dashboard, click on your name (bottom left), scroll down and create a long-lived access token.
You can check if you are properly connected by opening the settings tab in the app and looking at the bottom right corner.
Finally, click the connect button and you should be connected to your Home Assistant instance.
# 🛠 Development

3
assets/badges/github.svg Normal file
View File

@ -0,0 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:bc2f1211346c35acc90f745a213c60a5cea85103c2f968343b71efb9bb9fc431
size 3592

3
assets/badges/itch.svg Normal file
View File

@ -0,0 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:91017b20e311e26cb71b29b43822ab367fb09e224bae00c917ac3e6e9d10eecf
size 5675

View File

@ -0,0 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:0772af8ab15c2cb8b94ed54b8c7d4f37e577632ddba4b4904e7836e85487ebde
size 3441

View File

@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:1309fa049bf454d264618e50b07881c100bf1b80a5d928fd487537f74076895f
size 3464489
oid sha256:9e25fabb4455ad3207f25fbc1ca0410e44a66ae995241d3a636f457730f50cdf
size 2947483