Function getEncoderPortName

  • Returns a human-readable name for an encoder port for a given product.

    Circulo products:

    • Ports 1–2 → "Integrated encoder 1/2"
    • Ports 3–4 → "External encoder 1/2"
    • Port 5 → "Digital I/O"

    Other products: returns "Port X".

    Returns

    The display name for the encoder port.

    Parameters

    • port: number

      The encoder port number (1-based index).

    • Optional productId: null | string | number | HardwareDescription

      Optional product identifier (number, string, or HardwareDescription).

    Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc