Introduction

This section explains how to use the CM1-T Cool Muscle motor with EtherNet/IP. It is assumed there is a basic knowledge of EtherNet/IP and PLC programming. The implementation makes use of the different Direct Control in the motor. It does not use CML logic and bank programming. However, setup (K) and controller gain (H) parameters are used for things like motor resolution, s-curve, software limits, etc. These are all accessible to be setup with Control Room or over explicit messages.

Device Profile

The CM1-T uses a generic device profile. This is to allow it to be flexible and operate in a number of operation modes.

Direct Control Operation

This mode enables the PLC to directly control the motor. See Direct Control on how to use the I/O messages to control the motor. Add on instructions are supplied in the downloads section.

CML Operation

This mode lets to motor control itself through CML programming. The PLC reads and writes to registers to monitor and make changes how the motor operates.

I/O Messages

There are two distinct I/O Assemblies based on the operation mode required.

Direct Control Operation

T2O (Input) Message

• Instance = 100
• Size = 36 bytes

(1) - ErrorCode is currently reserved and returns 0. Use MotorStatus to get motor error information

O2T (Output) Message

• Instance = 112
• Size = 28

CML Operation

T2O (Input) Message

• Instance = 101
• Size = 60 bytes

(1) - ErrorCode is currently reserved and returns 0. Use MotorStatus to get motor error information

O2T (Output) Message

• Instance = 113
• Size = 44

Read/Write Motor Registers

In the I/O messages there is the ability to read and write to internal motor registers. These registers could be configured as flags, input counters, or other custom operations.

1. Direct Operation has
   • 1 x read register
   • 1 x write register
2. CML Operation has
   • 5 x read registers
   • 5 x write registers

The register addresses can be changed after a cycle to read/write to more than 1 register.

Register Address

The register address is coded into a 2 byte (UINT16) format as follows

Register Address = Register Type Register Number

The following list maps the register type and the applicable number range

For a complete list go to Complete Register Address Map

Explicit Messages

K Parameters - Setup Parameters

• Get Attribute Single  - Service Code 0x0E
• Set Attribute Single  - Service Code 0x10

H Parameters - Gain Parameters

• Get Attribute Single  - Service Code 0x0E
• Set Attribute Single  - Service Code 0x10

Direct Control Operation

Control Modes

This section focuses on controlling the motor with the provided Add on Instructions (AOIs). These will satisfy most applications, however, if required, the motor can be controlled by setting the CM1-T objects directly (see I/O Messages). Understanding the Direct Control will be important in this case.

There are currently 3 main control modes available while running the motor over EtherNet/IP. 

1. Position - this mode sets the motor to run to a target position. The position could be absolute or relative
2. Speed - this mode allows the motors speed to be controlled for continuous motion
3. Torque - this mode allows the motors torque to be controlled.

The control modes are mapped to the ModeOfOperation value from the CM1T_ControlMode  AOI:

In addition:

• Homing is an additional mode that can be executed at any point. Homing should start from a known safe state to avoid unexpected changes in motion
• All modes can be switched to during motion. It is recommended the state is switched during a known safe state.
• Torque can be limited in all modes. Running in torque mode will disable errors such as position error which can still occur in other modes if the set torque is too low. The torque is set in 0.1% of rated torque. The range is [0,1100]. By default the torque is set to 1100 when using the AOIs supplied.

Position Mode

Absolute position and relative position both use the position mode. The key difference in operation between the two is the usage of the start bit in the CM1T_Controlword. An absolute move will accept a new position immediately if the start bit is 1.

Start Bit Usage

Motion Parameters

Position moves will accept the following motion parameters. These will be processed immediately if the start bit is high.

(1) If the deceleration is set to 0 the acceleration value will be used
(2) MoveAbsolute or MoveRelative AOI

Speed Mode

A speed move has no target position and will continue to run at the target speed. Setting a -ve speed value will reverse direction.

Start Bit Usage

Motion Parameters

Speed moves will accept the following motion parameters. These will be processed immediately if the start bit is high.

(1) If the deceleration is set to 0 the acceleration value will be used
(2) MoveSpeed AOI

Torque Mode

A torque move only uses a target torque and maximum speed. Acceleration of the motor should be limited by adjusting the target torque or speed.

