ads-client | Beckhoff TwinCAT ADS client library for Node.js
    Preparing search index...

    Interface AdsSymbol

    ADS symbol object

    interface AdsSymbol {
        adsDataType: number;
        adsDataTypeStr: string;
        arrayDimension: number;
        arrayInfo: AdsArrayInfoEntry[];
        attributes: AdsAttributeEntry[];
        comment: string;
        extendedFlags: number;
        flags: number;
        flagsStr: string[];
        indexGroup: number;
        indexOffset: number;
        name: string;
        reserved: Buffer;
        size: number;
        type: string;
        typeGuid: string;
    }
    Index

    Properties

    adsDataType adsDataTypeStr arrayDimension arrayInfo attributes comment extendedFlags flags flagsStr indexGroup indexOffset name reserved size type typeGuid

    Properties

    adsDataType: number

    ADS data type as number (see ADS.ADS_DATA_TYPES)

    adsDataTypeStr: string

    ADS data type as string (see ADS.ADS_DATA_TYPES)

    arrayDimension: number

    If symbol is an array, its array dimension

    arrayInfo: AdsArrayInfoEntry[]

    If symbol is an array, information of each array dimension

    attributes: AdsAttributeEntry[]

    Symbol attributes, such as pragmas

    comment: string

    Symbol comment (variable comment in the PLC code)

    extendedFlags: number
    flags: number

    Symbol flags as bit-notation (see ADS.ADS_SYMBOL_FLAGS)

    flagsStr: string[]

    Symbol flags as string array (see ADS.ADS_SYMBOL_FLAGS)

    indexGroup: number

    Symbol address indexGroup

    indexOffset: number

    Symbol address indexOffset

    name: string

    Symbol name (variable path)

    reserved: Buffer

    Rest bytes in the end of data that have no meaning yet

    size: number

    Symbol size (bytes)

    type: string

    Symbol data type

    typeGuid: string

    GUID of the symbol

    Settings

    On This Page

    Properties