https://github.com/bendikrb/ha-devtools
Developer tools for Home Assistant
https://github.com/bendikrb/ha-devtools
developer-tools home-assistant
Last synced: 7 months ago
JSON representation
Developer tools for Home Assistant
- Host: GitHub
- URL: https://github.com/bendikrb/ha-devtools
- Owner: bendikrb
- License: mit
- Created: 2025-01-04T01:19:55.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2025-02-26T03:22:53.000Z (11 months ago)
- Last Synced: 2025-03-06T18:50:31.769Z (11 months ago)
- Topics: developer-tools, home-assistant
- Language: Python
- Homepage:
- Size: 40 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# [![DevTools Integration for Home Assistant][logo]][repo]
--------
[![GitHub Release][releases-shield]][releases]
![Downloads][downloads-total-shield]
[![License][license-shield]](LICENSE)
[![hacs][hacsbadge]][hacs]
[![Build Status][build-shield]][build]
![Made with Love in Norway][madewithlove-shield]
The `devtools` integration is a custom Home Assistant component designed to fill gaps and simplify tasks for the creator.
This integration currently provides a single feature that allows users to call any command registered with the WebSocket API as an action (previously known as a service) and get its response.
## Installation
### HACS
[](https://my.home-assistant.io/redirect/hacs_repository/?owner=bendikrb&repository=ha-devtools&category=Integration)
Or
Search for `Developer tools` in HACS and install it under the "Integrations" category.
### Manual Installation
More Details
* You should take the latest [published release](https://github.com/bendikrb/ha-devtools/releases).
* To install, place the contents of `custom_components` into the `/custom_components` folder of your Home Assistant installation.
* Restart Home Assistant
* In the HA UI go to Settings -> Integrations click "+" and search for "Developer tools"
## Configuration is done in the UI
The configuration UI will guide you through adding the integration to Home Assistant. You have two options for authentication:
### Option 1: Automatic (Recommended)
If you want to use this integration to run against the same Home Assistant instance (i.e. `localhost`):
1. Simply leave both fields "Access Token" empty
2. The integration will automatically generate the necessary authentication tokens
### Option 2: Manual
If you prefer to use your own token (e.g. for using the integrating with a different Home Assistant instance):
1. Create a [long-lived access token](https://developers.home-assistant.io/docs/auth_api/#long-lived-access-token) in the "Security" section of your Home Assistant profile page
2. Enter this token in the "Access Token" field during setup
3. If you want to use another Home Assistant Instance, enter its URL in the "Home Assistant URL" field
## Features
### Action: `call_ws_endpoint`
The `devtools.call_ws_endpoint` action enables you to call any command registered with the Home Assistant WebSocket API and retrieve its response. This can be particularly useful for debugging, testing, or automating tasks that require direct interaction with the WebSocket API.
[![Try this action][try-action-shield]](https://my.home-assistant.io/redirect/developer_call_service/?service=devtools.call_ws_endpoint)
#### Service Data
- `type` (string) - The WebSocket API command to call.
- `data` (dictionary, optional) - The parameters to pass to the command.
#### Example Usage
```yaml
action: devtools.call_ws_endpoint
data:
type: "validate_config"
data:
trigger: ...
condition: ...
action: ...
```
***
[repo]: https://github.com/bendikrb/ha-devtools
[commits-shield]: https://img.shields.io/github/commit-activity/y/bendikrb/ha-devtools.svg?style=flat
[commits]: https://github.com/bendikrb/ha-devtools/commits/main
[hacs]: https://github.com/hacs/integration
[hacsbadge]: https://img.shields.io/badge/HACS-Default-41BDF5.svg?style=flat
[logo]: https://brands.home-assistant.io/devtools/logo.png
[icon]: https://brands.home-assistant.io/devtools/icon.png
[build-shield]: https://github.com/bendikrb/ha_devtools/actions/workflows/validate.yaml/badge.svg
[build]: https://github.com/bendikrb/ha_devtools/actions/workflows/validate.yaml
[license-shield]: https://img.shields.io/github/license/bendikrb/ha-devtools.svg?style=flat
[maintenance-shield]: https://img.shields.io/badge/maintainer-%40bendikrb-blue.svg?style=flat
[releases-shield]: https://img.shields.io/github/release/bendikrb/ha-devtools.svg?style=flat
[releases]: https://github.com/bendikrb/ha-devtools/releases
[downloads-total-shield]: https://img.shields.io/github/downloads/bendikrb/ha-devtools/total?style=flat
[madewithlove-shield]: https://madewithlove.now.sh/no?heart=true&colorB=%233584e4
[try-action-shield]: https://my.home-assistant.io/badges/developer_call_service.svg