Mode: RFC‑A
Note: The maximum Ethernet packet size is 400 bytes.
| Parameter | 4.02.003 Network Status | ||
|---|---|---|---|
| Short description | Shows the module status | ||
| Minimum | 0 | Maximum | 6 |
| Default | Units | ||
| Type | 8 Bit Volatile | Update Rate | Written every second |
| Display Format | Standard | Decimal Places | 0 |
| Coding | RO, TE, ND, NC, PT, BU | ||
| Value | Text | Description |
| 0 | Initialising | The Ethernet interface is being initialised |
| 1 | Links Down | No link connection has been detected on either of the Ethernet ports |
| 2 | DHCP In Progress | The Ethernet interface is attempting to obtain an IP address, subnet mask, default gateway and DNS server addresses from a DHCP server. The Ethernet interface remains in this state for as long as the DHCP client is requesting for an IP address and/or keeps receiving packets, IP address offers or settings (e.g. default gateway) that are invalid. If the Ethernet interface remains in this state for a significant amount of time, there may be an issue with the IP address or settings being provided by the DHCP Server; consult with the server administrator. |
| 3 | No Address | The Ethernet interface does not have an IP address - either the user has not provided one manually or one could not be allocated via DHCP |
| 4 | Ready | The Ethernet interface has been successfully configured but no data is being received or transmitted |
| 5 | Active | The Ethernet interface is receiving or transmitting data |
| 6 | IP Addr Conflict | Duplicate IP address detected on network |
This parameter indicates the status of the network that the module is connected to.
| Parameter | 4.02.004 Network Message Count | ||
|---|---|---|---|
| Short description | Shows the number of messages per second | ||
| Minimum | 0 | Maximum | 65535 |
| Default | Units | Messages/s | |
| Type | 16 Bit Volatile | Update Rate | Written every second |
| Display Format | Standard | Decimal Places | 0 |
| Coding | RO, ND, NC, PT, BU | ||
The number of frames that the module is transmitting / receiving every second.
| Parameter | 4.02.005 DHCP Enable | ||
|---|---|---|---|
| Short description | Set to enable DHCP | ||
| Minimum | 0 | Maximum | 1 |
| Default | 1 | Units | |
| Type | 1 Bit User Save | Update Rate | Background read |
| Display Format | Standard | Decimal Places | 0 |
| Coding | RW, BU | ||
Controls whether or not the module will attempt to use a Dynamic Host Configuration Protocol (DHCP) server to obtain an IP address, subnet mask, default gateway and DNS servers.
When DHCP is enabled, the following parameters will become read-only immediately (no reset required):
Primary DNS (4.02.009)
Secondary DNS (4.02.010)
| Parameter | 4.02.006 IP Address | ||
|---|---|---|---|
| Short description | Sets and/or shows the IP address of the module | ||
| Minimum | 0 (Display: 0.0.0.0) | Maximum | 4294967295 (Display: 255.255.255.255) |
| Default | 3232235876 (Display: 192.168.1.100) | Units | |
| Type | 32 Bit User Save | Update Rate | DHCP enabled : write on event; DHCP disabled : read on reset |
| Display Format | IP Address | Decimal Places | 0 |
| Coding | RW, BU | ||
Controls and displays the IP address of the module.
If DHCP is enabled ( DHCP Enable (4.02.005) ) this parameter becomes read-only and, until an IP address is allocated to the module, will display 0.0.0.0.
If DHCP is disabled the module will initialise, on reset or power cycle, with the default IP address of 192.168.1.100 which can be updated and then saved.
| Parameter | 4.02.007 Subnet Mask | ||
|---|---|---|---|
| Short description | Sets and/or shows the subnet mask of the module | ||
| Minimum | 0 (Display: 0.0.0.0) | Maximum | 4294967295 (Display: 255.255.255.255) |
| Default | 4294967040 (Display: 255.255.255.0) | Units | |
| Type | 32 Bit User Save | Update Rate | DHCP enabled : write on event; DHCP disabled : read on reset |
| Display Format | IP Address | Decimal Places | 0 |
| Coding | RW, BU | ||
Controls and displays the subnet mask of the module.
If DHCP is enabled ( DHCP Enable (4.02.005) ) this parameter becomes read-only and, until a subnet mask is allocated to the module, will display 0.0.0.0.
If DHCP is disabled the module will initialise, on reset or power cycle, with the default subnet of 255.255.255.0 which can be updated and then saved.
| Parameter | 4.02.008 Default Gateway | ||
|---|---|---|---|
| Short description | Sets and/or shows the default gateway of the module | ||
| Minimum | 0 (Display: 0.0.0.0) | Maximum | 4294967295 (Display: 255.255.255.255) |
| Default | 3232236030 (Display: 192.168.1.254) | Units | |
| Type | 32 Bit User Save | Update Rate | DHCP enabled : write on event; DHCP disabled : read on reset |
| Display Format | IP Address | Decimal Places | 0 |
| Coding | RW, BU | ||
Controls and displays the default gateway of the module.
If DHCP is enabled ( DHCP Enable (4.02.005) ) this parameter becomes read-only and, until a default gateway is allocated to the module, will display 0.0.0.0.
If DHCP is disabled the module will initialise, on reset or power cycle, , with the default Gateway of 192.168.1.254 which can be updated and then saved.
| Parameter | 4.02.009 Primary DNS | ||
|---|---|---|---|
| Short description | Sets and/or shows the primary DNS address of the module | ||
| Minimum | 0 (Display: 0.0.0.0) | Maximum | 4294967295 (Display: 255.255.255.255) |
| Default | 0 (Display: 0.0.0.0) | Units | |
| Type | 32 Bit User Save | Update Rate | DHCP enabled : write on event; DHCP disabled : read on reset |
| Display Format | IP Address | Decimal Places | 0 |
| Coding | RW, BU | ||
The module can use this IP address when it wishes to resolve the IP address for a domain name. This parameter performs the same function as the Secondary DNS parameter Secondary DNS (4.02.010) , however the address specified in this parameter will be tried first. Only when this address is unsuccessful will the Secondary DNS address be tried.
If DHCP is enabled ( DHCP Enable (4.02.005) ) this parameter becomes read-only and, until a primary DNS address is allocated to the module, will display 0.0.0.0.
If DHCP is disabled the module will initialise, on reset or power cycle, with the primary DNS address stored for the parameter.
| Parameter | 4.02.010 Secondary DNS | ||
|---|---|---|---|
| Short description | Sets and/or shows the secondary DNS address of the module | ||
| Minimum | 0 (Display: 0.0.0.0) | Maximum | 4294967295 (Display: 255.255.255.255) |
| Default | 0 (Display: 0.0.0.0) | Units | |
| Type | 32 Bit User Save | Update Rate | DHCP enabled : write on event; DHCP disabled : read on reset |
| Display Format | IP Address | Decimal Places | 0 |
| Coding | RW, BU | ||
The module can use this IP address when it wishes to resolve the IP address for a domain name. This parameter performs the same function as the Primary DNS parameter Primary DNS (4.02.009) , however the address specified in this parameter will be tried only when the Primary DNS address is unsuccessful.
If DHCP is enabled ( DHCP Enable (4.02.005) ) this parameter becomes read-only and, until a secondary DNS address is allocated to the module, will display 0.0.0.0.
If DHCP is disabled the module will initialise, on reset or power cycle, with the secondary DNS address stored for the parameter.
| Parameter | 4.02.011 MAC Address | ||
|---|---|---|---|
| Short description | Shows the MAC address of the module | ||
| Minimum | 0 (Display: 00:00:00:00:00:00) | Maximum | 281474976710655 (Display: FF:FF:FF:FF:FF:FF) |
| Default | Units | ||
| Type | 64 Bit Volatile | Update Rate | Power-up write |
| Display Format | MAC Address | Decimal Places | 0 |
| Coding | RO, ND, NC, PT, BU | ||
The 48-bit MAC address of the module.
| Parameter | 4.02.018 Protocol Mode Select | ||
|---|---|---|---|
| Short description | Protocol Mode Select | ||
| Minimum | 1 | Maximum | 3 |
| Default | 1 | Units | |
| Type | 8 Bit User Save | Update Rate | Background read |
| Display Format | Standard | Decimal Places | 0 |
| Coding | RW, TE, BU | ||
Specifies the interface type of the option module. By default "EtherNet/IP" is selected. After selecting appropriate interface, user has to save the parameter, and then do the option reset.
| Value | Text | Description |
| 1 | EtherNet/IP | EtherNet/IP interface selected |
| 2 | ProfiNet | Profinet interface selected |
| 3 | CIP Safety | CIP Safety interface for safety module |
This parameter select one of three interfaces i.e. EtherNet/IP, Profinet or CIP Safety.
By default EtherNet/IP is selected.
If Mode Select = 1, then EtherNet/IP will be selected
If Mode Select = 2, then Profinet will be selected
If Mode Select = 3 then CIP Safety will be selected
After selecting the appropriate interface, user has to save and reset the option module
| Parameter | 4.02.019 Active Protocol Mode | ||
|---|---|---|---|
| Short description | Active Protocol Mode | ||
| Minimum | 1 | Maximum | 3 |
| Default | 1 | Units | |
| Type | 8 Bit Volatile | Update Rate | Power-up Or Reset |
| Display Format | Standard | Decimal Places | 0 |
| Coding | RO, TE, NC, PT, BU | ||
Shows currently active selected mode
| Value | Text | Description |
| 1 | EtherNet/IP | EtherNet/IP active interface |
| 2 | ProfiNet | Profinet active interface |
| 3 | CIP Safety | CIP Safety interface for safety module |
Shows, currently active protocol. By default Ethernet/IP will be enabled
| Parameter | 4.02.020 Priority Protocol | ||
|---|---|---|---|
| Short description | Sets the Priority Protocol | ||
| Minimum | 0 | Maximum | 2 |
| Default | 0 | Units | |
| Type | 8 Bit User Save | Update Rate | Background read |
| Display Format | Standard | Decimal Places | 0 |
| Coding | RW, TE, BU | ||
Selection of the fieldbus protocol to have priority over all other protocols.
| Value | Text | Description |
| 0 | None | All protocols have equal priority |
| 1 | Modbus TCP | Modbus TCP has highest priority |
| 2 | EtherNet/IP | EtherNet/IP has highest priority |
Enables selection of one fieldbus protocol to have priority over others. A tick period of 1 ms will be given to the highest priority fieldbus protocol, 5 ms to all other fieldbus protocols (equal priority).
If no fieldbus protocol has been selected to have priority over others all protocols will have equal priority and a tick rate of 5 ms.
| Parameter | 4.02.021 Web Server Enable | ||
|---|---|---|---|
| Short description | Enables the Web Server | ||
| Minimum | 0 | Maximum | 1 |
| Default | 1 | Units | |
| Type | 1 Bit User Save | Update Rate | Background read |
| Display Format | Standard | Decimal Places | 0 |
| Coding | RW, BU | ||
Controls the running of the webserver on the module.
| Parameter | 4.02.022 Web Server Port | ||
|---|---|---|---|
| Short description | Specifies the web server port | ||
| Minimum | 0 | Maximum | 65535 |
| Default | 80 | Units | |
| Type | 16 Bit User Save | Update Rate | Read on module reset and HTTP_ENABLE |
| Display Format | Standard | Decimal Places | 0 |
| Coding | RW, BU | ||
The web server port. This may be changed for added security.
| Parameter | 4.02.024 Ethernet MTU | ||
|---|---|---|---|
| Short description | Specifies the MTU for the Ethernet interface | ||
| Minimum | 158 | Maximum | 1500 |
| Default | 1500 | Units | Bytes |
| Type | 16 Bit User Save | Update Rate | Read on module reset |
| Display Format | Standard | Decimal Places | 0 |
| Coding | RW, BU | ||
This parameter sets the maximum Ethernet packet size (MTU). This is expressed as the size of IP payload as opposed to EThernet frame size.
| Parameter | 4.02.025 Gateway Mode | ||
|---|---|---|---|
| Short description | Specifies the operation mode of the gateway | ||
| Minimum | 0 | Maximum | 2 |
| Default | 0 | Units | |
| Type | 8 Bit User Save | Update Rate | Read on module reset |
| Display Format | Standard | Decimal Places | 0 |
| Coding | RW, TE, BU | ||
| Value | Text |
| 0 | Switch |
| 1 | Gateway |
| 2 | Strict Gateway |
Specifies the operation mode of the gateway. By default the gateway is disabled and the switch operates in normal switch mode, by enabling the gateway mode all packets are filtered by the module and prioritised before being forwarded on. In strict mode the gateway will drop packets from unsupported protocols.
VLAN must be enabled VLAN Enable (4.02.030) when the gateway is enabled.
| Parameter | 4.02.030 VLAN Enable | ||
|---|---|---|---|
| Short description | Enables VLAN tagging | ||
| Minimum | 0 | Maximum | 1 |
| Default | 0 | Units | |
| Type | 1 Bit User Save | Update Rate | Read on module reset |
| Display Format | Standard | Decimal Places | 0 |
| Coding | RW | ||
Controls whether the module will use VLAN tagging.
When used in conjunction with Drive VLAN ID (4.02.031) network traffic from the interface will be tagged with the chosen VLAN identifier.
When default values for Drive VLAN ID (4.02.031) is set, enabling this parameter will add VLAN prioritisation to all packets helping to ensure real-time packets are not delayed by those of lower priority. If disabled, prioritisation will use the Diffserv field in IP traffic only, meaning non-IP traffic can still affect real-time IP traffic.
| Parameter | 4.02.031 Drive VLAN ID | ||
|---|---|---|---|
| Short description | Specifies a VLAN ID that the drive (Port 0) will be a member of | ||
| Minimum | 1 | Maximum | 1 |
| Default | 1 | Units | |
| Type | 8 Bit User Save | Update Rate | Read on module reset and VLAN_ENABLE |
| Display Format | Standard | Decimal Places | 0 |
| Coding | RW, BU | ||
Specifies the VLAN ID that the interface will be a member of. Any packets entering the switch without this VLAN ID will not be handled.
| Parameter | 4.02.034 Drive compatibility mode | ||
|---|---|---|---|
| Short description | Specifies the mimic of the drive from a PLC for EthernetIP and Modbus | ||
| Minimum | 0 | Maximum | 1 |
| Default | 0 | Units | |
| Type | 8 Bit User Save | Update Rate | Read on module reset |
| Display Format | Standard | Decimal Places | 0 |
| Coding | RW, TE, BU | ||
Defines the parameter conversion for EthernetIP and Modbus.
| Value | Text |
| 0 | Default |
| 1 | Unidrive SP |
This parameter defines the conversion rules for parameter values coming via EthernetIP or Modbus.
This gives customers a way to mimic other drives from the point of view of PLC.
| Parameter | 4.02.035 Non cyclic enable | ||
|---|---|---|---|
| Short description | Specify non cyclic enable | ||
| Minimum | 0 | Maximum | 1 |
| Default | 0 | Units | |
| Type | 1 Bit User Save | Update Rate | Background |
| Display Format | Standard | Decimal Places | 0 |
| Coding | RW | ||
Enable the Non cyclic data transfer.
| Parameter | 4.02.036 Non cyclic base parameter | ||
|---|---|---|---|
| Short description | Specify the base parameter of the user program non cyclic handling | ||
| Minimum | 0 | Maximum | 59999 |
| Default | 0 | Units | |
| Type | 16 Bit User Save | Update Rate | Background |
| Display Format | Slot Menu Parameter | Decimal Places | 0 |
| Coding | RW, BU | ||
This parameter defines the base parameter address of a group of seven parameters which can be used by user programs to perform non-cyclic read and write actions to parameters on other drives connected to the Ethernet interface. It can also be used to provide non-cyclic access to option module parameters in other drives connected on the Ethernet interface, or to parameters in option modules on the same drive as the Ethernet interface. If the base parameter defined by this parameter is a drive parameter (e.g. parameter 18.011) then this feature can allow onboard user programs to access internal parameters in any option module on the same drive, or a parameter in another drive connected to the Ethernet interface.
Below are descriptions of the seven parameters required to use this feature. Please note that these parameters must be at least 16 bits in size.
The destination IP Address is in the format www.xxx.yyy.zzz.
| Parameter | Description |
| Base parameter | Command and Status |
| Base parameter + 1 | Destination IP Address www.xxx |
| Base parameter + 2 | Destination IP Address yyy.zzz |
| Base parameter + 3 | Parameter Address SMM |
| Base parameter + 4 | Parameter Address PPP |
| Base parameter + 5 | Parameter Value LSW / Error Code |
| Base parameter + 6 | Parameter Value MSW |
Parameter descriptions
| Parameter | Base Parameter (S.MM.PPP) | ||
| Description | Command and Status | ||
| Minimum | 0x0000 | Maximum | 0x0403 |
| Value | Meaning | Description |
| 0 | No Command | No command or abort during a command process |
| 1 | Check / Abort | Check if the status is READY or abort from read or write command |
| 2 | Read | Read one parameter |
| 3 | Write | Write one parameter |
Possible values for the Status (MSB) are:
| Value | Meaning | Description |
| 0 | IDLE | Idle |
| 1 | READY | The parameter channel is ready to take commands |
| 2 | PROCESSING | Processing the command |
| 3 | DONE | The command processed successfully |
| 4 | ERROR | Error is detected, detail will be found in the first parameter. |
| Parameter | Base Parameter + 1 (S.MM.PPP + 1) | ||
| Description | Destination IP Address www.xxx | ||
| Minimum | 0x0000 | Maximum | 0xFFFF |
| Parameter | Base Parameter + 2 (S.MM.PPP + 2) | ||
| Description | Destination IP Address yyy.zzz | ||
| Minimum | 0x0000 | Maximum | 0xFFFF |
Base Parameter + 1 defines the 1st and 2nd octet of the destination IP address.
Base Parameter + 2 defines the 3rd and 4th octet of the destination IP address.
An IP address of 127.0.0.1 (0x7F00 0001) represents the current drive and can be used to access drive or option module parameters on the current drive.
| Parameter | Base Parameter + 3 (S.MM.PPP + 3) | ||
| Description | Parameter Address SMM | ||
| Minimum | 0 | Maximum | 499 |
| Parameter | Base Parameter + 4 (S.MM.PPP + 4) | ||
| Description | Parameter Address PPP | ||
| Minimum | 0 | Maximum | 999 |
Base Parameter + 3 defines the slot and menu of the destination parameter in the format of SMM.
Base Parameter + 4 defines the destination parameter number in the format PPP.
| Parameter | Base Parameter + 5 (S.MM.PPP + 5) | ||
| Description | Parameter Value LSW / Error Code | ||
| Minimum | 0x0000 | Maximum | 0xFFFF |
Base Parameter + 5 holds the least significant word of the value to be written to the destination parameter when the command is Write (3), or the least significant word of the value read from the destination parameter when the command was Read (2) and the status is “OK”.
If the status shown in Base Parameter is “ERROR”, then this parameter will show the error code.
The following table list the possible error codes:
| Value | Meaning | Description |
| -1 | Address Type | The addressing type is not supported |
| -2 | Timeout | A timeout occurred trying to access the specified item |
| -3 | Access Denied | The requesting device does not have sufficient access rights |
| -4 | Does not exist | The specified item does not exist |
| -5 | Data Type | The data could not be converted from the specified type |
| -6 | Failed Read | The value could not be read, reason unknown |
| -7 | Failed Write | The value could not be written, reason unknown |
| -8 | Not Readable | The data could not be read as the source does not allow read access |
| -9 | Not Writeable | The data could not be written as the destination does not allow write access |
| -10 | Over Range | The specified value is outside the suitable range for the item |
| -11 | Request Invalid | The request contained invalid information |
| -12 | Response Too Big | The response will not fit in the maximum response size |
| -13 | Decimal Place | The decimal place information is invalid (i.e. out of range of allowed values for a write) |
| -14 | Invalid Param | Invalid parameter in the parameter channel |
| -15 | Invalid CMD | Invalid command |
| -16 | Invalid IP | Invalid IP address |
| -17 | Unknown Error | An unknown error occurred |
| -18 to -128 | Reserved |
| Parameter | Base Parameter + 6 (S.MM.PPP + 6) | ||
| Description | Parameter Value MSW | ||
| Minimum | 0x0000 | Maximum | 0xFFFF |
Examples
The following examples use a base parameter of Pr 18.011 on the drive.
Initial setup:
This then configures the following parameters in the drive.
| Parameter | Description |
| 18.011 | Command and Status |
| 18.012 | Destination IP Address www.xxx |
| 18.013 | Destination IP Address yyy.zzz |
| 18.014 | Parameter Address SMM |
| 18.015 | Parameter Address PPP |
| 18.016 | Parameter Value LSW / Error Code |
| 18.017 | Parameter Value MSW |
Example 1: Parameter read:
Read parameter 23.001 from the option module in slot 3 on the current drive (i.e. parameter 3.23.001 and IP address 127.0.0.1 (0x7F000001)).
Example 2: Parameter write:
Write a value of 12345678 (0x00BC614E) to parameter 20.21 in the drive at IP address 192.168.1.101 (0xC0A80165).