IoT SiteWise OPC-UA collector

The IoT SiteWise OPC-UA collector component (aws.iot.SiteWiseEdgeCollectorOpcua) enables Amazon IoT SiteWise gateways to collect data from local OPC-UA servers.

With this component, Amazon IoT SiteWise gateways can connect to multiple OPC-UA servers. For more information about Amazon IoT SiteWise gateways, see Using Amazon IoT SiteWise at the edge in the Amazon IoT SiteWise User Guide.

Versions

This component has the following versions:

Type

This component is a generic component (aws.greengrass.generic). The Greengrass nucleus runs the component's lifecycle scripts.

For more information, see Component types.

Operating system

Requirements

This component has the following requirements:

Dependencies

When you deploy a component, Amazon IoT Greengrass also deploys compatible versions of its dependencies. This means that you must meet the requirements for the component and all of its dependencies to successfully deploy the component. This section lists the dependencies for the released versions of this component and the semantic version constraints that define the component versions for each dependency. You can also view the dependencies for each version of the component in the Amazon IoT Greengrass console. On the component details page, look for the Dependencies list.

The following table lists the dependencies for all versions of this component.

For more information about component dependencies, see the component recipe reference.

Configuration

This component doesn't have any configuration parameters.

You can use the Amazon IoT SiteWise console or API to configure the IoT SiteWise OPC-UA collector component. For more information, see Step 4: Add data sources - optional in the Amazon IoT SiteWise User Guide.

Input data

This component only accepts data in the following formats, all others will be ignored and discarded. The table below maps the OPC UA data types to their SiteWise equivalent.

* For OPC UA data types UInt32 and Int64, its SiteWise data type will be INTEGER if SiteWise is able to represent its value, otherwise it will be DOUBLE.

Output data

This component writes BatchPutAssetPropertyValue messages to Amazon IoT Greengrass stream manager. For more information, see BatchPutAssetPropertyValue in the Amazon IoT SiteWise API Reference.

Local log file

This component uses the following log file.

Troubleshooting and debugging

This component includes a new events log to help customers identify and fix problems. The log file is separate from the local log file, and is found in the following location. Replace /greengrass/v2 or C:\greengrass\v2 with the path to the Amazon IoT Greengrass root folder.

This log includes detailed information and troubleshooting instructions. Troubleshooting information is provided alongside the diagnostics, with a description of how to remedy the issue, and sometimes with links to further information. Diagnostic information includes the following:

dataSourceConnectionSuccess:
  Summary: Successfully connected to OpcUa server
  Level: INFO
  Timestamp: '2023-06-15T21:04:16.303Z'
  Description: Successfully connected to the data source.
  AssociatedMetrics:
  - Name: FetchedDataStreams
    Description: The number of fetched data streams for this data source
    Value: 1.0
    Namespace: IoTSiteWise
    Dimensions:
    - Name: SourceName
      Value: SourceName{value=OPC-UA Server}
    - Name: ThingName
      Value: test-core
  AssociatedData:
  - Name: DataSourceTrace
    Description: Name of the data source
    Data:
    - OPC-UA Server
  - Name: EndpointUri
    Description: The endpoint to which the connection was attempted.
    Data:
    - '"opc.tcp://10.0.0.1:1234"'

Licenses

This component is released under the Greengrass Core Software License Agreement.

Changelog

The following table describes the changes in each version of the component.

See also