Function getCirculoEncoderMaxPermissiblePhaseError

  • Returns the max permissible phase error of the ring a calibration measures, in encoder increments.

    The calibration quality is the measured phase error expressed against this limit, so the limit has to match the ring: a Circulo 7 ring tolerates 256 increments, every other ring 128. Scoring a Circulo 9 against the Circulo 7 limit reports roughly twice the headroom the ring actually has.

    An external encoder type names the ring outright, so it wins over the product: that ring sits on a drive of an unrelated size. Everything else is answered by the product group of the device itself, which leaves a Circulo 9, a Circulo NG and an unrecognised product on 128.

    Returns

    The max permissible phase error in encoder increments

    Parameters

    • Optional productId: null | string | number | HardwareDescription

      The device carrying the encoder: a product id, a serial number or a HardwareDescription

    • externalEncoderType: number = CirculoExternalEncoderType.NONE

      The external ring the procedure was asked to calibrate, if any

    Returns number

Generated using TypeDoc