Drinkaware Integration for Home Assistant

This custom integration allows you to connect your Drinkaware account to Home Assistant, enabling you to track your alcohol consumption data, risk assessments, and goals as sensors within your smart home. I have developed this for personal use and it is not affiliated with or authorized by DrinkAware, so use at your own risk.

Features

• Display your Drinkaware risk level assessment
• Track drink-free days and streaks
• Monitor weekly unit consumption
• Track goal progress
• View your self-assessment scores
• See detailed list of drinks consumed today
• Log new drinks and drink-free days via services
• One-click button to log a drink-free day
• Support for custom drink IDs
• Remove logged drinks when needed

Installation

Method 1: HACS (Recommended)

1. Make sure you have HACS installed
2. Add this repository as a custom repository in HACS:
   • Go to HACS → Integrations → ⋮ (menu) → Custom Repositories
   • Add https://github.com/B-Hartley/drinkaware as a repository
   • Category: Integration
3. Click "Install" on the Drinkaware integration
4. Restart Home Assistant

Method 2: Manual Installation

1. Download the latest release
2. Extract the drinkaware folder into your custom_components directory
3. Restart Home Assistant

Configuration

The integration can be set up through the Home Assistant UI:

1. Go to Settings → Devices & Services
2. Click the + Add Integration button
3. Search for "Drinkaware" and select it
4. Follow the configuration flow

Authentication Method

This integration uses OAuth to authenticate with Drinkaware:

1. Enter a name for your Drinkaware account
2. Click the link to authorize Drinkaware
3. Log in with your Drinkaware credentials
4. After successful login, you'll be redirected to a page that won't load (this is normal)
5. Important: Open your browser's Developer Tools (press F12), go to the Network tab, find the callback URL, right-click and select "Copy URL"
6. Paste the copied URL in the next step of the setup process

Note: In the Network tab, look for a request with "callback" in the name. The URL should start with uk.co.drinkaware.drinkaware://oauth/callback and contain a code parameter.

Available Entities

Sensors

The integration creates several sensors:

Sensor	Description
Risk Level	Your assessed risk level (Low, Increasing, High, or Possible Dependency)
Self Assessment Score	Your total score from the self-assessment
Drink Free Days	Total number of alcohol-free days tracked
Current Drink Free Streak	Your current streak of consecutive alcohol-free days
Days Tracked	Total number of days tracked in the app
Goals Achieved	Number of goals you've achieved
Current Goal Progress	Progress toward your current goal as a percentage
Weekly Units	Total units consumed in the past week
Last Drink Date	Date of your most recent recorded drink
Drinks Today	Number of drinks consumed today, with detailed list in attributes

Buttons

Button	Description
Log Drink Free Day	One-click button to mark today as a drink-free day (automatically removes any existing drinks)

Services

The integration provides the following services to interact with your Drinkaware account:

Log Drink-Free Day

Mark a specific day as alcohol-free in your Drinkaware tracking:

service: drinkaware.log_drink_free_day
data:
  entry_id: "abc123"  # Select from the integration dropdown
  date: "2025-04-18"  # Optional, defaults to today
  remove_drinks: true  # Optional, removes existing drinks before marking as drink-free

Log Drink

Record a drink in your Drinkaware tracking. You can use either standard drinks from the dropdown or custom drink IDs:

# Using a standard drink
service: drinkaware.log_drink
data:
  entry_id: "abc123"  # Select from the integration dropdown
  drink_id: "D4F06BD4-1F61-468B-AE86-C6CC2D56E021"  # Beer (select from dropdown)
  measure_id: "B59DCD68-96FF-4B4C-BA69-3707D085C407"  # Pint (select from dropdown)
  abv: 4.5  # Optional
  name: "My Craft IPA"  # Optional custom name (only works with custom ABV)
  quantity: 1  # Optional, defaults to 1
  date: "2025-04-18"  # Optional, defaults to today
  auto_remove_dfd: true  # Optional, removes drink-free day mark if present

# Using a custom drink ID
service: drinkaware.log_drink
data:
  entry_id: "abc123"  # Select from the integration dropdown
  custom_drink_id: "12345678-ABCD-1234-5678-123456789ABC"  # Custom drink ID from Drinks Today sensor
  measure_id: "B59DCD68-96FF-4B4C-BA69-3707D085C407"  # Pint (select from dropdown)
  quantity: 1  # Optional, defaults to 1
  date: "2025-04-18"  # Optional, defaults to today
  auto_remove_dfd: true  # Optional, removes drink-free day mark if present

Delete Drink

Remove a recorded drink from your tracking:

# Using a standard drink
service: drinkaware.delete_drink
data:
  entry_id: "abc123"  # Select from the integration dropdown
  drink_id: "D4F06BD4-1F61-468B-AE86-C6CC2D56E021"  # Beer (select from dropdown)
  measure_id: "B59DCD68-96FF-4B4C-BA69-3707D085C407"  # Pint (select from dropdown)
  date: "2025-04-18"  # Optional, defaults to today

# Using a custom drink ID
service: drinkaware.delete_drink
data:
  entry_id: "abc123"  # Select from the integration dropdown
  custom_drink_id: "12345678-ABCD-1234-5678-123456789ABC"  # Custom drink ID from Drinks Today sensor
  measure_id: "B59DCD68-96FF-4B4C-BA69-3707D085C407"  # Pint (select from dropdown)
  date: "2025-04-18"  # Optional, defaults to today

Finding Custom Drink IDs

Custom drink IDs can be found in the attributes of the "Drinks Today" sensor. Go to Developer Tools > States, find your Drinks Today sensor, and look for the custom_drinks_reference attribute which lists all available custom drinks with their IDs.

Refresh Data

Manually refresh data from the Drinkaware API:

service: drinkaware.refresh
data:
  entry_id: "abc123"  # Select from the integration dropdown, leave empty to refresh all integrations

For more detailed information on available drink types, measures, and advanced usage examples, please refer to the GUIDE.md file.

Example Automation

Here's an example of how to use the services in an automation:

automation:
  - alias: "Mark Yesterday as Drink-Free at Midnight"
    trigger:
      - platform: time
        at: "00:00:00"
    action:
      - service: drinkaware.log_drink_free_day
        data:
          entry_id: "abc123"  # Select from the integration dropdown
          date: "{{ (now() - timedelta(days=1)).strftime('%Y-%m-%d') }}"
          remove_drinks: true

Troubleshooting

For common issues and troubleshooting tips, please see the TROUBLESHOOTING.md file.

Privacy

Your Drinkaware credentials and data are only stored locally in your Home Assistant instance. This integration communicates directly with the Drinkaware API and does not send your data to any third parties.

Support

If you encounter any issues or have feature requests, please create an issue on the GitHub repository.

Disclaimer

This integration is not officially affiliated with or endorsed by the Drinkaware Trust. It is an independent project developed for the Home Assistant community.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Version History

• 0.3.0 - Added button entity for one-click logging of drink-free days
• 0.2.4 - re-instated sensor attributes that seem to vanish on previous updates
• 0.2.3 - Removed account_name parameter from services, making config entry ID the standard way to select an integration
• 0.2.2 - Added support for custom drink IDs in service UI
• 0.2.1 - Added validation for drink and measure compatibility
• 0.2.0 - Added ability to set custom names for drinks when specifying custom ABV
• 0.1.8 - Added dropdown menus for drink and measure selection in services
• 0.1.7 - Fixed issues with custom drink measure descriptions and drink-free day functionality
• 0.1.6 - Previous release