Recipe Download
===============

Command the data logger to download a recipe via HTTP GET from a URL.

**Topic Structure:** ``<baseTopic>/cc/<deviceID>/recipe``

.. admonition:: Properties

    - ``"url:"`` {*string*} web address to a specific server to retrieve recipe.
    - ``"sensor":`` {*int*} *(Optional)* Specify onboard Recipe or sensor Recipes
        - ``-1`` Retrieve onboard recipe / Data Logger Configuration
        - ``1 .. N`` Retrieve Recipe for Sensor Number
    - ``"action":`` {*string*} *(Optional)* ``"reset"`` If "url" is omitted and action is ``"reset"`` the command will clear the recipe and trigger the logger to retrieve an updated version.
    - ``"tranID":`` *(optional)* - *Any*

**Example Command (onboard)**

:guilabel:`Subscribe` ``cs/v2/cc/ABCD-EFGH-1234/recipe``

.. code-block:: json

    {
        "url": "https://DataThings.com/recipe",
        "sensor": -1
    }

**Example Command (reset)**

:guilabel:`Subscribe` ``cs/v2/cc/ABCD-EFGH-1234/recipe``

.. code-block:: json

    {
        "action": "reset",
        "sensor": 1
    }

**Progress**

Progress of the Recipe download will be published on the state topic.

:guilabel:`Publish` ``cs/v2/state/ABCD-EFGH-1234``

- Download Started

.. code-block:: json

    {
        "clientId": "ABCD-EFGH-1234",
        "state": "online",
        "fileTransfer": "Recipe file download"
    }

- Back online

.. code-block:: json

    {
        "clientId": "ABCD-EFGH-1234",
        "state": "online",
        "fileTransfer": "Recipe file download"
    }

**Response**

:guilabel:`Publish` ``cs/v2/cr/ABCD-EFGH-1234/recipe``

In addition to the state topic messages, the data logger will publish a final result of the process on the ``cr`` topic.

.. code-block:: json

    {
        "success": "Recipe ran successfully"
    }