Multi-Option Device Support
Pat Telljohann
Rockwell Automation
Technical Trackwww.odva.org

AgendaIntroduction
Objectives
Multi-Option Device Support Definition• Identity Object• Keying• Device Class InformationUse cases• Online• Offline

Technical Track© 2014 ODVA, Inc.

2014 Industry Conference & 16th Annual Meeting
All rights reserved.

page 2www.odva.org

AgendaIntroduction
Objectives
Multi-Option Device Support Definition• Identity Object• Keying• Device Class Information

Use cases• Online• Offline

Technical Track© 2014 ODVA, Inc.

2014 Industry Conference & 16th Annual MeetingAll rights reserved.

page 3www.odva.org

Multi-option Device definition

A device that presents more than one logical view
depending on the option value for each option
These options are typically items the user canchoose either when the device is ordered or byadding pluggable components to the device
A car is an analogy• The customer can order a model of a car and then selectoptions like body style (coupe, convertible, hatchback,station wagon, etc.), engine type (4 cylinder, 6 cylinder,electric, etc.), wheel style (steel, aluminum, etc.),transmission (automatic, manual, etc.)

Technical Track© 2014 ODVA, Inc.

2014 Industry Conference & 16th Annual Meeting
All rights reserved.

page 4www.odva.org

Multi-option Device definition


The Multi-option Device definition is not meant to
be used to represent a modular system where
each module can be addressed using a portsegment
Some complex devices will be both modular andMulti-option

Technical Track© 2014 ODVA, Inc.

2014 Industry Conference & 16th Annual Meeting
All rights reserved.

page 5www.odva.org

Devices with multiple options


Currently devices with multiple options require aunique identity (product code) for each unique
combination of options
This results in many identities• A device with 6 options, each with 3 choices would resultin 36 identities (729)And many EDS files (729 in example above)Technical Track© 2014 ODVA, Inc.

2014 Industry Conference & 16th Annual Meeting
All rights reserved.

page 6www.odva.org

AgendaIntroduction
Objectives
Multi-Option Device Support Definition• Identity Object• Keying• Device Class InformationUse cases• Online• Offline

Technical Track© 2014 ODVA, Inc.

2014 Industry Conference & 16th Annual Meeting
All rights reserved.

page 7www.odva.org

ObjectivesUniquely identify each logical view presented byoption values
Provide the ability to verify the option values
supported by a specific device
Limit the number of files required to represent“device class” information (EDS)CIPSE-001-189 defines Multi-option support,
currently being reviewed by CIP System
Architecture SIG

Technical Track© 2014 ODVA, Inc.

2014 Industry Conference & 16th Annual Meeting
All rights reserved.

page 8www.odva.org

AgendaIntroduction
ObjectivesMulti-Option Device Support Definition• Identity Object• Keying• Device Class Information

Use cases• Online• Offline

Technical Track© 2014 ODVA, Inc.

2014 Industry Conference & 16th Annual Meeting
All rights reserved.

page 9www.odva.org

Identity Object and KeyingThe multi-option definition allows a single identity (VendorID, Device Type, Product Code) for the base device• Options are extensions to the base device

New attribute defined to identify options that are present
New information defined in Get_Attributes_All responsedata (bit 1 in Status attribute) to indicate device supports
additional identity information• New Get_Additional_Attributes service defined that returns
additional identity attributes, including the options attributeNew electronic key segment type defined to key optionvalues

Technical Track© 2014 ODVA, Inc.

2014 Industry Conference & 16th Annual Meeting
All rights reserved.

page 10www.odva.org

Device Class information

One EDS file is required for each Vendor ID,
Device Type, Product Code and Major Revision
One ODS (Option Data Sheet) is required foreach option value. The ODS file is identified byVendor ID, Option Type and Option Choice
ODS file definition is very similar to EDS filedefinition
A Multi-option device family with 6 options types,
each with 5 options choices would require 1 EDS
file and 30 ODS files - without the Multi-option
device definition, 15,625 EDS files would be
requiredTechnical Track© 2014 ODVA, Inc.

2014 Industry Conference & 16th Annual Meeting
All rights reserved.

page 11www.odva.org

Device Class information

The EDS defines the device class information forthe base device plus the supported option types
The ODS defines the device class information for
an option value for an option type
Typical information in an ODS• Catalog number• Attributes• Connections• Ports• Sub-options

EDS file and ODS files combined and result in thefull set of device class information for the device

Technical Track© 2014 ODVA, Inc.

