Eds

Members

baudRates :Array.<number>

Description:

• Supported baud rates.

Source:

• eds.js, line 977

Type:

• Array.<number>

createdBy :string

Description:

• Name or description of the file creator (max 245 characters).

Source:

• eds.js, line 848

Type:

• string

creationDate :Date

Description:

• File creation time.

Source:

• eds.js, line 823

Type:

• Date

dataObjects :object

Description:

• Constructs and returns the Eds DataObjects keyed by decimal string. This is provided to support old tools. For new code use the new Eds iterator methods (keyed by hex string) instead.

Source:

• eds.js, line 754

Deprecated:

• Use Eds#entries instead.

Type:

• object

description :string

Description:

• File description.

Source:

• eds.js, line 810

Type:

• string

dynamicChannelsSupported :boolean

Description:

• Indicates the facility of dynamic variable generation (not supported).

Source:

• eds.js, line 1057

See:

• CiA302

Type:

• boolean

fileName :string

Description:

• File name.

Source:

• eds.js, line 771

Type:

• string

fileRevision :number

Description:

• File revision (8-bit unsigned integer).

Source:

• eds.js, line 797

Type:

• number

fileVersion :number

Description:

• File version (8-bit unsigned integer).

Source:

• eds.js, line 784

Type:

• number

granularity :number

Description:

• Provides the granularity allowed for the mapping on this device - most devices support a granularity of 8. (8-bit integer, max 64).

Source:

• eds.js, line 1043

Type:

• number

groupMessaging :boolean

Description:

• Indicates the facility of multiplexed PDOs (not supported).

Source:

• eds.js, line 1071

See:

• CiA301

Type:

• boolean

lssSupported :boolean

Description:

• Indicates if LSS functionality is supported.

Source:

• eds.js, line 1116

Type:

• boolean

modificationDate :Date

Description:

• Time of the last modification.

Source:

• eds.js, line 861

Type:

• Date

modifiedBy :string

Description:

• Name or description of the last modifier (max 244 characters).

Source:

• eds.js, line 886

Type:

• string

nrOfRXPDO :number

Description:

• The number of supported receive PDOs (16-bit unsigned integer).

Source:

• eds.js, line 1084

Type:

• number

nrOfTXPDO :number

Description:

• The number of supported transmit PDOs (16-bit unsigned integer).

Source:

• eds.js, line 1100

Type:

• number

orderCode :string

Description:

• Product order code (max 245 characters).

Source:

• eds.js, line 964

Type:

• string

productName :string

Description:

• Product name (max 243 characters).

Source:

• eds.js, line 925

Type:

• string

productNumber :number

Description:

• Product code (32-bit unsigned integer).

Source:

• eds.js, line 938

Type:

• number

revisionNumber :number

Description:

• Revision number (32-bit unsigned integer).

Source:

• eds.js, line 951

Type:

• number

simpleBootUpMaster :boolean

Description:

• Indicates simple boot-up master functionality (not supported).

Source:

• eds.js, line 1016

Type:

• boolean

simpleBootUpSlave :boolean

Description:

• Indicates simple boot-up slave functionality (not supported).

Source:

• eds.js, line 1029

Type:

• boolean

vendorName :string

Description:

• Vendor name (max 244 characters).

Source:

• eds.js, line 899

Type:

• string

vendorNumber :number

Description:

• Unique vendor ID (32-bit unsigned integer).

Source:

• eds.js, line 912

Type:

• number

Methods

(static) fromFile(path) → {Eds}

Description:

• Create a new Eds from a file path.

Source:

• eds.js, line 1142

Since:

• 6.0.0

Parameters:

Returns:

Type

Eds

(static) isEds(obj) → {boolean}

Description:

• Returns true if the object is an instance of Eds.

Source:

• eds.js, line 1131

Since:

• 6.0.0

Parameters:

Returns:

Type

boolean

addEmcyConsumer(cobId, optionsopt)

Description:

• Add an entry to object 0x1028 - Emergency consumer object.

  • bit 0..11 - CAN-ID.
  • bit 16..23 - Reserved (0x00).
  • bit 31 - 0 = valid, 1 = invalid.

Source:

• eds.js, line 2566

Since:

• 6.0.0

Parameters:

addEntry(index, data) → {DataObject}

Description:

• Create a new entry.

Source:

• eds.js, line 1360

Parameters:

Fires:

