user manual addendum, managed configurations

58
Managed Configurations User Manual Addendum Document: 10003856761 Version: 01

Upload: others

Post on 01-Jun-2022

2 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: User Manual Addendum, Managed Configurations

Managed Configurations User Manual Addendum

Document: 10003856761 Version: 01

Page 2: User Manual Addendum, Managed Configurations

Managed Configurations User Manual Addendum 10003856761 Ver. 01 MMI-UM040B-EN-P

Copyright © 2018 Rockwell Automation, Inc. Page 2 of 58

Although every effort is made to keep this document accurate and up to date, MagneMotion® assumes no responsibility for any errors, omissions, or inaccuracies. Information that is provided in this document is subject to change without notice. Any sample code that that is referenced in this document or included with MagneMotion software is included for illustration only and is, therefore, unsupported.

MagneMotion®, MagneMover®, QuickStick®, MML™, MM LITE™, and SYNC IT™ are trademarks or registered trademarks of MagneMotion, a Rockwell Automation Company. Rockwell Automation® is a registered trademark of Rockwell Automation, Inc. EtherNet/IP™ is a trademark of ODVA®, Inc. All other trademarks are properties of their respective owners.

This product is protected under one or more U.S. and International patents. Additional U.S. and International patents are pending.

Copyright © 2018 MagneMotion, Inc., a Rockwell Automation Company. All Rights Reserved.

The information included in this document is proprietary or confidential to Rockwell Automation, Inc. Any disclosure, reproduction, use, or redistribution of this information by or to an unintended recipient is prohibited.

MagneMotion, Inc. A Rockwell Automation Company 139 Barnum Road Devens, MA 01434 USA

Phone: +1 978-757-9100 Fax: +1 978-757-9200

www.magnemotion.com

Page 3: User Manual Addendum, Managed Configurations

Managed Configurations User Manual Addendum 10003856761 Ver. 01 MMI-UM040B-EN-P

Copyright © 2018 Rockwell Automation, Inc. Page 3 of 58

Contents Overview ................................................................................................................................... 6

Related Manuals ........................................................................................................................ 6

Node Controller Interface User Manual Addendum ................................................................. 7 Managed Configurations Page ............................................................................................ 7

Upload a New Managed Node Controller Configuration File ...................................... 7 Activate a Managed Node Controller Configuration File ............................................. 9 Distribute a Managed Node Controller Configuration File ........................................ 10 Delete a Managed Node Controller Configuration File .............................................. 12 Download a Managed Node Controller Configuration File ....................................... 13 Managed Configurations and Configuration Files Page Interactions ......................... 14

NCHost TCP Interface Utility User Manual Addendum ........................................................ 15 Monitoring Transport System Status ................................................................................ 15

Node Controller Status Window ................................................................................. 16 HLC Status Window ................................................................................................... 16

Host Commands ................................................................................................................ 18 NC Configs Tab .......................................................................................................... 18

UI Reference ..................................................................................................................... 19 Host Commands Section – NC Configs Tab .............................................................. 19 Node Controller Status Window ................................................................................. 19 High Level Controller Status Window ....................................................................... 20

Host Controller TCP/IP Communication Protocol User Manual Addendum ......................... 22 Host Controller to HLC Communications ........................................................................ 22

Set Node Controller Configuration (0xBF 0C 01) ...................................................... 23 Restart Node Controllers (0xBF 0C 02) ..................................................................... 25 Get Extended Node Controller Status (0xBF 0C 03).................................................. 26 Get Extended High Level Controller Status (0xBF 0C 04) ........................................ 28

HLC to Host Controller Communications ........................................................................ 29 Command Status (0xD0) ............................................................................................. 30 Extended Node Controller Status (0xDF 0C 03) ........................................................ 32 Extended High Level Controller Status (0xDF 0C 04) ............................................... 34

Host Controller EtherNet/IP Communication Protocol User Manual Addendum .................. 36 Host Controller to HLC Communications ........................................................................ 36

MMI_mgmt_nc_set_config_cmd ............................................................................... 37 MMI_mgmt_nc_restart_cmd ...................................................................................... 40

HLC to Host Controller Communications ........................................................................ 42 MMI_extended_hlc_status .......................................................................................... 43 MMI_extended_nc_status ........................................................................................... 45 MMI_mgmt_nc_cmd_status ....................................................................................... 48

HLC Status Codes ................................................................................................................... 51

Page 4: User Manual Addendum, Managed Configurations

Managed Configurations User Manual Addendum 10003856761 Ver. 01 MMI-UM040B-EN-P

Copyright © 2018 Rockwell Automation, Inc. Page 4 of 58

Node Controller Remote Management Configuration ............................................................ 52 Node Controller Configuration File XML Reference ....................................................... 52

PLC_mgmt_nc_cmd_enable ....................................................................................... 53 PLC_extended_hlc_status ........................................................................................... 54 PLC_extended_nc_status ............................................................................................ 55

Node Controller Configuration File Example................................................................... 56

More Information .................................................................................................................... 57

Rockwell Automation Support ............................................................................................... 58

Figures

Figure 1: Managed Configurations Page .................................................................................. 7

Figure 2: Multiple Managed Configurations Uploaded ............................................................ 8

Figure 3: Activate a Node Controller Configuration File ......................................................... 9

Figure 4: Distribute Active Managed Configuration To All Node Controllers ...................... 10

Figure 5: HLC Log Showing Managed Node Controller Configuration File Distribution .... 11

Figure 6: Managed Configurations – Delete Config ID 2 ...................................................... 12

Figure 7: Configuration Files Page Using a Managed Configuration .................................... 14

Figure 8: NCHost TCP Interface Utility for MagneMover LITE ........................................... 15

Figure 9: Launch Status Windows Section ............................................................................. 15

Figure 10: Node Controller Status Window ........................................................................... 16

Figure 11: Node Controller Status Window Showing Extended Status ................................. 16

Figure 12: HLC Status Window ............................................................................................. 16

Figure 13: HLC Status Window Showing Extended Status ................................................... 17

Figure 14: Host Commands Section ....................................................................................... 18

Figure 15: Host Commands Section – NC Configs Tab ......................................................... 18

Figure 16: Host Commands Section – NC Configs Tab ......................................................... 19

Figure 17: Node Controller Status Window ........................................................................... 19

Figure 18: Extended High Level Controller Status Window .................................................. 20

Figure 19: UDT udt_MMI_mgmt_nc_set_config_cmd .......................................................... 37

Figure 20: Example Set NC Configuration Command Explicit Message Configuration ....... 38

Figure 21: UDT udt_MMI_mgmt_nc_restart_cmd ................................................................ 40

Figure 22: Example Restart NCs Command Explicit Message Configuration ....................... 41

Figure 23: UDT udt_MMI_extended_hlc_status .................................................................... 43

Figure 24: UDT udt_MMI_extended_nc_status ..................................................................... 46

Figure 25: UDT udt_MMI_mgmt_nc_cmd_status ................................................................. 49

Page 5: User Manual Addendum, Managed Configurations

Managed Configurations User Manual Addendum 10003856761 Ver. 01 MMI-UM040B-EN-P

Copyright © 2018 Rockwell Automation, Inc. Page 5 of 58

Figure 26: Example Remote Management Node Controller EtherNet/IP Configuration ....... 56

Tables

Table 1: Host Controller to HLC Commands ......................................................................... 22

Table 2: HLC to Host Controller Status Responses ................................................................ 29

Table 3: PLC to HLC Explicit Message Requests .................................................................. 36

Table 4: HLC to PLC Status Memory Tags............................................................................ 42

Table 5: HLC to PLC Response Memory Tags ...................................................................... 42

Table 6: HLC Status Codes..................................................................................................... 51

Table 7: Node Controller Remote Management Configuration XML Elements .................... 52

Page 6: User Manual Addendum, Managed Configurations

Managed Configurations User Manual Addendum 10003856761 Ver. 01 MMI-UM040B-EN-P

Copyright © 2018 Rockwell Automation, Inc. Page 6 of 58

Overview

This document provides an overview of the Managed Configurations, Host Controller Based Management, Extended Node Controller Status, and Extended High Level Controller Status features.

The Managed Configurations feature allows up to 20 Managed Node Controller Configuration Files to be uploaded for a system. A Managed Node Controller Configuration File can be activated on the high level controller, and distributed to all node controllers system wide.

