Update wiki Home page for milo-client

gitea_admin 2026-10-12 05:39:07 +00:00
parent 0c84a32468
commit 0b59a20449

69
Home.md

@ -1,21 +1,62 @@
# Deploy the Project on CamelX Platform # OPC UA Client
Deploy on CamelX Platform in three steps Connect to OPC UA servers using the binary protocol for acquiring telemetry data.
## Step 1: Create a release ## Metadata
From the project space, click on **"Create a release"**
The new version is automatically available in the list | Property | Value |
|----------|-------|
| Scheme | `milo-client` |
| Support Level | Stable |
| Labels | iot |
| Version | 4.20.0 (CEQ 3.36.0) |
## Step 2: Deploy ## Maven Dependency
Click on **"Deploy"**
- **Version:** Select the desired release ```xml
- **Environment:** Choose `Development`, `Staging`, or `Production` <dependency>
- **Configuration:** Select the configuration source <groupId>org.apache.camel.quarkus</groupId>
- **Resources:** Set CPU and Memory <artifactId>camel-quarkus-milo</artifactId>
<version>4.20.0 (CEQ 3.36.0)</version>
</dependency>
```
## Step 3: Expose ## Endpoint Properties
Enable **"Expose"**
Choose an **API Gateway** (Internal, Public, etc.) | Name | Type | Required | Default | Description |
|------|------|----------|---------|-------------|
| `endpointUri` | string | ✓ | | The OPC UA server endpoint |
| `clientId` | string | | | A virtual client id to force the creation of a new connection instance |
| `dataChangeFilterDeadbandType` | object | | `0` | Deadband type for MonitorFilterType DataChangeFilter. |
| `dataChangeFilterDeadbandValue` | number | | `0.0` | Deadband value for MonitorFilterType DataChangeFilter. |
| `dataChangeFilterTrigger` | enum | | `StatusValueTimestamp` | Data change trigger for data change monitor filter type. |
| `defaultAwaitWrites` | boolean | | `false` | Default await setting for writes |
| `discoveryEndpointSuffix` | string | | | A suffix for endpoint URI when discovering |
| `discoveryEndpointUri` | string | | | An alternative discovery URI |
| `method` | string | | | The method definition (see Method ID) |
| `monitorFilterType` | enum | | | Monitor Filter Type for MonitoredItems. |
| `node` | string | | | The node definition (see Node ID) |
| `omitNullValues` | boolean | | `true` | Omit notifications in case of null values |
| `samplingInterval` | number | | `0.0` | The sampling interval in milliseconds |
| `bridgeErrorHandler` | boolean | | `false` | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. |
| `exceptionHandler` | object | | | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. |
| `exchangePattern` | enum | | | Sets the exchange pattern when the consumer creates an exchange. |
| `lazyStartProducer` | boolean | | `false` | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. |
| `allowedSecurityPolicies` | string | | | A set of allowed security policy URIs. Default is to accept all and use the highest. |
| `applicationName` | string | | `Apache Camel adapter for Eclipse Milo` | The application name |
| `applicationUri` | string | | `http://camel.apache.org/EclipseMilo/Client` | The application URI |
| `channelLifetime` | integer | | | Channel lifetime in milliseconds |
| `keyAlias` | string | | | The name of the key in the keystore file |
| `keyPassword` | string | | | The key password |
| `keyStorePassword` | string | | | The keystore password |
| `keyStoreType` | string | | | The key store type |
| `keyStoreUrl` | string | | | The URL where the key should be loaded from |
| `maxPendingPublishRequests` | integer | | | The maximum number of pending publish requests |
| `maxResponseMessageSize` | integer | | | The maximum number of bytes a response message may have |
| `overrideHost` | boolean | | `false` | Override the server reported endpoint host with the host from the endpoint URI. |
| `overridePort` | boolean | | `false` | Override the server reported endpoint port with the port from the endpoint URI. |
| `productUri` | string | | `http://camel.apache.org/EclipseMilo` | The product URI |
| `requestedPublishingInterval` | number | | `1_000.0` | The requested publishing interval in milliseconds |
| `requestTimeout` | integer | | | Request timeout in milliseconds |
| `sessionName` | string | | | Session name |
| `sessionTimeout` | integer | | | Session timeout in milliseconds |