EthercatDevice_XXX.getObjectDescription()

[EthercatDevice_XXX]

Description

(CoE) Get the object list’s Description from EtherCAT Slave device to EtherCAT Master.

Format

int getObjectDescription(uint16_t od_index, uint16_t *datatype, uint8_t *max_od_subindex, uint8_t *objcode, char *objname, size_t objname_size, uint32_t *abortcode = NULL, uint32_t timeout_us = ECAT_DEFAULT_COE_TIMEOUT_US);

Syntax

EthercatDevice_XXX slave;
slave.getObjectDescription();

Parameters

• uint16_t od_index: CANOpen Object index.
• uint16_t *datatype: Object’s data type.
• uint8_t *max_od_subindex: The maximum CANOpen Object sub-index.
• uint8_t *objcode: Object code.
• char *objname: Buffer of the object’s name.
• size_t objname_size: Buffer length of the object’s name.
• uint32_t *abortcode: SDO abort code pointer.
• uint32_t timeout_us: Timeout, unit for microsecond.

Returns

Int: >=0 for Length of Object name; if the return value is smaller than 0 means error.

---

Libraries Reference Home

The text of the 86Duino reference is a modification of the Arduino reference and is licensed under a Creative Commons Attribution-ShareAlike 3.0 License. Code samples in the reference are released into the public domain.