From 24ebd833b362b266eee563e132577bdb9e81276a Mon Sep 17 00:00:00 2001 From: Jesse Hills <3060199+jesserockz@users.noreply.github.com> Date: Thu, 11 May 2023 13:54:03 +1200 Subject: [PATCH 1/2] Add note for project info requirement for dashboard import (#2908) --- guides/creators.rst | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/guides/creators.rst b/guides/creators.rst index 134f2ce0e..5aed84e01 100644 --- a/guides/creators.rst +++ b/guides/creators.rst @@ -79,10 +79,16 @@ Relevant Documentation credentials and they must be set by the user via either the ``ap`` + ``captive_portal`` or the ``esp32_improv`` / ``improv_serial`` components. - ``dashboard_import`` - - ``package_import_url`` - This should point to the public repository containing - the configuration for the device so that the user's ESPHome dashboard can autodetect this device and - create a minimal YAML using :ref:`config-git_packages`. - - ``import_full_config`` - This signals if ESPHome should download the entire YAML file as the user's config YAML instead of referencing the package. Set this to `true` if you are creating a tutorial to let users easily tweak the whole configuration or be able to uncomment follow-up tutorial steps. + .. note:: + + The :ref:`esphome-creators_project` above is required for adoption to work in the Dashboard. + + - ``package_import_url`` - This should point to the public repository containing + the configuration for the device so that the user's ESPHome dashboard can autodetect this device and + create a minimal YAML using :ref:`config-git_packages`. + - ``import_full_config`` - This signals if ESPHome should download the entire YAML file as the user's config + YAML instead of referencing the package. Set this to ``true`` if you are creating a tutorial to let users + easily tweak the whole configuration or be able to uncomment follow-up tutorial steps. - ``improv_serial`` - :doc:`/components/improv_serial` See Also From 83fcab4ec6b1f11c25a7dae35977ee587b86896f Mon Sep 17 00:00:00 2001 From: Eli <4274160+eli-xciv@users.noreply.github.com> Date: Thu, 11 May 2023 00:09:55 -0400 Subject: [PATCH 2/2] Updated rc522.rst to correct image reference (#2910) --- components/binary_sensor/rc522.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/components/binary_sensor/rc522.rst b/components/binary_sensor/rc522.rst index 0de0ef3e5..5c761ba78 100644 --- a/components/binary_sensor/rc522.rst +++ b/components/binary_sensor/rc522.rst @@ -18,7 +18,7 @@ The RC522 supports SPI, I²C and UART communication protocols, ESPHome can use e Component/Hub ------------- -* If you have a module like the image above, it can only be used in SPI mode (`unless hacked `__) +* If you have a module like the image below, it can only be used in SPI mode (`unless hacked `__) and you need to have an :ref:`SPI bus ` in your configuration with both the **miso_pin** and **mosi_pin** set. * If you have a RC522 which communicates via I²C like in the M5 Stack then you need to have an :ref:`I²C ` bus configured.