SEW Driver Ethernet
Review the following information for setting up and configuring the SEW Drive Ethernet driver.
Use this driver to read Common Industrial Protocol (CIP) objects on a SEW-EURODRIVE drive over EtherNet/IP. Objects are addressed by Class, Instance, and Attribute, and you can also read SEW device parameters by index and subindex.
The driver samples Status Word 1 to track whether the drive's output stage is enabled. You set a separate sampling interval for each state, and you can configure a parameter tag to poll only while the output stage is enabled. All other tags poll on their own intervals.
This driver does not support browsing for devices. Use DeviceHub > Asset Discovery to find devices on the network.
Compatibility table
Compatibility Parameter | Compatible Items |
|---|---|
Driver Type | Ethernet |
Validated Devices/Series | SEW-EURODRIVE drives |
How to configure the PLC
To set up and configure this device in Litmus Edge (LE), you will need to do the following:
- Step 1: Set up and configure the PLC device
- Step 2: Set up the PLC device in Litmus Edge DeviceHub
- Step 3: Configure the list of registers
Step 1: Set up and configure the PLC device
- Assign the drive an IP address that LE can reach.
- Confirm the drive accepts EtherNet/IP connections on the port it is configured to use. The driver defaults to port 44818.
- Record the subaddress and subchannel the drive uses. You enter both when you connect the device.
Note: The driver reads CIP objects that are addressable by Class, Instance, and Attribute. Refer to your drive's documentation for the objects it exposes and the attributes each one provides.
Step 2: Set up the PLC device in Litmus Edge DeviceHub
Configure the following parameters when you connect a device with this driver. Update default values to the specific setup of your device.
Parameter | Value |
|---|---|
Type | Ethernet |
Driver | SEW Drive Ethernet |
Name | A unique name for this device. LE uses it to identify the device throughout the edge gateway, including in message broker topics and logs. Default is sew-drive-ethernet_device. |
Description | Optional free-text notes about this device, such as its physical location or purpose. |
NetworkAddress | The IP address of the device on the network. Default is 192.168.0.1. |
NetworkPort | The TCP or UDP port used to communicate with the device. Default is 44818. The value must match the port configured on the device. Range is 0 to 65535. |
ReadTimeout | The read timeout in milliseconds. Default is 3000. Range is 10 to 10000. |
Subaddress1 | The drive's subaddress. Default is 0. Range is 0 to 255. |
Subchannel1 | The drive's subchannel. Default is 0. Range is 0 to 255. |
CIP service type | The CIP service type, either Connected or Unconnected. Default is Connected. |
SW1 Poll Interval while Output Stage Disabled (ms) | How often Status Word 1 is sampled while the drive's output stage is disabled. Default is 50. Range is 10 to 5000. |
SW1 Poll Interval while Output Stage Enabled (ms) | How often Status Word 1 is sampled while the drive's output stage is enabled. Default is 500. Range is 50 to 10000. |
Device-specific properties
Property | Description |
|---|---|
Subaddress1, Subchannel1 | Different subaddresses and subchannels address different drive components. Subaddress1 = 1 and Subchannel1 = 1 address the parameters of the communication and control unit (PFH). Subaddress1 = 20 and Subchannel1 = 3 address the parameters of the power section unit (PFA). |
CIP service type | ODVA CIP defines Connected messaging, which allocates resources, and Unconnected messaging. SEW-EURODRIVE drives support Connected services only. |
SW1 | Status Word 1, bit 0. Indicates the inverter status. |
Step 3: Configure the list of registers
When you Add a Tag to the connected device, refer to the following register table and tag parameters.
Refer to the following additional resources:
Register table
This driver provides three register types. The type you select determines which tag parameters appear and which value types are available.
Name | Value Types | Access Types | Description |
|---|---|---|---|
Attribute | bool, uint8, uint16, uint32, uint64, int8, int16, int32, int64, float32, float64, string, bit[], uint8[], uint16[], uint32[], uint64[], int8[], int16[], int32[], int64[], float32[], float64[] | R/W | A single CIP attribute, addressed by Class ID, Instance ID, and Attribute ID |
AttributeRange | string, uint8[], uint16[], uint32[], uint64[], int8[], int16[], int32[], int64[], float32[], float64[] | R/O | A consecutive run of CIP attributes read as one array, starting at the Attribute ID you enter |
Parameter | int32 | R/O | A SEW device parameter, addressed by index and subindex rather than by CIP class |
Tag parameters
The following parameters apply to every register type.
Parameter | Value |
|---|---|
Name | Select a register name from the drop-down list. Available options depend on the names in the register table. |
Value Type | Select a data type from the drop-down list. Available options depend on the register name selected. |
Polling Interval | Enter a value in seconds. This determines how often the tag should poll the register for data. Enter 0 to disable polling. |
Tag Name | Enter a name for the tag. |
Description (Optional) | Enter a description for the tag. |
Tag Formula | Enter a formula to process tag data. See Tag formula below. |
Only Publish on Change of Value | Select the checkbox to publish NATS messages only when the value parameter changes to a new value. Change of Value only applies to boolean, numeric (such as int or float), and simple string data types. It does not apply to complex types, such as JSON or array. Poll-once topics are not affected by Change of Value settings. These topics will still only see a single message. |
Meta Data | Metadata summarizes basic information about data. This feature allows you to define key-value pair data for the device output payload later on. It can then be used to find, use, and reuse particular instances of data. Note: If you use special characters in meta data key names, the special characters are replaced with underscore characters in the payload. This can cause two key names to be combined into one. For example, configuring the key names a**b and a&&b will cause only one key name to be created (a__b). |
Attribute parameters
Parameter | Value |
|---|---|
Class ID | The CIP class. A class is a set of objects that all represent the same kind of system component. Range is 0 to 65535. |
Instance ID | The CIP object instance. An object instance is one particular object within a class. Every instance of a class has the same set of attributes, each with its own values. Range is 0 to 65535. |
Attribute ID | The attribute's identification value. Range is 0 to 65535. |
Data | Hexadecimal data to send with the request. Optional. |
Response Data Offset | The byte offset at which to start reading the response. Default is 0. Range is 0 to 500. |
Response Data Endianness | The byte order of the response, either Little-Endian or Big-Endian. Default is Little-Endian. |
AttributeRange parameters
Parameter | Value |
|---|---|
Class ID | The CIP class. A class is a set of objects that all represent the same kind of system component. Range is 0 to 65535. |
Instance ID | The CIP object instance. An object instance is one particular object within a class. Every instance of a class has the same set of attributes, each with its own values. Range is 0 to 65535. |
Attribute ID | The identification value of the first attribute in the range. Range is 0 to 65535. |
Count | The number of attributes to read. Default is 1. Range is 1 to 65535. |
Parameter parameters
Parameter | Value |
|---|---|
SEW device index | The parameter's index on the drive. Default is 8300. Range is 0 to 65535. |
SEW device subindex | The parameter's subindex on the drive. Default is 0. Range is 0 to 255. |
Poll condition | Continuous polls the parameter on its own interval regardless of drive state. Output Stage Enabled polls it only while the drive's output stage is enabled. Default is Output Stage Enabled. |
Browse parameters
Browsing scans the drive across ranges of CIP classes, instances, and attributes, and returns the objects it finds. Narrow the ranges to shorten a scan.
Parameter | Value |
|---|---|
Scan Range for Classes | The range of CIP classes to scan. Default is 1-255. |
Scan Range for Instances | The range of object instances to scan. Default is 0-2. |
Scan Range for Attributes | The range of attributes to scan. Default is 1-10. |
Tag formula
Enter a formula for the tag to process the generated data. Two variables are permitted: value (current tag value) and timestamp (current tag UNIX time in milliseconds). The following math functions are available:
Function | Description |
|---|---|
sin | Sine |
cos | Cosine |
sqrt | Square root |
tan | Tangent |
power(x) | Performs the operation 10^x |
log(x) | Natural logarithm (base e) |
exp(x) | Performs the operation e^x |