Update lamarzocco documentation with connection methods per entity (#…

…35985)
home-assistant · Dec 1, 2024 · e84a537 · e84a537
1 parent c6421e3
commit e84a537
Showing 1 changed file with 48 additions and 44 deletions.
diff --git a/source/_integrations/lamarzocco.markdown b/source/_integrations/lamarzocco.markdown
@@ -67,77 +67,81 @@ Use Bluetooth:
 
 # Available platforms & entities
 
+{% icon "material-symbols:cloud-outline" title="La Marzocco Cloud" %} = La Marzocco Cloud
+<iconify-icon inline title="Bluetooth" icon="material-symbols:bluetooth"></iconify-icon> = Bluetooth
+{% icon "material-symbols:wifi" title="Local connection" %} = Local network
+
 ## Buttons
 
-| Button name | Description | Available for machines |
-|-------------|-------------| ---------------------- |
-| Start backflush | Starts the backflush process on your machine. You got 15 seconds to turn the paddle after activation. | all |
+| Button name | Description | Available for machines | Controllable through |
+|-------------|-------------| ---------------------- | -------------------- |
+| **Start backflush** | Starts the backflush process on your machine. You got 15 seconds to turn the paddle after activation. | `all` | {% icon "material-symbols:cloud-outline" title="La Marzocco Cloud" %} | 
 
 
 ## Numbers
 
-| Number name | Description | Available for machines | Remarks |
-|-------------|-------------| ---------------------- | ------- |
-| Coffee target temperature | Temperature the coffee boiler is set to | GS3 AV, GS3 MP | - |
-| Steam target temperature | Temperature the steam boiler is set to | GS3 AV, GS3 MP | - |
-| Tea water duration | Dose hot water (in seconds) | GS3 AV, GS3 MP | - |
-| Dose | Doseage (in ticks) for each key | GS3 AV | GS3 has this multiple times, one for each physical key (1-4), and the entities are disabled by default |
-| Prebrew on time | Time prebrew wets the puck | Linea Micra, Linea Mini, GS3 AV | GS3 has this multiple times, one for each physical key (1-4), and the entities are disabled by default |
-| Prebrew off time | Time prebrew waits before turning on the pump | Linea Micra, Linea Mini, GS3 AV | GS3 has this multiple times, one for each physical key (1-4), and the entities are disabled by default |
-| Preinfusion time | Duration of preinfusion | Linea Micra, Linea Mini, GS3 AV | GS3 has this multiple times, one for each physical key (1-4), and the entities are disabled by default |
-| Smart standby time | Time until the machine will automatically stand by (if enabled) | all | - |
+| Number name | Description | Available for machines | Controllable through | Remarks |
+|-------------|-------------| ---------------------- |--------------------- | ------- |
+| **Coffee target temperature** | Temperature the coffee boiler is set to | `GS3 AV`, `GS3 MP` | {% icon "material-symbols:cloud-outline" title="La Marzocco Cloud" %} <iconify-icon inline title="Bluetooth" icon="material-symbols:bluetooth"></iconify-icon> | - |
+| **Steam target temperature** | Temperature the steam boiler is set to | `GS3 AV`, `GS3 MP` | {% icon "material-symbols:cloud-outline" title="La Marzocco Cloud" %} <iconify-icon inline title="Bluetooth" icon="material-symbols:bluetooth"></iconify-icon> | - |
+| **Tea water duration** | Dose hot water (in seconds) | `GS3 AV`, `GS3 MP` | {% icon "material-symbols:cloud-outline" title="La Marzocco Cloud" %} | - |
+| **Dose** | Doseage (in ticks) for each key | `GS3 AV` | {% icon "material-symbols:cloud-outline" title="La Marzocco Cloud" %} | `GS3` has this multiple times, one for each physical key (1-4), and the entities are disabled by default |
+| **Prebrew on time** | Time prebrew wets the puck | `Linea Micra`, `Linea Mini`, `GS3 AV` | {% icon "material-symbols:cloud-outline" title="La Marzocco Cloud" %} | `GS3` has this multiple times, one for each physical key (1-4), and the entities are disabled by default |
+| **Prebrew off time** | Time prebrew waits before turning on the pump | `Linea Micra`, `Linea Mini`, `GS3 AV` | {% icon "material-symbols:cloud-outline" title="La Marzocco Cloud" %} | `GS3` has this multiple times, one for each physical key (1-4), and the entities are disabled by default |
+| **Preinfusion time** | Duration of preinfusion | `Linea Micra`, `Linea Mini`, `GS3 AV` | {% icon "material-symbols:cloud-outline" title="La Marzocco Cloud" %} | `GS3` has this multiple times, one for each physical key (1-4), and the entities are disabled by default |
+| **Smart standby time** | Time until the machine will automatically stand by (if enabled) | `all` | {% icon "material-symbols:cloud-outline" title="La Marzocco Cloud" %} | - |
 
 
 ## Switches
 
