TonCut Engine

https://docs.toncut.com
Admin
TonCut Engine is an optimization program that performs cutting optimization through a JSON-based API...
Tokens:19,897
Snippets:221
Trust Score:5.9
Update:5 months ago
Show doc for...
Tokens:
Raw
### OctagonShape Example

Source: https://docs.toncut.com/shapes

Defines an octagon with cut lengths for each corner and veneer IDs for all sides and cuts.

```json
{
  "shapeType": "octagon",
  "shape": {
    "tlV": 20,
    "tlH": 20,
    "trV": 20,
    "trH": 20,
    "brV": 20,
    "brH": 20,
    "blV": 20,
    "blH": 20,
    "veneers": {
      "leftVeneerId": 1,
      "topVeneerId": 2,
      "rightVeneerId": 3,
      "bottomVeneerId": 4,
      "topLeftVeneerId": 5,
      "topRightVeneerId": 6,
      "bottomRightVeneerId": 7,
      "bottomLeftVeneerId": 8
    }
  }
}
```

--------------------------------

### Stock Object Example

Source: https://docs.toncut.com/dataobjects

Represents a stock item with material details, quantity, and edging information. Used for both 1D and 2D input.

```json
{
  "stock": [
    {
      "materialId": 3,
      "identifier": "",
      "description": "",
      "priority": "normal",
      "length": 6000,
      "quantity": 10,
      "edging": {
          "left": 0,
          "right": 0
      },
      "id": 2
    }
  ]
}
```

--------------------------------

### Configuration Data Group Example

Source: https://docs.toncut.com/datagroups

Illustrates the structure of the Configuration data group, including version, default units, and a list of optimization profiles with their algorithms and limits. Use this to define optimization settings.

```json
{
  "version": 3,
  "defaultUnits": {
    "time": "s",
    "percent": "%",
    "length": "mm",
    "field": "sqmm",
    "angle": "rad"
  },
  "profiles": [
    {
      "name": "fromSmall",
      "active": true,
      "algorithms": {
        "grouping": true,
        "deduction": true,
        "lastStockItem": true,
        "firstHit": true,
        "fast": false,
        "balance": false,
        "forking": {
          "enabled": false,
          "level": 1
        },
        "adaptive": {
          "enabled": true,
          "level": 5
        },
        "ai": {
          "enabled": false,
          "level": 0
        }
      },
      "limits": {
        "maxCombinations": {
          "enabled": false,
          "limit": 5000000
        },
        "maxTimeSingle": {
          "enabled": false,
          "limit": "5s"
        },
        "maxTime": {
          "enabled": false,
          "limit": "0s"
        },
        "goodEnoughWaste": {
          "enabled": false,
          "limit": "0.00%"
        }
      },
      // ...
    }
  ]
}
```

--------------------------------

### Sending Requests and Handling Responses

Source: https://docs.toncut.com/commands

Example JavaScript code demonstrating how to send commands via a WebSocket connection and handle responses, including managing command IDs and promises.

```javascript
let requestMap = {};
let socket = null;

function SendCommand(aCommand) {
  // Generate command id.
  aCommand.id = Math.floor(Math.random() * 100000);

  // Send command.
  socket.send(JSON.stringify(aCommand));

  // Add command to request map.
  requestMap[aCommand.id] = {};
  promise = new Promise((resolve, reject) => {
    requestMap[aCommand.id].resolveCb = resolve;
    requestMap[aCommand.id].rejectCb = reject;
  });
  requestMap[aCommand.id].promise = promise;

  // Return promise.
  return promise;
}

function onOpen(aEvent) {
  console.log('Connected.');

  const cmd = {
    cmd: 'cmdListJobs'
  };
  SendCommand(cmd).then(data => {
    // TODO: Handle data.jobs...
  });
}

function onMessage(aEvent) {
  data = JSON.parse(aEvent.data);

  if (data.id) {
    // Handle response.
    if (data.id in requestMap) {
      // Trigger success or failure callback.
      if (data.success)
        requestMap[data.id].resolveCb(data);
      else
        requestMap[data.id].rejectCb(data);

      // Delete request from the map.
      delete requestMap[data.id];
    }
  } else {
    // TODO: Handle events.
  }
}
```

