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 documentation for acaia binary_sensor platform #35775

Open
wants to merge 20 commits into
base: next
Choose a base branch
from
Open

Add documentation for acaia binary_sensor platform #35775

Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
8d4f686
Add documentation for acaia integration
zweckj Nov 7, 2024
ae1a18b
coderabbitai comments
zweckj Nov 7, 2024
0b5bee7
fix UI string
zweckj Nov 7, 2024
d72d7e5
Update acaia.markdown
zweckj Nov 7, 2024
523e66e
Update acaia.markdown
zweckj Nov 8, 2024
17d500e
Update acaia.markdown
zweckj Nov 8, 2024
51ab507
Update acaia.markdown
zweckj Nov 8, 2024
86cdbc9
Update acaia.markdown
zweckj Nov 8, 2024
27e24a8
Update acaia.markdown
zweckj Nov 8, 2024
5b8970e
Update acaia.markdown
zweckj Nov 8, 2024
62eff5c
Apply suggestions from code review
c0ffeeca7 Nov 8, 2024
439c399
remove required option from configuration_basic block
c0ffeeca7 Nov 8, 2024
838db21
Update acaia.markdown
zweckj Nov 8, 2024
ad92e02
Update acaia.markdown
zweckj Nov 8, 2024
597b41f
tweak
c0ffeeca7 Nov 8, 2024
3a37f82
Update acaia.markdown
zweckj Nov 8, 2024
cb5248d
Add known limitations
zweckj Nov 10, 2024
680242e
remove acaial limitation (solved)
zweckj Nov 13, 2024
35061e9
Add documentation for acaia binary_sensor platform
zweckj Nov 15, 2024
cd9375b
Merge branch 'next' into acaia/binary_sensors
zweckj Nov 15, 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
7 changes: 6 additions & 1 deletion source/_integrations/acaia.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,13 @@ title: Acaia
description: Instructions on how to integrate your Acaia smart coffee scale with Home Assistant.
ha_release: 2024.12
ha_category:
- Binary sensor
- Button
ha_iot_class: Local Push
ha_config_flow: true
ha_domain: acaia
ha_platforms:
- binary_sensor
- button
ha_bluetooth: true
ha_codeowners:
Expand All @@ -28,6 +30,10 @@ MAC:

# Available platforms & entities

## Binary sensors

- **Timer running**: Whether the timer is currently running on the scale
Comment on lines +33 to +35
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Enhance binary sensor documentation with additional details

While the basic functionality is documented, please consider adding:

  • The actual entity ID or naming pattern (e.g., binary_sensor.acaia_timer_running)
  • Clear description of what the states mean (e.g., on = timer is running, off = timer is stopped)
  • Update frequency or any limitations users should be aware of

Example enhancement:

 ## Binary sensors
 
-  - **Timer running**: Whether the timer is currently running on the scale
+  - **Timer running** (`binary_sensor.acaia_timer_running`): Indicates whether the timer is currently running on the scale.
+    - State `on`: Timer is currently running
+    - State `off`: Timer is stopped
+    - Updates in real-time as the timer state changes
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
## Binary sensors
- **Timer running**: Whether the timer is currently running on the scale
## Binary sensors
- **Timer running** (`binary_sensor.acaia_timer_running`): Indicates whether the timer is currently running on the scale.
- State `on`: Timer is currently running
- State `off`: Timer is stopped
- Updates in real-time as the timer state changes


## Buttons

- **Tare**: Tares the scale.
Expand Down Expand Up @@ -94,4 +100,3 @@ actions:

Make sure your scale is turned on and in Bluetooth range to your Home Assistant instance. [ESPHome Bluetooth Proxies](https://esphome.io/components/bluetooth_proxy.html) are a great way to increase the range if your instance is too far away. Turn on debug settings in the acaia integration and check your logs.
{% enddetails %}