Experimental: the PES output is new. Test the created files on your Brother machines and software before you use them in production.
CreatePES creates stitch data in the Brother PES format (extension .pes) from text, from an existing design, or from both. Send it as an HTTP POST with a JSON body to StitchJob (see Overview) with "RequestType": "CreatePES", "ServerVersion": 3 and a valid WebApiLicense (see ZSK Web API License). ServerVersion 1 and 2 are rejected. Key names are case-sensitive, and integer fields need JSON integers ("DistanceMM": 2, not 2.5).
Input
- Text only: send
MonogramsandNeedle, omitEmbroideryBase64. - Existing design only: send
EmbroideryTypeandEmbroideryBase64, omitMonograms(or send an empty list). NoNeedlelist is needed. - Design + text: send
EmbroideryType,EmbroideryBase64,MonogramsandNeedle(with a TC or TBF design,"UseEmbroideryColors": 1can replaceNeedle, see Colors).TextAlignmentwith aModeplaces the text relative to the design (see TextAlignment to Design).
Text rules: without a design, every monogram needs a non-blank text; up to 9 monograms, one line each, 200 characters in total; FontSizeMM 5 to 50; FontFamily as listed by GetFontList (case-sensitive); UsedNeedle starts at 1. See Monograms.
EmbroideryType is required with every design and must be one of these values (case-sensitive):
| EmbroideryType | File | Processing |
|---|---|---|
TC | .z00 | Used directly. From ServerVersion 3, an optional SeqAssignmentJson assigns its sequences to new needles and colors. |
TBF | .tbf | Used directly. |
DST | .dst | Converted to TC with the needle assignment in SeqAssignmentJson (required). |
DSZ | .dsz | Converted to DST, then handled like DST input; the sequence indexes in SeqAssignmentJson refer to the converted DST. |
PES is an output format only; a PES file cannot be sent as a design. SeqAssignmentJson works as for CreateTC, see NeedleAssignment.
Colors
Needlesets the colors by position (first entry = needle 1); each monogram uses the entry in itsUsedNeedle, so with textNeedleneeds at least that many entries.Red,Green,Blue: integers 0 to 255; other fields: strings.- A PES file stores no RGB colors. For every color block it stores one of the 64 Brother threads of the PEC palette: the thread nearest to the needle color. Two needles with similar colors can therefore get the same Brother thread.
NeedleColorin the response shows the threads that were written. - With a TC or TBF design,
"UseEmbroideryColors": 1buildsNeedlefrom the design, replacing a sent list;UsedNeedlethen selects an entry by position. See UseEmbroideryColors.
Response
On success: HTTP 200 with a JobResponseType with Success true and:
RequestData: the created PES file (PES version 1 with PEC block), Base64-encoded.Info: no values for PES output; all fields are 0 ornull.NeedleColor: one entry per needle inNeedleSequencewith the Brother thread written for it:Red,Green,Blueof the thread,ColorName(Brother thread name),ColorNumber(PEC palette index 1 to 64) andManufacturerBrother. If the color blocks of the file cannot be matched to the needle sequence,NeedleColorholds the colors of the request or the design instead, as for CreateDST; these entries do not haveManufacturerBrother.NeedleSequence: with a design, the design sequence (a stop starts a new sequence on the same needle), then the monogram needles numberedUsedNeedle+ the highest design needle. Text only: theUsedNeedleof each monogram.Time: processing times.PreviewDatastays empty, also withWithPreview; use CreatePNG for a preview.
Info, NeedleColor, NeedleSequence and Time are JSON strings: parse each non-empty string a second time. Example for a design + text (formatted and shortened):
{
"Info": "{ \"widthMm\": 0.0, \"heightMm\": 0.0, ..., \"numberOfStitches\": 0, ... }",
"NeedleColor": "[ { \"NeedleNumber\": 1, \"Red\": 237, \"Green\": 23, \"Blue\": 31, \"ColorName\": \"Red\", \"ColorNumber\": \"5\", \"Manufacturer\": \"Brother\", ... }, ... ]",
"NeedleSequence": "[ 1, 2, 3 ]",
"PreviewData": "",
"RequestData": "base64 encoded PES data",
"Success": true,
"Time": "{ ... }"
}On error, Success is false and RequestData holds the error message.
Errors
| HTTP | RequestData | Cause |
|---|---|---|
| 200 | Error: unknown command! | RequestType is not exactly CreatePES. |
| 400 | CreatePES needs ServerVersion 3 or higher. | ServerVersion 1 or 2. |
| 400 | No licence token found. / Invalid licence token. | WebApiLicense is missing, empty or rejected. |
| 400 | Only one line of text per monogram ... / A maximum of 9 lines ... / The text length is longer ... | More than one Text entry, more than 9 monograms, or more than 200 characters. |
| 400 | Invalid needle color list | Text without a Needle list, or too few Needle entries for the highest UsedNeedle. |
| 400 | Invalid monogram text. Found empty text | No design, and Monograms is missing or empty or a monogram text is blank. |
| 400 | Invalid font size. ... / Invalid font name(s). ... / The text contains not supported character(s): ... | FontSizeMM outside 5 to 50, FontFamily not listed by GetFontList, or characters the font does not support. |
| 400 | embroideryData.Length == 0 | DST or DSZ input without a valid SeqAssignmentJson. |
| 400 | ApplyNasTC: ... (for example ApplyNasTC: Sequence 1 is not assigned to a cone) | TC input: SeqAssignmentJson does not fit the design, or the design has K-head (Moos/Kettel) needles. See NeedleAssignment. |
| 500 | Error message | Unexpected error, for example invalid Base64 in EmbroideryBase64. |
| 503 | Error message | The stitch data could not be created; retry later. |