--------------------------------

### TonCut Engine Command Line Usage Examples

Source: https://docs.toncut.com/modes

Demonstrates various ways to execute TonCut Engine from the command line, including file-based I/O, standard stream redirection, and piping between applications. Use the -q option when redirecting output to stdout.

```batch
rem Using files only
TonCutEngine.exe -c config.json -i input.json -o output.json

rem Using stdin & stdout
type input.json | TonCutEngine.exe -q -c config.json > output.json

rem Mix files and stdout
TonCutEngine.exe -q -i input.json -c config.json > output.json

rem Full batch chain
SomeApp.exe | TonCutEngine.exe -q -c config.json | SomeOtherApp.exe

```

--------------------------------

### Get Job Info (`cmdGetJobInfo`)

Source: https://docs.toncut.com/commands

Retrieves all information about a specified job. Requires the `jobId` of the job for which to retrieve information.

```APIDOC
## cmdGetJobInfo

The cmdGetJobInfo command returns all information about the specified job.
### Request parameters
  * `jobId`
int mandatory
ID of the job to get information about.


### Response parameters
  * `state`
JobState
✕
## `JobState`enum
State of the job
Allowed values
* * *
### `sNew`
The job is new and waiting in a queue.
### `sPending`
The job is currently optimized.
### `sCanceled`
The job was cancelled.
### `sDone`
The job was optimized.
### `sError`
There was an error while handling the job.
State of the job.
  * `errorCode`
ErrorCode
✕
## `ErrorCode`enum
Contains the error code
Allowed values
* * *
### `ecNoActiveLicenseFound`
No active license was found.
### `ecConfigParsingFailed`
There was an error while parsing the configuration data group.
### `ecInputParsingFailed`
There was an error while parsing the input data group.
### `ecNoActiveProfilesFound`
No active optimization profiles were found. Probably all of them are not active.
### `ecNoResultsFound`
No results found.   
There may be many reasons for this, e.g., no stocks provided, stock material groups not matching piece material groups, too small stock items, etc.
```

--------------------------------

### Set Datatype Example

Source: https://docs.toncut.com/datatypes

Sets are represented as JSON arrays of strings. This is used when a property can accept multiple values from a predefined set.

```json
{ "property": ["value1", "value2"] }
```

--------------------------------

### TrapezoidShape Example

Source: https://docs.toncut.com/shapes

Defines a trapezoid with specified lengths for the left and right sloping edges, and veneer IDs for its sides.

```json
{
  "shapeType": "trapezoid",
  "shape": {
    "leftSlopeLength": 30,
    "rightSlopeLength": 40,
    "veneers": {
      "leftVeneerId": 1,
      "topVeneerId": 2,
      "rightVeneerId": 3,
      "bottomVeneerId": 4
    }
  }
}
```

--------------------------------

### Veneer Object Input

Source: https://docs.toncut.com/dataobjects

Example JSON structure for defining a veneer. The `maxMaterialThickness` attribute is mandatory and specifies the maximum material thickness this veneer can be applied to.

```json
{
"veneers": [
    {
      "title": "Oak",
      "width": 22,
      "thickness": 1.5,
      "maxMaterialThickness": 18,
      "id": 1
    }
  ]
}
```

--------------------------------

### Stock Object with Defects Example

Source: https://docs.toncut.com/dataobjects

Includes defect information within the stock object, specifying the location and dimensions of defects on the stock item. Requires Enterprise license.

```json
{
  "stock": [
    {
      "id": 2,
      "materialId": 1,
      "quantity": 1,
      "edging": {
        "left": 15,
        "right": 15,
        "top": 15,
        "bottom": 15
      },
      "defects": [
        {
          "x": 250,
          "y": 480,
          "length": 100,
          "width": 150
        },
        {
          "x": 1350,
          "y": 100,
          "length": 150,
          "width": 100
        }
      ]
    }
  ]
}
```

--------------------------------

### RightTriangleShape Example

Source: https://docs.toncut.com/shapes

Defines a right triangle with the right angle at the bottom left corner and specifies veneers for its sides.

