Skip to content

Commit 048a15b

Browse files
piconempiconem
committed
Documentation updated for the release 0.4.0
1 parent 0b8dd66 commit 048a15b

File tree

12 files changed

+957
-15
lines changed

12 files changed

+957
-15
lines changed

‎README.md

+49
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,52 @@ npm run lint
1414
```
1515

1616
and follow the linting reccomendations.
17+
18+
## Run the Local Server
19+
20+
```bash
21+
npm run dev
22+
```
23+
24+
## Page Creation
25+
26+
Some examples of page creation through npm commands:
27+
28+
```bash
29+
npm run create docs/guides/dt_model.md
30+
npm run create docs/guides/dt-model/dt_model.md
31+
npm run create docs/guides/dt-model.md
32+
npm run create docs/guides/dt-life-cycle.md
33+
npm run create docs/introduction/library-structure.md
34+
npm run create docs/guides/physical-adapter.md
35+
npm run create docs/guides/_index.md
36+
npm run create docs/guides/shadowing-function.md
37+
npm run create docs/guides/digital-adapter.md
38+
npm run create docs/guides/dt-process.md
39+
npm run create docs/guides/digital-actions.md
40+
npm run create docs/guides/dt-relationships.md
41+
npm run create docs/guides/configurable-adapters.md
42+
npm run create docs/change-logs/change-log-0.3.0.md
43+
npm run create docs/change-logs/_index.md
44+
npm run create docs/adapters/_index.md
45+
npm run create docs/adapters/mqtt_physical.md
46+
npm run create docs/adapters/mqtt_digital.md
47+
npm run create docs/adapters/http_digital.md
48+
```
49+
50+
#### New Change Log Creation
51+
52+
```bash
53+
npm run create docs/change-logs/change-log-0.4.0.md
54+
```
55+
56+
#### Blog Post Creation
57+
58+
```bash
59+
npm run create blog/release_040.md
60+
```
61+
62+
## References
63+
64+
- Hyas: https://gethyas.com/
65+
- Thulite Docs: https://docs.thulite.io/

‎assets/images/wldt_events.jpg

2.37 MB
Loading

‎content/blog/release_030.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "ls WLDT Library Version 0.3.0"
2+
title: "WLDT Library Version 0.3.0"
33
description: "Introducing WLDT Library Version 0.3.0"
44
summary: ""
55
date: 2024-03-13T16:27:22+02:00

‎content/blog/release_040.md

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
title: "WLDT Library Version 0.4.0"
3+
description: ""
4+
summary: ""
5+
date: 2024-08-29T17:40:54+02:00
6+
lastmod: 2024-08-29T17:40:54+02:00
7+
draft: false
8+
weight: 50
9+
images: []
10+
categories: []
11+
tags: []
12+
contributors: []
13+
pinned: false
14+
homepage: false
15+
---
16+
17+
We're excited to announce the release of WLDT version 0.4.0! This update brings powerful new features to enhance your Digital Twin (DT) experience, including event observation capabilities, a robust storage layer, and a flexible query system.
18+
19+
For detailed information about these changes and their impact, please refer to the information provided:
20+
21+
- [Official Changelog](/docs/change-logs/change-log-0.4.0/)
22+
- [Official Documentation](/docs/guides/storage-layer/)
23+
24+
## Key Highlights
25+
26+
- **WldtEventObserver**: A new class has been introduced, simplifying the observation of specific events generated by Digital Twins and their components
27+
- **Storage Layer**: The new storage layer allows DTs to store data related to their state, events, actions, and more. It consists of:
28+
- `Storage Manager`: Manage and use various storage systems (e.g., in-memory, file-based, DBMS) simultaneously.
29+
- `WldtStorage`: An abstract class to implement custom storage systems. The default in-memory storage is available for development and testing.
30+
- `Query System`: The query system enables external components like Digital Adapters to retrieve stored data efficiently, supporting both synchronous and asynchronous queries.
31+
32+
WLDT 0.4.0 significantly enhances the flexibility and capabilities of Digital Twins, making it easier to manage and retrieve data, and observe events. We encourage developers to explore these new features and integrate them into their projects.
33+
34+
Stay tuned for more updates!

‎content/docs/adapters/http_digital.md

+87-5
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ Key Features:
2525
- **Dynamic Configuration:** Offers a flexible configuration mechanism through the HttpDigitalAdapterConfiguration, allowing developers to customize the adapter's behavior based on specific requirements.
2626
- **State Monitoring:** Monitors changes in the Digital Twin state and provides HTTP endpoints to query the state of the Digital Twin (properties, events, actions and relationships).
2727
- **Event Notifications:** Allows developers to retrieve event notifications triggered by changes in the Digital Twin state.
28+
- **Storage & Query:** Since version 0.2 the HTTP Digital Adapter is able to retrieve Storage Statistics and execute query on the target DT
2829

2930
![HTTP Digital Adapter](images/http_digital_adapter_schema.jpg)
3031

@@ -34,9 +35,10 @@ A complete example is provided in the `test` folder with a complete DT Creation
3435

3536
The correct mapping and compatibility between versions is reported in the following table
3637

37-
| **http-digital-adapter** | wldt-core 0.2.1 | wldt-core 0.3.0 |
38-
|:------------------------:|:------------------:|:------------------:|
39-
| 0.1.1 | :x: | :white_check_mark: |
38+
| **http-digital-adapter** | wldt-core 0.2.1 | wldt-core 0.3.0 | wldt-core 0.4.0 |
39+
|:------------------------:|:------------------:|:------------------:|:------------------:|
40+
| 0.1.1 | :x: | :white_check_mark: | :white_check_mark: |
41+
| 0.2 | :x: | :x: | :white_check_mark: |
4042

4143
## Installation
4244

@@ -48,14 +50,14 @@ To use HttpDigitalAdapter in your Java project, you can include it as a dependen
4850
<dependency>
4951
<groupId>io.github.wldt</groupId>
5052
<artifactId>http-digital-adapter</artifactId>
51-
<version>0.1.1</version>
53+
<version>0.2</version>
5254
</dependency>
5355
```
5456

