Base+ Modbus Register Map

Register map for firmware version 1.5

Legend

Type

Description

RO / RW

Read Only / Read Write

xN

Multiplier used for value conversion

../../_images/PIC1.png

Register supports data transmission via Fast Modbus events

Device Description (For Internal Use Only).

Dec Addr

Hex Addr

Format

Access

Type

Description

Values

16

0x0010

U8

RO

Input

Device Type (Cloud)

“-”

17

0x0011

U8

RO

Input

HW Version (Cloud)

“-”

18

0x0012

U16

RO

Input

Firmware Version

“-”

19

0x0013

U16

RO

Input

Board Version

“-”

Service Registers (Communication Parameters, Factory Reset, Reboot). 0x1000 - 0x10FF (256 registers).

Dec Addr

Hex Addr

Format

Access

Type

Description

Values

110

0x006E

U16

RW

Holding

Modbus communication baud rate

12-1200, 24-2400, 48-4800, 96-9600, 192-19200, 384-38400, 576-57600, 1152-115200 bps

111

0x006F

U8

RW

Holding

Parity bit

0 - None, 1 - Odd, 2 - Even

112

0x0070

U8

RW

Holding

Number of stop bits

1, 2

114

0x0072

U8

RW

Holding

Continuous register reading mode with gaps

0 - Disabled, 1 - Enabled, 2 - Retained after reboot

128

0x0080

U8

RW

Holding

Modbus network address

0x01 - 0xF7

New communication settings take effect after device reboot.

Dec Addr

Hex Addr

Format

Access

Type

Description

Values

200

219

0x00C8

0x00DB

U8

RO

Input

Device Model

WK-BASE+ (1 character per register)

250

264

0x00FA

0x0108

U32

RO

Input

Firmware Version String

1.5 and higher (1 character per register)

290

300

0x0122

0x012C

U32

RO

Input

Firmware Signature

apt.3g (1 character per register)

270

271

0x010E

0x010F

U32

RW

Holding

Fast Modbus Serial Number (32-bit)

“-”

4112

0x1010

Bool

RW

Holding

Enter bootloader mode (settings preserved)

Any non-zero value written to the register places the device into bootloader mode for two minutes.

4113

0x1011

Bool

RW

Holding

Device reboot

0 - No action, 1 - Reboot

4114

0x1012

Bool

RW

Holding

Reset communication settings

0 - No action, 1 - Reset

4115

0x1013

Bool

RW

Holding

Reset settings except communication settings

0 - No action, 1 - Reset

4116

4127

0x1014

0x101F

“-”

“-”

“-”

Reserved gap between registers

“-”

4128

4129

0x1020

0x1021

U32

RW

Holding

UTC Time in UNIX format (32-bit)

Seconds

4130

4131

0x1022

0x1023

U32

RO

Input

Device uptime since power-on

Seconds

4132

4133

0x1024

0x1025

U32

RO

Input

Time until anti-seizure operation

Seconds; test register, may be omitted from user documentation

Main Device Parameters.

Dec Addr

Hex Addr

Format

Access

Type

Description

Register

Values

512

513

0x0200

0x0201

U32

RO

Input

Status Register

../../_images/PIC1.png

Upper 16 bits

Lower 16 bits

514

515

0x0202

0x0203

U32

RO

Input

Alarm Counter

../../_images/PIC1.png

Upper 16 bits

Lower 16 bits

516

517

0x0204

0x0205

U32

RO

Input

Valve Channel 1 Open/Close Count

../../_images/PIC1.png

Upper 16 bits

Lower 16 bits

561

0x0231

Bool

RW

Holding

Shut-off Valve Control

../../_images/PIC1.png

1 - Valve Open, 0 - Valve Closed

562

0x0232

Bool

RW

Holding

Wet Cleaning Mode

../../_images/PIC1.png

1 - Wet Cleaning Mode, 0 - Normal Mode

563

0x0233

Bool

RW

Holding

Audible Alarm Enable

1 - Enabled, 0 - Disabled

564

0x0234

Bool

RW

Holding

Alarm Mode

../../_images/PIC1.png

1 - Alarm, 0 - Normal Mode Writing 1 has no effect, 0 - Exit Alarm Mode

565

0x0235

Bool

RO

Input

External Contact State

../../_images/PIC1.png

1 - Closed, 0 - Open

566

0x0236

Bool

RO

Input

Anti-Seizure Operation Active

../../_images/PIC1.png

1 - Currently Running, 0 - Not Running

576

0x0240

U16

RW

Holding

Anti-Seizure Protection Interval

7 - 28 Days

New communication settings (address, baud rate, stop bits, and parity) take effect only after a device reboot.

Disabling the alarm via register 0x0234 is possible only if the leak sensor no longer reports a leak. Otherwise, the alarm remains active, but the audible indication is muted until the next alarm event.

Registers 0x010E and 0x010F describe the device serial number used during Fast Modbus arbitration when scanning the network. In the event of serial number conflicts, it can be overridden by writing any value in the range from 1 to 268,435,455 (0x00000001 - 0x0FFFFFFF). A value of 0 means “use the default serial number”.

Registers 0x1024 and 0x1025 are used to test the anti-seizure function. They allow monitoring the current stage of device operation and indicate the remaining time until the anti-seizure function is expected to activate.

Registers 0x00C8 - 0x00DB contain the ASCII codes of the device model. For the BASE+ leak protection device this string is "WK-BASE+".

Firmware version register 0x0012 consists of two parts: major and minor version numbers (for example, version 1.0 consists of major version 1 and minor version 0). Accordingly, the register is divided into two bytes:

  • Lower byte — minor version

  • Upper byte — major version

Status Register Description (0x0200 - 0x0201)

Bit No.

Description

Value

31-7

Reserved

“-”

6

Shut-off Valve State

0 – Valve Closed, 1 – Valve Open

5

Wet Cleaning Mode

0 – Wet Cleaning Mode Disabled, 1 – Wet Cleaning Mode Enabled

4

Audible Alarm State

0 – Audible alarm disabled during alarm events, 1 – Audible alarm enabled during alarm events

3

Anti-Seizure Protection

0 – Not Running, 1 – Running

2

External Contact State

0 – Contact Open, 1 – Contact Closed

1

Leak Sensor State

0 – Sensor Dry, 1 – Sensor Wet

0

Device State

0 – Normal operation, no leak detected; 1 – Alarm, leak detected