Interface ParameterEsiExtension

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.

Hierarchy

Properties

bitSize?: number

Size of the parameter in bits.

canBeMappedAsRxPdo?: boolean

Indicates if the parameter can be mapped as an RxPDO.

canBeMappedAsTxPdo?: boolean

Indicates if the parameter can be mapped as a TxPDO.

defaultData?: number

Default numeric value for the parameter, if defined.

description?: string

Human-readable description of the parameter or subitem.

esiType?: string

Raw ESI data type string (e.g., "UINT16", "STRING(50)").

group?: null | string

Group or category name for the parameter.

inputType?: ParameterInputType

Suggested HTML form input type for the parameter.

isSmm?: boolean

Flag indicating if the parameter belongs to an SMM module.

mandatory?: boolean

Indicates if the parameter is mandatory (true) or optional (false/undefined).

max?: null | number

Maximum allowed numeric value for the parameter, if applicable.

min?: null | number

Minimum allowed numeric value for the parameter, if applicable.

options?: Record<string, any>

Parsed options for enumerated parameter values, if available.

originalOptions?: Record<string, any>

Original options preserved for reference or restoration.

originalUnit?: string

Original unit value preserved for reference or restoration.

recordDescription?: string

Description specifically for record data types, if applicable.

strlen?: number

Maximum length allowed for STRING type parameters, adjusted to accommodate firmware-specific constraints.

typeValue?: "intValue" | "uintValue" | "floatValue" | "stringValue" | "rawValue"

Optional type value string representing the parameter data type.

typeValueKey?: "intValue" | "uintValue" | "floatValue" | "stringValue" | "rawValue"

Optional type value key string, prioritizing typeValueKey over typeValue.

unit?: null | string

Unit symbol associated with the parameter (empty string if none).

Generated using TypeDoc