mirror of
https://gitee.com/pnoker/iot-dc3.git
synced 2026-10-31 18:21:58 +08:00
pnoker
769d1cb977
- expand single-line Javadocs to multi-line blocks, rewrap Markdown prose, and reflow POM, YAML, and TypeScript formatting - formatting only: no Java code lines changed, no build-file semantics changed - verified: backend compile and check_documentation.py pass, pnpm check and pnpm lint:check pass, and the dc3 YAML files parse
2.4 KiB
2.4 KiB
DC3 Driver HTTP
Overview
dc3-driver-http is the HTTP REST client driver of the IoT DC3 platform. It uses Spring WebFlux WebClient to call
configured REST endpoints, reads point values from JSON responses (with simple JSON path extraction), and writes values
via request body templates containing a ${value} placeholder.
Module Information
- Group ID: io.github.pnoker
- Artifact ID: dc3-driver-http
- Driver Name: HTTP REST Client Driver
Driver Attributes (Device-level)
| Attribute | Description |
|---|---|
| Base URL | Base URL for API requests (e.g. https://api.example.com) |
| Method | Default HTTP method (GET, POST, PUT, DELETE) |
| Headers | Custom headers as JSON (e.g. {"Authorization":"Bearer xxx"}) |
| Timeout | Request timeout in milliseconds |
Point Attributes
| Attribute | Description |
|---|---|
| Path | API path (e.g. /api/v1/sensor/{id}) |
| Method | HTTP method override for this point |
| Body Template | Request body template with ${value} placeholder |
| Response Path | JSON path to extract value (e.g. $.data.temperature) |
Command Attributes (write)
| Attribute | Description |
|---|---|
| Path | API path for command |
| Method | HTTP method for command |
The module application.yml is authoritative for attribute codes, types, default values, scheduling, health, and local
buffering. Keep this README aligned when those user-facing settings change.
Prerequisites
A reachable HTTP/REST endpoint that the driver can call as configured via the device's Base URL and point paths.
Running Locally
1. Start Infrastructure and Center Services
make up-db
make up-dev GROUP=core
2. Build and Run
mvn -s .mvn/settings.xml -pl dc3-driver/dc3-driver-http -am package
java -jar dc3-driver/dc3-driver-http/target/dc3-driver-http.jar
Testing
Run the module tests from the repository root:
mvn -s .mvn/settings.xml -pl dc3-driver/dc3-driver-http -am test
Related Modules
dc3-common-driver— Driver SDK for registration, scheduling, and RabbitMQ integration