The Host Controller Based Management feature allows the host controller to modify the active Managed Node Controller Configuration file for their MagneMover LITE Transport System. Commands are available to activate a new Managed Node Controller Configuration File, and Restart Services on all node controllers to run the new configuration.

The use of Extended Node Controller Status and Extended High Level Controller Status is described in this document.

This document is divided into three sections that document the changes to the documents listed in the Related Manuals section.

Related Manuals

This document references the following manuals:

• Node Controller Interface User Manual, 990000377.

• Host Controller TCP/IP Communication Protocol User Manual, 990000436.

• Host Controller EtherNet/IP Communication Protocol User Manual, 990000437.

• NCHost TCP Interface Utility User Manual, 990000562.

NOTE: Distribution of this manual and all addendums and attachments are not controlled. Changes to the document set or the software can be made at any time. To identify the current revisions or to obtain a current version, contact Customer Support at +1 978-757-9102 or [email protected].

Page 7: User Manual Addendum, Managed Configurations

Managed Configurations User Manual Addendum 10003856761 Ver. 01 MMI-UM040B-EN-P

Copyright © 2018 Rockwell Automation, Inc. Page 7 of 58

Node Controller Interface User Manual Addendum

This section is an addendum to the Node Controller Interface User Manual and describes additions to the User Interface for support of Managed Configurations.

Managed Configurations Page

This section describes how to upload, activate, distribute, delete, and download Managed Node Controller Configuration Files.

Upload a New Managed Node Controller Configuration File

1. If the transport system has multiple node controllers, connect to the node controller assigned as the high level controller. Once connected, run the Node Controller Web Interface (see the Node Controller Interface User Manual).

2. Select Managed Configurations from the Main Menu. The Managed Configurations page (shown in Figure 1) is displayed.

Figure 1: Managed Configurations Page

3. Under Upload Managed Node Controller Configuration File, next to Config ID, select the ID to assign to the Managed Node Controller Configuration File to be uploaded.

4. Under Upload Managed Node Controller Configuration File, select Browse. The Choose File to Upload dialog box is displayed.

Page 8: User Manual Addendum, Managed Configurations

Managed Configurations User Manual Addendum 10003856761 Ver. 01 MMI-UM040B-EN-P

Copyright © 2018 Rockwell Automation, Inc. Page 8 of 58

5. Use the dialog box controls to select the appropriate Node Controller Configuration File to upload and select Open. The file name is displayed in the Browse text field.

6. Select Upload File. The file upload status is temporarily displayed while the file is uploaded. The Managed Configurations page is redisplayed showing the uploaded file that is listed in the Managed Node Controller Configuration Files list (shown in Figure 2).

Up to 20 Managed Configurations can be uploaded. Figure 2 displays the Managed Configurations page with multiple Managed Node Controller Configuration Files present.

Figure 2: Multiple Managed Configurations Uploaded

Page 9: User Manual Addendum, Managed Configurations

Managed Configurations User Manual Addendum 10003856761 Ver. 01 MMI-UM040B-EN-P

Copyright © 2018 Rockwell Automation, Inc. Page 9 of 58

Activate a Managed Node Controller Configuration File

This section describes how to activate a different Managed Node Controller Configuration File on the high level controller.

1. If the transport system has multiple node controllers, connect to the node controller assigned as the HLC. Once connected, run the Node Controller Web Interface (see the Node Controller Interface User Manual).

2. Select Managed Configurations from the Main Menu. The Managed Configurations page (shown in Figure 2) is displayed.

3. Under Managed Node Controller Configuration Files, identify the Node Controller Configuration File to be activated and select Activate for that file. The file is activated and the file upgrade status is temporarily displayed. The Managed Configurations page (shown in Figure 3) is redisplayed showing the selected Node Controller Configuration File as being active. A notice to Restart Services or Reboot the node controllers to activate the selected file is displayed.

Figure 3: Activate a Node Controller Configuration File

Page 10: User Manual Addendum, Managed Configurations

Managed Configurations User Manual Addendum 10003856761 Ver. 01 MMI-UM040B-EN-P

Copyright © 2018 Rockwell Automation, Inc. Page 10 of 58

Distribute a Managed Node Controller Configuration File

This section describes how to distribute an active Managed Node Controller Configuration File to all node controllers in the transport system.

1. If the transport system has multiple node controllers, connect to the node controller assigned as the HLC. Once connected, run the Node Controller Web Interface (see the Node Controller Interface User Manual).

2. Select Managed Configurations from the Main Menu. The Managed Configurations page (shown in Figure 4) is displayed showing the Managed Node Controller Configuration Files and identifying the active file.

Figure 4: Distribute Active Managed Configuration To All Node Controllers

3. Select Distribute To All Node Controllers. The active Managed Node Controller Configuration File is distributed to all node controllers in the transport system. The Managed Configurations page is redisplayed showing the request to distribute the Managed Node Controller Configuration File to all node controllers and instructions to review the HLC log to verify the status of the distribution.

4. Select View Log from the Main Menu (see the Node Controller Interface User Manual). The Node Controller Log page is displayed.

5. Select View High Level Controller Log.

Page 11: User Manual Addendum, Managed Configurations

Managed Configurations User Manual Addendum 10003856761 Ver. 01 MMI-UM040B-EN-P

Copyright © 2018 Rockwell Automation, Inc. Page 11 of 58

The Node Controller Log page is updated to display the HLC Log. The last lines in the log show the distribution of the Managed Node Controller Configuration File and the status of the distribution. See Figure 5 for an example of the log messages.

NOTE: A Restart Services on all node controllers is required after distribution to run the new Managed Node Controller Configuration File.

Figure 5: HLC Log Showing Managed Node Controller Configuration File Distribution

Mar 20 16:46:09.103450 SYSTEM,CRITICAL: CONF DIST: Sending File: node_configuration.xml of type: Node Controller Configuration XML to NC @ 192.168.110.230 Mar 20 16:46:09.223214 SYSTEM,CRITICAL: CONF DIST: SUCCESS: Transfer Reported Complete. Mar 20 16:46:09.223385 SYSTEM,CRITICAL: CONF DIST: Sending File: node_configuration.config_id of type: Node Controller Configuration ID to NC @ 192.168.110.230 Mar 20 16:46:09.303113 SYSTEM,CRITICAL: CONF DIST: SUCCESS: Transfer Reported Complete.

Page 12: User Manual Addendum, Managed Configurations

Managed Configurations User Manual Addendum 10003856761 Ver. 01 MMI-UM040B-EN-P

Copyright © 2018 Rockwell Automation, Inc. Page 12 of 58

Delete a Managed Node Controller Configuration File

This section describes how to delete a Managed Node Controller Configuration File from the Managed Configurations on the HLC.

1. If the transport system has multiple node controllers, connect to the node controller assigned as the HLC. Once connected, run the Node Controller Web Interface (see the Node Controller Interface User Manual).

2. Select Managed Configurations from the Main Menu. The Managed Configurations page (shown in Figure 2) is displayed.

3. Under Managed Node Controller Configuration Files, identify the Node Controller Configuration File to be deleted and select Delete for that file. NOTE: The active Managed Node Controller Configuration File cannot be deleted. The file is deleted and the file deletion status is temporarily displayed. The Managed Configurations page is redisplayed showing the selected Node Controller Configuration File has been deleted as shown in Figure 6.

Figure 6: Managed Configurations – Delete Config ID 2

Page 13: User Manual Addendum, Managed Configurations

Managed Configurations User Manual Addendum 10003856761 Ver. 01 MMI-UM040B-EN-P

Copyright © 2018 Rockwell Automation, Inc. Page 13 of 58

Download a Managed Node Controller Configuration File

This section describes how to download an existing Node Controller Configuration File from the Managed Node Controller Configuration Files to a user-specified location.

1. If the transport system has multiple node controllers, connect to the node controller assigned as the HLC. Once connected, run the Node Controller Web Interface (see the Node Controller Interface User Manual).

2. Select Managed Configurations from the Main Menu. The Managed Configurations page (shown in Figure 4) is displayed.

3. Under Managed Node Controller Configuration Files, identify the Node Controller Configuration File to be downloaded and select Download for that file. The File Download confirmation dialog box is displayed. NOTE: The options for saving or opening this file may vary by web browser.

4. Select Save to download the file. The Save As dialog box is displayed.

5. Browse to the appropriate location to save the file.

6. Change the file name as appropriate, and select Save. The file is named and saved as specified.

Page 14: User Manual Addendum, Managed Configurations