5557
### Gradle
5658

5759
```groovy
58-
implementation 'io.github.wldt:http-digital-adapter:0.1.1'
60+
implementation 'io.github.wldt:http-digital-adapter:0.2'
5961
```
6062

6163
## Class Structure & Functionalities
@@ -198,8 +200,88 @@ Available endpoints with the associated methods are:
198200
- `POST` `/state/actions/{actionKey}`: Triggers the specified action (e.g., /state/actions/switch_on) in the Digital Twin state. The raw body contains the action request payload.
199201
- `GET` `/state/relationships`: Retrieves the list of relationships in the Digital Twin state.
200202
- `GET` `/state/relationships/{relationshipName}/instances`: Retrieves the instances of the specified relationship (e.g., /state/relationships/insideIn/instances) in the Digital Twin state.
203+
- `GET` `/storage`: Retrieves Storage Statistics from the target Digital Twin
204+
- `POST` `/storage/query`: Allows the execution of a query, where the query structure is specified through a JSON Message in the request Body. For additional information about the Query System see [Query System Page](/docs/guides/storage-layer/)
201205

202206
Note: Replace {propertyKey}, {actionKey}, and {relationshipName} with the actual values you want to retrieve or trigger.
203207
Make sure to use the appropriate HTTP method (GET, POST) and include any required parameters or payload as described in each endpoint's description. For more detailed information, refer to the Postman Collection for this API available in the folder `api`: [http_adapter_api_postman.json](https://github.com/wldt/http-digital-adapter-java/blob/master/api/http_adapter_api_postman.json)
204208

209+
Example of Storage Query Requests are the following:
205210