Setting a -ve torque value will reverse direction.

Start Bit Usage

Motion Parameters

Torque moves will accept the following motion parameters. These will be processed immediately if the start bit is high.

(1) MoveTorque AOI

General Resources

EDS File

The CM1-T EtherNet/IP eds file can be found on the Datasheets and Downloads page.

CM1-T Library

The CM1-T Library for use with Codesys, Schneider, Beckhoff, Wago and other IEC 61131-3 PLCs can be found on the Datasheets and Downloads page.

RSLogix Resources

See Datasheets and Downloads to download the UDTs, AOIs and sample program.

User Data Types

Direct Control Operation

CM1T_Axis

The CM1-T_Axis data type defines how the bytes are assigned withing the IO message.

CM1T_Controlword

CM1T_DriveStatus

CML Operation

CM1T_CMLAxis

The CM1-T_CMLAxis data type defines how the bytes are assigned withing the IO message.

CM1T_CMLDriveStatus

Add-On Instructions

Direct Control Operation

The following tables outlines the available add-on instructions

CM1T_DataExchange

This AOI is required if any other AOIs are used. One instance is required for each CM1-T axis being controlled.

It has a number of functions

1. It exchanges data between the motor connections and the motor/drive tag.
2. It places the Controlword bits into the Controlword data type
3. It retrieves the drive status and places it into the DriveStatus variable.

Parameters

Execution

CM1T_Enable

This AOI enables the motor and drive. Torque will be present.

Parameters

Execution

CM1T_Disable

This AOI disables the motor and drive. Torque will not be present

Parameters

Execution

CM1T_ClearFault

This AOI clears any drive fault/error condition. This will also enable the motor. The rung-out-condition indicates the drive error state (true or false).

Parameters

Execution

CM1T_ControlMode

This AOI set the motion control mode.

Parameters

Execution

CM1T_MoveAbsolute

This AOI will execute an absolute position move.

Parameters

Execution

CM1T_MoveRelative

This AOI will execute a relative position move.

Parameters

Execution

CM1T_MoveSpeed

This AOI will execute a speed move.

Parameters

Execution

CM1T_MoveTorque

This AOI will execute a torque move.

Parameters

Execution

CM1T_ReadRegister

This AOI loads a register address to read. It returns the register value. The value is returned when the ReadRegister (output) address and the ReadValueAddress (input) address are equal.

Parameters

Execution

CM1T_WriteRegister

This AOI loads a register address and value to write. Once the write cycle is complete the done output is set.

Parameters

Execution

CML Operation

The following tables outlines the available add-on instructions

CM1T_CMLDataExchange

This AOI is required if any other CML AOIs are used. One instance is required for each CM1-T axis being controlled.

It has a number of functions

1. It exchanges data between the motor connections and the motor/drive tag.
2. It retrieves the drive status and places it into the DriveStatus variable.

Parameters

Execution

CM1T_CMLReadRegister

This AOI loads a register address to read. It returns the register value. The value is returned when the ReadRegister (output) address and the ReadValueAddress (input) address are equal.

Parameters

Execution

CM1T_CMLWriteRegister

This AOI loads a register address and value to write. Once the write cycle is complete the done output is set.

Parameters

Execution

Adding CM1-T and AOIs to Project

Download and extract the CM1-T_AOIs.zip support file.

The file includes the following

1. Direct Control Operation
   1. CM1T_SampleApplication.ACD - This a sample application built RSLogix. It shows how to
      1. Run the motors in each of the modes
      2. Reset from faults
      3. Enable/Disable the motor
   2. User Data Types (UDT)
   3. Add-On Instructions (AOI)
2. CML Operation
   1. CM1T_CMLSampleApplication.ACD - RSLogix application to read/write motor registers
   2. CM1T_CMLSampleApplication.crp - Control Room project with CML sample program.
      1. Executes incremental move if variable is set (Run, distance, speed and acceleration set from PLC)
      2. Increments counter variable (Variable read in PLC)
   3. User Data Types (UDT)
   4. Add-On Instructions (AOI)

Direct Control Operation

Import User Data Types (UDTs)

The following steps show how to import the UDTs used by the CM1-T module.

1. Right click on Data Types → User-Defined and select "Import Data Type..."
   
