Examine individual changes

''''CANopen''' is a communication [[Protocol (computing)|protocol]] and device profile specification for [[embedded system]]s used in [[automation]]. In terms of the [[OSI model]], CANopen implements the layers above and including the [[network layer]]. The CANopen standard consists of an addressing scheme, several small communication protocols and an [[application layer]] defined by a device profile. The communication protocols have support for network management, device monitoring and communication between nodes, including a simple [[transport layer]] for message segmentation/desegmentation. The lower level protocol implementing the [[Data link layer|data link]] and [[physical layer]]s is usually [[Controller Area Network]] (CAN), although devices using some other means of communication (such as [[Ethernet Powerlink]], [[EtherCAT]]) can also implement the CANopen device profile. The basic CANopen device and communication profiles are given in the CAN in Automation (CiA) draft standard 301.{{ref|CiA301}} Profiles for more specialized devices are built on top of this basic profile, and are specified in numerous other standards released by CAN in Automation, such as CiA401{{ref|CiA401}} for I/O-modules and CiA402{{ref|CiA402}} for motion control. ==Device model== Every CANopen device has to implement certain standard features in its controlling software. * A '''Communication unit''' implements the protocols for messaging with the other nodes in the network * Starting and resetting the device is controlled via a [[Finite-state machine |state machine]]. It must contain the states Initialization, Pre-operational, Operational and Stopped. The transitions between states are made by issuing a network management (NMT) communication object to the device. * The '''object dictionary''' is an array of variables with a 16-bit index. Additionally, each variable can have an 8-bit subindex. The variables can be used to configure the device and reflect its environment, i.e. contain measurement data. * The '''application''' part of the device actually performs the desired function of the device, after the state machine is set to the operational state. The application is configured by variables in the object directory and the data is sent and received through the communication layer. ===Object dictionary=== CANopen devices must have an object dictionary, which is used for configuration and non-realtime communication with the device. An entry in the object dictionary is defined by: * '''Index''', the 16-bit address of the object in the dictionary * '''Object name''', a symbolic type of the object in the entry, such an array, record, or simple variable * '''Name''', a string describing the entry * '''Type''', gives the datatype of the variable * '''Attribute''', which gives information on the access rights for this entry, this can be read/write, read-only, write-only or read only constant * The '''Mandatory/Optional''' field defines whether a device conforming to the device specification has to implement this object or not The basic [[datatype]]s for object dictionary values such as booleans, integers and floats are defined in the standard, as well as composite datatypes such as arrays, records and strings. The composite datatypes can be subindexed with an 8-bit index. The value in subindex 0 of an array or record indicates the number of elements in the data structure, and is of type UNSIGNED8. For example, the device communication parameters, standardized in the basic device profile DS301{{ref|CiA301}} are mapped in the index range 0x1000 - 0x1FFF ("communication profile area"). The first few entries in this area are as follows: {| class="wikitable" |- ! Index ! Object name ! Name ! Type ! Attribute ! M/O |- | 0x1000 | VAR | device type | UNSIGNED32 | ro | M |- | 0x1001 | VAR | error register | UNSIGNED8 | ro | M |- | ... | | | | | |- | 0x1008 | VAR | manufacturer device name | Vis-String | const | O |- | ... | | | | | |} Given suitable tools, the object dictionary of a device can be configured by editing an electronic data sheet (EDS) file and uploading the variable values to the device. The format of the EDS-file according to CiA306{{ref|CiA306}} is [[INI file]], there is an upcoming XML-style format, that is described in CiA311{{ref|CiA311}}. ==Communication== ===Communication objects=== [[CANbus]], the physical layer of CANopen, can only transmit short packages consisting of an 11-bit id, remote transmission request (RTR) bit and a 0 to 8 bytes of data. The CANopen standard divides the 11-bit CAN frame id into a 4-bit function code and 7-bit CANopen node id. This limits the number of devices in a CANopen network to 127. An extension to the CANbus standard (CAN 2.0 B) allows extended frame ids of 29 bits, but in practice CANopen networks big enough to need the extended id range are rarely seen. In CANopen the 11-bit id of a CAN-frame is known as communication object identifier, or COB-ID. In case of a transmission collision, the bus arbitration used in the CANbus allows the frame with the smallest id to be transmitted first and without a delay. Since in CANopen frames the first 4 bits of the frame id are reserved to the function code, giving a low code number for time critical functions ensures the lowest possible delay. Contents of a standard CANopen frame: {| class="wikitable" |- ! ! Function code ! Node ID ! RTR ! Data length ! Data |- ! Length | 4 bits | 7 bits | 1 bit | 4 bits | 0-8 bytes |} The standard reserves certain COB-IDs to network management and SDO transfers. Some function codes and COB-IDs have to be mapped to standard functionality after device initialization, but can be configured for other uses later. ===Communication models=== Different kinds of communication models are used in the messaging between CANopen nodes. In a '''master/slave''' relationship, one CANopen node is designated as the master, which sends or requests data from the slaves. The NMT protocol is an example of a master/slave communication model. A '''client/server''' relationship is implemented in the SDO protocol, where the SDO client sends data (the object directory index and subindex) to an SDO server, which replies with one or more SDO packages containing the requested data (the contents of the object directory at the given index). A '''producer/consumer''' model is used in the Heartbeat and Node Guarding protocols. In the ''push-model'' of producer/consumer, the producer sends data to the consumer without a specific request, whereas in the ''pull model'', the consumer has to request the data from the producer. ===Protocols=== ====Network management (NMT) protocols==== The NMT protocols are used to issue state machine change commands (ie. to start and stop the devices), detect remote device bootups and error conditions. The '''Module control protocol''' is used by the NMT master to change the state of the devices. The CAN-frame COB-ID of this protocol is always 0, meaning that it has a function code 0 and node id 0, which means that every node in the network will process this message. The actual node id, to which the command is meant to, is given in the data part of the message. This can also be 0, meaning that all the devices in the bus should go to the indicated state. The '''Heartbeat protocol''' is used to monitor the nodes in the network and verify that they are alive. A heartbeat producer (usually a slave device) periodically sends a message with binary function code of 1110 and its node id (COB ID = 0x700 + node id). The data part of the frame contains a byte indicating the node status. The heartbeat consumer reads these messages. If the messages fail to arrive within a certain time limit (defined in the object directory of the devices) the consumer can take action to, for example, reset the device or indicate an error. Frame format is : COBID + DATA(status of node) CANopen devices are required to make the transition from the state Initializing to Pre-operational automatically during bootup. When this transition is made, a single heartbeat message is sent to the bus. This is the '''bootup protocol'''. A response/reply-style (pull model) protocol for slave monitoring called Node guarding protocol exists. ====Service Data Object (SDO) protocol==== The SDO protocol is used to set and read values from the object directory of a remote device. The device whose object directory is accessed is the SDO server and the device accessing the remote device is the SDO client. The communication is always initiated by the SDO client. In CANopen terminology, communication is viewed from the SDO server, so that a read from an object directory results in an SDO upload and a write to directory is an SDO download. <small>(see talk page for "upload/download" ambiguity)</small> As the object directory values can be larger than the 8 byte limit of a CAN frame, the SDO protocol implements segmentation and desegmentation of longer messages. Actually, there are two of these protocols: SDO download/upload and SDO Block download/upload. The SDO block transfer is a newer addition to standard, which allows large amounts of data to be transferred with slightly less protocol overhead. The COB IDs of the respective SDO transfer messages from client to server and server to client can be set in the object directory. Up to 127 SDO servers can be set up in the object directory addresses 0x1200 - 0x127F. Similarly, the SDO client connections of the device can be configured with variables at 0x1280 - 0x12FF. However the ''pre-defined connection set'' defines an SDO channel which can be used even just after bootup (in the Pre-operational state) to configure the device. The COB IDs of this channel are 0x600 + node id for receiving and 0x580 + node id for transmitting. To initiate a download, the SDO client sends the following data in a CAN message with the 'receive' COB ID of the SDO channel: {| class="wikitable" |- ! 3 bits ! 1 bit ! 2 bits ! 1 bit ! 1 bit ! 2 bytes ! 1 byte ! 4 bytes |- | ccs=1 | reserved(=0) | n | e | s | index | subindex | data |} * '''ccs''' is the client command specifier of the SDO transfer, this is 0 for SDO segment download, 1 for initiating download, 2 for initiating upload, 3 for SDO segment upload and 4 for aborting an SDO transfer * '''n''' is the number of bytes in the data part of the message which do not contain data, only valid if e and s are set * '''e''', if set, indicates an expedited transfer , i.e. all data exchanged are contained within the message. If this bit is cleared then the message is a segmented transfer where the data does not fit into one message and multiple messages are used. * '''s''', if set, indicates that the data size is specified in n (if e is set) or in the data part of the message * '''index''' is the object directory index of the data to be accessed * '''subindex''' is the subindex of the object directory variable * '''data''' contains the data to be uploaded in the case of an expedited transfer (e is set), or the size of the data to be uploaded (s is set, e is not set) ====Process Data Object (PDO) protocol==== Process Data Object protocol is used to process real time data among various nodes. You can transfer up to 8 bytes (64bits) data per one PDO either from or to the device. One PDO can contain multiple object dictionary entries and the objects within one PDO is configurable using the mapping and parameter object dictionary entries. There are two kinds of PDOs: transmit and receive PDOs (TPDO and RPDO). The former is for data coming from the device and the latter is for data going to the device, ie. with RPDO you can send data to the device and with TPDO you can read data from the device. In the pre-defined connection set there are identifiers for four (4) TPDOs and four (4) RPDOs available. With configuration 512 PDOs are possible. PDOs can be sent synchronously or asynchronously. Synchronous PDOs are sent after the SYNC message whereas asynchronous messages are sent after internal or external trigger. For example, you can make a request to a device to transmit TPDO that contains data you need by sending empty TPDO with RTR flag (if the device is configured to accept TPDO requests). With RPDOs you can, for example, start two devices simultaneously. You only need to map the same RPDO into two or more different device and make sure those RPDOs are mapped with the same COB ID. ====Synchronization Object (SYNC) protocol==== The Sync-Producer provides the synchronization-signal for the Sync-Consumer. When the Sync-Consumer receive the signal they start carrying out their synchronous tasks. In general the fixing of the transmission time of synchronous PDO messages coupled with the periodicity of transmission of the Sync Object guarantees that sensor devices may arrange to sample process variables and that actuator devices may apply their actuation in a coordinated fashion. The identifier of the Sync Object is available at index 1005h. ====Time Stamp Object (TIME) protocol==== Usually the Time-Stamp object represents an absolute time in ms after midnight and the number of days since January 1, 1984. This is a bit sequence of length 48 (6 byte). Some time critical applications especially in large networks with reduced transmission rates require very accurate synchronization; it may be necessary to synchronize the local clocks with an accuracy in the order of microseconds. This is achieved by using the optional high resolution synchronization protocol which employs a special form of time stamp message to adjust the inevitable drift of the local clocks. The high-resolution time-stamp is encoded as unsigned32 with a resolution of 1 microsecond which means that the time counter restarts every 72 minutes. It is configured by mapping the high resolution time-stamp (object 1013h) into a PDO. ====Emergency Object (EMCY) protocol==== Emergency messages are triggered by the occurrence of a device internal fatal error situation and are transmitted from the concerned application device to the other devices with high priority. This makes them suitable for interrupt type error alerts. An Emergency Telegram may be sent only once per ‘error event’, i.e. the emergency messages must not be repeated. As long as no new errors occur on a device no further emergency message must be sent. By means of CANopen Communication Profile defined emergency error codes, the error register and device specific additional information are specified in the device profiles. ===Initialization=== Sample trace of communications between a master and 2 pressure transducer slaves configured for id 1 and node id 2. {| class="wikitable" |- ! CAN ID ! DATA LENGTH ! DATA ! Description |- | 0x0 | 2 | 1 0 | Master puts bus into operational mode |- | 0x80 | 0 | | Master sends a SYNC message, which triggers devices to send data |- | 0x181 | 4 | CD 82 01 00 | Node at ID 1 (CID-0x180), reading pressure of 0x0182CD(99021) [[pascal (unit)|pascals]] |- | 0x182 | 4 | E5 83 01 00 | Node at ID 2 (CID-0x181), reading pressure of 0x0183E5(99301) pascals |} ==Electronic Device Description== The EDS file is a file format, defined in CiA306, that describes the communication behaviour and the object dictionary entries of a device. This allows tools such as service tools, configuration tools, development tools, and others to handle the devices properly. Those EDS files are mandatory for passing the CiA CANopen Conformance Test. A free EDS checker is [https://canopen-forum.com/ CANchkEDS]. Since end of 2007 a new [[XML]] based format called XDD is defined in CiA311. XDD is conformant to [[ISO]] Standard 15745. For both formats a free editor is available, called CANeds. This and an open platform for discussion and support is available at [https://canopen-forum.com/ https://canopen-forum.com/]. ==Glossary of CANopen Terms== PDO Process Data Object - Inputs and outputs. Values of type RPM, V, Hz, mAmps etc.<br /> SDO Service Data Object - Configuration settings, possibly NODE ID, baud rate, offset, gain etc.<br /> COB-ID - CAN Object Identifiers<br /> CAN ID - CAN Identifier. This is the 11 bit CAN message identifier which is at the beginning of every CAN message on the bus.<br /> EDS - Electronic data sheet. This is an INI style resp. XML style formatted file.<br /> DCF - Device configuration file. This is modified EDS with settings for node ID and baud rate. ==See also== * [[Controller area network]] Article on the CANBUS. ==References== #{{Note|CiA301}} CiA Draft Standard 301, available from [http://www.can-cia.org CAN in Automation] #{{Note|CiA306}} CiA Draft Standard 306 #{{Note|CiA311}} CiA Draft Standard 311 #{{Note|CiA401}} CiA Draft Standard 401 #{{Note|CiA402}} CiA Draft Standard 402 <!-- How to add a footnote: NOTE: Footnotes in this article use names, not numbers. Please see [[Wikipedia:Footnotes]] for details. 1) Assign your footnote a unique name, for example TheSun_Dec9. 2) Add the macro {{ref|TheSun_Dec9}} to the body of the article, where you want the new footnote. 3) Take note of the name of the footnote that immediately precedes yours in the article body. 4) Add #{{Note|TheSun_Dec9}} to the list, immediately below the footnote you noted in step 3. No need to re-number anything! 5) Multiple footnotes to the same reference: see [[Wikipedia:Footnotes]] for a how-to. NOTE: It is important to add footnotes in the right order in the list! --> ==External links== *[http://www.canopensolutions.com/english/about_canopen/about_canopen.shtml About CANopen (canopensolutions.com)] *[http://www.canfestival.org/ CanFestival - An open source CANopen multiplatform framework] *[http://www.industrialcontroldesignline.com/showArticle.jhtml?articleID=192200423 CANopen: An Introduction] *[http://www.can-cia.org/index.php?id=171 CANopen overview] *[http://www.cannewsletter.com CANnewsletter-Information on CAN, CANopen and J1939] *[http://www.softing.com/home/en/industrial-automation/products/can-bus/more-can-open/communication/reference-model.php CANopen educational pages] *[http://www.can-wiki.info/CanOpen CANopen-Page in the CAN-wiki] *[http://www.esacademy.com/myacademy/classes/CANopenIntro/CANopenIntro_files/frame.htm?category=& CANopen Introduction] *[http://www.canopen-solutions.com/canopen_fundamentals_en.html Introduction to CANopen Fundamentals (in www.canopen-solutions.com)] *[http://en.canopen-lift.org/ Wiki of the CANopen-Lift Community] *[https://canopen-forum.com/ Open discussion platform for questions around EDS and XDD] *[http://www.thaiio.com/CANinfo.html CAN Informations for industry] [[Category:Network protocols]] [[Category:Automation]] [[ca:CANopen]] [[de:CANopen]] [[fr:CANopen]] [[it:CANopen]] [[ja:CANopen]] [[ru:CANopen]] [[zh:CANopen]]'