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

    Variable BASE_DATA_TYPESConst

    BASE_DATA_TYPES: {
        find: (
            name: string,
        ) =>
            | {
                adsDataType: number;
                fromBuffer: (buffer: Buffer) => string;
                name: string[];
                size: number;
                toBuffer: (value: string, buffer: Buffer) => number;
            }
            | {
                adsDataType: number;
                fromBuffer: (buffer: Buffer) => boolean;
                name: string[];
                size: number;
                toBuffer: (value: number | boolean, buffer: Buffer) => number;
            }
            | {
                adsDataType: number;
                fromBuffer: (buffer: Buffer) => number;
                name: string[];
                size: number;
                toBuffer: (value: number, buffer: Buffer) => number;
            }
            | {
                adsDataType: number;
                fromBuffer: (buffer: Buffer, convertDates: boolean) => number | Date;
                name: string[];
                size: number;
                toBuffer: (value: number | Date, buffer: Buffer) => void;
            }
            | {
                adsDataType: number;
                fromBuffer: (buffer: Buffer) => bigint | Buffer<ArrayBufferLike>;
                name: string[];
                size: number;
                toBuffer: (
                    value: number | Buffer<ArrayBufferLike> | BigInt,
                    buffer: Buffer,
                ) => void;
            }
            | null;
        findPseudoType: (
            name: string,
        ) =>
            | { actualTypesBySize: { [k: number]: string }; name: string[] }
            | undefined;
        fromBuffer: (
            name: string,
            buffer: Buffer,
            convertDates: boolean,
        ) => string | number | bigint | boolean | Buffer<ArrayBufferLike> | Date;
        getTypeByPseudoType: (name: string, byteSize: number) => string | undefined;
        isKnownType: (name: string) => boolean;
        isPseudoType: (name: string) => boolean;
        pseudoTypes: { actualTypesBySize: { [k: number]: string }; name: string[] }[];
        toBuffer: (
            name: string,
            value: PlcPrimitiveType,
            buffer?: Buffer<ArrayBufferLike>,
        ) => Buffer<ArrayBufferLike>;
        types: (
            | {
                adsDataType: number;
                fromBuffer: (buffer: Buffer) => string;
                name: string[];
                size: number;
                toBuffer: (value: string, buffer: Buffer) => number;
            }
            | {
                adsDataType: number;
                fromBuffer: (buffer: Buffer) => boolean;
                name: string[];
                size: number;
                toBuffer: (value: number | boolean, buffer: Buffer) => number;
            }
            | {
                adsDataType: number;
                fromBuffer: (buffer: Buffer) => number;
                name: string[];
                size: number;
                toBuffer: (value: number, buffer: Buffer) => number;
            }
            | {
                adsDataType: number;
                fromBuffer: (buffer: Buffer, convertDates: boolean) => number | Date;
                name: string[];
                size: number;
                toBuffer: (value: number | Date, buffer: Buffer) => void;
            }
            | {
                adsDataType: number;
                fromBuffer: (buffer: Buffer) => bigint | Buffer<ArrayBufferLike>;
                name: string[];
                size: number;
                toBuffer: (
                    value: number | Buffer<ArrayBufferLike> | BigInt,
                    buffer: Buffer,
                ) => void;
            }
        )[];
    } = ...

    Base data types

    Object that handles PLC base data types

    Type Declaration

    • find: (
          name: string,
      ) =>
          | {
              adsDataType: number;
              fromBuffer: (buffer: Buffer) => string;
              name: string[];
              size: number;
              toBuffer: (value: string, buffer: Buffer) => number;
          }
          | {
              adsDataType: number;
              fromBuffer: (buffer: Buffer) => boolean;
              name: string[];
              size: number;
              toBuffer: (value: number | boolean, buffer: Buffer) => number;
          }
          | {
              adsDataType: number;
              fromBuffer: (buffer: Buffer) => number;
              name: string[];
              size: number;
              toBuffer: (value: number, buffer: Buffer) => number;
          }
          | {
              adsDataType: number;
              fromBuffer: (buffer: Buffer, convertDates: boolean) => number | Date;
              name: string[];
              size: number;
              toBuffer: (value: number | Date, buffer: Buffer) => void;
          }
          | {
              adsDataType: number;
              fromBuffer: (buffer: Buffer) => bigint | Buffer<ArrayBufferLike>;
              name: string[];
              size: number;
              toBuffer: (
                  value: number | Buffer<ArrayBufferLike> | BigInt,
                  buffer: Buffer,
              ) => void;
          }
          | null

      Finds the given data type from array

    • findPseudoType: (
          name: string,
      ) =>
          | { actualTypesBySize: { [k: number]: string }; name: string[] }
          | undefined

      Finds the given pseudo data type from array using regular expressions

    • fromBuffer: (
          name: string,
          buffer: Buffer,
          convertDates: boolean,
      ) => string | number | bigint | boolean | Buffer<ArrayBufferLike> | Date

      Reads given data type from given buffer

    • getTypeByPseudoType: (name: string, byteSize: number) => string | undefined

      Finds the given pseudo data type from array using regular expressions

    • isKnownType: (name: string) => boolean

      Returns true if given data type is found and known

    • isPseudoType: (name: string) => boolean

      Returns true if given data type is found and known

    • pseudoTypes: { actualTypesBySize: { [k: number]: string }; name: string[] }[]

      All pseudo data types and their actual types depending on size Example: XINT is 4 bytes @ 32 bit platform -> DINT

    • toBuffer: (
          name: string,
          value: PlcPrimitiveType,
          buffer?: Buffer<ArrayBufferLike>,
      ) => Buffer<ArrayBufferLike>

      Writes given value to given or new buffer

    • types: (
          | {
              adsDataType: number;
              fromBuffer: (buffer: Buffer) => string;
              name: string[];
              size: number;
              toBuffer: (value: string, buffer: Buffer) => number;
          }
          | {
              adsDataType: number;
              fromBuffer: (buffer: Buffer) => boolean;
              name: string[];
              size: number;
              toBuffer: (value: number | boolean, buffer: Buffer) => number;
          }
          | {
              adsDataType: number;
              fromBuffer: (buffer: Buffer) => number;
              name: string[];
              size: number;
              toBuffer: (value: number, buffer: Buffer) => number;
          }
          | {
              adsDataType: number;
              fromBuffer: (buffer: Buffer, convertDates: boolean) => number | Date;
              name: string[];
              size: number;
              toBuffer: (value: number | Date, buffer: Buffer) => void;
          }
          | {
              adsDataType: number;
              fromBuffer: (buffer: Buffer) => bigint | Buffer<ArrayBufferLike>;
              name: string[];
              size: number;
              toBuffer: (
                  value: number | Buffer<ArrayBufferLike> | BigInt,
                  buffer: Buffer,
              ) => void;
          }
      )[]

      All base data types and properties