```json
{
  "shapeType": "rightTriangle",
  "shape": {
    "rightAnglePos": "bottomLeft",
    "veneers": {
      "vertVeneerId": 1,
      "horzVeneerId": 2,
      "hypoVeneerId": 3
    }
  }
}
```

--------------------------------

### EllipseShape Example

Source: https://docs.toncut.com/shapes

Defines an elliptical shape with a single veneer ID for its border.

```json
{
  "shapeType": "ellipse",
  "shape": {
    "veneers": {
      "veneerId": 1
    }
  }
}
```

--------------------------------

### Cut Data Object Examples

Source: https://docs.toncut.com/dataobjects

Defines straight cuts between two points. Use for straight line cuts, with an option to enable material shifting.

```json
{
  "cuts": [
    {
      "type": "line",
      "startX": 820,
      "startY": 0,
      "endX": 793.2,
      "endY": 100,
      "needShift": false
    },
    {
      "type": "line",
      "startX": 1613.2,
      "startY": 0,
      "endX": 1613.2,
      "endY": 100,
      "needShift": false
    },
    {
      "type": "line",
      "startX": 2433.2,
      "startY": 0,
      "endX": 2406.4,
      "endY": 100,
      "needShift": false
    },
    {
      "type": "line",
      "startX": 3226.4,
      "startY": 0,
      "endX": 3226.4,
      "endY": 100,
      "needShift": false
    }
  ]
}
```

--------------------------------

### Material Object 1D Input

Source: https://docs.toncut.com/dataobjects

Example JSON structure for defining a 1D material. Ensure all required fields are present for proper material definition.

```json
{
  "materials": [
    {
      "deviceId": 1,
      "title": "Material 1D",
      "kind": "1d",
      "width": 100,
      "thickness": 100,
      "canRotate": true,
      "canMirror": true,
      "surplus": 0,
      "surplusEditable": true,
      "margin": 0,
      "marginEditable": true,
      "defaultEdging": 0,
      "kerf": 0,
      "allowEdgeCuts": true,
      "reuseWaste": {
          "minLongerLength": 200,
          "edging": {
            "enabled": false,
            "default": 0
          }
      },
      "canBeVeneered": true,
      "id": 3
    }
  ]
}
```

--------------------------------

### SlopeRectangleShape Example

Source: https://docs.toncut.com/shapes

Defines a rectangle with a sloped top edge, specifying the remaining width at the sloped side and veneer IDs for each edge.

```json
{
  "shapeType": "slopeRect",
  "shape": {
    "toWidth": 50,
    "slopeDirection": "downToRight",
    "veneers": {
      "leftVeneerId": 1,
      "topVeneerId": 2,
      "rightVeneerId": 3,
      "bottomVeneerId": 4
    }
  }
}
```

--------------------------------

### AnyShape JSON Example

Source: https://docs.toncut.com/shapes

Represents an arbitrary shape defined by an SVG path. This is useful for complex, custom geometries. Ensure the path is continuous and closed.

```json
{
  "shapeType": "any",
  "shape": {
    "format": "svg-path",
    "path": "M0,0 L100,0 L100,50 Z",
    "scale": 100
  }
}
```

--------------------------------

### CircleShape JSON Example

Source: https://docs.toncut.com/shapes

Represents a circular shape with optional inner and outer veneer IDs. Use this for simple circular cuts.

```json
{
  "shapeType": "circle",
  "shape": {
    "variant": "full",
    "veneers": {
      "outerVeneerId": 1,
      "innerVeneerId": 2
    }
  }
}
```

--------------------------------

### Enum Datatype Example

Source: https://docs.toncut.com/datatypes

Enums are represented as strings in JSON. Use this when a property must be one of a predefined set of values.

```json
{ "property": "value2" }
```

--------------------------------

### RingShape JSON Example

Source: https://docs.toncut.com/shapes

Defines a ring shape with an inner radius and veneer information for both outer and inner edges. Suitable for shapes with a central hole.

```json
{
  "shapeType": "ring",
  "shape": {
    "innerRadius": 40,
    "veneers": {
      "outerVeneerId": 1,
      "innerVeneerId": 2
    }
  }
}
```

