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.

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

Add documentation for acaia integration #35635

Merged
merged 19 commits into from
Nov 15, 2024
Merged
104 changes: 104 additions & 0 deletions source/_integrations/acaia.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
---
title: Acaia
description: Instructions on how to integrate your Acaia smart coffee scale with Home Assistant.
ha_release: 2024.12
zweckj marked this conversation as resolved.
Show resolved Hide resolved
ha_category:
- Button
frenck marked this conversation as resolved.
Show resolved Hide resolved
ha_iot_class: Local Push
ha_config_flow: true
ha_domain: acaia
ha_platforms:
- button
Comment on lines +10 to +11
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

Add sensor platform to ha_platforms.

The integration appears to handle weight measurements and timer values, but these aren't reflected in the platforms list. Consider adding the 'sensor' platform to expose these values as entities.

 ha_platforms:
   - button
+  - sensor
📝 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
ha_platforms:
- button
ha_platforms:
- button
- sensor

ha_bluetooth: true
ha_codeowners:
- '@zweckj'
ha_integration_type: device
---

The **Acaia** {% term integrations %} allows you to control [Acaia](https://acaia.co/) scales through Home Assistant.

If your machine is within Bluetooth range to your Home Assistant host and the [Bluetooth](/integrations/bluetooth) integration is fully loaded, the scale should be discovered automatically. If you are configuring this integration, your scale needs to be turned on during setup.

{% include integrations/config_flow.md %}

{% configuration_basic %}
MAC:
description: "The MAC address of your scale."
{% endconfiguration_basic %}

# Available platforms & entities

## Buttons

- **Tare**: Tares the scale.
- **Reset timer**: Resets the timer. If the timer is running, it will continue to run.
- **Start/stop timer**: Starts or stops the timer, depending on whether the timer is currently running. Does not reset, but continue the timer.

frenck marked this conversation as resolved.
Show resolved Hide resolved
## Supported devices

The following devices have been tested successfully with this integration:

- Lunar (manufactured after 2021)
- Pyxis

If you have successfully tested this integration with another Acaia model, please let us know by enhancing this documentation, or by opening an issue in GitHub.

## Possible use-cases

This integration can be used in combination with integrations for smart coffee machines, such as the [La Marzocco integration](https://www.home-assistant.io/integrations/lamarzocco/) integration.
It could also be used to display the weight on secondary displays when brewing on a Pyxis or Lunar where you cannot see the display.

## Automations

Get started with these automation examples.

### Tare & start timer when brew starts

{% details "Example YAML configuration" %}

{% raw %}

```yaml
alias: Start timer on scale
frenck marked this conversation as resolved.
Show resolved Hide resolved
description: "When a brew starts on the machine, the following actions are started: tare, reset the timer, and start the timer on the scale."
triggers:
- entity_id:
- binary_sensor.lm001234_brewing_active
to: "on"
from: "off"
trigger: state
frenck marked this conversation as resolved.
Show resolved Hide resolved
conditions: []
frenck marked this conversation as resolved.
Show resolved Hide resolved
actions:
- action: button.press
target:
entity_id: button.lunar_tare
data: {}
frenck marked this conversation as resolved.
Show resolved Hide resolved
- action: button.press
target:
entity_id:
- button.lunar_reset_timer
data: {}
frenck marked this conversation as resolved.
Show resolved Hide resolved
- action: button.press
target:
entity_id:
- button.lunar_start_stop_timer
data: {}
mode: single

frenck marked this conversation as resolved.
Show resolved Hide resolved
```

{% endraw %}
{% enddetails %}

## Troubleshooting

{% details "Problem: Not reacting to commands" %}
zweckj marked this conversation as resolved.
Show resolved Hide resolved

Try toggling the **Is new style scale** setting in the reconfiguration settings. This setting tells the integration whether you have a newer model (newer than 2021) or not.
zweckj marked this conversation as resolved.
Show resolved Hide resolved
{% enddetails %}
frenck marked this conversation as resolved.
Show resolved Hide resolved

{% details "Device not discovered or found" %}

Make sure your scale is 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.
c0ffeeca7 marked this conversation as resolved.
Show resolved Hide resolved
{% enddetails %}