Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update lamarzocco documentation with connection methods per entity #35985

Merged
merged 14 commits into from
Dec 1, 2024
Merged

Update lamarzocco documentation with connection methods per entity #35985

Changes from 10 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
25bd85a
Update lamarzocco.markdown
zweckj Nov 26, 2024
96d2f40
Update lamarzocco.markdown
zweckj Nov 26, 2024
c8af1ab
Update lamarzocco.markdown
zweckj Nov 26, 2024
f9b3bf9
Update lamarzocco.markdown
zweckj Nov 26, 2024
3c1b7e3
Update lamarzocco.markdown
zweckj Nov 26, 2024
05a60ff
Update lamarzocco.markdown
zweckj Nov 26, 2024
3895bd3
Update lamarzocco.markdown
zweckj Nov 26, 2024
dff1aae
backtick options
zweckj Nov 26, 2024
b420bc7
bold ui strings
zweckj Nov 26, 2024
d3d5793
use extensive code for bluetooth icons
zweckj Nov 27, 2024
be5397e
Update lamarzocco.markdown
zweckj Nov 27, 2024
c5e93b4
add titles
zweckj Nov 28, 2024
cc0f5fd
Merge branch 'current' into lamarzocco/icon-test
zweckj Nov 28, 2024
1580a9a
Update lamarzocco.markdown
zweckj Nov 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
92 changes: 48 additions & 44 deletions source/_integrations/lamarzocco.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,77 +67,81 @@ Use Bluetooth:

# Available platforms & entities

{% icon "material-symbols:cloud-outline" %} = La Marzocco Cloud
<iconify-icon inline title="Bluetooth" icon="material-symbols:bluetooth"></iconify-icon> = Bluetooth
{% icon "material-symbols:wifi" %} = Local network
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe show this as a list?

I like that you use icons to make it clear to users what is supported ❤️

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought about that, but didn't want to use too much estate for the legend. I think it's pretty neat as well, just waiting for another PR, so the icons have proper titles e.g. for screen readers.


## 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" %} |


## 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" %} <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" %} <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" %} | - |
| **Dose** | Doseage (in ticks) for each key | `GS3 AV` | {% icon "material-symbols:cloud-outline" %} | 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" %} | 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" %} | 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" %} | 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" %} | - |


## 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" %} <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" %} <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" %} |

## 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" %} {% icon "material-symbols:wifi" %} | - |
| **Brewing active** | Is on if you are in the process of making coffee. | `all` | {% icon "material-symbols:wifi" %} | 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" %} {% icon "material-symbols:wifi" %} | - |

## 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" %} {% icon "material-symbols:wifi" %} | 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" %} {% icon "material-symbols:wifi" %} | - |
| **Total coffees made** | Counter for total coffees made| `all` | {% icon "material-symbols:cloud-outline" %} | - |
| **Total flushes made** | Counter for total flushes done | `all` | {% icon "material-symbols:cloud-outline" %}| - |
| **Shot timer** | Time the current brew is running | `all` | {% icon "material-symbols:wifi" %} | 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" %} |
| **Machine firmware** | Firmware status of the machine | `all` | {% icon "material-symbols:cloud-outline" %} |

## 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" %} |
| **Steam level** | The level your steam boiler should run at | `1`,`2`,`3` | `Linea Micra` | {% icon "material-symbols:cloud-outline" %} <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" %} |

## 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

Expand Down