• Eds#event:newEntry

Returns:

Type

DataObject

addHeartbeatConsumer(deviceId, timeout, optionsopt)

Description:

• Add an entry to object 0x1016 - Consumer heartbeat time.

  • bit 0..15 - Heartbeat time in ms.
  • bit 16..23 - Node-ID of producer.
  • bit 24..31 - Reserved (0x00);

Source:

• eds.js, line 2272

Since:

• 6.0.0

Parameters:

addReceivePdo(pdo, options)

Description:

• Create a RPDO communication/mapping parameter object.

  Object 0x1400..0x15FF - RPDO communication parameter

  Sub-index 1 (mandatory):

  • bit 0..10 - CAN base frame.
  • bit 11..28 - CAN extended frame.
  • bit 29 - Frame type.
  • bit 30 - RTR allowed.
  • bit 31 - RPDO valid.

  Sub-index 2 (mandatory):

  • bit 0..7 - Transmission type.

  Sub-index 3 (optional):

  • bit 0..15 - Inhibit time.

  Object 0x1600..0x17FF - RPDO mapping parameter

  • bit 0..7 - Bit length.
  • bit 8..15 - Sub-index.
  • bit 16..31 - Index.

  Inhibit time and synchronous RPDOs are not yet supported. All entries are treated as event-driven with an inhibit time of 0.

Source:

• eds.js, line 2993

Since:

• 6.0.0

Parameters:

addSdoClientParameter(deviceId, cobIdTx, cobIdRx, optionsopt)

Description:

• Add an SDO client parameter object.

  Object 0x1280..0x12FF - SDO client parameter.

  Sub-index 1/2:

  • bit 0..10 - CAN base frame.
  • bit 11..28 - CAN extended frame.
  • bit 29 - Frame type (base or extended).
  • bit 30 - Dynamically allocated.
  • bit 31 - SDO exists / is valid.

  Sub-index 3:

  • bit 0..7 - Node-ID of the SDO server.

Source:

• eds.js, line 2835

Since:

• 6.0.0

Parameters:

addSdoServerParameter(deviceId, cobIdTx, cobIdRx, optionsopt)

Description:

• Add an SDO server parameter object.

  Object 0x1200..0x127F - SDO server parameter.

  Sub-index 1/2:

  • bit 0..10 - CAN base frame.
  • bit 11..28 - CAN extended frame.
  • bit 29 - Frame type (base or extended).
  • bit 30 - Dynamically allocated.
  • bit 31 - SDO exists / is valid.

  Sub-index 3 (optional):

  • bit 0..7 - Node-ID of the SDO client.

Source:

• eds.js, line 2689

Since:

• 6.0.0

Parameters:

addSubEntry(index, subIndex, data) → {DataObject}

Description:

• Create a new sub-entry.

Source:

• eds.js, line 1448

Parameters:

Returns:

Type

DataObject

addTransmitPdo(pdo, options)

Description:

• Create a TPDO communication/mapping parameter object.

  Object 0x1800..0x19FF - TPDO communication parameter

  Sub-index 1 (mandatory):

  • bit 0..10 - CAN base frame.
  • bit 11..28 - CAN extended frame.
  • bit 29 - Frame type.
  • bit 30 - RTR allowed.
  • bit 31 - TPDO valid.

  Sub-index 2 (mandatory):

  • bit 0..7 - Transmission type.

  Sub-index 3 (optional):

  • bit 0..15 - Inhibit time.

  Sub-index 5 (optional):

  • bit 0..15 - Event timer value.

  Sub-index 6 (optional):

  • bit 0..7 - SYNC start value.

  Object 0x2000..0x21FF - TPDO mapping parameter

  • bit 0..7 - Bit length.
  • bit 8..15 - Sub-index.
  • bit 16..31 - Index.

Source:

• eds.js, line 3229

Since:

• 6.0.0

Parameters:

entries() → {Iterable.<Array>}

Description:

• Returns a new iterator object that iterates key/DataObjects pairs.

Source:

• eds.js, line 1296

Since:

• 6.0.0

Returns:

Type

Iterable.<Array>

findEntry(name) → {Array.<DataObject>}

Description:

• Get a data object by name.

Source:

• eds.js, line 1319

Since:

• 6.0.0

Parameters:

Returns:

Type

Array.<DataObject>

getDeviceName() → {string}

Description:

• Get object 0x1008 - Manufacturer device name.

