Skip to content

Latest commit

 

History

History
198 lines (158 loc) · 9 KB

README.md

File metadata and controls

198 lines (158 loc) · 9 KB
Raw

node-canopen

CANopen is the internationally standardized (EN 50325-4) CAN-based higher-layer protocol for embedded control system. More information on CANopen can be found on the CiA site

This library allows the manipulation of CANopen devices as defined in CiA 301.

Porting Guide (Version 5 -> 6)

When updating from version 5 to version 6 be aware of the following changes:

  1. Modifying the Eds via the protocol modules has been deprecated and the preferred method is to use the new dedicated methods in the Eds class itself. This change was made to allow configuration without needing to create a Device object first. The following table is non-exhaustive and serves only to illustrate the change:
Old method New method
device.emcy.cobId = 0x8A device.eds.setEmcyCobId(0x8A)
device.nmt.producerTime = 500 device.eds.setHeartbeatProducerTime(500)
device.sdo.addServer(0x8B) device.eds.addSdoClientParameter(0x8B)
device.sync.generate = true device.eds.setSyncGenerationEnable(true)

  1. NMT state now matters. Prior to version 6 the NMT state was available, but not used internally. The Device object is now aware of the NMT state and will bring up and shutdown protocol objects as the state changes. If your PDOs are not firing after the update make sure you are calling Nmt#startNode to switch to NmtState.OPERATIONAL. This new behavior should only take effect upon calling Device#start().

  2. Events have been refactored and moved to their respective protocol modules. Old events are still available, but will only fire if the Device#init() method has been called.

  3. The internal Eds array of DataObjects is now keyed from the hex index rather than the decimal index to make debug printing less confusing. A getter with the old indexing is provided so that iterating directly on Eds.dataObjects will still work as expected, however you should switch to using the new iterator methods (Eds.values(), Eds.entries(), Eds.keys()).

  4. SDO client/server parameters will no longer assume you want to add the node ID if you choose 0x580/0x600 for the SDO COB-IDs. As far as I can tell this is not officially in the standard, but was a convienence added to some other libraries.

Documentation

Pre-built documentation for the latest release is available here.

Examples for each protocol are also available in the examples folder.

Device

The Device class represents a CANopen device and provides context for the protocol objects as well as access methods for the manufacturer data fields. It contains the Eds and protocol objects.

OD Entry Description Supported
0x1000 Device type ❌
0x1002 Manufacturer status register ✔️
0x1008 Manufacturer device name ✔️
0x1009 Manufacturer hardware version ✔️
0x100A Manufacturer software version ✔️
0x1010 Store parameters ❌
0x1011 Restore default parameters ❌

Eds

The Eds class represents a CANopen electronic datasheet file and can be used to load and save the eds file format as defined in CiA 306. Device configuration files (DCF) are not currently supported.

Eds provides setters for many of the communication profile objects that are defined in CiA 301. Most of the protocol objects require one or more entries in the Eds before they can function. Typically the user will want to create or set those entries before calling Device.start().

Protocols

Emergency - EMCY

The CANopen emergency protocol is used to indicate internal errors with a CANopen device. Call Emcy.write() to produce an emergency object. If a valid 'Emergency consumer object entry' is present, the Emcy module will emit event:emergency when the matching COB-ID is consumed.

OD Entry Description Supported
0x1001 Error register ✔️
0x1003 Pre-defined error field ✔️
0x1014 COB_ID EMCY ✔️
0x1015 Inhibit time EMCY ✔️
0x1028 Emergency consumer object ✔️
0x1029 Error behavior object ❌

Layer Setting Services - LSS

The CANopen layer setting services protocol allows the CAN-ID and bitrate of an LSS consumer device to be modified. This allows for setting up a network of identical devices without relying on physical dip switches or non-volatile storage to distinguish between them.

OD Entry Description Supported
0x1018 Identity object ✔️

Supported Features:

  • LSS producer ✔️
  • LSS consumer ✔️

Network Management - NMT

The CANopen network management protocol is used to manipulate the state of NMT consumer devices on the network and is responsible for the device heartbeat. Heartbeat generation will begin automatically when 'Producer heartbeat time' is set. If a 'Consumer heartbeat time' entry is present, then the Nmt module will emit event:timeout if the consumer heartbeat is lost.

OD Entry Description Supported
0x100C Guard time ❌
0x100D Life time factor ❌
0x1016 Consumer heartbeat time ✔️
0x1017 Producer heartbeat time ✔️

Supported Features:

  • Remote state changes ✔️
  • Heartbeat
    • Generation ✔️
    • Monitoring ✔️
  • Command processing
    • State changes ✔️
    • Reset node ✔️
    • Reset communications ✔️

Process Data Object - PDO

The CANopen process data object protocol is used for broadcasting data changes with minimal overhead, similar to a more traditional CAN network architecture. A mapped TPDO can be sent with the Pdo.write() method. Event driven TPDOs will be sent automatically when the device is in NmtState.OPERATIONAL. The Pdo module will emit event:pdo when a mapped RPDO is consumed.

OD Entry Description Supported
0x1400 - 0x15FF RPDO communication parameter ✔️
0x1600 - 0x17FF RPDO mapping parameter ✔️
0x1800 - 0x19FF TPDO communication parameter ✔️
0x1A00 - 0x1BFF TPDO mapping parameter ✔️

Service Data Object - SDO

The CANopen service data object protocol provides direct access to a device's object dictionary. Call the SdoClient.upload() or SdoClient.download() methods to initate a transfer.

OD Entry Description Supported
0x1200 - 0x127F SDO server parameter ✔️
0x1280 - 0x12FF SDO client parameter ✔️

Synchronization - SYNC

The CANopen sync protocol is used to synchronize actions between devices on the network. If enabled, Sync message generation will begin automatically when Device.start() is called. Sync will emit event:sync when a Sync object is consumed.

OD Entry Description Supported
0x1005 COB-ID SYNC ✔️
0x1006 Communication cycle period ✔️
0x1007 Sync window length ❌
0x1019 Sync counter overflow value ✔️

Time stamp - TIME

The CANopen time protocol is used to provide a simple network clock. Call Time.write() to produce a time stamp object. Time will emit event:time when a time stamp object is consumed.

OD Entry Description Supported
0x1012 COB-ID TIME ✔️
0x1013 High resolution time stamp ❌