2. Browse to the location where the CM1T_AOI support file was extracted. Select the CM1T_Axis and click import. 
   
3. On the Import Configuration window click OK
4. The CM1T_Axis, CM1T_Controlword and CM1T_DriveStatus should all have been import as shown below. If they were not repeat steps 1-3 with the CM1T_Controlword and CM1T_DriveStatus.
   

Import Add-On Instructions (AOIs)

The following steps show how to import the CM1-T modules AOIs. The only required AOI is CM1T_DataExchange. All the other AOIs depend on this one to populate the data type.

1. Right click on Add-On Instructions and select "Import Add-On Instruction..."
   
2. Browse to the extracted AOI folder and select CM1T_DataExchange. Click Import
   
3. On the Configuration Import window click OK.
4. Repeat steps 1-3 until all required AOIs are imported
5. The Add-On Instruction tree will look as follows once all AOIs are imported
   

Add CM1-T Module

The following steps show how to add an CM1-T module in RSLogix. At present the EtheNet/IP is in testing and the CM1-T is added a a generic module.

1. Open an existing project or start a new one
2. In the Controller Organizer expand I/O Configuration and right click on "Ethernet". Select "New Module"
   
3. Search "Generic", Select "ETHERNET-MODULE" and click Create
   
4. Fill in the following properties shown below
   
   1. Name: Give the drive a name. E.g. CM1T_Drive, Axis1, LabelXAxis, etc
   2. Comm Format: Data - SINT
   3. IP Address: Enter the IP Address of the CM1-T you are adding.
   4. Connection Parameters
      1. Input: Assembly Instance = 100, Size = 36
      2. Output: Assembly Instance = 112, Size = 28
      3. Configuration: Assembly Instance = 1, Size = 0
   5. Click OK
5. The Module Properties window should open. If it does not double click on the newly created module inside the Ethernet heading.
   Select the Connection Tab
   
   1. Set the packet interval as required. Typically this would be 10ms.
   2. Check the boxes as shown in the picture above

The final set of steps below shows how to add the CM1T_DataExchange AOI and configure it to exchange data between the tag created for the CM1-T and the CM1-T module. A single instance of the CM1T_DataExchange should be created per module. There should never be more than one per module.

1. Add the CM1T_DataExchange AOI to a rung
   
2. Create a CM1T_DataExchange Tag and attached it to this instance. In this example it is called FB_CM1T_DataExchnage
   
3. Expand the DriveInput drop down menu and select the CM1T_Drive module input create earlier
   
4. Expand the DriveOuput drop down menu and select the CM1T_Drive module output create earlier
   
5. Create a new CM1T_Axis tag and attach it to the instruction. This is the tag that will be used in all other AOIs
   

All CM1-T AOIs are now ready to be used. See the example application for more details on running the motor.

Example Logic - Direct Control Operation Sample

The following logic is from the Direct operation sample application. The example shows how to run the motor in each of the modes, enable, disable, halt, and recover from an error.

CML Operation

Import User Data Types (UDTs)

Following the instructions for Direct Control Operation except import 

• CM1T_CMLAxis
• CM1T_CMLDriveStatus

Import Add-On Instructions (AOIs)

Follow the instructions for Direct Control Operation except import

• CM1T_CMLDataExchange
• CM1T_CMLReadRegister
• CM1T_CMLWriteRegister

Add CM1-T Module

Follow the instructions for Direct Control Operation except on step 4 enter the following configuration data

1. Name: Give the drive a name. E.g. CM1T_Drive, Axis1, LabelXAxis, etc
2. Comm Format: Data - SINT
3. IP Address: Enter the IP Address of the CM1-T you are adding.
4. Connection Parameters
   1. Input: Assembly Instance = 101, Size = 60
   2. Output: Assembly Instance = 113, Size = 44
   3. Configuration: Assembly Instance = 1, Size = 0
5. Click OK

Example Logic - CML Operation Sample

The following sample logic is supplied with the AOIs. It requires the motor to be programmed with a CML program. The program does the following

1. Motor indexes continuously by the distance amount defined by PLC
2. Motor indexes with speed and acceleration defined by PLC
3. Indexing is started and stopped by PLC
4. A counter showing number of indexes is read by the PLC

Appendix

A - Support Files

See Datasheets and Downloads.

B - Complete Register Address Map