any2orca API reference
    Preparing search index...

    Interface ConvertOptions

    interface ConvertOptions {
        aboveStock?: AboveStockChoice;
        explain?: boolean;
        filamentComplianceMode?: "generic" | "snapmaker";
        hardenedNozzles?: boolean;
        highFlowHotends?: boolean | readonly boolean[];
        onProgress?: (stage: ConvertStage) => void;
        preset?: Preset;
        profileId?: string;
        profiles: ProfileCatalog | ProfileSource;
        snapmakerOrcaVersion?: string;
        stamp?: boolean;
    }
    Index
    aboveStock? explain? filamentComplianceMode? hardenedNozzles? highFlowHotends? onProgress? preset? profileId? profiles snapmakerOrcaVersion? stamp?
    aboveStock?: AboveStockChoice

    For speeds, accelerations and filament max volumetric speed above Snapmaker's stock values: settings to keep at the creator's value (accelerations and travel speed above stock, uncapped max volumetric speed) and settings to set to Snapmaker's stock value (print speeds). The U1's machine limits still cap everything. Each "What changed?" item that can be chosen differently has an alternative. Default: none.

    explain?: boolean

    Also put every difference between the original and converted settings in report.whatChanged.diff (for "What changed?" > all differences, and its export). The grouped record is always in the report. Default false.

    filamentComplianceMode?: "generic" | "snapmaker"

    Relabel filament identity to Generic or Snapmaker presets (identity only, never tuning).

    hardenedNozzles?: boolean

    The U1's nozzles are hardened steel rather than the stock stainless steel. Changes the 0.4 nozzle profile only (Snapmaker makes the other sizes only in hardened steel). Snapmaker Orca uses it to warn when a filament is too abrasive for the nozzle. Default false.

    highFlowHotends?: boolean | readonly boolean[]

    Which toolheads have the Liber High Flow Hotend: true for all, or one entry per toolhead, T1 first (the U1 has four), e.g. [true, false, false, false]. Ignored, with a warning, where the nozzle has no high-flow option.

    onProgress?: (stage: ConvertStage) => void

    Called as the conversion moves through its steps, for a progress display.

    preset?: Preset

    Convert onto the preset's base profile and write its print settings over the creator's. Can't be combined with profileId. Speeds above the U1's machine limits are still capped; check report.preset.changes for values above stock and show them to the user.

    profileId?: string

    Use this profile instead of matching one. A retired id converts with its successor, with a warning.

    profiles: ProfileCatalog | ProfileSource

    Where profiles come from. Pass the same catalog for every conversion so profiles load once.

    snapmakerOrcaVersion?: string

    The Snapmaker Orca release to convert for, e.g. "2.4.0": its profiles, its stock values and the Application line the file carries. Pick the release the user has installed; Snapmaker Orca's command line refuses a value an older release doesn't accept. Default: the newest release the catalog holds. ProfileCatalog.releases() lists them; one it doesn't hold throws Any2orcaError release_not_found.

    stamp?: boolean

    Add the output stamp (Metadata/any2orca.json). Default true.

    Settings

    On This Page
    Properties