https://github.com/mintcreg/pantry_tracker_sensor
Sensor integration for Pantry Tracker to integrate data with HomeAssistant
https://github.com/mintcreg/pantry_tracker_sensor
homeassistant homeassistant-custom-component pantry-tracker
Last synced: about 2 months ago
JSON representation
Sensor integration for Pantry Tracker to integrate data with HomeAssistant
- Host: GitHub
- URL: https://github.com/mintcreg/pantry_tracker_sensor
- Owner: mintcreg
- License: gpl-3.0
- Created: 2024-12-15T17:10:40.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-01-30T13:07:44.000Z (5 months ago)
- Last Synced: 2025-04-22T12:08:04.368Z (about 2 months ago)
- Topics: homeassistant, homeassistant-custom-component, pantry-tracker
- Language: Python
- Homepage:
- Size: 316 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.MD
- License: LICENSE
Awesome Lists containing this project
README
#
Pantry Tracker - Sensor
> [!CAUTION]
> This is a work in progress and made using GPT and basic knowledge.
## Description
The **Pantry Tracker Sensor** repository provides a set of Home Assistant integrations to enable seamless interaction between the **Pantry Tracker Add-on** and Home Assistant. These components allow you to automatically create sensors for pantry categories and products, update their counts in real time, and manage their lifecycle effectively.
---
## Features
- 🖥️ **Dynamic Sensor Creation**
Automatically creates sensors for each product and category stored in the Pantry Tracker database.
- 📊 **Real-Time Count Updates**
Synchronizes product counts between Home Assistant and the Pantry Tracker Add-on.
- ❌ **Automatic Cleanup**
Removes sensors for products that are deleted from the database to ensure a clean and up-to-date system.
- 🔄 **Bi-Directional Updates**
Supports increasing and decreasing product counts from Home Assistant services.
---
## Requirements
1. **Pantry Tracker Add-on**
The [Pantry Tracker Add-on 1.0.51 (onward)](https://github.com/mintcreg/pantry_tracker) must be installed and running.
---
## Installation
1. Add [https://github.com/mintcreg/pantry_tracker_sensor](https://github.com/mintcreg/pantry_tracker_sensor) to HACS
[](https://my.home-assistant.io/redirect/hacs_repository/?owner=mintcreg&repository=pantry_tracker_sensor&category=Integration)
3. Install from HACS
4. Add the Integration via Settings > Devices > Add Integration "Pantry Tracker Sensor"
[](https://my.home-assistant.io/redirect/config_flow_start/?domain=pantry_tracker)
5. Restart HomeAssistant
**Alternatively**
1. Download and Install
Copy the `pantry_tracker` folder to the `custom_components` directory in your Home Assistant configuration.
2. Add the Integration via Settings > Devices > Add Integration "Pantry Tracker Sensor"
[](https://my.home-assistant.io/redirect/config_flow_start/?domain=pantry_tracker)
## Usage
Auto Entities & Browsermod (No Tracker Card)
```yaml
type: custom:auto-entities
card:
type: entities
title: Pantry Products
show_header_toggle: false
state_color: true
filter:
include:
- entity_id: sensor.product_*
options:
type: custom:template-entity-row
name: |
{{ state_attr(config.entity, 'product_name') }}
tap_action:
action: fire-dom-event
browser_mod:
service: browser_mod.popup
data:
title: Update Stock
content:
type: vertical-stack
cards:
- type: custom:mushroom-template-card
entity: this.entity_id
primary: |
Product: {{ state_attr(entity, 'product_name') }}
secondary: |
Stock Count: {{ states(entity) }}
icon: mdi:food-apple
layout: vertical
right_button: Add 1 Item
left_button: Remove 1 Item
right_button_action:
service: pantry_tracker.increase_count
data:
entity_id: this.entity_id
amount: 1
left_button_action:
service: pantry_tracker.decrease_count
data:
entity_id: this.entity_id
amount: 1
```
### Demo
Tracker Card
Requires the Pantry Tracker Card - https://github.com/mintcreg/pantry_tracker_card
```yaml
type: custom:pantry-card
entity_prefix: sensor.product
search: true
show_images: true
category_filter: true
```
## Services
The custom component provides the following services to interact with pantry products:
| **Service** | **Parameters** | **Description** |
|----------------------------------|------------------------------------------------------------------------------------------------------|-------------------------------------------------------------|
| `pantry_tracker.increase_count` | `product_name` (string)
`amount` (int, optional, default: 1) | Increase the count of a specific product by its name. |
| `pantry_tracker.decrease_count` | `product_name` (string)
`amount` (int, optional, default: 1) | Decrease the count of a specific product by its name. |
| `pantry_tracker.barcode_increase`| `barcode` (string)
`amount` (int, optional, default: 1) | Increase the count of a product by providing its barcode. |
| `pantry_tracker.barcode_decrease`| `barcode` (string)
`amount` (int, optional, default: 1) | Decrease the count of a product by providing its barcode. |
## Service Call Examples
Increase Count
```yaml
service: pantry_tracker.increase_count
data:
entity_id: sensor.product_banana
amount: 1
```
Decrease Count
```yaml
service: pantry_tracker.decrease_count
data:
entity_id: sensor.product_banana
amount: 1
```
Barcode Increase
```yaml
service: pantry_tracker.barcode_increase
data:
barcode: "123456789012"
amount: 3
```
Barcode Decrease
```yaml
service: pantry_tracker.barcode_decrease
data:
barcode: "123456789012"
amount: 3
```