211+
Retrieve the first 4 Digital Twin State Variations
212+
213+
```json
214+
{
215+
"resourceType": "DIGITAL_TWIN_STATE",
216+
"queryType": "SAMPLE_RANGE",
217+
"startIndex": 0,
218+
"endIndex": 3
219+
}
220+
```
221+
222+
Retrieve Digital Twin State Variations in a Time Range
223+
224+
```json
225+
{
226+
"resourceType": "DIGITAL_TWIN_STATE",
227+
"queryType": "TIME_RANGE",
228+
"startIndex": 161989898,
229+
"endIndex": 162989898
230+
}
231+
```
232+
233+
Retrieve the last Digital Twin State
234+
235+
```json
236+
{
237+
"resourceType": "DIGITAL_TWIN_STATE",
238+
"queryType": "LAST_VALUE"
239+
}
240+
```
241+
242+
Available keywords for Query Resource Type and Query Type are the following (as explained in the dedicated [Query System Page](/docs/guides/storage-layer/)):
243+
244+
- PHYSICAL_ASSET_PROPERTY_VARIATION
245+
- TIME_RANGE
246+
- SAMPLE_RANGE
247+
- COUNT
248+
- PHYSICAL_ASSET_EVENT_NOTIFICATION
249+
- TIME_RANGE
250+
- SAMPLE_RANGE
251+
- COUNT
252+
- PHYSICAL_ACTION_REQUEST
253+
- TIME_RANGE
254+
- SAMPLE_RANGE
255+
- COUNT
256+
- DIGITAL_ACTION_REQUEST
257+
- TIME_RANGE
258+
- SAMPLE_RANGE
259+
- COUNT
260+
- DIGITAL_TWIN_STATE
261+
- TIME_RANGE
262+
- SAMPLE_RANGE
263+
- COUNT
264+
- LAST_VALUE
265+
- NEW_PAD_NOTIFICATION
266+
- TIME_RANGE
267+
- SAMPLE_RANGE
268+
- COUNT
269+
- UPDATED_PAD_NOTIFICATION
270+
- TIME_RANGE
271+
- SAMPLE_RANGE
272+
- COUNT
273+
- PHYSICAL_RELATIONSHIP_INSTANCE_CREATED_NOTIFICATION
274+
- TIME_RANGE
275+
- SAMPLE_RANGE
276+
- COUNT
277+
- PHYSICAL_RELATIONSHIP_INSTANCE_DELETED_NOTIFICATION
278+
- TIME_RANGE
279+
- SAMPLE_RANGE
280+
- COUNT
281+
- LIFE_CYCLE_EVENT
282+
- TIME_RANGE
283+
- SAMPLE_RANGE
284+
- COUNT
285+
- LAST_VALUE
286+
- STORAGE_STATS
287+
- LAST_VALUE

‎content/docs/adapters/mqtt_digital.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,10 @@ a test MQTT consumer.
4242

4343
The correct mapping and compatibility between versions is reported in the following table
4444

45-
| **mqtt-digital-adapter** | wldt-core 0.2.1 | wldt-core 0.3.0 |
46-
|:------------------------:|:------------------:|:------------------:|
47-
| 0.1.0 | :white_check_mark: | :x: |
48-
| 0.1.1 | :x: | :white_check_mark: |
45+
| **mqtt-digital-adapter** | wldt-core 0.2.1 | wldt-core 0.3.0 | wldt-core 0.4.0 |
46+
|:------------------------:|:------------------:|:------------------:|:------------------:|
47+
| 0.1.0 | :white_check_mark: | :x: | :x: |
48+
| 0.1.1 | :x: | :white_check_mark: | :white_check_mark: |
4949

5050
## Installation
5151

‎content/docs/adapters/mqtt_physical.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -47,10 +47,10 @@ a test MQTT consumer.
4747

4848
The correct mapping and compatibility between versions is reported in the following table
4949

50-
| **mqtt-physical-adapter** | wldt-core 0.2.1 | wldt-core 0.3.0 |
51-
|:-------------------------:|:------------------:|:------------------:|
52-
| 0.1.0 | :white_check_mark: | :x: |
53-
| 0.1.1 | :x: | :white_check_mark: |
50+
| **mqtt-physical-adapter** | wldt-core 0.2.1 | wldt-core 0.3.0 | wldt-core 0.4.0 |
51+
|:-------------------------:|:------------------:|:------------------:|:------------------:|
52+
| 0.1.0 | :white_check_mark: | :x: | :x: |
53+
| 0.1.1 | :x: | :white_check_mark: | :white_check_mark: |
5454

5555
## Installation
5656

0 commit comments

Comments
 (0)