Skip to content

Commit 79a9ac1

Browse files
committed
update readme
1 parent 0b0f5ad commit 79a9ac1

File tree

1 file changed

+29
-23
lines changed

1 file changed

+29
-23
lines changed

README.md

Lines changed: 29 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -5,28 +5,34 @@ Plugin for polling Modbus devices and publishing the data to thin-edge.io. If us
55

66
## Table of contents
77

8-
- [Overview](#overview)
9-
- [Requirements](#requirements)
10-
- [Demo](#demo)
11-
- [Config files](#config-files)
12-
- [modbus.toml](#modbustoml)
13-
- [devices.toml](#devicestoml)
14-
- [Updating the config files](#updating-the-config-files)
15-
- [Logs and systemd service](#logs-and-systemd-service)
16-
- [Cumulocity Integration](#cumulocity-integration)
17-
18-
- [Installation via Software Management](#installation-via-software-management)
19-
- [Log file access](#log-file-access)
20-
- [Config management](#config-management)
21-
- [Cloud Fieldbus](#cloud-fieldbus)
22-
- [Writing operations](#writing-operations)
23-
24-
- [Testing](#testing)
25-
- [Build](#build)
26-
- [Debian package](#debian-package)
27-
- [Deployment](#deployment)
28-
- [As Python script (for dev only)](#as-python-script-for-dev-only)
29-
- [As deb file](#as-deb-file)
8+
- [tedge-modbus-plugin](#tedge-modbus-plugin)
9+
- [Table of contents](#table-of-contents)
10+
- [Overview](#overview)
11+
- [Requirements](#requirements)
12+
- [Demo](#demo)
13+
- [Config files](#config-files)
14+
- [modbus.toml](#modbustoml)
15+
- [devices.toml](#devicestoml)
16+
- [Updating the config files](#updating-the-config-files)
17+
- [Logs and systemd service](#logs-and-systemd-service)
18+
- [Cumulocity Integration](#cumulocity-integration)
19+
- [Installation via Software Management](#installation-via-software-management)
20+
- [Log file access](#log-file-access)
21+
- [Config management](#config-management)
22+
- [Cloud Fieldbus](#cloud-fieldbus)
23+
- [Write operations](#write-operations)
24+
- [thin-edge.io Commands](#thin-edgeio-commands)
25+
- [Payload Formats](#payload-formats)
26+
- [Write to Register (c8y\_SetRegister / modbus\_SetRegister)](#write-to-register-c8y_setregister--modbus_setregister)
27+
- [Write to Coil (c8y\_SetCoil / modbus\_SetCoil)](#write-to-coil-c8y_setcoil--modbus_setcoil)
28+
- [Testing](#testing)
29+
- [Build](#build)
30+
- [Debian package](#debian-package)
31+
- [Deployment](#deployment)
32+
- [As Python script (for dev only)](#as-python-script-for-dev-only)
33+
- [As deb file](#as-deb-file)
34+
- [Contributing](#contributing)
35+
- [Coding Style](#coding-style)
3036

3137
## Overview
3238

@@ -193,7 +199,7 @@ The plugin supports two payload formats for write operations:
193199
1. **Explicit address format** - directly specify register/coil address and parameters
194200
2. **Name-based format** - use metrics array with name field to match configuration in devices.toml
195201

196-
For the name-based format, the `name` field in devices.toml registers/coils configuration is required to match the metrics. The matching uses prefix matching: if the metric name starts with the configured name, it will match. For example, a metric name `"test_test_setPoint"` will match a register with `name = "test_test"` in devices.toml.
202+
For the name-based format, the `name` field in devices.toml registers/coils configuration is required to match the metrics. The matching uses prefix matching: if the metric name starts with the configured name, it will match. For example, a metric name `"foo_bar_setPoint"` will match a register with `name = "foo_bar"` in devices.toml.
197203

198204
**Command Status Flow:**
199205
- Commands with `"status": "init"` are automatically converted to `"executing"` by the plugin

0 commit comments

Comments
 (0)