Source:

• eds.js, line 1867

Since:

• 6.0.0

Returns:

Type

string

getEmcyCobId() → {number}

Description:

• Get object 0x1014 - COB-ID EMCY.

Source:

• eds.js, line 2113

Since:

• 6.0.0

Returns:

Type

number

getEmcyConsumers() → {Array.<number>}

Description:

• Get object 0x1028 - Emergency consumer object.

Source:

• eds.js, line 2533

Since:

• 6.0.0

Returns:

Type

Array.<number>

getEmcyInhibitTime() → {number}

Description:

• Get object 0x1015 - Inhibit time EMCY.

Source:

• eds.js, line 2198

Since:

• 6.0.0

Returns:

Type

number

getEmcyValid() → {boolean}

Description:

• Get object 0x1014 [bit 31] - EMCY valid.

Source:

• eds.js, line 2154

Since:

• 6.0.0

Returns:

Type

boolean

getEntry(index) → {DataObject|null}

Description:

• Get a data object by index.

Source:

• eds.js, line 1333

Parameters:

Returns:

Type

DataObject | null

getErrorHistory() → {Array.<object>}

Description:

• Get object 0x1003 - Pre-defined error field.

Source:

• eds.js, line 1636

Since:

• 6.0.0

Returns:

Type

Array.<object>

getErrorRegister() → {number}

Description:

• Get object 0x1001 - Error register.

Source:

• eds.js, line 1494

Since:

• 6.0.0

Returns:

Type

number

getHardwareVersion() → {string}

Description:

• Get object 0x1009 - Manufacturer hardware version.

Source:

• eds.js, line 1905

Since:

• 6.0.0

Returns:

Type

string

getHeartbeatConsumers() → {Array.<object>}

Description:

• Get object 0x1016 - Consumer heartbeat time.

Source:

• eds.js, line 2236

Since:

• 6.0.0

Returns:

Type

Array.<object>

getHeartbeatProducerTime() → {number}

Description:

• Get object 0x1017 - Producer heartbeat time.

Source:

• eds.js, line 2354

Since:

• 6.0.0

Returns:

Type

number

getIdentity() → {object|null}

Description:

• Get object 0x1018 - Identity object.

Source:

• eds.js, line 2394

Since:

• 6.0.0

Returns:

Type

object | null

getReceivePdos() → {Array.<object>}

Description:

• Get RPDO communication/mapping parameters.

Source:

• eds.js, line 2935

Since:

• 6.0.0

Returns:

Type

Array.<object>

getSdoClientParameters() → {Array.<object>}

Description:

• Get SDO client parameters.

Source:

• eds.js, line 2789

Since:

• 6.0.0

Returns:

Type

Array.<object>

getSdoServerParameters() → {Array.<object>}

Description:

• Get SDO server parameters.

Source:

• eds.js, line 2643

Since:

• 6.0.0

Returns:

Type

Array.<object>

getSoftwareVersion() → {string}

Description:

• Get object 0x100A - Manufacturer software version.

Source:

• eds.js, line 1943

Since:

• 6.0.0

Returns:

Type

string

getStatusRegister() → {number}

Description:

• Get object 0x1002 - Manufacturer status register.

Source:

• eds.js, line 1598

Since:

• 6.0.0

Returns:

Type

number

getSubEntry(index, subIndex) → {DataObject|null}

Description:

• Get a sub-entry.

Source:

• eds.js, line 1426

Parameters:

Returns:

Type

DataObject | null

getSyncCobId() → {number}

Description:

• Get object 0x1005 - COB-ID SYNC.

Source:

• eds.js, line 1738

Since:

• 6.0.0

Returns:

Type

number

getSyncCyclePeriod() → {number}

Description:

• Get object 0x1006 - Communication cycle period.

Source:

• eds.js, line 1826

Since:

• 6.0.0

Returns:

Type

number

getSyncGenerationEnable() → {boolean}

Description:

• Get object 0x1005 [bit 30] - Sync generation enable.

Source:

• eds.js, line 1782

Since:

• 6.0.0

Returns:

Type

boolean

getSyncOverflow() → {number}

Description:

• Get object 0x1019 - Synchronous counter overflow value.

Source:

• eds.js, line 2492

Since:

• 6.0.0

Returns:

Type

number

getTimeCobId() → {number}

Description:

• Get object 0x1012 - COB-ID TIME.

