Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.mealie.services Namespace Reference

Functions

MealieConfigEntry async_get_entry (HomeAssistant hass, str config_entry_id)
 
None setup_services (HomeAssistant hass)
 

Variables

string SERVICE_GET_MEALPLAN = "get_mealplan"
 
 SERVICE_GET_MEALPLAN_SCHEMA
 
string SERVICE_GET_RECIPE = "get_recipe"
 
 SERVICE_GET_RECIPE_SCHEMA
 
string SERVICE_IMPORT_RECIPE = "import_recipe"
 
 SERVICE_IMPORT_RECIPE_SCHEMA
 
string SERVICE_SET_MEALPLAN = "set_mealplan"
 
 SERVICE_SET_MEALPLAN_SCHEMA
 
string SERVICE_SET_RANDOM_MEALPLAN = "set_random_mealplan"
 
 SERVICE_SET_RANDOM_MEALPLAN_SCHEMA
 

Detailed Description

Define services for the Mealie integration.

Function Documentation

◆ async_get_entry()

MealieConfigEntry homeassistant.components.mealie.services.async_get_entry ( HomeAssistant  hass,
str  config_entry_id 
)
Get the Mealie config entry.

Definition at line 101 of file services.py.

◆ setup_services()

None homeassistant.components.mealie.services.setup_services ( HomeAssistant  hass)
Set up the services for the Mealie integration.

Definition at line 118 of file services.py.

Variable Documentation

◆ SERVICE_GET_MEALPLAN

string homeassistant.components.mealie.services.SERVICE_GET_MEALPLAN = "get_mealplan"

Definition at line 40 of file services.py.

◆ SERVICE_GET_MEALPLAN_SCHEMA

homeassistant.components.mealie.services.SERVICE_GET_MEALPLAN_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  vol.Required(ATTR_CONFIG_ENTRY_ID): str,
4  vol.Optional(ATTR_START_DATE): cv.date,
5  vol.Optional(ATTR_END_DATE): cv.date,
6  }
7 )

Definition at line 41 of file services.py.

◆ SERVICE_GET_RECIPE

string homeassistant.components.mealie.services.SERVICE_GET_RECIPE = "get_recipe"

Definition at line 49 of file services.py.

◆ SERVICE_GET_RECIPE_SCHEMA

homeassistant.components.mealie.services.SERVICE_GET_RECIPE_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  vol.Required(ATTR_CONFIG_ENTRY_ID): str,
4  vol.Required(ATTR_RECIPE_ID): str,
5  }
6 )

Definition at line 50 of file services.py.

◆ SERVICE_IMPORT_RECIPE

string homeassistant.components.mealie.services.SERVICE_IMPORT_RECIPE = "import_recipe"

Definition at line 57 of file services.py.

◆ SERVICE_IMPORT_RECIPE_SCHEMA

homeassistant.components.mealie.services.SERVICE_IMPORT_RECIPE_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  vol.Required(ATTR_CONFIG_ENTRY_ID): str,
4  vol.Required(ATTR_URL): str,
5  vol.Optional(ATTR_INCLUDE_TAGS): bool,
6  }
7 )

Definition at line 58 of file services.py.

◆ SERVICE_SET_MEALPLAN

string homeassistant.components.mealie.services.SERVICE_SET_MEALPLAN = "set_mealplan"

Definition at line 75 of file services.py.

◆ SERVICE_SET_MEALPLAN_SCHEMA

homeassistant.components.mealie.services.SERVICE_SET_MEALPLAN_SCHEMA
Initial value:
1 = vol.Any(
2  vol.Schema(
3  {
4  vol.Required(ATTR_CONFIG_ENTRY_ID): str,
5  vol.Required(ATTR_DATE): cv.date,
6  vol.Required(ATTR_ENTRY_TYPE): vol.In(
7  [x.lower() for x in MealplanEntryType]
8  ),
9  vol.Required(ATTR_RECIPE_ID): str,
10  }
11  ),
12  vol.Schema(
13  {
14  vol.Required(ATTR_CONFIG_ENTRY_ID): str,
15  vol.Required(ATTR_DATE): cv.date,
16  vol.Required(ATTR_ENTRY_TYPE): vol.In(
17  [x.lower() for x in MealplanEntryType]
18  ),
19  vol.Required(ATTR_NOTE_TITLE): str,
20  vol.Required(ATTR_NOTE_TEXT): str,
21  }
22  ),
23 )

Definition at line 76 of file services.py.

◆ SERVICE_SET_RANDOM_MEALPLAN

string homeassistant.components.mealie.services.SERVICE_SET_RANDOM_MEALPLAN = "set_random_mealplan"

Definition at line 66 of file services.py.

◆ SERVICE_SET_RANDOM_MEALPLAN_SCHEMA

homeassistant.components.mealie.services.SERVICE_SET_RANDOM_MEALPLAN_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  vol.Required(ATTR_CONFIG_ENTRY_ID): str,
4  vol.Required(ATTR_DATE): cv.date,
5  vol.Required(ATTR_ENTRY_TYPE): vol.In([x.lower() for x in MealplanEntryType]),
6  }
7 )

Definition at line 67 of file services.py.