2014 Industry Conference & 16th Annual Meeting
All rights reserved.

page 12www.odva.org

Options

EDS defines the supported options, which defines which
ODS files to use
One ODS per option value
Example EDS and ODS files:
EDS file snippet

ODS file snippet[Device]
VendCode = 65535;
VendName = "Widget-Works, Inc.";
ProdType = 768;
ProdTypeStr = "Option type device";
ProdCode = 1;
MajRev = 1;
MinRev = 1;
ProdName = "Option Device";
Option1 = 1, “Frame Size”,
1, “Large”,
2, “Small”;
Option2 = 5, “Overload Type”,
1, “Alloy”,
2, “Bi-metal”;
Option3 = 25, “Control Power”,
1, “24 VDC”,
2, “110 VAC”;[Option]
VendCode = 65535;
VendName = "Widget-Works, Inc.";
OptionType = 1;
OptionTypeName = “Frame Size”;
OptionChoice = 1;
OptionChoiceName = “Large”;

Technical Track© 2014 ODVA, Inc.

ODS file snippet[Option]
VendCode = 65535;
VendName = "Widget-Works, Inc.";
OptionType = 1;
OptionTypeName = “Frame Size”;
OptionChoice = 2;
OptionChoiceName = “Small”;

2014 Industry Conference & 16th Annual Meeting
All rights reserved.

page 13www.odva.org

Catalog NumberEDS defines the base catalog number
Each ODS optionally defines an addition to thebase catalog number
The combination is a catalog number for thespecific device
Example EDS and ODS files and result:

EDS file snippet[Device]
VendCode = 65535;
VendName = "Widget-Works, Inc.";
ProdType = 768;
ProdTypeStr = "Option type device";
ProdCode = 1;
MajRev = 1;
MinRev = 1;
ProdName = "Option Device";
Catalog = "3255-OptDev%1";

Technical Track© 2014 ODVA, Inc.

ODS file snippet[Option]
VendCode = 65535;
VendName = "Widget-Works,Inc.";
OptionType = 1;
OptionTypeName = “Frame Size”;
OptionChoice = 1;
OptionChoiceName = “Large”;
Catalog = “Ex";2014 Industry Conference & 16th Annual MeetingAll rights reserved.

Resulting device class information[Device]
VendCode = 65535;
VendName = "Widget-Works, Inc.";
ProdType = 768;
ProdTypeStr = "Option type device";
ProdCode = 1;
MajRev = 1;
MinRev = 1;
ProdName = "Option Device";
Catalog = "3255-OptDevEx";

page 14www.odva.org

Attributes

EDS defines the attributes that exist in the base device via
ParamN and AssemN keywords
Each ODS defines attributes that exist for the option via
Resulting device class information
ParamN and AssemN keywords[Params]
Param1 =Examples:
0,EDS snippet

ODS snippet[Params]
Param1 =0,6,"20 1D 24 01 30 06",
0x0002,0xC7,2,"FilterOffOn","ms","Input OFF-to-ON Filter.\n""",0,16000,1000,,,,,,,,,;[Params]
Param2 =0,6,"20 1D 24 01 30 08",0x0002,
0xC7,2,"Connection Config","","Some Config""",0,,10,,,,,,,,,;

Technical Track© 2014 ODVA, Inc.

2014 Industry Conference & 16th Annual Meeting
All rights reserved.

6,"20 1D 24 01 30 06",
0x0002,0xC7,2,"FilterOffOn","ms","Input OFF-to-ON Filter.\n""",0,16000,1000,,,,,,,,,;
Param2 =0,6,"20 1D 24 01 30 08",0x0002,0xC7,
2,"Connection Config","","Some Config"
page 15"",www.odva.org
0,,10,,,,,,,,,;

Connections


EDS defines the connections that exist in thebase device
Each ODS defines connections that exist for theoption
If an option adds to previous I/O assemblies theODS defines an AssemN entry that matches aprevious AssemN

Technical Track© 2014 ODVA, Inc.

2014 Industry Conference & 16th Annual Meeting
All rights reserved.

page 16www.odva.orgConnection added by option
EDS snippet

ODS snippet[Connection Manager]
Connection1 =0x04020002,0x66240405,,0,,,0,,,,,,"Simple short cut path","","20 04 24 66 2C 23 2C 69";

[Connection Manager]
Connection2 =0x04020002,0x66240405,,0,,,0,,,,,,"Single short cut path","","20 04 24 66";

