Function getCirculoEncoderBatteryModeOptions

  • Retrieves the available battery mode options for a Circulo encoder product.

    This function identifies the product by its ID or hardware description and, if the product belongs to the 'Circulo' family, returns an array of battery mode options specific to the product group. Each option consists of a human-readable key describing the mode and its corresponding encoded value.

    The returned array always includes a "Default" option based on the provided shaft type.

    Returns

    An array of battery mode options with keys describing the mode and their associated encoded values. Returns an empty array if the product is not part of the Circulo family or no modes are found.

    Parameters

    • productId: string | number | HardwareDescription

      The identifier of the product. Can be a number, string, or a HardwareDescription object.

    • Optional shaft: EncoderShaft

      Optional encoder shaft type ('motor' or 'driving') used to determine the default battery mode.

    Returns {
        key: string;
        value: number;
    }[]

Generated using TypeDoc