Add Home Assistant
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 78/100
- Issue type
- Feature
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- javascript
- Domain
- api
Research direction
Start with docs/ADDING_APPS.md, then copy the shape of the gitea definition in src/catalog/apps/batch-19.js, which uses a url field with format: "url". Check the Home Assistant REST docs for the base URL, bearer-token auth and the GET /api/ connection test before writing it. Done when the new app definition is in the most fitting file under src/catalog/apps/, npm run validate and npm test pass, and npm run logos -- <app id> has produced the logo.
Written by the indexing model from the issue text.
Description
Add Home Assistant to the catalog. It's a popular self-hosted app and a good first contribution: Conector already supports apps on your own server through a url field.
API documentation: https://developers.home-assistant.io/docs/api/rest/
What we know so far (check it against the docs before relying on it):
- Base URL:
{url}/api, where{url}is a field withformat: "url"(see thegiteaapp insrc/catalog/apps/batch-19.jsfor an example). - Authentication: A long-lived access token (Profile → Security → Long-lived access tokens), sent as
Authorization: Bearer <token>. - Connection test:
GET /(that is,{url}/api/) answers{"message": "API running."}with a valid token. - What agents could do with it: Call services (lights, scenes, scripts), read entity states and history.
How to add it
- Follow docs/ADDING_APPS.md: add the definition to the most fitting file in
src/catalog/apps/, with help text that leads people to the key in a few numbered steps. - Run
npm run validateandnpm test, and generate the logo withnpm run logos -- <app id>. - If you run Home Assistant yourself, connect it in a local Conector and try a couple of requests from your agent. Say in the pull request what you tested.
Comment here if you'd like to take it, so nobody else starts the same work.
- Dominant language
- JavaScript
- Stars
- 1
- Forks
- 1
- Avg merge
- 1h 50m
- Merged PRs (30d)
- 21
Getting set up
- Ships a Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from Secra-Solutions/Conector
-
Add AudiobookshelfPossibly taken @masyarakatai claimed this 2 days ago. Openapp request good first issue help wanted self-hosted app
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Secra-Solutions/Conector#15 · 1 comment ·
Maintainers usually reply within 1 day
-
Add BookStackPossibly taken @masyarakatai claimed this 2 days ago. Openapp request good first issue help wanted self-hosted app
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Secra-Solutions/Conector#14 · 1 comment ·
Maintainers usually reply within 1 day
-
app request good first issue help wanted self-hosted app
Difficulty 2/5 Half a day Newbie friendliness 72/100
Secra-Solutions/Conector#13 ·
Maintainers usually reply within 1 day
-
app request good first issue help wanted self-hosted app
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
All issues in Secra-Solutions/Conector
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 79/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
highcharts/highcharts-react#594 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
Maintainers usually reply within 1 day