# Modbus Commander

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

Write and read Modbus register.

<!-- END GENERATED -->

_Installation guide coming soon._

## Reference

<!-- BEGIN GENERATED: integrationpluginmodbuscommander.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:** `ModbusCommander`

#### Supported models
| Model | Role | Transport | Pairing | Quantities |
| --- | --- | --- | --- | --- |
| **Modbus TCP client** | — | Modbus TCP | Manual / Auto-discovery | 1 |
| **Modbus RTU client** | — | Modbus RTU | Auto-discovery | 1 |
| **Coil** | — | — | Auto-discovery | 2 |
| **Discrete input** | — | — | Auto-discovery | 2 |
| **Input register** | — | — | Auto-discovery | 2 |
| **Holding register** | — | — | Auto-discovery | 2 |

#### Per-model detail
??? abstract "Modbus TCP client — `modbusTCPClient`"
    _Settings:_

    | Key | Label | Type | Range | Default | Read-only |
    | --- | --- | --- | --- | --- | --- |
    | `ipAddress` | IP Address | QString | — | `127.0.0.1` | no |
    | `port` | Port | uint | — | `502` | no |

    _Measured quantities:_

    | Key | Quantity | Type | Unit |
    | --- | --- | --- | --- |
    | `connected` | Connected | bool | — |

??? abstract "Modbus RTU client — `modbusRTUClient`"
    _Settings:_

    | Key | Label | Type | Range | Default | Read-only |
    | --- | --- | --- | --- | --- | --- |
    | `modbusMasterUuid` | Modbus RTU master | QUuid | — | — | no |

    _Measured quantities:_

    | Key | Quantity | Type | Unit |
    | --- | --- | --- | --- |
    | `connected` | Connected | bool | — |

??? abstract "Coil — `coil`"
    _Settings:_

    | Key | Label | Type | Range | Default | Read-only |
    | --- | --- | --- | --- | --- | --- |
    | `slaveAddress` | Slave address | uint | — | `1` | no |
    | `registerAddress` | Register address | uint | — | `0` | no |

    _Measured quantities:_

    | Key | Quantity | Type | Unit |
    | --- | --- | --- | --- |
    | `connected` | Connected | bool | — |
    | `value` | Value | bool | — |

??? abstract "Discrete input — `discreteInput`"
    _Settings:_

    | Key | Label | Type | Range | Default | Read-only |
    | --- | --- | --- | --- | --- | --- |
    | `slaveAddress` | Slave address | uint | — | `1` | no |
    | `registerAddress` | Register address | uint | — | `0` | no |

    _Measured quantities:_

    | Key | Quantity | Type | Unit |
    | --- | --- | --- | --- |
    | `connected` | Connected | bool | — |
    | `value` | Value | bool | — |

??? abstract "Input register — `inputRegister`"
    _Settings:_

    | Key | Label | Type | Range | Default | Read-only |
    | --- | --- | --- | --- | --- | --- |
    | `slaveAddress` | Slave address | uint | — | `1` | no |
    | `registerAddress` | Register address | uint | — | `0` | no |

    _Measured quantities:_

    | Key | Quantity | Type | Unit |
    | --- | --- | --- | --- |
    | `connected` | Connected | bool | — |
    | `value` | Value | int | — |

??? abstract "Holding register — `holdingRegister`"
    _Settings:_

    | Key | Label | Type | Range | Default | Read-only |
    | --- | --- | --- | --- | --- | --- |
    | `slaveAddress` | Slave address | uint | — | `1` | no |
    | `registerAddress` | Register address | uint | — | `0` | no |

    _Measured quantities:_

    | Key | Quantity | Type | Unit |
    | --- | --- | --- | --- |
    | `connected` | Connected | bool | — |
    | `value` | Value | uint | — |

<!-- END GENERATED -->