Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add EzBEQ integration #34748

Closed
wants to merge 2 commits into from
Closed

Add EzBEQ integration #34748

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ac57a3e
feat: add ezbeq docs
iloveicedgreentea Sep 15, 2024
2a88878
fix: docs
iloveicedgreentea Oct 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions source/_integrations/ezbeq.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
title: EzBEQ
description: Instructions on how to integrate EzBEQ into Home Assistant.
ha_category:
- Sensor
ha_release: '2024.8'
ha_iot_class: Local Polling
ha_config_flow: true
ha_codeowners:
- '@iloveicedgreentea'
ha_domain: ezbeq
ha_platforms:
- sensor
ha_integration_type: device
---

The EzBEQ allows for the automation and control of [EzBEQ](https://github.com/3ll3d00d/ezbeq). Its main purpose is to automate loading and unloading [BEQ](https://beqcatalogue.readthedocs.io/en/latest/) profiles.

{% include integrations/config_flow.md %}

## Supported Devices

This integration supports the EzBEQ API. It should work with any device that is compatible with the EzBEQ API although it has only been tested with a MiniDSP 2x4HD.

It will create a "Device" for every physical device attached to EzBEQ. For example, if you have two MiniDSPs that EzBEQ manages, they will appear as separate devices.

### Sensor

This integration creates a sensor on each device to show the currently loaded BEQ Profile.

`sensor.{device_name}_current_profile`
Comment on lines +1 to +31
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codebase verification

Add Missing Standard Sections to EzBEQ Integration Documentation

The ezbeq.markdown documentation is missing some common sections found in other integrations, such as:

  • Configuration
  • Options
  • Services
  • Automation

Including these sections will ensure consistency and provide comprehensive information for users.

🔗 Analysis chain

Overall, excellent documentation for the EzBEQ integration.

The documentation provides a comprehensive overview of the EzBEQ integration, covering all necessary aspects including metadata, introduction, supported devices, and sensor information. It adheres to Home Assistant documentation standards and offers clear, concise information for users.

A few minor enhancements have been suggested throughout the review to further improve clarity and completeness. These include:

  1. Adding a brief explanation of BEQ in the introduction.
  2. Fixing a minor grammatical issue in the Supported Devices section.
  3. Expanding the Sensor section with more detailed information and usage examples.

To ensure consistency with other integration documentations, please run the following command:

This will help verify that we haven't missed any common sections that are typically included in integration documentations.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for common sections in other integration documentations

# Test: Look for common sections in other integration docs
rg --type markdown -i "^## (Configuration|Options|Services|Automation)" source/_integrations/

Length of output: 21685

🧰 Tools
🪛 LanguageTool

[uncategorized] ~23-~23: Use a comma before ‘although’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ce that is compatible with the EzBEQ API although it has only been tested with a MiniDSP ...

(COMMA_COMPOUND_SENTENCE)