Resulting device classinformation[Connection Manager]
Connection1 =0x04020002,0x66240405,,0,,,0,,,,,,"Simple short cut path","","20 04 24 66 2C 23 2C 69";
Connection2 =0x04020002,0x66240405,,0,,,0,,,,,,"Single short cut path","","20 04 24 66";

Technical Track© 2014 ODVA, Inc.

2014 Industry Conference & 16th Annual Meeting
All rights reserved.

page 17www.odva.org

Connection extended by option
EDS snippet

ODS snippet

Resulting device class information[Connection Manager]
Connection1 =0x04020002,0x66240405,,,Assem1,,0,,,,,,"Assembly example","","20 04 24 66 2C 23 2C 69";

[Assembly]
Assem1 ="More input",,4,,,,,Param2,,Param3;[Connection Manager]
Connection1 =0x04020002,0x66240405,,,Assem1,,0,,,,,,"Assembly example","","20 04 24 66 2C 23 2C 69";

[Assembly]
Assem1 =“Input",,2,,,,,Param1;

Technical Track© 2014 ODVA, Inc.

[Assembly]
Assem1 =“Input",,6,,,,,Param1,,Param2,,Param3;

2014 Industry Conference & 16th Annual Meeting
All rights reserved.

page 18
www.odva.org

Ports

EDS defines the ports that exist in the basedeviceIf the option adds ports then the ODS defines
PortN entries
Examples:EDS snippet

ODS snippet[Port]
Port1 = TCP,
"Port A",
"20 F5 24 01",2;[Port]
Port2 = ControlNet,"Port B",
"20 F0 24 01",3;Technical Track© 2014 ODVA, Inc.

2014 Industry Conference & 16th Annual Meeting
All rights reserved.

Resulting device classinformation[Port]
Port1 = TCP,
"Port A",
"20 F5 24 01",2;
Port2 = ControlNet,"Port B",
"20 F0 24 01",3;

page 19
www.odva.org

Sub-options


An ODS can define supported sub-options for this specificoption value (similar to EDS defining the supported optionsfor the base device)
The ODS defines the device class information for an option
value for a sub-option
Example option ODS file and sub-option ODS files:
Sub-option ODS file snippet

Option ODS file snippet[Option]
VendCode = 65535;
VendName = "Widget-Works, Inc.";
OptionType = 5;
OptionTypeName = “Overload Type”;
OptionChoice = 1;
OptionChoiceName = “Alloy”;
Option1 = 987, “Heating Element”
3, “FLC 1-10 amps”,
10, “FLC 11-20 amps”;

Technical Track© 2014 ODVA, Inc.

[Option]
VendCode = 65535;
VendName = "Widget-Works, Inc.";
OptionType = 987;
OptionTypeName = “Heating Element”;
OptionChoice = 3;
OptionChoiceName = “FLC 1-10 amps”;
Sub-option ODS file snippet[Option]
VendCode = 65535;
VendName = "Widget-Works, Inc.";
OptionType = 987;
OptionTypeName = “Heating Element”;
OptionChoice = 10;
OptionChoiceName = “FLC 11-20 amps”;

2014 Industry Conference & 16th Annual Meeting
All rights reserved.

page 20www.odva.org

AgendaIntroduction
Objectives
Multi-Option Device Support Definition• Identity Object• Keying• Device Class Information

Use cases• Online• Offline

Technical Track© 2014 ODVA, Inc.

2014 Industry Conference & 16th Annual Meeting
All rights reserved.

page 21www.odva.org

Offline usage





User adds multi-option device to configuration(same as adding other devices)
This results in a default set of options choices
User changes option choices
The EDS and ODS files are “combined” toproduce device class information for device
User configures multi-option device (same asconfiguring other devices)

Technical Track© 2014 ODVA, Inc.

2014 Industry Conference & 16th Annual Meeting
All rights reserved.

page 22www.odva.org

Online usage
The bus is browsed - CIP Identity object
Get_Attributes_All - for each possible link address
The Get_Attributes_All response indicates more
identity is available for the device
Get_Additional_Attributes is used to read theoption types and values
When device is added to configuration, theoptions are pre-selected
When communicating with the configured device
the new key segment to verify options is used

Technical Track© 2014 ODVA, Inc.

2014 Industry Conference & 16th Annual Meeting
All rights reserved.

page 23www.odva.org

Questions?

Technical Track© 2014 ODVA, Inc.

2014 Industry Conference & 16th Annual Meeting
All rights reserved.

page 24www.odva.org