Managed Configurations User Manual Addendum 10003856761 Ver. 01 MMI-UM040B-EN-P

Copyright © 2018 Rockwell Automation, Inc. Page 14 of 58

Managed Configurations and Configuration Files Page Interactions

The Managed Configurations feature impacts the use of the Node Controller Configuration Files section on the Configuration Files page of the Node Controller Web Interface.

After activating a Managed Configuration, do not upload a Node Controller Configuration File to the Configuration Files page. The active Managed Node Controller Configuration File becomes the current Node Controller Configuration File. The Config ID of the activated Managed Configuration is shown in green next to the name of the Node Controller Configuration File in the Configuration Files page as shown in Figure 7.

The Node Controller Configuration File section on the Configuration Files page affects Managed Configurations as follows:

• Uploading a new Node Controller Configuration File on the Configuration Files page automatically deletes the existing Node Controller Configuration File and replaces it with the new static Node Controller Configuration File. The static Node Controller Configuration File is displayed with no Config ID following it.

o No Managed Node Controller Configuration File is deleted.

• Deleting the Managed Node Controller Configuration File on the Configuration Files page results in the deletion of the current Node Controller Configuration File.

o No Managed Node Controller Configuration File is deleted.

Figure 7: Configuration Files Page Using a Managed Configuration

Page 15: User Manual Addendum, Managed Configurations

Managed Configurations User Manual Addendum 10003856761 Ver. 01 MMI-UM040B-EN-P

Copyright © 2018 Rockwell Automation, Inc. Page 15 of 58

NCHost TCP Interface Utility User Manual Addendum

This section is an addendum to the NCHost TCP Interface Utility User Manual and describes additional functions added to the User Interface. These additions support Host Controller Based Management, Extended Node Controller Status, and Extended High Level Controller Status.

Figure 8: NCHost TCP Interface Utility for MagneMover LITE

Monitoring Transport System Status

This section provides an overview of the additional monitoring functions for the NCHost TCP Interface Utility. All transport system status is available through the Launch Status Windows section (see Figure 9).

Figure 9: Launch Status Windows Section

Page 16: User Manual Addendum, Managed Configurations

Managed Configurations User Manual Addendum 10003856761 Ver. 01 MMI-UM040B-EN-P

Copyright © 2018 Rockwell Automation, Inc. Page 16 of 58

Node Controller Status Window

To monitor node controller status:

1. In the Launch Status Windows section (see Figure 9), select Node Controllers.

2. The Node Controller Status window is displayed as shown in Figure 10.

Figure 10: Node Controller Status Window

3. Move the status window to a convenient location.

4. Select the Extended Status checkbox at the top of the window to view the Software Version, Configuration ID, and Configuration Status of the node controllers as shown in Figure 11.

Figure 11: Node Controller Status Window Showing Extended Status

5. When finished using the Node Controller Status window, select the X in the upper-right corner to close the window.

HLC Status Window

To monitor the high level controller status:

1. In the Launch Status Windows section (see Figure 9), select HLC.

2. The HLC Status window is displayed as shown in Figure 12.

Figure 12: HLC Status Window

Page 17: User Manual Addendum, Managed Configurations

Managed Configurations User Manual Addendum 10003856761 Ver. 01 MMI-UM040B-EN-P

Copyright © 2018 Rockwell Automation, Inc. Page 17 of 58

3. Move the status window to a convenient location.

4. Select the Extended Status checkbox at the top of the window to view the Software Version, Configuration ID, and Configuration Status of the HLC as shown in Figure 13.

Figure 13: HLC Status Window Showing Extended Status

5. When finished using the High Level Controller Status window, select the X in the upper-right corner to close the window.

Page 18: User Manual Addendum, Managed Configurations

Managed Configurations User Manual Addendum 10003856761 Ver. 01 MMI-UM040B-EN-P

Copyright © 2018 Rockwell Automation, Inc. Page 18 of 58

Host Commands

This section provides an overview of the additional command functions for the NCHost TCP Interface Utility. All commands available to be sent from NCHost to the HLC are in the Host Commands section (see Figure 14).

Figure 14: Host Commands Section

NC Configs Tab

To use Host Controller Based Management to modify the active Managed Configuration:

1. In the Host Commands section, select NC Configs (shown in Figure 15).

Figure 15: Host Commands Section – NC Configs Tab