Source:

• eds.js, line 1981

Since:

• 6.0.0

Returns:

Type

number

getTimeConsumerEnable() → {boolean}

Description:

• Get object 0x1012 [bit 31] - Time consumer enable.

Source:

• eds.js, line 2069

Since:

• 6.0.0

Returns:

Type

boolean

getTimeProducerEnable() → {boolean}

Description:

• Get object 0x1012 [bit 30] - Time producer enable.

Source:

• eds.js, line 2025

Since:

• 6.0.0

Returns:

Type

boolean

getTransmitPdos() → {Array.<object>}

Description:

• Get TPDO communication/mapping parameters.

Source:

• eds.js, line 3169

Since:

• 6.0.0

Returns:

Type

Array.<object>

keys() → {Iterable.<string>}

Description:

• Returns a new iterator object that iterates the keys for each entry.

Source:

• eds.js, line 1276

Since:

• 6.0.0

Returns:

Type

Iterable.<string>

load(path)

Description:

• Read and parse an EDS file.

Source:

• eds.js, line 1153

Parameters:

pushErrorHistory(code, info)

Description:

• Push an entry to object 0x1003 - Pre-defined error field.

  • bit 0..15 - Error code.
  • bit 16..31 - Additional info.

Source:

• eds.js, line 1665

Since:

• 6.0.0

Parameters:

removeEmcyConsumer(cobId)

Description:

• Remove an entry from object 0x1028 - Emergency consumer object.

Source:

• eds.js, line 2617

Since:

• 6.0.0

Parameters:

removeEntry(index) → {DataObject}

Description:

• Delete an entry.

Source:

• eds.js, line 1395

Parameters:

Fires:

• Eds#event:removeEntry

Returns:

Type

DataObject

removeHeartbeatConsumer(deviceId)

Description:

• Remove an entry from object 0x1016 - Consumer heartbeat time.

Source:

• eds.js, line 2331

Since:

• 6.0.0

Parameters:

removeReceivePdo(cobId) → {object}

Description:

• Remove an RPDO communication/mapping parameter object.

Source:

• eds.js, line 3133

Since:

• 6.0.0

Parameters:

Returns:

Type

object

removeSdoClientParameter(deviceId)

Description:

• Remove an SDO client parameter object.

Source:

• eds.js, line 2902

Since:

• 6.0.0

Parameters:

removeSdoServerParameter(deviceId)

Description:

• Remove an SDO server parameter object.

Source:

• eds.js, line 2756

Since:

• 6.0.0

Parameters:

removeSubEntry(index, subIndex)

Description:

• Delete a sub-entry.

Source:

• eds.js, line 1468

Parameters:

removeTransmitPdo(cobId) → {object}

Description:

• Remove a TPDO communication/mapping parameter object.

Source:

• eds.js, line 3374

Since:

• 6.0.0

Parameters:

Returns:

Type

object

reset()

Description:

• Reset objects to their default values.

Source:

• eds.js, line 1305

Since:

• 6.0.0

save(path, optionsopt)

Description:

• Write an EDS file.

Source:

• eds.js, line 1201

Parameters:

setDeviceName(name, optionsopt)

Description:

• Set object 0x1008 - Manufacturer device name.

Source:

• eds.js, line 1883

Since:

• 6.0.0

Parameters:

setEmcyCobId(cobId, optionsopt)

Description:

• Set object 0x1014 - COB-ID EMCY.

Source:

• eds.js, line 2130

Since:

• 6.0.0

Parameters:

setEmcyInhibitTime(inhibitTime, optionsopt)

Description:

• Set object 0x1015 - Inhibit time EMCY.

Source:

• eds.js, line 2215

Since:

• 6.0.0

Parameters:

setEmcyValid(valid, optionsopt)

Description:

• Set object 0x1014 [bit 31] - EMCY valid.

Source:

• eds.js, line 2171

Since:

• 6.0.0

Parameters:

setErrorHistoryLength(length, optionsopt)

Description:

• Configures the length of 0x1003 - Pre-defined error field.

Source:

• eds.js, line 1704

Since:

• 6.0.0

Parameters:

setErrorRegister(flags)

Description:

• Set object 0x1001 - Error register.

  • bit 0 - Generic error.
  • bit 1 - Current.
  • bit 2 - Voltage.
  • bit 3 - Temperature.
  • bit 4 - Communication error.
  • bit 5 - Device profile specific.
  • bit 6 - Reserved (always 0).
  • bit 7 - Manufacturer specific.

