Added service "add-missing-products-to-shopping-list" to add all items below min stock amount to given shopping list, addressing #275

Author: rapala-b

README.md

@@ -77,6 +77,10 @@ Executes the given chore with an optional timestamp and executor.
 
 Consumes the given recipe.
 
+- **Grocy: Add Missing Products to Shopping List** (_grocy.add_missing_products_to_shopping_list_)
+
+Adds currently missing products to a given shopping list.
+
 
 # Translations
 

custom_components/grocy/services.py

@@ -24,6 +24,7 @@
 SERVICE_RECIPE_ID = "recipe_id"
 SERVICE_BATTERY_ID = "battery_id"
 SERVICE_OBJECT_ID = "object_id"
+SERVICE_LIST_ID = "list_id"
 
 SERVICE_ADD_PRODUCT = "add_product_to_stock"
 SERVICE_OPEN_PRODUCT = "open_product"
@@ -35,6 +36,7 @@
 SERVICE_DELETE_GENERIC = "delete_generic"
 SERVICE_CONSUME_RECIPE = "consume_recipe"
 SERVICE_TRACK_BATTERY = "track_battery"
+SERVICE_ADD_MISSING_PRODUCTS_TO_SHOPPING_LIST = "add_missing_products_to_shopping_list"
 
 SERVICE_ADD_PRODUCT_SCHEMA = vol.All(
     vol.Schema(
@@ -130,6 +132,14 @@
     )
 )
 
+SERVICE_ADD_MISSING_PRODUCTS_TO_SHOPPING_LIST_SCHEMA: vol.All(
+    vol.Schema(
+        {
+            vol.Optional(SERVICE_LIST_ID): vol.Coerce(int),
+        }
+    )
+)
+
 SERVICES_WITH_ACCOMPANYING_SCHEMA: list[tuple[str, vol.Schema]] = [
     (SERVICE_ADD_PRODUCT, SERVICE_ADD_PRODUCT_SCHEMA),
     (SERVICE_OPEN_PRODUCT, SERVICE_OPEN_PRODUCT_SCHEMA),
@@ -141,6 +151,7 @@
     (SERVICE_DELETE_GENERIC, SERVICE_DELETE_GENERIC_SCHEMA),
     (SERVICE_CONSUME_RECIPE, SERVICE_CONSUME_RECIPE_SCHEMA),
     (SERVICE_TRACK_BATTERY, SERVICE_TRACK_BATTERY_SCHEMA),
+    (SERVICE_ADD_MISSING_PRODUCTS_TO_SHOPPING_LIST, SERVICE_ADD_MISSING_PRODUCTS_TO_SHOPPING_LIST_SCHEMA),
 ]
 
 
@@ -351,6 +362,14 @@ def wrapper():
 
     await hass.async_add_executor_job(wrapper)
 
+async def async_add_missing_products_to_shopping_list(hass, coordinator, data):
+    '''Adds currently missing proudcts (below defined min. stock amount) to the given shopping list.'''
+    list_id = data.get(SERVICE_LIST_ID, None)
+
+    def wrapper():
+        coordinator.grocy_api.add_missing_product_to_shopping_list(list_id)
+    
+    await hass.async_add_executor_job(wrapper)
 
 async def _async_force_update_entity(
     coordinator: GrocyDataUpdateCoordinator, entity_key: str

custom_components/grocy/services.yaml

@@ -304,3 +304,15 @@ track_battery:
       description: The id of the battery
       selector:
         text:
+
+add_missing_products_to_shopping_list:
+  name: Add Missing Products to Shopping List
+  description: Adds currently missing products to the given shopping list.
+  fields:
+    list_id:
+      name: List Id
+      example: '1'
+      required: false
+      description: The id of the shopping list to be added to.
+      selector:
+        text: