Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
mikejgray committed Feb 8, 2025
1 parent 98b77a8 commit 25fa27f
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The PHAL Plugin provides GUI interfaces and API for Home Assistant Instants.

NOTE: this plugin is roadmapped for merging with https://github.com/OpenVoiceOS/ovos-PHAL-plugin-commonIOT for ovos-core release 0.0.9, the UI will become IOT framework agnostic
NOTE: this plugin will be merged with its companion skill and archived in the future.

# Demo GIF

Expand Down Expand Up @@ -91,6 +91,12 @@ The plugin is in early development, so there are some features that are not yet
- Binary Sensor
- Sensor

### Troubleshooting

The websocket API does not expose entity information in the same way as the REST API, so some friendly names and aliases (especially for Assist) will not be available. PRs welcome to work around this limitation. Otherwise, we recommend using the REST API instead of the Websocket API.

To switch to the REST API, change the URL in the config to `https://yoururl.toinstance` instead of `wss://yoururl.toinstance`.

---

#### BUS API (For Other Plugins / GUIs) - WIP / TODO Documentation
Expand Down

0 comments on commit 25fa27f

Please sign in to comment.