Function makeDeviceParameterId

  • Make device parameter id by providing a device serial number and tuple of index and subindex.

    Throws

    if index or subindex are less than 0

    Returns

    combined index and subindex in uppercase hexadecimal format and device serial number, e.g. "0x60FE:02.9002-02-0000466-2339"

    Parameters

    • serialNumber: string

      device serial number from the hardware description file

    • tuple: [undefined | null | number, undefined | null | number]

      an array of index and subindex

    Returns string

  • Make device parameter id by providing a device serial number and object which has index and subindex properties.

    Throws

    if index or subindex are less than 0

    Returns

    combined index and subindex in uppercase hexadecimal format and device serial number, e.g. "0x60FE:02.9002-02-0000466-2339"

    Parameters

    • serialNumber: string

      device serial number from the hardware description file

    • parameter: {
          index?: null | number;
          subindex?: null | number;
      }

      an object with optional index and subindex properties

      • Optional index?: null | number
      • Optional subindex?: null | number

    Returns string

  • Make parameter id by providing a device serial number and index and subindex.

    Throws

    if index or subindex are less than 0

    Returns

    combined index and subindex in uppercase hexadecimal format and device serial number, e.g. "0x60FE:02.9002-02-0000466-2339"

    Parameters

    • serialNumber: string

      device serial number from the hardware description file

    • Optional index: null | number

      from 0x0000 to 0xFFFF for objects defined in ESI and >0xFFFF for custom object

    • Optional subindex: null | number

      defaults to 0 if not provided

    Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc