Configure an Ethernet/IP (EIP) source - AWS IoT SiteWise
Configure an Ethernet/IP source (CLI)

Configure an Ethernet/IP (EIP) source

You can use the AWS IoT SiteWise console or a SiteWise Edge gateway capability to define and add an Ethernet IP source to your SiteWise Edge gateway. This source represents a local Ethernet IP server.

Note

  • SiteWise Edge gateways running on AWS IoT Greengrass V2 currently don't support Ethernet IP sources.

  • You must install the AWS IoT SiteWise connector to use an Ethernet IP source.

To configure an Ethernet/IP source

  1. Navigate to the AWS IoT SiteWise console.

  2. In the left navigation pane, choose Gateways.

  3. On the SiteWise Edge gateway you want to create a source for, choose Manage, and then choose View details.

    AWS IoT SiteWise "Gateways" page screenshot with "View details" highlighted.

  4. Choose New source in the upper-right corner.

  5. For Protocol options, choose Ethernet/IP (EIP).

  6. For EtherNet/IP source configuration, enter a Name for the source.

  7. For IP address, enter the IP address for the data source server.

  8. (Optional) Enter the Port for the source server.

  9. For Minimum inter-request duration, enter the time interval between subsequent requests sent to your server. Your SiteWise Edge gateway automatically calculates the minimum allowable interval based on your device and the number of registers you have.

  10. For Property groups, enter a Name.

  11. For Properties:

    1. For Tag, enter the property alias for your register set. For example, boiler.inlet.temperature.value.

    2. For Destination data type, choose the AWS IoT SiteWise data type that you want your data to be converted to. The default is String.

  12. For Scan rate, update the rate at which you want the SiteWise Edge gateway to read your registers. AWS IoT SiteWise automatically calculates the minimum allowable scan rate for your SiteWise Edge gateway.

  13. (Optional) For Destination, choose where the source data is sent. By default, your source sends data to AWS IoT SiteWise.You can use a AWS IoT Greengrass stream to export your data to a local destination or to the AWS Cloud instead.

    Note

    You must choose AWS IoT SiteWise as the destination for your source data if you want to process data from this source at the edge with AWS IoT SiteWise. For more information about processing data at the edge, see Turn on edge data processing.

    To send your data to another destination:

    1. For Destination options, choose Other destinations.

    2. For Greengrass stream name, enter the exact name of your AWS IoT Greengrass stream.

      Note

      You can use a stream that you've already created, or you can create a new AWS IoT Greengrass stream to export your data. If you want to use an existing stream, you must enter the exact name of the stream or a new stream will be created.

      For more information about working with AWS IoT Greengrass streams, see Manage data streams in the AWS IoT Greengrass developer guide.

  14. Choose Add source.

    AWS IoT SiteWise deploys the SiteWise Edge gateway configuration to your AWS IoT Greengrass core. You don't need to manually launch a deployment.

Configure an Ethernet/IP source (CLI)

You can define EIP data sources in a SiteWise Edge gateway capability. You must define all of your EIP sources in a single capability configuration.

Note

You must install the AWS IoT SiteWise connector to use an Ethernet IP source.

This capability has the following versions.

Version Namespace
1 iotsitewise:eipcollector:1

EIP capability configuration parameters

When you define EIP sources in a capability configuration, you must specify the following information in the capabilityConfiguration JSON document:

sources

A list of EIP source definition structures that each contain the following information:

name

A unique, friendly name for the source. This can be up to 256 characters.

destinationPathPrefix

(Optional) A string to prepend to all data streams from the source. The SiteWise Edge gateway adds this prefix to all data streams from this source. Use a data stream prefix to distinguish between data streams that have the same name from different sources. Each data stream should have a unique name within your account.

destination

A destination structure that contains the following information:

type

The type of the destination.

streamName

The name of the AWS IoT Greengrass stream.

streamBufferSize

The size of the stream buffer.

endpoint

An endpoint structure that contains the following information:

ipAddress

The IP address of the EIP source.

port

(Optional) The port of the EIP source. Accepted values are numbers between 1 and 65535.

minimumInterRequestDuration

(Optional) The minimum duration between each request in milliseconds.

propertyGroups

The list of property groups that define the tag definition requested by the protocol. Each source can have one property group.

name

The name of the property group. This should be a unique identifier with a maximum length of 256 characters.

tagPathDefinitions

The list of structures specifying the data to collect from the Ethernet/IP device and how to transform it for output.

type

The type of the tagPathDefinition. For example, EIPTagPath.

path

The path of the tagPathDefinition. Each tag in a path can be a maximum length of 40 characters and can start with a letter or an underscore. Tags can’t contain consecutive or trailing underscores. The path is prefixed with any value of destinationPathPrefix.

dstDataType

The data type to output the tag data. Accepted values are integer, double, string, and boolean.

scanMode

Defines the scan mode behavior and configurable parameters for the source.

type

The type of the scan mode behavior. Accepted values are POLL.

rate

The rate in milliseconds that the connector should read tags from the Ethernet/IP source.