[@wago/wdx-schema](../README.md) / [Exports](../modules.md) / [WDX](../modules/WDX.md) / [Schema](../modules/WDX.Schema.md) / [Model](../modules/WDX.Schema.Model.md) / [Instance](../modules/WDX.Schema.Model.Instance.md) / [DataAdapter](../modules/WDX.Schema.Model.Instance.DataAdapter.md) / MODBUSOptions

# Class: MODBUSOptions

[Instance](../modules/WDX.Schema.Model.Instance.md).[DataAdapter](../modules/WDX.Schema.Model.Instance.DataAdapter.md).MODBUSOptions

## Table of contents

### Constructors

- [constructor](WDX.Schema.Model.Instance.DataAdapter.MODBUSOptions.md#constructor)

### Properties

- [clientId](WDX.Schema.Model.Instance.DataAdapter.MODBUSOptions.md#clientid)
- [connectTimeout](WDX.Schema.Model.Instance.DataAdapter.MODBUSOptions.md#connecttimeout)
- [connectionType](WDX.Schema.Model.Instance.DataAdapter.MODBUSOptions.md#connectiontype)
- [hiByte](WDX.Schema.Model.Instance.DataAdapter.MODBUSOptions.md#hibyte)
- [host](WDX.Schema.Model.Instance.DataAdapter.MODBUSOptions.md#host)
- [id](WDX.Schema.Model.Instance.DataAdapter.MODBUSOptions.md#id)
- [instance](WDX.Schema.Model.Instance.DataAdapter.MODBUSOptions.md#instance)
- [maxRegistryGroupLength](WDX.Schema.Model.Instance.DataAdapter.MODBUSOptions.md#maxregistrygrouplength)
- [mostSignificantByte](WDX.Schema.Model.Instance.DataAdapter.MODBUSOptions.md#mostsignificantbyte)
- [mostSignificantWord](WDX.Schema.Model.Instance.DataAdapter.MODBUSOptions.md#mostsignificantword)
- [poolInterval](WDX.Schema.Model.Instance.DataAdapter.MODBUSOptions.md#poolinterval)
- [port](WDX.Schema.Model.Instance.DataAdapter.MODBUSOptions.md#port)
- [reconnectTimeout](WDX.Schema.Model.Instance.DataAdapter.MODBUSOptions.md#reconnecttimeout)
- [rtuBaudRate](WDX.Schema.Model.Instance.DataAdapter.MODBUSOptions.md#rtubaudrate)
- [rtuBufferSize](WDX.Schema.Model.Instance.DataAdapter.MODBUSOptions.md#rtubuffersize)
- [rtuDataBits](WDX.Schema.Model.Instance.DataAdapter.MODBUSOptions.md#rtudatabits)
- [rtuParity](WDX.Schema.Model.Instance.DataAdapter.MODBUSOptions.md#rtuparity)
- [rtuPath](WDX.Schema.Model.Instance.DataAdapter.MODBUSOptions.md#rtupath)
- [rtuRtsCts](WDX.Schema.Model.Instance.DataAdapter.MODBUSOptions.md#rturtscts)
- [rtuStopBits](WDX.Schema.Model.Instance.DataAdapter.MODBUSOptions.md#rtustopbits)
- [rtuX](WDX.Schema.Model.Instance.DataAdapter.MODBUSOptions.md#rtux)
- [rtuXany](WDX.Schema.Model.Instance.DataAdapter.MODBUSOptions.md#rtuxany)
- [rtuXoff](WDX.Schema.Model.Instance.DataAdapter.MODBUSOptions.md#rtuxoff)
- [rtuXon](WDX.Schema.Model.Instance.DataAdapter.MODBUSOptions.md#rtuxon)
- [timeout](WDX.Schema.Model.Instance.DataAdapter.MODBUSOptions.md#timeout)
- [uuid](WDX.Schema.Model.Instance.DataAdapter.MODBUSOptions.md#uuid)
- [zeroBasedAddressing](WDX.Schema.Model.Instance.DataAdapter.MODBUSOptions.md#zerobasedaddressing)

## Constructors

### constructor

• **new MODBUSOptions**(): [`MODBUSOptions`](WDX.Schema.Model.Instance.DataAdapter.MODBUSOptions.md)

#### Returns

[`MODBUSOptions`](WDX.Schema.Model.Instance.DataAdapter.MODBUSOptions.md)

## Properties

### clientId

• **clientId**: `number`

#### Defined in

src/WDX/Schema/Model/Instance/DataAdapter/MODBUSOptions.ts:127

___

### connectTimeout

• **connectTimeout**: `number`

#### Defined in

src/WDX/Schema/Model/Instance/DataAdapter/MODBUSOptions.ts:133

___

### connectionType

• **connectionType**: [`MODBUSConnectionType`](../enums/WDX.Schema.Model.Instance.DataAdapter.MODBUSConnectionType.md)

#### Defined in

src/WDX/Schema/Model/Instance/DataAdapter/MODBUSOptions.ts:28

___

### hiByte

• **hiByte**: `boolean`

SHORT/USHORT: we read the first byte under the configured byte order.
If your device actually uses the other byte.

#### Defined in

src/WDX/Schema/Model/Instance/DataAdapter/MODBUSOptions.ts:179

___

### host

• **host**: `string`

#### Defined in

src/WDX/Schema/Model/Instance/DataAdapter/MODBUSOptions.ts:33

___

### id

• `Optional` **id**: `number`

#### Defined in

src/WDX/Schema/Model/Instance/DataAdapter/MODBUSOptions.ts:16

___

### instance

• **instance**: [`MODBUSDataAdapterInstance`](WDX.Schema.Model.Instance.DataAdapter.MODBUSDataAdapterInstance.md)

#### Defined in

src/WDX/Schema/Model/Instance/DataAdapter/MODBUSOptions.ts:195

___

### maxRegistryGroupLength

• **maxRegistryGroupLength**: `number`

#### Defined in

src/WDX/Schema/Model/Instance/DataAdapter/MODBUSOptions.ts:185

___

### mostSignificantByte

• **mostSignificantByte**: `boolean`

#### Defined in

src/WDX/Schema/Model/Instance/DataAdapter/MODBUSOptions.ts:157

___

### mostSignificantWord

• **mostSignificantWord**: `boolean`

#### Defined in

src/WDX/Schema/Model/Instance/DataAdapter/MODBUSOptions.ts:163

___

### poolInterval

• **poolInterval**: `number`

#### Defined in

src/WDX/Schema/Model/Instance/DataAdapter/MODBUSOptions.ts:151

___

### port

• **port**: `number`

#### Defined in

src/WDX/Schema/Model/Instance/DataAdapter/MODBUSOptions.ts:38

___

### reconnectTimeout

• **reconnectTimeout**: `number`

#### Defined in

src/WDX/Schema/Model/Instance/DataAdapter/MODBUSOptions.ts:139

___

### rtuBaudRate

• **rtuBaudRate**: `number`

How fast bits are sent. Common Modbus values: 9600, 19200, 38400, 57600, 115200.
Tip: Start with the slave’s documented baud. Higher ≠ better if the line is long/noisy.

#### Defined in

src/WDX/Schema/Model/Instance/DataAdapter/MODBUSOptions.ts:52

___

### rtuBufferSize

• **rtuBufferSize**: `number`

Driver/read buffer size. Modbus-RTU max response is ~256 bytes (253 PDU + addr + CRC). Give headroom.
Typical: 512 or 1024.

#### Defined in

src/WDX/Schema/Model/Instance/DataAdapter/MODBUSOptions.ts:122

___

### rtuDataBits

• **rtuDataBits**: `number`

Bits per character, usually 8 for Modbus (a.k.a. “8N1” or “8E1”). Some very old gear uses 7.
Typical: 8.

#### Defined in

src/WDX/Schema/Model/Instance/DataAdapter/MODBUSOptions.ts:61

___

### rtuParity

• **rtuParity**: [`MODBUSRTUParity`](../enums/WDX.Schema.Model.Instance.DataAdapter.MODBUSRTUParity.md)

parity?: 'none' | 'even' | 'mark' | 'odd' | 'space'
Error detection bit in each character. Modbus-RTU devices most often use even or none.
Typical: 'even' (8E1) or 'none' (8N1). Match the slave exactly.

#### Defined in

src/WDX/Schema/Model/Instance/DataAdapter/MODBUSOptions.ts:80

___

### rtuPath

• **rtuPath**: `string`

#### Defined in

src/WDX/Schema/Model/Instance/DataAdapter/MODBUSOptions.ts:43

___

### rtuRtsCts

• **rtuRtsCts**: `boolean`

Hardware flow control (RTS/CTS). RS-485 adapters often don’t use CTS/RTS for flow; many do auto-direction. Enable only if your adapter/slave requires it.
Typical: false for Modbus-RTU.

#### Defined in

src/WDX/Schema/Model/Instance/DataAdapter/MODBUSOptions.ts:89

___

### rtuStopBits

• **rtuStopBits**: `number`

Time between characters to let receivers resync. Usually 1; some devices require 2 at high baud or with parity=none.
Typical: 1 (or 2 if the device manual says so).

#### Defined in

src/WDX/Schema/Model/Instance/DataAdapter/MODBUSOptions.ts:70

___

### rtuX

• **rtuX**: `boolean`

#### Defined in

src/WDX/Schema/Model/Instance/DataAdapter/MODBUSOptions.ts:113

___

### rtuXany

• **rtuXany**: `boolean`

#### Defined in

src/WDX/Schema/Model/Instance/DataAdapter/MODBUSOptions.ts:108

___

### rtuXoff

• **rtuXoff**: `boolean`

#### Defined in

src/WDX/Schema/Model/Instance/DataAdapter/MODBUSOptions.ts:103

___

### rtuXon

• **rtuXon**: `boolean`

Software (in-band) flow control. Modbus frames are binary and should not use XON/XOFF.
Typical: false for all three.

#### Defined in

src/WDX/Schema/Model/Instance/DataAdapter/MODBUSOptions.ts:98

___

### timeout

• **timeout**: `number`

#### Defined in

src/WDX/Schema/Model/Instance/DataAdapter/MODBUSOptions.ts:145

___

### uuid

• **uuid**: `string`

#### Defined in

src/WDX/Schema/Model/Instance/DataAdapter/MODBUSOptions.ts:22

___

### zeroBasedAddressing

• **zeroBasedAddressing**: `boolean`

#### Defined in

src/WDX/Schema/Model/Instance/DataAdapter/MODBUSOptions.ts:169