Automated Computed Embroidery

ACEParaBitmapToPunch

POST

The object is required in every Create request. Each field is optional: a field that is left out gets its default.

LineWidth (default 10)

Value in 1/10th of a mm, maximum surface thickness that is still executed as a stitching line.

SatinStitchWidth (default 70)

Value in 1/10th of a mm, maximum surface thickness that is still executed as a satin stitch; all surfaces that are thicker are executed as a fill stitch.

Overlap (default 2)

Value in 1/10th of a mm, overlap of adjacent surfaces

This function allows you to adjust the overlap of the individual areas. The areas are "inflated" by the set value, thus automatically creating a certain overlap and preventing gaps from forming between the individual areas due to the tension of the thread.

MinimumAreaSize (default 5)

Minimum size of an area in square millimeters

MinimumHoleSize (default 1)

Minimum size of a hole in square millimeters

MinimumLineLength (default 50)

Minimum length for stitching lines in 1/10th of a mm.

UseThreadCones

Name of the thread series (color chart) whose thread numbers are written to the embroidery file, e.g. Amann-Isacord 40. Send the name without .json, exactly as GetThreadConeSeries returns it. If ACEParaOptimize.ThreadTable is empty, the server copies this name there, so that the optimization also matches the colors to this series; if you send both, use the same name. A trailing .json is also accepted here, but not in ThreadTable. An unknown name is ignored without an error.

Series installed on the server (GetThreadConeSeries returns the current list):

  • A&E-Robison Anton Polyester 40
  • Amann-Isacord 40
  • Amann-Saba 40
  • Amann-Serafil 60
  • Candle Polyester Shade
  • Candle Viscose Rayon Shade
  • Coats-Sylko 40
  • Fil-Tec-Glide 40
  • Gunold-Cotty 30
  • Gunold-Poly 40
  • Gunold-Poly 60
  • Gunold-Polyfire
  • Gunold-Sulky 40
  • Madeira-CLASSIC 12
  • Madeira-CLASSIC 30
  • Madeira-CLASSIC 40
  • Madeira-CLASSIC 60
  • Madeira-FIRE FIGHTER
  • Madeira-FROSTED MATT 40
  • Madeira-POLYNEON 40
  • Madeira-POLYNEON 60
  • Madeira-POLYNEON 75
  • Madeira-POLYNEON FR 40
  • Madeira-POLYNEON green 40
  • Madeira-SENSA green 40
  • Perfel-Polysol

ZOrderColorGrouping (default 0, opt-in)

Minimize color changes: 1 reorders the areas so that same-colored areas are stitched together, minimizing thread-color changes; 0 keeps the original order.

MultilayerThreadCut(default 0, opt-in)

Save thread trims (multilayer): 1 keeps jump threads that are later covered by overstitching instead of trimming them, reducing the number of trims; 0 trims every jump.

MultilayerAlwaysCutAbove (default 30)

Always cut above: jumps longer than this length (in mm) are always trimmed, even in multilayer mode. Only relevant when MultilayerThreadCut = 1.

MultilayerMaxVisible (default 2)

Max. visible thread: the total amount (in mm) of visible (uncovered) jump thread that may remain untrimmed in multilayer mode; the visible portions along one jump are added up, not measured individually. Only relevant when MultilayerThreadCut = 1.

JumpOptimization (default 0, opt-in)

Minimize jumps: 1 optimizes the stitching order to reduce the number and length of jumps; 0 off.

StitchParamsEnabled (default 0, opt-in)

Switches the five stitch fields below on: any value other than 0 applies StitchDivision, StitchDivisionValue, StitchLengthRun, RunLength and StitchDensity. With 0 they are ignored and fixed values are used: satin with spacing 400 and no split, fill with spacing 400 and stitch length 40.

StitchDivision (default 2)

Split pattern of the satin stitches (narrow areas only): 0 none, 1 simple split, 2 irregular split, 3 rhythm (step), 4 angle (step), 5 regular (step). Only used when StitchParamsEnabled is not 0.

StitchDivisionValue (default 40)

Split value in percent of the stitch length. Only used with StitchDivision = 1 and StitchParamsEnabled not 0.