--------------------------------

### Reload SSL Certificate for TonCut Engine

Source: https://docs.toncut.com/ssl

Use this command to inform TonCut Engine about changes to its SSL certificate, such as after a renewal. Ensure the path to TonCutEngine.exe is correct for your installation.

```bash
"C:\Program Files (x86)\TonCut Engine\TonCutEngine.exe" -reload-ssl-cert
```

--------------------------------

### Cost Optimization (`cost`)

Source: https://docs.toncut.com/commands

Initiates cost optimization. This command requires specification of various costs and gains in devices, material groups, and stock items. It is available only with an Enterprise license.

```APIDOC
## `cost`

Tells the optimizer to run cost optimization. It requires specification of various costs and gains in devices, material groups and stock items.
Available only with Enterprise license!
def: optimal

The `bestSolutionCriterion` parameter allows you to choose the criterion for selecting the best solution. Thanks to this, the algorithms know what the optimization goal is.
  * `maxResultsPerMaterial`
int
The `maxResultsPerMaterial` parameter allows you to limit the number of cuttings per material group. This is useful when running continuous optimization in a dynamic environment where the list of pieces keeps growing. In such cases, optimizing everything at once might produce suboptimal results. Instead, it is better to wait until more pieces are available for optimization.
Note that the optimizer might return more cutting results than specified in this parameter.
  * `maxCombinations`
int
The `maxCombinations` parameter allows you to limit the number of combinations the optimizer will check. This is useful when you want to limit the optimization time.
Note that the optimization process may stop before finding the best solution if this limit is reached.
Note that different algorithms process different numbers of combinations per second.
  * `maxTime`
time
The `maxTime` parameter allows you to limit the optimization time. This is useful when you want to limit the optimization time.
Note that the optimization process may stop before finding the best solution if this limit is reached.

### Response parameters
  * `jobId`
int mandatory
ID of the new job.
```

--------------------------------

### cmdAddJob

Source: https://docs.toncut.com/commands

Creates a new job and adds it to the queue. Requires 'input' and optionally accepts 'config', 'allowOverstock', and 'bestSolutionCriterion'.

```APIDOC
## cmdAddJob

Creates a new job and adds it to the queue.

### Request parameters

* `config` (Configuration) - Configuration data group object. Overwrites default settings.
* `input` (Input) - Mandatory input data group object.
* `allowOverstock` (bool, optional, default: false) - Allows allocating more stock items than available. Applies only to standard stock sizes.
* `bestSolutionCriterion` (BestSolutionCriterion, optional) - Criterion for determining the best solution.

### `BestSolutionCriterion` enum

Allowed values:
* `smallestSheetArea`
* `smallestWasteArea`
* `productionTime`
* `optimal`
```

--------------------------------

### cmdGetJobInfo

Source: https://docs.toncut.com/commands

Returns all information about the specified job.

```APIDOC
## cmdGetJobInfo

Returns all information about the specified job.
```

--------------------------------

### Configure 1D Device Settings

Source: https://docs.toncut.com/dataobjects

Defines settings for a 1D device, including slant support and cut length limitations. Ensure 'materialKind' is set to '1d'.

```json
{
  "devices": [
    {
      "title": "Device 1D",
      "materialKind": "1d",
      "slants": {
          "supported": true,
          "leftMeasurement": "fromMiddleToRight",
          "rightMeasurement": "fromMiddleToLeft"
      },
      "minCutWidth": 0,
      "edgingCuts": "optimal",
      "maxCutLengthByLength": {
          "enabled": false,
          "limit": 10000
      },
      "id": 1
    }
  ]
}
```

--------------------------------

### cmdGetStatus

Source: https://docs.toncut.com/commands

Returns the current server status.

```APIDOC
## cmdGetStatus

Returns current server status.
```

--------------------------------

### Connect to TonCut Engine WebSocket API

Source: https://docs.toncut.com/connection

Establishes a WebSocket connection and sets up event listeners for open, close, error, and message events. Includes automatic reconnection logic on close.

```javascript
let socket = null;

function onOpen(event) {
  console.log('Connected.');
  // Now you can get status, job list and job info.
}

function onClose(event) {
  console.log('Connection closed!');

  // Wait 1s and retry.
  setTimeout(connect, 1000);
}

function onError(event) {
  console.log('Connection error: ', event);
  socket.close();
}

function onMessage(event) {
  data = JSON.parse(event.data);

  if (data.id) {
    // It must be a command response.
    // You need to keep requests in a map to match them here.
  } else {
    // It must be an event.
  }
}

function connect() {
  socket = new WebSocket('ws://localhost:8080');
  socket.addEventListener('open', onOpen);
  socket.addEventListener('close', onClose);
  socket.addEventListener('error', onError);
  socket.addEventListener('message', onMessage);
}

connect();

```

--------------------------------

### List Jobs (`cmdListJobs`)

Source: https://docs.toncut.com/commands

Retrieves a list of all jobs, regardless of their status (finished, waiting, or in process). A job is considered in process when it is currently being optimized. This command does not require any additional request parameters.

```APIDOC
## cmdListJobs

You can use the cmdListJobs command to get a list of jobs.
The list will show you all the jobs, no matter if they are finished, waiting or in process.
A job is in process when it is currently being optimized.
The `cmdListJobs` command does not have any additional request parameters.
### Response parameters
  * `jobs`
list(object)
Contains list of all the job.  
Each job is described by an object with the following properties.
#### Show Child Attributes
    * `id`
int
Job ID.
    * `state`
JobState
✕
## `JobState`enum
State of the job
Allowed values
* * *
### `sNew`
The job is new and waiting in a queue.
### `sPending`
The job is currently optimized.
### `sCanceled`
The job was cancelled.
### `sDone`
The job was optimized.
### `sError`
There was an error while handling the job.
State of the job.
    * `errorCode`
ErrorCode
✕
## `ErrorCode`enum
Contains the error code
Allowed values
* * *
### `ecNoActiveLicenseFound`
No active license was found.
### `ecConfigParsingFailed`
There was an error while parsing the configuration data group.
### `ecInputParsingFailed`
There was an error while parsing the input data group.
### `ecNoActiveProfilesFound`
No active optimization profiles were found. Probably all of them are not active.
### `ecNoResultsFound`
No results found.   
There may be many reasons for this, e.g., no stocks provided, stock material groups not matching piece material groups, too small stock items, etc.
### `ecUnexpectedException`
There was an unexpected error. Please contact us to solve the problem!
If the job state is set to `sError`, then `errorCode` contains the error code.
    * `errorDescription`
string
Additional error information.
    * `progress`
float
Optimization progress in percent, so 100 means 100%.
    * `combinationCount`
int
Number of combinations checked.
    * `createDate`
date
Date of the job creation.
    * `startDate`
date
Date when the job optimization started.
    * `endDate`
date
Date when job optimization ended.
```

--------------------------------

### Profile Object Configuration

Source: https://docs.toncut.com/dataobjects

Defines a comprehensive profile for optimization algorithms, including settings for grouping, deduction, and various limits. This configuration can be used to tailor the optimization process for specific needs.

```json
{
  "profiles": {
    "name": "fromSmall",
    "active": true,
    "algorithms": {
      "grouping": true,
      "deduction": true,
      "lastStockItem": true,
      "firstHit": true,
      "fast": false,
      "balance": false,
      "forking": {
          "enabled": false,
          "level": 1
      },
      "adaptive": {
          "enabled": true,
          "level": 5
      },
      "ai": {
          "enabled": false,
          "level": 0
      }
    },
    "limits": {
      "single": {
        "maxCombinations": {
          "enabled": false,
          "limit": 1000
        },
        "maxTime": {
          "enabled": true,
          "limit": "5s"
        },
        "goodEnoughWaste": {
          "enabled": true,
          "limit": "5%"
        }
      },
      "variant": {
        "maxCombinations": {
          "enabled": false,
          "limit": 100000
        },
        "maxTime": {
          "enabled": false,
          "limit": "30s"
        }
      },
      "profile": {
        "maxCombinations": {
          "enabled": false,
          "limit": 10000000
        },
        "maxTime": {
          "enabled": true,
          "limit": "10m"
        }
      }
    },
    "stockOrder": {
      "order": {
          "direction": "fromSmall",
          "switchToSmall": {
            "enabled": false,
            "minWaste": "0.20%"
          },
          "randomOrders": {
            "enabled": false,
            "count": 5
          },
          "randomDrawCount": 10
      },
      "adaptiveOrder": {
          "enabled": true,
          "minWaste": "0.15%",
          "maxTries": 3,
          "maxCycles": 1
      }
    },
    "advanced": {
      "dynamicMethodSwitch": {
          "enabled": true,
          "threshold": "1s"
      },
      "fastMethodForLastStockItems": {
          "enabled": true,
          "threshold": "0.80%"
      },
      "searchDirection": "auto",
      "searchPrecision": {
          "firstLevel": 2147483647,
          "nextLevels": 1
      }
    }
  }
}

```

--------------------------------

### cmdListJobs

Source: https://docs.toncut.com/commands

Shows a list of all jobs, including those that are finished, waiting, or currently in process.

```APIDOC
## cmdListJobs

Shows a list of jobs. The list will show you all the jobs, no matter if they are finished, waiting, or in process. A job is in process when it is currently being optimized.
```

--------------------------------

### JavaScript WebSocket Command Handling

Source: https://docs.toncut.com/commands

This JavaScript code demonstrates how to send commands over a WebSocket connection, manage request IDs, and handle responses using Promises. It includes functions for sending commands and processing incoming messages.

```javascript
  let requestMap = {};
  let socket = null;

  function SendCommand(aCommand) {
    // Generate command id.
    aCommand.id = Math.floor(Math.random() * 100000);

    // Send command.
    socket.send(JSON.stringify(aCommand));

    // Add command to request map.
    requestMap[aCommand.id] = {};
    promise = new Promise((resolve, reject) => {
      requestMap[aCommand.id].resolveCb = resolve;
      requestMap[aCommand.id].rejectCb = reject;
    });
    requestMap[aCommand.id].promise = promise;

    // Return promise.
    return promise;
  }

  function onOpen(aEvent) {
    console.log('Connected.');

    const cmd = {
      cmd: 'cmdListJobs'
    };
    SendCommand(cmd).then(data => {
      // TODO: Handle data.jobs...
    });
  }

  function onMessage(aEvent) {
    data = JSON.parse(aEvent.data);

    if (data.id) {
      // Handle response.
      if (data.id in requestMap) {
        // Trigger success or failure callback.
        if (data.success)
          requestMap[data.id].resolveCb(data);
        else
          requestMap[data.id].rejectCb(data);

        // Delete request from the map.
        delete requestMap[data.id];
      }
    } else {
      // TODO: Handle events.
    }
  }

```

--------------------------------

### Input Data Group JSON Structure

Source: https://docs.toncut.com/datagroups

This JSON structure defines the input parameters for an optimization process. It includes default units, device configurations, piece specifications, material properties, and stock details. Ensure all required fields are populated for accurate optimization.

```json
{
  "version": 3,
  "defaultUnits": {
    "time": "s",
    "percent": "%",
    "length": "mm",
    "field": "sqmm",
    "angle": "deg"
  },
  "devices": [
    {
      "title": "Device 1D",
      "materialKind": "1d",
      "slants": {
        "supported": true,
        "leftMeasurement": "fromMiddleToRight",
        "rightMeasurement": "fromMiddleToLeft"
      },
      "minCutWidth": 0,
      "edgingCuts": "optimal",
      "maxCutLengthByLength": {
        "enabled": false,
        "limit": 10000
      },
      "id": 1
    }
  ],
  "pieces": [
    {
      "materialId": 3,
      "identifier": "",
      "length": 500,
      "shapeType": "linear",
      "quantity": 15,
      "priority": "normal",
      "description": "",
      "surplus": 0,
      "margin": 0,
      "shape": {
        "leftAngle": 45,
        "rightAngle": 25
      },
      "id": 1
    }
  ],
  "materials": [
    {
      "deviceId": 1,
      "title": "Material 1D",
      "kind": "1d",
      "width": 100,
      "thickness": 100,
      "canRotate": true,
      "canMirror": true,
      "surplus": 0,
      "surplusEditable": true,
      "margin": 0,
      "marginEditable": true,
      "defaultEdging": 0,
      "kerf": 0,
      "allowEdgeCuts": true,
      "reuseWaste": {
        "minLongerLength": 200,
        "edging": {
          "enabled": false,
          "default": 0
        }
      },
      "canBeVeneered": true,
      "id": 3
    }
  ],
  "stock": [
    {
      "materialId": 3,
      "identifier": "",
      "description": "",
      "priority": "normal",
      "length": 6000,
      "quantity": 10,
      "edging": {
        "left": 0,
        "right": 0
      },
      "id": 2
    }
  ],
  "veneers": []
}
```

--------------------------------

### Command Structure

Source: https://docs.toncut.com/commands

All commands sent to the Toncut API must include a 'cmd' property specifying the command type and an 'id' property for tracking requests. The 'CommandType' enum lists the available commands.

```APIDOC
## Command Structure

Every command has the following properties:

* `cmd` (CommandType) - The command name.
* `id` (int) - Unique id of the command.

### `CommandType` enum

Allowed values:
* `cmdAddJob`
* `cmdListJobs`
* `cmdRemoveJob`
* `cmdGetJobInfo`
* `cmdGetStatus`
```

--------------------------------

### JavaScript WebSocket Command Handling

Source: https://docs.toncut.com/commands

Handles user interactions for adding jobs, refreshing job lists, and canceling jobs using WebSocket commands. It updates the UI with job status and progress. Ensure the `SendCommand` function and necessary HTML elements are defined.

```javascript
function start() {
  $('#bAddJob').on('click', event => {
    const cmd = {
      cmd: 'cmdAddJob',
      config: config,
      input: input
    };
    SendCommand(cmd);
  });

  $('#bRefresh').on('click', event => {
    const cmd = {
      cmd: 'cmdListJobs'
    };
    SendCommand(cmd).then(data => {
      $('#ulJobs').empty();
      for (let i = 0; i < data.jobs.length; i++) {
        let job = data.jobs[i];

        if (job.state == 'sPending')
          activeJobId = job.id;

        let stateHtml;
        if (job.state == 'sError')
          stateHtml = `${job.state}, ${job.errorCode}, ${job.errorDescription}`;
        else
          stateHtml = job.state;

        let jobEl = $(`#job-${job.id}`);
        if (jobEl.length == 0)
          $('#ulJobs').append(`<li id="job-${job.id}">Job ${job.id}
                               <span className='clsState'>${stateHtml}</span>
                               <span className='clsProgress'>${job.progress.toFixed(2) + '%'}</span></li>`);
        else
          jobEl.replace(`<li id="job-${job.id}">Job ${job.id}
                         <span className='clsState'>${stateHtml}</span>
                         <span className='clsProgress'>${job.progress.toFixed(2) + '%'}</span></li>`);

        const cmd = {
          cmd: 'cmdGetJobInfo',
          jobId: job.id
        };
        SendCommand(cmd).then(data => {
          // TODO: do something with results if available.
        });
      }
    });
  });

  $('#bCancel').on('click', event => {
    const cmd = {
      cmd: 'cmdRemoveJob',
      jobId: activeJobId
    };
    SendCommand(cmd);
  });
}
```

--------------------------------

### Set Default Time Unit to Minutes

Source: https://docs.toncut.com/datatypes

Configure the default time unit to minutes by setting the 'time' property in the 'defaultUnits' JSON object. This affects values that do not explicitly specify a unit.

```json
{
    "defaultUnits": {
        "time": "m"
    }
}

```

--------------------------------

### Set Default Percent Unit

Source: https://docs.toncut.com/datatypes

Ensure the percent unit is set to '%' in the 'defaultUnits' JSON object for consistent percentage calculations. This is the default behavior.

```json
{
    "defaultUnits": {
        "percent": "%"
    }
}

