API Reference

ODVA CIP Networks Library Volume 1: Common Industrial Protocol, and Volume 2: EtherNet/IP Adaptation of CIP

This package provides a pure-Python implementation of the Common Industrial Protocol (CIP): a network-independent, object-oriented application layer in which every device exposes its data and behavior as class/instance/attribute addressed objects (icspacket.proto.cip.objects), located through EPATHs (icspacket.proto.cip.epath) and manipulated through Message Router requests (icspacket.proto.cip.msgrouter).

EtherNet/IP (CIP Volume 2) is the TCP/UDP adaptation covered here: session encapsulation (icspacket.proto.cip.encap) and the Common Packet Format that carries addressing and data items alongside it (icspacket.proto.cip.cpf). On top of that transport, the package implements both CIP messaging types - explicit (unconnected and Connection-Manager-brokered connected messaging, icspacket.proto.cip.connmgr) and implicit (cyclic Class 0/1 I/O, icspacket.proto.cip.io) - behind client connections (icspacket.proto.cip.connection).

Added in version 0.3.0.

Protocol Layers

• Connection
• EtherNet/IP Encapsulation
• Messaging

Object Library

• Object Library
  • Core Objects
  • Network Objects
  • I/O and Parameter Objects
  • Motion, Drive, and Semiconductor Objects
  • Switch Management Objects
  • Diagnostics Objects