StitchLengthRun (default 40)

Value in 1/10th of a mm. Despite the name, this is the stitch length of the step fill used for wide areas; it does not set the running-stitch length. Only used when StitchParamsEnabled is not 0.

RunLength (default 30)

Running-stitch length in 1/10th of a mm. The value is accepted but currently has no effect; running lines keep the built-in stitch length of the server.

StitchDensity (default 500)

Stitch spacing in 1/1000th of a mm for satin stitches and fills. Only used when StitchParamsEnabled is not 0. Do not send 0: the server then ignores all satin and fill stitch fields.

Parameters

Parameter Type Description Required
LineWidth int Value in 1/10th of a mm, maximum surface thickness that is still executed as a stitching line. No
SatinStitchWidth int Value in 1/10th of a mm, maximum surface thickness that is still executed as a satin stitch; all surfaces that are thicker are executed as a fill stitch. No
Overlap int Value in 1/10th of a mm, overlap of adjacent surfaces No
MinimumAreaSize int Minimum size of an area in square millimeters No
MinimumHoleSize int Minimum size of a hole in square millimeters No
MinimumLineLength int Minimum length for stitching lines in 1/10th of a mm. No
UseThreadCones string Thread series for the thread numbers in the embroidery file, as returned by GetThreadConeSeries, without .json (e.g. "Amann-Isacord 40"). Copied to an empty ACEParaOptimize.ThreadTable; if you send both, use the same name. No
ZOrderColorGrouping int Minimize color changes: 1 reorders the areas so that same-colored areas are stitched together, minimizing thread-color changes; 0 keeps the original order. No
MultilayerThreadCut int Save thread trims (multilayer): 1 keeps jump threads that are later covered by overstitching instead of trimming them, reducing the number of trims; 0 trims every jump. No
MultilayerAlwaysCutAbove int Always cut above: jumps longer than this length (in mm) are always trimmed, even in multilayer mode. Only relevant when MultilayerThreadCut = 1. No
MultilayerMaxVisible int Max. visible thread: the total amount (in mm) of visible (uncovered) jump thread that may remain untrimmed in multilayer mode. Only relevant when MultilayerThreadCut = 1. No
JumpOptimization int Minimize jumps: 1 optimizes the stitching order to reduce the number and length of jumps; 0 off. No
StitchParamsEnabled int Switches the stitch fields StitchDivision, StitchDivisionValue, StitchLengthRun, RunLength and StitchDensity on (any value other than 0); 0 ignores them and uses fixed values. No
StitchDivision int Split pattern of the satin stitches: 0 none, 1 simple, 2 irregular, 3 rhythm (step), 4 angle (step), 5 regular (step). Only used when StitchParamsEnabled is not 0. No
StitchDivisionValue int Split value in percent of the stitch length. Only used with StitchDivision = 1. No
StitchLengthRun int Value in 1/10th of a mm, stitch length of the step fill for wide areas (despite the name, not the running stitch). Only used when StitchParamsEnabled is not 0. No
RunLength int Running-stitch length in 1/10th of a mm. Accepted, but currently has no effect. No
StitchDensity int Stitch spacing in 1/1000th of a mm for satin stitches and fills. Only used when StitchParamsEnabled is not 0; 0 makes the server ignore all satin and fill stitch fields. No

Example

  "ACEParaBitmapToPunch": {
    "LineWidth": "10",
    "SatinStitchWidth": "70",
    "Overlap": "2",
    "MinimumAreaSize": "5",
    "MinimumHoleSize": "1",
    "MinimumLineLength": "50",
    "UseThreadCones": "Amann-Isacord 40",
    "ZOrderColorGrouping": "1",
    "MultilayerThreadCut": "1",
    "MultilayerAlwaysCutAbove": "30",
    "MultilayerMaxVisible": "2",
    "JumpOptimization": "1",
    "StitchParamsEnabled": "1",
    "StitchDivision": "2",
    "StitchDivisionValue": "40",
    "StitchLengthRun": "40",
    "RunLength": "30",
    "StitchDensity": "500"
  }