Source:

• eds.js, line 1523

Since:

• 6.0.0

Parameters:

setHardwareVersion(version, optionsopt)

Description:

• Set object 0x1009 - Manufacturer hardware version.

Source:

• eds.js, line 1921

Since:

• 6.0.0

Parameters:

setHeartbeatProducerTime(producerTime, optionsopt)

Description:

• Set object 0x1017 - Producer heartbeat time.

  A value of zero disables the heartbeat.

Source:

• eds.js, line 2373

Since:

• 6.0.0

Parameters:

setIdentity(identity, optionsopt)

Description:

• Set object 0x1018 - Identity object.

  • sub-index 1 - Vendor id.
  • sub-index 2 - Product code.
  • sub-index 3 - Revision number.
  • sub-index 4 - Serial number.

Source:

• eds.js, line 2425

Since:

• 6.0.0

Parameters:

setSoftwareVersion(version, optionsopt)

Description:

• Set object 0x100A - Manufacturer software version.

Source:

• eds.js, line 1959

Since:

• 6.0.0

Parameters:

setStatusRegister(status, optionsopt)

Description:

• Set object 0x1002 - Manufacturer status register.

Source:

• eds.js, line 1614

Since:

• 6.0.0

Parameters:

setSyncCobId(cobId, optionsopt)

Description:

• Set object 0x1005 - COB-ID SYNC.

Source:

• eds.js, line 1755

Since:

• 6.0.0

Parameters:

setSyncCyclePeriod(cyclePeriod, optionsopt)

Description:

• Set object 0x1006 - Communication cycle period.

Source:

• eds.js, line 1843

Since:

• 6.0.0

Parameters:

setSyncGenerationEnable(enable, optionsopt)

Description:

• Set object 0x1005 [bit 30] - Sync generation enable.

Source:

• eds.js, line 1799

Since:

• 6.0.0

Parameters:

setSyncOverflow(overflow, optionsopt)

Description:

• Set object 0x1019 - Synchronous counter overflow value.

Source:

• eds.js, line 2509

Since:

• 6.0.0

Parameters:

setTimeCobId(cobId, optionsopt)

Description:

• Set object 0x1012 - COB-ID TIME.

Source:

• eds.js, line 1998

Since:

• 6.0.0

Parameters:

setTimeConsumerEnable(enable, optionsopt)

Description:

• Set object 0x1012 [bit 31] - Time consumer enable.

Source:

• eds.js, line 2086

Since:

• 6.0.0

Parameters:

setTimeProducerEnable(enable, optionsopt)

Description:

• Set object 0x1012 [bit 30] - Time producer enable.

Source:

• eds.js, line 2042

Since:

• 6.0.0

Parameters:

values() → {Iterable.<DataObject>}

Description:

• Returns a new iterator object that iterates DataObjects.

Source:

• eds.js, line 1286

Since:

• 6.0.0

Returns:

Type

Iterable.<DataObject>

Events

newEntry

Description:

• A DataObject was added to the Eds.

Source:

• eds.js, line 1370

Type:

• DataObject

newRpdo

Description:

• A new receive PDO was mapped.

Source:

• eds.js, line 3113

Since:

• 6.0.0

Type:

• object

newSdoClient

Description:

• A SDO server parameter object was added.

Source:

• eds.js, line 2741

Type:

• object

newSdoServer

Description:

• An SDO client parameter object was added.

Source:

• eds.js, line 2887

Type:

• object

newTpdo

Description:

• A transmit PDO was removed.

Source:

• eds.js, line 3147

Since:

• 6.0.0

Type:

• object

newTpdo

Description:

• A new transmit PDO was mapped.

Source:

• eds.js, line 3357

Since:

• 6.0.0

Type:

• object

newTpdo

Description:

• A transmit PDO was removed.

Source:

• eds.js, line 3388

Since:

• 6.0.0

Type:

• object

removeEntry

Description:

• A DataObject was removed from the Eds.

Source:

• eds.js, line 1408

Type:

• DataObject

removeSdoClient

Description:

• A SDO server parameter object was removed.

Source:

• eds.js, line 2766

Type:

• object

removeSdoServer

Description:

• An SDO client parameter object was removed.

Source:

• eds.js, line 2912

Type:

• object