# SG-Ready

<!-- BEGIN GENERATED: __badges_sgready__ -->
<span class="badge stable">STABLE</span> <span class="badge origin-nymea">NYMEA</span> <span class="badge community">COMMUNITY</span>

Control heat pumps offering the SG-Ready interface using GPIOs.

<!-- END GENERATED -->

_Installation guide coming soon._

## Reference

<!-- BEGIN GENERATED: integrationpluginsgready.json -->
!!! info "Application labels"
    The keys and labels below are the ones the application shows,
    **in English**. They are left verbatim so that you find them
    word for word on screen.

**Manufacturer:** nymea  
**Plugin:** `SgReady`

#### Supported models
| Model | Role | Transport | Pairing | Quantities |
| --- | --- | --- | --- | --- |
| **SG Ready interface** | smartgridheatpump | — | Manual | 3 |

#### Per-model detail
??? abstract "SG Ready interface — `sgReadyInterface`"
    _Settings:_

    | Key | Label | Type | Range | Default | Read-only |
    | --- | --- | --- | --- | --- | --- |
    | `gpioNumber1` | GPIO number 1 | int | — | `-1` | no |
    | `gpioNumber2` | GPIO number 2 | int | — | `-1` | no |

    _Measured quantities:_

    | Key | Quantity | Type | Unit |
    | --- | --- | --- | --- |
    | `sgReadyMode` | Smart grid mode | QString | — |
    | `gpio1State` | Relay 1 enabled | bool | — |
    | `gpio2State` | Relay 2 enabled | bool | — |

<!-- END GENERATED -->