Optional
bitSize of the parameter in bits.
Optional
canIndicates if the parameter can be mapped as an RxPDO.
Optional
canIndicates if the parameter can be mapped as a TxPDO.
Optional
defaultDefault numeric value for the parameter, if defined.
Optional
descriptionHuman-readable description of the parameter or subitem.
Optional
esiRaw ESI data type string (e.g., "UINT16", "STRING(50)").
Optional
groupGroup or category name for the parameter.
Optional
inputSuggested HTML form input type for the parameter.
Optional
isFlag indicating if the parameter belongs to an SMM module.
Optional
mandatoryIndicates if the parameter is mandatory (true) or optional (false/undefined).
Optional
maxMaximum allowed numeric value for the parameter, if applicable.
Optional
minMinimum allowed numeric value for the parameter, if applicable.
Optional
optionsParsed options for enumerated parameter values, if available.
Optional
originalOriginal options preserved for reference or restoration.
Optional
originalOriginal unit value preserved for reference or restoration.
Optional
recordDescription specifically for record data types, if applicable.
Optional
strlenMaximum length allowed for STRING type parameters, adjusted to accommodate firmware-specific constraints.
Optional
typeOptional type value string representing the parameter data type.
Optional
typeOptional type value key string, prioritizing typeValueKey over typeValue.
Optional
unitUnit symbol associated with the parameter (empty string if none).
Generated using TypeDoc
Extended information for a device parameter derived from the EtherCAT Slave Information (ESI) file.
This interface represents additional metadata and constraints extracted from the ESI file, which enhances the base device parameter description with validation, description, unit, mapping capabilities, and UI hints.