-| Switch name | Description | Available for machines |
-|-------------|-------------| ---------------------- |
-| Main        | Allows to turn machines on-/off | all |
-| Steam boiler | Allows to enable/disable the steam boiler | all |
-| Smart standby enabled | Whether smart standby is on (machine will automatically stand by after given time) | all |
+| Switch name | Description | Available for machines | Controllable through |
+|-------------|-------------| ---------------------- | -------------------- |
+| **Main**      | Allows to turn machines on-/off | `all` | {% icon "material-symbols:cloud-outline" title="La Marzocco Cloud" %} <iconify-icon inline title="Bluetooth" icon="material-symbols:bluetooth"></iconify-icon> |
+| **Steam boiler** | Allows to enable/disable the steam boiler | `all` | {% icon "material-symbols:cloud-outline" title="La Marzocco Cloud" %} <iconify-icon inline title="Bluetooth" icon="material-symbols:bluetooth"></iconify-icon> |
+| **Smart standby enabled** | Whether smart standby is on (machine will automatically stand by after given time) | `all` | {% icon "material-symbols:cloud-outline" title="La Marzocco Cloud" %} |
 
 ## Binary sensors
 
-| Binary sensor name | Description | Available for machines | Remarks |
-|-------------|-------------| ---------------------- | ------- |
-| Water tank empty | Indicates whether the water tank needs a refill. | all | - |
-| Brewing active | Is on if you are in the process of making coffee. | all | Only available when the *Host* was set during component configuration. |
-| Backflush enabled | Is on if you started the backflushing process. | all | - |
+| Binary sensor name | Description | Available for machines |  Retrievable from | Remarks |
+|------------------- |-------------| ---------------------- | ----------------- | ------- |
+| **Water tank empty** | Indicates whether the water tank needs a refill. | `all` | {% icon "material-symbols:cloud-outline" title="La Marzocco Cloud" %} {% icon "material-symbols:wifi" title="Local connection" %} | - |
+| **Brewing active** | Is on if you are in the process of making coffee. | `all` | {% icon "material-symbols:wifi" title="Local connection" %} |  Only available when the `Host` was set during component configuration. |
+| **Backflush enabled** | Is on if you started the backflushing process. | `all` | {% icon "material-symbols:cloud-outline" title="La Marzocco Cloud" %} {% icon "material-symbols:wifi" title="Local connection" %} | - |
 
 ## Sensors
 