2. Enter the desired Configuration ID from the available Config IDs. (refer to the Managed Configurations page in the Node Controller Web Interface.

3. Select Set Configuration.

4. Select Restart NCs. NOTE: All paths must be in the Init state before a Restart NCs command can be

issued. Confirm the path status by viewing the State in the Path Status window.

NCHost must be reconnected to the node controller once the restart completes,

Page 19: User Manual Addendum, Managed Configurations

Managed Configurations User Manual Addendum 10003856761 Ver. 01 MMI-UM040B-EN-P

Copyright © 2018 Rockwell Automation, Inc. Page 19 of 58

UI Reference

This section provides an overview of the changes to the User Interface (UI) for the NCHost TCP Interface Utility. Examples of each window, pane, and dialog in the UI that have changed and descriptions of the new features are provided.

Host Commands Section – NC Configs Tab

The NC Configs tab (see Figure 16) is used to send Host Controller Based Management commands to the HLC.

Figure 16: Host Commands Section – NC Configs Tab

• Configuration ID – The Config ID of the desired Managed Node Controller Configuration File to be activated.

• Set Configuration – Sends a Set Node Controller Configuration command to the HLC.

• Restart NCs – Sends a Restart Node Controllers command to the HLC.

Node Controller Status Window

The Node Controller Status window (see Figure 17) is used to display the status of all node controllers in the transport system.

Select any of the column headers to sort the contents of the Node Controller Status window by that column. An arrow is displayed that indicates the sort order.

Figure 17: Node Controller Status Window

• Extended Status – Select to display the extended Node Controller Status (see Figure 17).

• NC ID – Displays the ID number of the node controller.

• State – Displays the state of the node controller.

• Disconnected – The TCP connection from the HLC to the node controller is down (background is red).

Page 20: User Manual Addendum, Managed Configurations

Managed Configurations User Manual Addendum 10003856761 Ver. 01 MMI-UM040B-EN-P

Copyright © 2018 Rockwell Automation, Inc. Page 20 of 58

• Initializing – The node controller is loading the Node Controller Configuration File, or an error is preventing the node controller from exiting this state (background is yellow).

• Operational – The node controller is running (background is green).

• Notification Mask – Displays a four-digit hexadecimal value that identifies the digital I/O input bits that are enabled (bit set high) to send unsolicited notification messages to the HLC whenever a state change is detected.

• Input Data – Displays a four-digit hexadecimal value that identifies the status of all digital I/O input bits on the node controller.

• Output Data – Displays a four-digit hexadecimal value corresponding to the last node controller digital I/O output bit operation performed.

• Software Version – Displays the active node controller software version.

• Configuration ID – Displays the Config ID of the active Node Controller Configuration File.

• 0 – A Static Node Controller Configuration File is active.

• 1–20 – The ID of the active Managed Node Controller Configuration File.

• Configuration Status – Displays the Configuration Status of the node controller.

• Valid – The active node controller configuration is valid.

• Invalid – The active node controller configuration is invalid.

High Level Controller Status Window

The High Level Controller Status window (see Figure 18) is used to display the status of the HLC.

Figure 18: Extended High Level Controller Status Window

• Extended Status – Select to display the extended HLC Status (see Figure 18).

• State – Displays the state of the HLC specified in HLC IP Address.

• Degraded – The HLC is unable to communicate with one or more node controllers in the transport system (background is orange).

• Initialization – The HLC is loading the Node Controller Configuration File or an error is keeping the HLC from exiting this state (background is yellow).

• Operational – The HLC is running properly (background is green).

Page 21: User Manual Addendum, Managed Configurations

Managed Configurations User Manual Addendum 10003856761 Ver. 01 MMI-UM040B-EN-P

Copyright © 2018 Rockwell Automation, Inc. Page 21 of 58

• Ethernet/IP – Displays the state of the EtherNet/IP connection from the host controller (typically a PLC) to the HLC. This connection is only used when EtherNet/IP communication has been defined in the Node Controller Configuration File for communication with a PLC.

• Down – The EtherNet/IP connection is down, the HLC is unable to contact the PLC at the configured IP address, or connectivity has been lost (background is red).

• Not Conf – Not Configured. The specified IP address does not use EtherNet/IP (background is gray).

• Unknown – The HLC is not connected, or an IP address has not been specified (background is gray).

• Up – The EtherNet/IP connection is running properly (background is green).

• Software Version – Displays the HLC software version.

• Configuration ID – Displays the Config ID of the active Node Controller Configuration File.

• 0 – A Static Node Controller Configuration File is active.

• 1–20 – The ID of the active Managed Node Controller Configuration File.

• Configuration Status – Displays the Configuration Status of the HLC.

• Valid – The active HLC configuration is valid.

• Invalid – The active HLC configuration is invalid.

Page 22: User Manual Addendum, Managed Configurations

Managed Configurations User Manual Addendum 10003856761 Ver. 01 MMI-UM040B-EN-P

Copyright © 2018 Rockwell Automation, Inc. Page 22 of 58

Host Controller TCP/IP Communication Protocol User Manual Addendum

This section is an addendum to the Host Controller TCP/IP Communication Protocol User Manual and describes additions to the protocol. This protocol is used for communication between the MagneMotion HLC and a host controller that is equipped with a TCP/IP interface to support the Host Controller Based Management, Extended Node Controller Status, and Extended High Level Controller Status features.

Host Controller to HLC Communications

The Commands that are shown in Table 1 are sent from the host controller to the HLC as asynchronous requests for the transport system to perform an action. These requests are responded to by the HLC by routing the command to the appropriate node controller for completion and sending responses to the host controller.

Table 1: Host Controller to HLC Commands Description and Value Use Page

Set Node Controller Configuration (0xBF 0C 01) MM LITE 23 Restart Node Controllers (0xBF 0C 02) MM LITE 24 Get Extended Node Controller Status (0xBF 0C 03) MM LITE 26 Get Extended High Level Controller Status (0xBF 0C 04) MM LITE 28

Page 23: User Manual Addendum, Managed Configurations

Managed Configurations User Manual Addendum 10003856761 Ver. 01 MMI-UM040B-EN-P

Copyright © 2018 Rockwell Automation, Inc. Page 23 of 58

Set Node Controller Configuration (0xBF 0C 01)

Type

Host Controller HLC

Purpose

Selects the specified Managed Configuration as active on all node controllers in a transport system.

Support

This command is supported in the latest software release for the following product lines:

• MagneMover LITE transport systems.

Format

Offset Item Bytes Range 0 Command Header 1 0xBF 1 Extension Type 1 0x0C 2 Extension Subtype 1 0x01 3 Configuration ID 1 1–20 4 Host Command Count 4 0x0–0xFFFFFFFF

Arguments

Command Header – Fixed message type that identifies this message as a Host Extension command.

Extension Type – Fixed extension type that identifies this command as a Remote Management extension command.

Extension Subtype – Fixed extension subtype that identifies this command as a Set Node Controller Configuration extension command.

Configuration ID – The ID of the managed Node Controller Configuration File to set as active on all node controllers in a transport system.

Host Command Count – A unique value that is supplied by the host controller when this message is sent. It aids the host controller in tracking execution of this command. The Host Command Count field is always returned in Command Status (0xD0) messages.

Response

After receiving the command, the HLC verifies the command parameters and sends either a ‘Command Accepted’ or ‘Command Rejected’ response as appropriate (see Command Status

Page 24: User Manual Addendum, Managed Configurations

Managed Configurations User Manual Addendum 10003856761 Ver. 01 MMI-UM040B-EN-P

Copyright © 2018 Rockwell Automation, Inc. Page 24 of 58

(0xD0) on page 30). If the command is accepted, the HLC handles setting the specified Node Controller Configuration File as active on all node controllers in a transport system.

On command completion, the HLC sends a ‘Command Complete’ or a ‘Command Failed’ response.

See Also

Command Status (0xD0) on page 30

Page 25: User Manual Addendum, Managed Configurations

Managed Configurations User Manual Addendum 10003856761 Ver. 01 MMI-UM040B-EN-P

Copyright © 2018 Rockwell Automation, Inc. Page 25 of 58

Restart Node Controllers (0xBF 0C 02)

Type

Host Controller HLC

Purpose

Restarts all node controllers in the transport system.

Support

This command is supported in the latest software release for the following product lines: • MagneMover LITE transport systems.

Format

Offset Item Bytes Range 0 Command Header 1 0xBF 1 Extension Type 1 0x0C 2 Extension Subtype 1 0x02 3 Host Command Count 4 0x0–0xFFFFFFFF

Arguments

Command Header – Fixed message type that identifies this message as a Host Extension command.

Extension Type – Fixed extension type that identifies this command as a Remote Management extension command.

Extension Subtype – Fixed extension subtype that identifies this command as a Restart Node Controllers extension command.

Host Command Count – A unique value that is supplied by the host controller when this message is sent. It aids the host controller in tracking execution of this command. The Host Command Count field is always returned in Command Status (0xD0) messages.

Response

After receiving the command, the HLC verifies the command parameters and sends either a ‘Command Accepted’ or ‘Command Rejected’ response as appropriate (see Command Status (0xD0) on page 30). If the command is accepted, the HLC handles restarting all node controllers in the transport system.

On command completion, the HLC sends a ‘Command Complete’ or a ‘Command Failed’ response.

See Also

Command Status (0xD0) on page 30

Page 26: User Manual Addendum, Managed Configurations

Managed Configurations User Manual Addendum 10003856761 Ver. 01 MMI-UM040B-EN-P

Copyright © 2018 Rockwell Automation, Inc. Page 26 of 58

Get Extended Node Controller Status (0xBF 0C 03)

Type

Host Controller HLC

Purpose

Requests extended node controller status for a specific node controller or for all node controllers in a transport system.

Support

This command is supported in the latest software release for the following product lines:

• MagneMover LITE transport systems.

Format

Offset Item Bytes Range 0 Command Header 1 0xBF 1 Extension Type 1 0x0C 2 Extension Subtype 1 0x03 3 NC ID 2 Values are:

0 – Get status for all node controllers 1–128 – Get status for a specific node controller

Arguments

Command Header – Fixed message type That identifies this message as a Host Extension command message.

Extension Type – Fixed extension type that identifies this command as a Remote Management extension command.

Extension Subtype – Fixed extension subtype that identifies this command as an Extended Node Controller Status extension command.

NC ID – The ID of the node controller for which status is being requested. If the NC ID field is nonzero, the HLC gets status only for the specified node controller. If the specified node controller does not exist, an Extended Node Controller Status (0xDF 0C 03) response message is returned with the failing NC ID and the Command Status field set indicating that no such node controller exists in the transport system. If the NC ID field is 0, the HLC gets status for all configured node controllers. An Extended Node Controller Status (0xDF 0C 03) response message is returned for each node controller with its success or failure status.

Page 27: User Manual Addendum, Managed Configurations

Managed Configurations User Manual Addendum 10003856761 Ver. 01 MMI-UM040B-EN-P

Copyright © 2018 Rockwell Automation, Inc. Page 27 of 58

If the HLC rejects a Get Extended Node Controller Status command, the ID of the node controller and the failure status are included in the Extended Node Controller Status (0xDF 0C 03) response message.

Response

After receiving the command, the HLC verifies the command parameters and sends one or more Extended Node Controller Status (0xDF 0C 03) response messages to the host controller.

See Also

Extended Node Controller Status (0xDF 0C 03) on page 32

Page 28: User Manual Addendum, Managed Configurations

Managed Configurations User Manual Addendum 10003856761 Ver. 01 MMI-UM040B-EN-P

Copyright © 2018 Rockwell Automation, Inc. Page 28 of 58

Get Extended High Level Controller Status (0xBF 0C 04)

Type

Host Controller HLC

Purpose

Requests extended status for the high level controller of a transport system.

Support

This command is supported in the latest software release for the following product lines:

• MagneMover LITE transport systems.

Format

Offset Item Bytes Range 0 Command Header 1 0xBF 1 Extension Type 1 0x0C 2 Extension Subtype 1 0x04

Arguments

Command Header – Fixed message type that identifies this message as a Host Extension command message.

Extension Type – Fixed extension type that identifies this command as a Remote Management extension command.

Extension Subtype – Fixed extension subtype that identifies this command as a Get Extended High Level Controller Status extension command.

Response

After receiving the command, the HLC verifies the command parameters and sends an Extended High Level Controller Status (0xDF 0C 04) response message to the host controller.

See Also

Extended High Level Controller Status (0xDF 0C 04) on page 34

Page 29: User Manual Addendum, Managed Configurations

Managed Configurations User Manual Addendum 10003856761 Ver. 01 MMI-UM040B-EN-P

Copyright © 2018 Rockwell Automation, Inc. Page 29 of 58

HLC to Host Controller Communications

The high level controller responds to commands from the host controller by issuing the following responses (shown in Table 2), to the host controller.

Table 2: HLC to Host Controller Status Responses Description and Value Use Page

Command Status (0xD0) MM LITE 30 Extended Node Controller Status (0xDF 0C 03) MM LITE 32 Extended High Level Controller Status (0xDF 0C 04) MM LITE 34

Page 30: User Manual Addendum, Managed Configurations

Managed Configurations User Manual Addendum 10003856761 Ver. 01 MMI-UM040B-EN-P

Copyright © 2018 Rockwell Automation, Inc. Page 30 of 58

Command Status (0xD0)

Type

HLC Host Controller

Purpose

Acknowledges the reception or rejection of a command by the HLC. This response signals a command execution failure, or command completion to the host controller.

NOTE: Receipt of a valid command or the event of a command completion is required.

Support

This command is supported in the latest software release for the following product lines:

• MagneMover LITE transport systems.

Format

Offset Item Bytes Range 0 Response Header 1 0xD0 1 Command 1 0xB0–0xBC, 0xBF 2 Command Status 1 0x00–0x80 3 Command Data Detail Varies Varies for each command

Arguments

Response Header – Fixed message type that identifies this message as a Command Status response message.

Command – Header of the command that this message is acknowledging.

Cmd Ext Sub Command Valid Command Status Values 0xBF 0x0C 0x01 Set Node Controller

Configuration 0x00, 0x0B, 0x0C, 0x0E, 0x41, 0x80

0xBF 0x0C 0x02 Restart Node Controllers 0x00, 0x0C, 0x0E, 0x41, 0x80

Command Status – The status of the command that this message is acknowledging, see HLC Status Codes on page 51.

Page 31: User Manual Addendum, Managed Configurations

Managed Configurations User Manual Addendum 10003856761 Ver. 01 MMI-UM040B-EN-P

Copyright © 2018 Rockwell Automation, Inc. Page 31 of 58

Command Data Detail – Variable amount of data that provides the details of the command that is specified in the Command field.

Cmd Ext Sub Command Description Command Data 0xBF 0x0C 0x01 Set Node Controller

Configuration Extension Type (1 byte) Extension Subtype (1 byte) Configuration ID (2 bytes) Host Command Count (4 bytes)

0xBF 0x0C 0x02 Restart Node Controllers Extension Type (1 byte) Extension Subtype (1 byte) Host Command Count (4 bytes)

See Also

Set Node Controller Configuration (0xBF 0C 01) on page 23 Restart Node Controllers (0xBF 0C 02) on page 25

Page 32: User Manual Addendum, Managed Configurations

Managed Configurations User Manual Addendum 10003856761 Ver. 01 MMI-UM040B-EN-P

Copyright © 2018 Rockwell Automation, Inc. Page 32 of 58

Extended Node Controller Status (0xDF 0C 03)

Type

HLC Host Controller

Purpose

Reports extended status for one or more node controllers that are specified in a Get Extended Node Controller Status (0xBF 0C 03) command message to the host controller.

Support

This command is supported in the latest software release for the following product lines:

• MagneMover LITE transport systems.

Format

Offset Item Bytes Range 0 Response Header 1 0xDF 1 Extension Type 1 0x0C 2 Extension Subtype 1 0x03 3 Command Status 1 0x00, 0x0C, 0x0E 4 NC ID 2 1–128 6 State 1 Values are:

1 – Initialization 2 – Disconnected 3 – Operational

7 Software Major Version 1 0–255 8 Software Minor Version 1 0–255 9 Software Patch Version 1 0–255

10 Configuration ID 1 Values are: 0 – Static Node Controller Configuration File 1–20 – Managed Node Controller Configuration File

11 Configuration Valid 1 Values are: 0 – Configuration not valid 1 – Configuration valid

Arguments

Response Header – Fixed message type that identifies this message as a Host Extension message.

Page 33: User Manual Addendum, Managed Configurations

Managed Configurations User Manual Addendum 10003856761 Ver. 01 MMI-UM040B-EN-P

Copyright © 2018 Rockwell Automation, Inc. Page 33 of 58

Extension Type – Fixed extension type that identifies this message as a Remote Management extension message.

Extension Subtype – Fixed extension subtype that identifies this message as an Extended Node Controller Status extension message.

Command Status – Status of the command that this Extended Node Controller Status message is acknowledging (see HLC Status Codes on page 51).

NC ID – The ID of the node controller for which status is being requested.

State – Indicates the operational state of this node controller. Possible node controller states include; initialization, disconnected, and operational.

Software Major Version – The software Major Version number for the node controller.

Software Minor Version – The software Minor Version number for the node controller.

Software Patch Version – The software Patch Version number of the node controller.

Configuration ID – The ID of the active Node Controller Configuration File for this node controller.

Configuration Valid – Indicates whether the configuration for this node controller is valid.

See Also

Get Extended Node Controller Status (0xBF 0C 03) on page 26

Page 34: User Manual Addendum, Managed Configurations

Managed Configurations User Manual Addendum 10003856761 Ver. 01 MMI-UM040B-EN-P

Copyright © 2018 Rockwell Automation, Inc. Page 34 of 58

Extended High Level Controller Status (0xDF 0C 04)

Type

HLC Host Controller

Purpose

Reports extended status for the HLC that is specified in a Get Extended High Level Controller Status (0xBF 0C 04) command message to the host controller.

Support

This command is supported in the latest software release for the following product lines:

• MagneMover LITE transport systems.

Format

Offset Item Bytes Range 0 Response Header 1 0xDF 1 Extension Type 1 0x0C 2 Extension Subtype 1 0x04 3 State 1 Values are:

1 – Initialization 2 – Degraded 3 – Operational

4 Software Major Version 1 0–255 5 Software Minor Version 1 0–255 6 Software Patch Version 1 0–255 7 Configuration ID 1 Values are:

0 – Static Node Controller Configuration File 1–20 – Managed Node Controller Configuration File

8 Configuration Valid 1 Values are: 0 – Configuration not valid 1 – Configuration valid

9 PLC Communication Status 1 Values are: 0 – PLC EtherNet/IP control is not configured 1 – PLC EtherNet/IP communication link is up 2 – PLC EtherNet/IP communication link is down

Page 35: User Manual Addendum, Managed Configurations

Managed Configurations User Manual Addendum 10003856761 Ver. 01 MMI-UM040B-EN-P

Copyright © 2018 Rockwell Automation, Inc. Page 35 of 58

Arguments

Response Header – Fixed message type that identifies this message as a Host Extension command message.

Extension Type – Fixed extension type that identifies this message as a Remote Management extension message.

Extension Subtype – Fixed extension subtype that identifies this message as an Extended High Level Controller Status extension message.

State – Indicates the operational state of the high level controller. Possible HLC states include; initialization, degraded, and operational.

Software Major Version – The software Major Version number for the HLC.

Software Minor Version – The software Minor Version number for the HLC.

Software Patch Version – The software Patch Version number for the HLC.

Configuration ID – The ID of the active High Level Controller Configuration File for the HLC.

Configuration Valid – Indicates whether the configuration for this HLC is valid.

PLC Communication Status – This field indicates the status of the PLC EtherNet/IP communication link with the HLC.

See Also

Get Extended High Level Controller Status (0xBF 0C 04) on page 28

Page 36: User Manual Addendum, Managed Configurations

Managed Configurations User Manual Addendum 10003856761 Ver. 01 MMI-UM040B-EN-P

Copyright © 2018 Rockwell Automation, Inc. Page 36 of 58

Host Controller EtherNet/IP Communication Protocol User Manual Addendum

This section is an addendum to the Host Controller EtherNet/IP Communication Protocol User Manual and describes additions to the protocol. This protocol is used for communication between the MagneMotion HLC and a host controller that is equipped with an EtherNet/IP interface to support the Host Controller Based Management, Extended Node Controller Status, and Extended High Level Controller Status features.

Host Controller to HLC Communications

This section describes Explicit Message types and Tag memory formats that traverse TCP connections between the host controller (PLC) and the HLC.

Command (explicit) messages (listed in Table 3) are sent from the host controller to the HLC to request the HLC to perform an action. These requests are responded to by the HLC by routing the command to the appropriate node controller for completion and updating the corresponding response tags in PLC memory (listed in Table 4 and Table 5).

Table 3: PLC to HLC Explicit Message Requests Message Name Message Element Use Page

MMI_mgmt_nc_set_config_cmd udt_MMI_mgmt_nc_set_config_cmd MM LITE 37 MMI_mgmt_nc_restart_cmd udt_MMI_mgmt_nc_restart_cmd MM LITE 40

Page 37: User Manual Addendum, Managed Configurations

Managed Configurations User Manual Addendum 10003856761 Ver. 01 MMI-UM040B-EN-P

Copyright © 2018 Rockwell Automation, Inc. Page 37 of 58

MMI_mgmt_nc_set_config_cmd

Type

Host Controller HLC

Purpose

Contains one tag of type udt_MMI_mgmt_nc_set_config_cmd used to set the specified managed Node Controller Configuration File as active on all node controllers in a transport system.

Each Set Node Controller Configuration command can be monitored via its corresponding udt_MMI_mgmt_nc_cmd_status entry in the MMI_mgmt_nc_cmd_status tag.

Support

This command is supported in the latest software release for the following product lines:

• MagneMover LITE transport systems.

Message Element Data Type

The UDT type editor in Figure 19 shows the type of each element comprising udt_MMI_mgmt_nc_set_config_cmd type.

Figure 19: UDT udt_MMI_mgmt_nc_set_config_cmd

UDT Field Descriptions

This section describes the format of the UDT used to define Set Node Controller Configuration commands. UDT fields (shown in italics) are described in more detail below.

Field Name Data Type Style Range configuration_id SINT Decimal 1–20 command_count DINT Hex 0x0–0xFFFFFFFF

Page 38: User Manual Addendum, Managed Configurations

Managed Configurations User Manual Addendum 10003856761 Ver. 01 MMI-UM040B-EN-P

Copyright © 2018 Rockwell Automation, Inc. Page 38 of 58

configuration_id – The ID of the managed Node Controller Configuration File to set as active on all node controllers in a transport system.

command_count – The command_count field is used to confirm that the HLC has received the command and has accepted or rejected the command by matching it up with fields in the MMI_mgmt_nc_cmd_status tag, which is written to by the HLC in response to a MMI_mgmt_nc_set_config_cmd. This count provides a convenient handshake mechanism.

Using a scratch DINT tag as a counter is suggested. The scratch DINT tag can be incremented and copied to the command_count field each time a new Set Node Controller Configuration command is issued so the new command can be tracked against the various count fields that are described in MMI_mgmt_nc_cmd_status on page 48.

Message Configuration

Source Element Type Number of Elements

Destination Element

udt_MMI_mgmt_nc_set_config_cmd Min: 1 Max: 1 MMI_mgmt_nc_set_config_cmd

The source element mgmt_nc_set_config_cmd shown in Figure 20 is a single element of type udt_MMI_mgmt_nc_set_config_cmd.

Figure 20: Example Set NC Configuration Command Explicit Message Configuration

Response

After receiving the command and verifying command parameters, the HLC updates the MMI_mgmt_nc_cmd_status tag with a Command Accepted or a Command Rejected response as appropriate. If the Set Node Controller Configuration command is accepted, the

Page 39: User Manual Addendum, Managed Configurations

Managed Configurations User Manual Addendum 10003856761 Ver. 01 MMI-UM040B-EN-P

Copyright © 2018 Rockwell Automation, Inc. Page 39 of 58

HLC handles distributing and setting the specified Node Controller Configuration File as active on all node controllers in the transport system.

On completion of the command, the HLC updates the MMI_mgmt_nc_cmd_status tag with a Command Complete or a Command Failed response.

See Also

MMI_mgmt_nc_cmd_status on page 48

Page 40: User Manual Addendum, Managed Configurations

Managed Configurations User Manual Addendum 10003856761 Ver. 01 MMI-UM040B-EN-P

Copyright © 2018 Rockwell Automation, Inc. Page 40 of 58

MMI_mgmt_nc_restart_cmd

Type

Host Controller HLC

Purpose

Contains one tag of type udt_MMI_mgmt_nc_restart_cmd used to restart all node controllers in the transport system.

Each Restart Node Controllers command can be monitored via its corresponding udt_MMI_mgmt_nc_cmd_status entry in the MMI_mgmt_nc_cmd_status tag.

Support

This command is supported in the latest software release for the following product lines:

• MagneMover LITE transport systems.

Message Element Data Type

The UDT type editor in Figure 21 shows the type of each element comprising udt_MMI_mgmt_nc_restart_cmd type.

Figure 21: UDT udt_MMI_mgmt_nc_restart_cmd

UDT Field Descriptions

This section describes the format of the UDT used to define Restart Node Controllers commands. UDT fields (shown in italics) are described in more detail following the table.

Field Name Data Type Style Range command_count DINT Hex 0x0–0xFFFFFFFF

command_count – The command_count field is used to confirm the HLC has received the command and has accepted or rejected the command by matching it up with fields in the MMI_mgmt_nc_cmd_status array, which is written to by the HLC in response to a MMI_mgmt_nc_restart_cmd. This count provides a convenient handshake mechanism.

Page 41: User Manual Addendum, Managed Configurations

Managed Configurations User Manual Addendum 10003856761 Ver. 01 MMI-UM040B-EN-P

Copyright © 2018 Rockwell Automation, Inc. Page 41 of 58

Using a scratch DINT tag as a counter is suggested. The scratch DINT tag can be incremented and copied to the command_count field each time a new Restart Node Controller command is issued so the new command can be tracked against the various count fields that are described in MMI_mgmt_nc_cmd_status on page 48.

Message Configuration

Source Element Type Number of Elements

Destination Element

udt_MMI_mgmt_nc_restart_cmd Min: 1 Max: 1 MMI_mgmt_nc_restart_cmd

The source element mgmt_nc_restart_cmd shown in Figure 22 is a single element of type udt_MMI_mgmt_nc_restart_cmd.

Figure 22: Example Restart NCs Command Explicit Message Configuration

Response

After receiving the command and verifying command parameters, the HLC updates the MMI_mgmt_nc_cmd_status tag with a Command Accepted or Command Rejected response as appropriate. If the Restart Node Controllers command is accepted, the HLC handles restarting all node controllers in the transport system.

On completion of the command, the HLC updates the MMI_mgmt_nc_cmd_status tag with a Command Complete or a Command Failed response.

See Also

MMI_mgmt_nc_cmd_status on page 48

Page 42: User Manual Addendum, Managed Configurations

Managed Configurations User Manual Addendum 10003856761 Ver. 01 MMI-UM040B-EN-P

Copyright © 2018 Rockwell Automation, Inc. Page 42 of 58

HLC to Host Controller Communications

This section describes the Status and Response Memory Tags that the HLC updates to interoperate with the PLC.

The HLC updates the Status Tags (listed in Table 4) on state change or when the EtherNet/IP link between the HLC and the PLC has been re-established after going down. Status Tags are informational for the PLC for disseminating status about the Extended Node Controller Status and Extended High Level Controller Status functions. The HLC updates the Response Tags (listed in Table 5) only in response to specific commands from the PLC issued via explicit messages.

Table 4: HLC to PLC Status Memory Tags Message Name Message Element Use Page

MMI_extended_hlc_status udt_MMI_extended_hlc_status MM LITE 43 MMI_extended_nc_status udt_MMI_extended_nc_status MM LITE 45

Table 5: HLC to PLC Response Memory Tags Message Name Message Element Use Page

MMI_mgmt_nc_cmd_status udt_MMI_mgmt_nc_cmd_status MM LITE 48

Page 43: User Manual Addendum, Managed Configurations

Managed Configurations User Manual Addendum 10003856761 Ver. 01 MMI-UM040B-EN-P

Copyright © 2018 Rockwell Automation, Inc. Page 43 of 58

MMI_extended_hlc_status

Type

HLC Host Controller

Purpose

Reports the extended status of the HLC in a transport system. This tag consists of an element of type udt_MMI_extended_hlc_status.

The HLC updates the MMI_extended_hlc_status tag whenever the link between the HLC and the PLC is re-established and on content change.

Support

This command is supported in the latest software release for the following product lines:

• MagneMover LITE transport systems.

Tag Format

Tag Name MMI_extended_hlc_status Type udt_MMI_extended_hlc_status Array No

The UDT type editor in Figure 23 shows the type of an element in the MMI_extended_hlc_status tag. This type must be first created with the type editor and then a tag of name MMI_extended_hlc_status must be created as an element of the UDT type.

Figure 23: UDT udt_MMI_extended_hlc_status

Page 44: User Manual Addendum, Managed Configurations

Managed Configurations User Manual Addendum 10003856761 Ver. 01 MMI-UM040B-EN-P

Copyright © 2018 Rockwell Automation, Inc. Page 44 of 58

UDT Field Descriptions

This section describes the format of the UDT used to report the Extended High Level Controller status in a transport system. UDT fields are described in more detail following the table.

Field Name Data Type

Style Range

state SINT Decimal

Values are: 1 – Initialization 2 – Degraded 3 – Operational

software_major_version SINT Decimal 0–255 software_minor_version SINT Decimal 0–255 software_patch_version SINT Decimal 0–255

config_id SINT Decimal

Values are: 0 – Static Node Controller Configuration File 1–20 – Managed Node Controller Configuration File

config_valid_flag SINT Decimal Values are: 0 – Configuration not valid 1 – Configuration valid

State – This field indicates the operational state of the HLC. Possible HLC states include; initialization, degraded, and operational.

software_major_version – The software Major Version number for the HLC.

software_minor_version – The software Minor Version number for the HLC.

software_patch_version – The software Patch Version number for the HLC.

config_id – The ID of the active Node Controller Configuration File for the HLC.

config_valid_flag – Indicates whether the configuration is valid for the HLC.

Page 45: User Manual Addendum, Managed Configurations

Managed Configurations User Manual Addendum 10003856761 Ver. 01 MMI-UM040B-EN-P

Copyright © 2018 Rockwell Automation, Inc. Page 45 of 58

MMI_extended_nc_status

Type

HLC Host Controller

Purpose

Reports the extended status of all node controllers in a transport system. This tag is a one-dimensional array of type udt_MMI_extended_nc_status indexed by Node Controller ID. Index 0 is not used since a Node Controller ID of 0 in the transport system is invalid.

This array must be sized to the maximum Node Controller ID configured in the transport system plus 1.

The HLC updates the MMI_extended_nc_status array whenever the link between the HLC and the PLC is re-established and on content change.

Support

This command is supported in the latest software release for the following product lines:

• MagneMover LITE transport systems.

Tag Format

Tag Name MMI_extended_nc_status Type udt_MMI_extended_nc_status[Node Controllers+1] Array Yes Array Dimension Limits Minimum array size: 2

Maximum array size: max Node Controllers + 1 Array index corresponds to Node Controller ID. Since Node Controller ID 0 is invalid, array element [0] is not used.

The UDT type editor in Figure 24 shows the type of each element in the MMI_extended_nc_status array. This type must be first created with the type editor and then a tag of name MMI_extended_nc_status must be created as an array of the UDT type dimensioned to at most the maximum number of node controllers plus 1.

Page 46: User Manual Addendum, Managed Configurations

Managed Configurations User Manual Addendum 10003856761 Ver. 01 MMI-UM040B-EN-P

Copyright © 2018 Rockwell Automation, Inc. Page 46 of 58

Figure 24: UDT udt_MMI_extended_nc_status

UDT Field Descriptions

This section describes the format of the UDT used to report the status for all node controllers in a transport system. UDT fields are described in more detail following the table.

Field Name Data Type

Style Range

state SINT Decimal

Values are: 1 – Initialization 2 – Disconnected 3 – Operational

software_major_version SINT Decimal 0–255 software_minor_version SINT Decimal 0–255 software_patch_version SINT Decimal 0–255

config_id SINT Decimal

Values are: 0 – Static Node Controller Configuration File 1–20 – Managed Node Controller Configuration File

config_valid_flag SINT Decimal Values are: 0 – Configuration not valid 1 – Configuration valid

state – This field indicates the operational state of this node controller. Possible node controller states include; initialization, disconnected, and operational.

software_major_version – The software Major Version number for the node controller.

software_minor_version – The software Minor Version number for the node controller.

Page 47: User Manual Addendum, Managed Configurations

Managed Configurations User Manual Addendum 10003856761 Ver. 01 MMI-UM040B-EN-P

Copyright © 2018 Rockwell Automation, Inc. Page 47 of 58

software_patch_version – The software Patch Version number for the node controller.

config_id – The ID of the active Node Controller Configuration File for this node controller.

config_valid_flag – Indicates whether the configuration is valid for this node controller.

Page 48: User Manual Addendum, Managed Configurations

Managed Configurations User Manual Addendum 10003856761 Ver. 01 MMI-UM040B-EN-P

Copyright © 2018 Rockwell Automation, Inc. Page 48 of 58

MMI_mgmt_nc_cmd_status

Type

HLC Host Controller

Purpose

Reports the status of Node Controller Remote Management commands in the transport system. This tag consists of a single element of type udt_MMI_mgmt_nc_cmd_status.

The MMI_mgmt_nc_cmd_status tag is updated only in response to a Set Node Controller Configuration or a Restart Node Controllers explicit message sent from the PLC to the HLC.

This tag can be used to handshake Node Controller Remote Management commands so the PLC logic can know that the HLC received a command, and either rejected it with an appropriate error code, or accepted it for processing. The tag array can be consulted to determine if a command completed and whether it completed successfully or an error occurred.

Support

This command is supported in the latest software release for the following product lines:

• MagneMover LITE transport systems.

Tag Format

Tag Name MMI_mgmt_nc_cmd_status Type udt_MMI_mgmt_nc_cmd_status Array No

The UDT type editor in Figure 25 shows the type of an element in the MMI_mgmt_nc_cmd_status tag. This type must be first created with the type editor and then a tag of name MMI_mgmt_nc_cmd_status must be created as a single element of the UDT type.

Page 49: User Manual Addendum, Managed Configurations

Managed Configurations User Manual Addendum 10003856761 Ver. 01 MMI-UM040B-EN-P

Copyright © 2018 Rockwell Automation, Inc. Page 49 of 58

Figure 25: UDT udt_MMI_mgmt_nc_cmd_status

UDT Field Descriptions

This section describes the format of the UDT used to report the status of Node Controller Remote Management commands. UDT fields are described in more detail following the table.

Field Name Data Type

Style Range

last_command_received_count DINT Hex 0x0–0xFFFFFFFF last_command_accepted_count DINT Hex 0x0–0xFFFFFFFF last_command_received SINT Hex Values are:

0x01 – Set NC Configuration command 0x02 – Restart NCs command

last_command_received_status SINT Hex 0x00, 0x0B, 0x0C, 0x0E, 0x41 last_command_accepted SINT Hex Values are:

0x01 – Set NC Configuration command 0x02 – Restart NCs command

last_command_accepted_completion_status

SINT Hex 0x00, 0x41, 0x80

last_command_received_count – The HLC writes the command_count field of the most recently received Node Controller Remote Management command to this field. PLC logic can use this field to determine if the HLC received a Node Controller Remote Management command.

Page 50: User Manual Addendum, Managed Configurations

Managed Configurations User Manual Addendum 10003856761 Ver. 01 MMI-UM040B-EN-P

Copyright © 2018 Rockwell Automation, Inc. Page 50 of 58

last_command_accepted_count – The HLC writes the command_count field of the most recently accepted Node Controller Remote Management command to this field when the HLC accepts a command. PLC logic can use this field to determine whether a Node Controller Remote Management command received by the HLC has been accepted or not.

last_command_received – The HLC writes the command type of the most recently received Node Controller Remote Management command to this field.

last_command_received_status – The HLC writes an acceptance or rejection status to this field upon receiving a new Node Controller Remote Management command from the PLC. See HLC Status Codes on page 51 for the meaning of HLC error status codes.

last_command_accepted – The HLC writes the command type of the most recently accepted Node Controller Remote Management command to this field. This field is not updated when a received command is rejected.

last_command_accepted_completion_status – The HLC writes the completion status of the last_command_accepted to this field when a Node Controller Remote Management command actually completes or fails. See HLC Status Codes on page 51 for the meaning of HLC error status codes.

See Also

MMI_mgmt_nc_set_config_cmd on page 37 MMI_mgmt_nc_restart_cmd on page 40

Page 51: User Manual Addendum, Managed Configurations

Managed Configurations User Manual Addendum 10003856761 Ver. 01 MMI-UM040B-EN-P

Copyright © 2018 Rockwell Automation, Inc. Page 51 of 58

HLC Status Codes

Table 6 lists the status codes that the HLC returns when it accepts, rejects, or completes Host Controller Based Management, Extended Node Controller Status, or Extended High Level Controller Status commands.

Table 6: HLC Status Codes

Status Value Status Description

0x00 Command Accepted 0x0B Command Rejected – Invalid parameter 0x0C Command Rejected – Initialization has not completed 0x0E Command Rejected – No record available 0x41 Command Failed – Unable to complete 0x80 Command Completed Successfully

Page 52: User Manual Addendum, Managed Configurations

Managed Configurations User Manual Addendum 10003856761 Ver. 01 MMI-UM040B-EN-P

Copyright © 2018 Rockwell Automation, Inc. Page 52 of 58

Node Controller Remote Management Configuration

See the MagneMover LITE Configurator User Manual for information on the Node Controller Configuration File.

Node Controller Configuration File XML Reference

This section describes the additional XML elements that are used to enable and tailor the reporting of Remote Management Status and Response memory tags to a PLC, shown in Table 7. These XML elements must be used in the EtherNet/IP section of the Node Controller Configuration File.

Table 7: Node Controller Remote Management Configuration XML Elements Element Description Use Page

PLC_mgmt_nc_cmd_enable Enables use of the node controller remote management commands

MM LITE 53

PLC_extended_hlc_status Enables reporting of the extended HLC status

MM LITE 54

PLC_extended_nc_status Enables reporting of the extended node controller status

MM LITE 55

Page 53: User Manual Addendum, Managed Configurations

Managed Configurations User Manual Addendum 10003856761 Ver. 01 MMI-UM040B-EN-P

Copyright © 2018 Rockwell Automation, Inc. Page 53 of 58

PLC_mgmt_nc_cmd_enable

Purpose

Controls whether the HLC pushes node controller remote management command response memory tags to PLC memory. The default value for this element is False.

Syntax

<PLC_mgmt_nc_cmd_enable>Enable</PLC_mgmt_nc_cmd_enable>

Contents Enable: False – Do not push NC remote management response tags to PLC memory.

True – Push NC remote management response tags to PLC memory.

Example

The following example enables node controller remote management status reporting.

<PLC_mgmt_nc_cmd_enable>True</PLC_mgmt_nc_cmd_enable>

Page 54: User Manual Addendum, Managed Configurations

Managed Configurations User Manual Addendum 10003856761 Ver. 01 MMI-UM040B-EN-P

Copyright © 2018 Rockwell Automation, Inc. Page 54 of 58

PLC_extended_hlc_status

Purpose

Controls whether the HLC pushes extended HLC status tags to PLC memory. The default value for this element is False.

Syntax

<PLC_extended_hlc_status>Enable</PLC_extended_hlc_status>

Contents Enable: False – Do not push extended HLC status tags to PLC memory.

True – Push extended HLC status tags to PLC memory.

Example

The following example enables extended HLC status reporting.

<PLC_extended_hlc_status>True</PLC_extended_hlc_status>

Page 55: User Manual Addendum, Managed Configurations

Managed Configurations User Manual Addendum 10003856761 Ver. 01 MMI-UM040B-EN-P

Copyright © 2018 Rockwell Automation, Inc. Page 55 of 58

PLC_extended_nc_status

Purpose

Controls whether the HLC pushes extended node controller status tags to PLC memory. The default value for this element is False.

Syntax

<PLC_extended_nc_status>Enable</PLC_extended_nc_status>

Contents Enable: False – Do not push extended node controller status tags to PLC memory.

True – Push extended node controller status tags to PLC memory.

Example

The following example enables extended node controller status reporting.

<PLC_extended_nc_status>True</PLC_extended_nc_status>

Page 56: User Manual Addendum, Managed Configurations

Managed Configurations User Manual Addendum 10003856761 Ver. 01 MMI-UM040B-EN-P

Copyright © 2018 Rockwell Automation, Inc. Page 56 of 58

Node Controller Configuration File Example

Figure 26 is an example EtherNet/IP configuration from a Node Controller Configuration File that shows how to configure a node controller to report Remote Management Status and Response Memory Tags to a PLC.

Figure 26: Example Remote Management Node Controller EtherNet/IP Configuration

<Ethernet_IP> <PLC_IP_address>192.168.110.72</PLC_IP_address> <PLC_CPU_slot>0</PLC_CPU_slot> <PLC_max_vehicle_ID>64</PLC_max_vehicle_ID> <PLC_send_vehicle_status_period>100</PLC_send_vehicle_status_period> <PLC_tag_request_retry_timeout>250</PLC_tag_request_retry_timeout> <PLC_mgmt_nc_cmd_enable>True</PLC_mgmt_nc_cmd_enable> <PLC_extended_hlc_status>True</PLC_extended_hlc_status> <PLC_extended_nc_status>True</PLC_extended_nc_status> </Ethernet_IP>

Page 57: User Manual Addendum, Managed Configurations

Managed Configurations User Manual Addendum 10003856761 Ver. 01 MMI-UM040B-EN-P

Copyright © 2018 Rockwell Automation, Inc. Page 57 of 58

More Information

MagneMotion website: www.magnemotion.com

Questions and Comments: www.magnemotion.com/about-magnemotion/contact.cfm

Revision History Ver. Change Description

00 Initial release

01 Added EtherNet/IP Communication Protocol and Node Controller Configuration File XML Reference

Page 58: User Manual Addendum, Managed Configurations

Managed Configurations User Manual Addendum 10003856761 Ver. 01 MMI-UM040B-EN-P

Copyright © 2018 Rockwell Automation, Inc. Page 58 of 58

Rockwell Automation Support

Use the following resources to access support information. Technical Support Center Knowledgebase Articles, How-to Videos, FAQs, Chat, User

Forums, and Product Notification Updates. https://rockwellautomation.custhelp.com/

Local Technical Support Phone Numbers Locate the phone number for your country. http://www.rockwellautomation.com/global/support/get-support-now.page

Direct Dial Codes Find the Direct Dial Code for your product. Use the code to route your call directly to a technical support engineer.

http://www.rockwellautomation.com/global/support/direct-dial.page

Literature Library Installation Instructions, Manuals, Brochures, and Technical Data.

http://www.rockwellautomation.com/global/support/direct-dial.page

Product Compatibility and Download Center (PCDC)

Get help determining how products interact, check features and capabilities, and find associated firmware.

http://www.rockwellautomation.com/global/support/pcdc.page

Documentation Feedback Your comments will help us serve your documentation needs better. If you have any suggestions on how to improve this document, complete the How Are We Doing? form at http://literature.rockwellautomation.com/idc/groups/literature/documents/du/ra-du002_-en-e.pdf. Rockwell Automation maintains current product environmental information on its website at http://www.rockwellautomation.com/rockwellautomation/about-us/sustainability-ethics/product-environmental-compliance.page. Allen-Bradley, Compact I/O, CompactLogix, ControlLogix, DH+, DriveLogix, FactoryTalk, FLEX, Logix5000, PanelBuilder, PanelView, PLC-2, PLC-3, PLC-5, POINT I/O, PowerFlex, Rockwell Automation, Rockwell Software, RSLinx, RSLogix, RSNetWorx, RSView, SLC, SoftLogix, Studio 5000, and Studio 5000 Logix Designer are trademarks of Rockwell Automation, Inc. Trademarks not belonging to Rockwell Automation are property of their respective companies. Rockwell Otomasyon Ticaret A.Ş., Kar Plaza İş Merkezi E Blok Kat:6 34752 İçerenköy, İstanbul, Tel: +90 (216) 5698400 www.rockwellautomation.com

Power, Control and Information Solutions Headquarters Americas: Rockwell Automation, 1201 South Second Street, Milwaukee, WI 53204-2496 USA, Tel: (1) 414.382.2000, Fax: (1) 414.382.4444 Europe/Middle East/Africa: Rockwell Automation NV, Pegasus Park, De Kleetlaan 12a, 1831 Diegem, Belgium, Tel: (32) 2 663 0600, Fax: (32) 2 663 0640 Asia Pacific: Rockwell Automation, Level 14, Core F, Cyberport 3, 100 Cyberport Road, Hong Kong, Tel: (852) 2887 4788, Fax: (852) 2508 1846