TandoorRecipes/docs/features/connectors.md

1.6 KiB

!!! warning Connectors are currently in a beta stage.

Connectors

Connectors are a powerful add-on component to TandoorRecipes. They allow for certain actions to be translated to api calls to external services.

General Config

!!! danger In order for this application to push data to external providers it needs to store authentication information. Please use read only/separate accounts or app passwords wherever possible.

  • DISABLE_EXTERNAL_CONNECTORS is a global switch to disable External Connectors entirely.
  • EXTERNAL_CONNECTORS_QUEUE_SIZE is the amount of changes that are kept in memory if the worker cannot keep up.

Example Config

DISABLE_EXTERNAL_CONNECTORS=0 // 0 = connectors enabled, 1 = connectors enabled
EXTERNAL_CONNECTORS_QUEUE_SIZE=100 

Current Connectors

HomeAssistant

The current HomeAssistant connector supports the following features:

  1. Push newly created shopping list items.
  2. Pushes all shopping list items if a recipe is added to the shopping list.
  3. Removed todo's from HomeAssistant IF they are unchanged and are removed through TandoorRecipes.

How to configure:

Step 1:

  1. Generate a HomeAssistant Long-Lived Access Tokens Profile Page
  2. Get/create a todo list entry you want to sync too. Todos Viewer
  3. Create a connector New Connector Config
  4. ???
  5. Profit