```

--------------------------------

### Output Data Group Structure

Source: https://docs.toncut.com/datagroups

This JSON structure represents the output of a cutting optimization process. It includes default units, statistical summaries for 2D and 1D materials, and detailed cutting information.

```json
{
  "version": 3,
  "defaultUnits": {
      "length": "mm",
      "field": "sqmm",
      "angle": "rad"
  },
  "statistics": {
      "2d": {
        "field": 0,
        "usedField": 0,
        "wasteField": 0,
        "unusedField": 0,
        "cutCount": 0,
        "cutsLength": 0
      },
      "1d": {
        "length": 48000,
        "usedLength": 42582,
        "wasteLength": 5418,
        "unusedLength": 0,
        "cutCount": 114,
        "cutsLength": 12316.7744553597
      }
  },
  "cuttings": [
      {
        "stockItemId": 2,
        "quantity": 1,
        "statistics": {
            "1d": {
              "length": 6000,
              "usedLength": 5939.4,
              "wasteLength": 60.6,
              "unusedLength": 0,
              "cutCount": 8,
              "cutsLength": 817.64466576987
            }
        },
        "pieces": [
            {
              "pieceId": 3,
              "x": 0,
              "y": 0,
              "rotated": false,
              "mirrored": false
            },
            {
              "pieceId": 3,
              "x": 820,
              "y": 0,
              "rotated": true,
              "mirrored": false
            },
            {
              "pieceId": 3,
              "x": 1613.2,
              "y": 0,
              "rotated": false,
              "mirrored": false
            }
        ],
        "rest": [
            {
              "x": 0,
              "y": 0,
              "length": 0,
              "width": 100,
              "shapeType" :"linear",
              "shape": {
                  "leftAngle": "0.00rad",
                  "rightAngle": "0.00rad"
              },
              "identifier": "",
              "usable": false
            },
            {
              "x": 5952.8,
              "y": 0,
              "length": 74,
              "width": 100,
              "shapeType": "linear",
              "shape": {
                  "leftAngle": "0.26rad",
                  "rightAngle": "0.00rad"
              },
              "identifier": "",
              "usable": false
            }
        ]
      }
  ]
}
```

--------------------------------

### Common Data Group Structure

Source: https://docs.toncut.com/datagroups

Defines the common 'version' and 'defaultUnits' properties found in all TonCut Engine data groups. 'version' tracks format changes, and 'defaultUnits' sets defaults for time, percentage, length, field, and angle measurements.

```json
{
  "version": 3,
  "defaultUnits": {
    "time": "{s|m|h|d}",
    "percent": "{%}",
    "length": "{mm|cm|in}",
    "field": "{sqmm|sqcm|sqm|sqin|sqft}",
    "angle": "{rad|deg}"
  },
  // ...
}
```

--------------------------------

### Define a Piece object for 1D input

Source: https://docs.toncut.com/dataobjects

This JSON structure defines a Piece object, used as input for 1D processing. It includes material, dimensions, quantity, and shape details.

```json
{
  "pieces": [
    {
      "materialId": 3,
      "identifier": "",
      "length": 500,
      "shapeType": "linear",
      "quantity": 15,
      "priority": "normal",
      "description": "",
      "surplus": 0,
      "margin": 0,
      "shape": {
          "leftAngle": 45,
          "rightAngle": 25
      },
      "id": 1
    },
    {
      "materialId": 3,
      "identifier": "",
      "length": 532,
      "shapeType": "linear",
      "quantity": 12,
      "priority": "normal",
      "description": "",
      "surplus": 0,
      "margin": 0,
      "shape": {
          "leftAngle": 35,
          "rightAngle": -25
      },
      "id": 2
    }
  ]
}
```

--------------------------------

### cmdRemoveJob

Source: https://docs.toncut.com/commands

Allows removing a specified job from the queue.

```APIDOC
## cmdRemoveJob

Allows removing a specified job.
```

--------------------------------

### Define a RectangleShape

Source: https://docs.toncut.com/shapes

Use this JSON structure to define a rectangle shape, specifying veneer IDs for each side.

```json
{
  "shapeType": "rectangle",
  "shape": {
    "veneers": {
      "leftVeneerId": 1,
      "rightVeneerId": 2,
      "topVeneerId": 3,
      "bottomVeneerId": 4
    }
  }
}
```
Tokens:
Raw