-| Sensor name | Description | Available for machines | Remarks |
-|-------------|-------------| ---------------------- | ------- |
-| Current coffee temperature | Current temperature of the coffee boiler | all | When the machine reaches temperature, this will be approximately 3 degrees higher than the `Coffee target temperature`, due to different measurement points. |
-| Current steam temperature| Current temperature of the steam boiler | Linea Micra, GS3 AV, GS3 MP | - |
-| Total coffees made | Counter for total coffees made| all | - |
-| Total flushes made | Counter for total flushes done | all | - |
-| Shot timer | Time the current brew is running | all | Only available when the *Host* was set during component configuration. |
+| Sensor name | Description | Available for machines | Retrievable from | Remarks |
+|-------------|-------------| ---------------------- | ---------------- | ------- |
+| **Current coffee temperature** | Current temperature of the coffee boiler | `all` | {% icon "material-symbols:cloud-outline" title="La Marzocco Cloud" %} {% icon "material-symbols:wifi" title="Local connection" %} | When the machine reaches temperature, this will be approximately 3 degrees higher than the `Coffee target temperature`, due to different measurement points. |
+| **Current steam temperature**| Current temperature of the steam boiler | `Linea Micra`, `GS3 AV`, `GS3 MP` | {% icon "material-symbols:cloud-outline" title="La Marzocco Cloud" %} {% icon "material-symbols:wifi" title="Local connection" %} | - |
+| **Total coffees made** | Counter for total coffees made| `all` | {% icon "material-symbols:cloud-outline" title="La Marzocco Cloud" %} | - |
+| **Total flushes made** | Counter for total flushes done | `all` | {% icon "material-symbols:cloud-outline" title="La Marzocco Cloud" %}| - |
+| **Shot timer** | Time the current brew is running | `all` | {% icon "material-symbols:wifi" title="Local connection" %} | Only available when the `Host` was set during component configuration. |
 
 ## Updates
 
-| Update name | Description | Available for machines |
-|-------------|-------------| ---------------------- |
-| Gateway firmware | Firmware status of the gateway | all |
-| Machine firmware | Firmware status of the machine | all |
+| Update name | Description | Available for machines | Retrievable from |
+|-------------|-------------| ---------------------- |---------------- | 
+| **Gateway firmware** | Firmware status of the gateway |  `all` | {% icon "material-symbols:cloud-outline" title="La Marzocco Cloud" %} |
+| **Machine firmware** | Firmware status of the machine |  `all` | {% icon "material-symbols:cloud-outline" title="La Marzocco Cloud" %} |
 
 ## Selects
 
-| Select name | Description | Options | Available for machines | 
-|-------------|-------------| ------------------------| ---------------------- |
-| Prebrew/-infusion mode | Whether to use prebrew, preinfusion, or neither | Disabled, Prebrew, Preinfusion | Linea Micra, Linea Mini, GS3 AV |
-| Steam level | The level your steam boiler should run at | 1,2,3 | Linea Micra |
-| Smart standby mode | The smart standby mode, that decides from which events the timer to standby will run. | Last brewing, Power on | all |
+| Select name | Description | Options | Available for machines | Controllable through |
+|-------------|-------------| --------| ---------------------- | -------------------- |
+| **Prebrew/-infusion mode** | Whether to use prebrew, preinfusion, or neither | `Disabled`, `Prebrew`, `Preinfusion` | `Linea Micra`, `Linea Mini`, `GS3 AV` | {% icon "material-symbols:cloud-outline" title="La Marzocco Cloud" %} |
+| **Steam level** | The level your steam boiler should run at | `1`,`2`,`3` | `Linea Micra` | {% icon "material-symbols:cloud-outline" title="La Marzocco Cloud" %} <iconify-icon inline title="Bluetooth" icon="material-symbols:bluetooth"></iconify-icon> |
+| **Smart standby mode** | The smart standby mode, that decides from which events the timer to standby will run. | `Last brewing`, `Power on` | `all` | {% icon "material-symbols:cloud-outline" title="La Marzocco Cloud" %} |
 
 ## Supported devices
 
 Currently, only devices from the **"Home"** range are supported:
 
-- Linea Mini
-- Linea Mini R
-- Linea Micra
-- GS3 AV
-- GS3 MP
+- `Linea Mini`
+- `Linea Mini R`
+- `Linea Micra`
+- `GS3 AV`
+- `GS3 MP`
 
 ## Possible use-cases