Properties and Enums
This page lists every property the HEIDENHAIN DNC connector exposes, the data format of each value, and all enum values that can appear in those properties.
Use it when building flows, dashboards, or database mappings on top of HEIDENHAIN data.
Properties
Each property is identified by its address. The connector subscribes to the matching HEIDENHAIN data stream as soon as a property with that address exists on the connector.
| Name | Address | Type | Category | Value |
|---|---|---|---|---|
| NC Uptime | NcUptime | Int | Uptime | Time the NC software has been running, in seconds. |
| Machine Uptime | MachineUptime | Int | Uptime | Time the machine has been powered on, in seconds. |
| Machine Running Time | MachineRunningTime | Int | Uptime | Time the machine has been executing programs, in seconds. |
| State | State | String | State | Connection/machine state. See State. |
| Cutter Locations | CutterLocations | JSON | Cutter Locations | Axis positions of channel 0. See Cutter Locations. |
| Execution Mode | ExecutionMode | String | Execution Mode | Active operating mode. See Execution Mode. |
| Current Call | CurrentCall | String | Execution Stack | Path of the program currently being called, e.g. TNC:\nc_prog\part.h. |
| Program Position | ProgramPosition | JSONArray | Execution Stack | Program call stack. See Program Position. |
| Program Status | ProgramStatus | String | Program Status | Status of the selected NC program. See Program Status. |
| COM Interface Version | ComInterfaceVersion | String | Identification | Version of the HEIDENHAIN DNC COM interface. |
| SIK | Sik | String | Identification | Serial number of the System Identification Key (SIK) of the control. |
| Software Version List | SoftwareVersionList | JSONArray | Identification | Installed software components. See Software Version List. |
| Feed Override | FeedOverride | Int | Override Info | Feed rate override as reported by the control. |
| Speed Override | SpeedOverride | Int | Override Info | Spindle speed override as reported by the control. |
| Rapid Override | RapidOverride | Int | Override Info | Rapid traverse override as reported by the control. |
| Errors | Errors | JSONArray | Error List | Active errors on the control. See Errors. |
:::note Data formats
- String enum properties (
State,ExecutionMode,ProgramStatus) contain the HEIDENHAIN enum name, for exampleDNC_PRG_STS_RUNNING. - JSON / JSONArray properties use PascalCase keys. Enums nested inside these JSON values are written as their number, not their name. Use the tables below to translate them.
- JSON strings may contain escaped characters, for example
+written as+. Any JSON parser decodes these automatically. :::
State
Property State (String). Reports the state of the DNC connection and the machine.
| Value | Number | Description | Connector health |
|---|---|---|---|
DNC_EVT_STATE_NOT_INITIALIZED | -1 | No state received yet. Initial value inside the connector. | Transient |
DNC_EVT_STATE_HOST_NOT_AVAILABLE | 0 | The control cannot be reached on the network. | Error |
DNC_EVT_STATE_HOST_AVAILABLE | 1 | The control is reachable; the DNC connection is being set up. | Transient |
DNC_EVT_STATE_WAIT_PERMISSION | 2 | Waiting for the control to grant DNC access. | Transient |
DNC_EVT_STATE_DNC_AVAILABLE | 3 | The DNC server on the control is available. | Transient |
DNC_EVT_STATE_MACHINE_BOOTED | 4 | The control software has booted. | Transient |
DNC_EVT_STATE_MACHINE_INITIALIZING | 5 | The NC software is initializing. | Transient |
DNC_EVT_STATE_MACHINE_AVAILABLE | 6 | The machine is fully available. All data interfaces can be read. | Operational |
DNC_EVT_STATE_MACHINE_SHUTTING_DOWN | 7 | The control is shutting down. | Transient |
DNC_EVT_STATE_DNC_STOPPED | 8 | The DNC server on the control was stopped. | Error |
DNC_EVT_STATE_HOST_STOPPED | 9 | The control was stopped. | Error |
DNC_EVT_STATE_CONNECTION_LOST | 10 | The connection to the control was lost. | Error |
DNC_EVT_STATE_PERMISSION_DENIED | 11 | The control refused DNC access. Check the Controller Setup. | Error |
Connector health shows how the connector reacts to each state:
- Operational: only
DNC_EVT_STATE_MACHINE_AVAILABLE. All machine data is available. - Transient: the machine is starting, stopping, or still negotiating access. The connector stays running and waits for the next state.
- Error: a terminal connection state. The connector is marked unhealthy and its status changes to Error.
Execution Mode
Property ExecutionMode (String). The operating mode currently active on the control.
| Value | Number | Description |
|---|---|---|
DNC_EXEC_MANUAL | 0 | Manual operation. |
DNC_EXEC_MDI | 1 | Positioning with Manual Data Input (MDI). |
DNC_EXEC_RPF | 2 | Traversing the reference points. |
DNC_EXEC_SINGLESTEP | 3 | Program run, single block. |
DNC_EXEC_AUTOMATIC | 4 | Program run, full sequence. |
DNC_EXEC_OTHER | 5 | Any other mode, for example programming or test run. |
DNC_EXEC_HANDWHEEL | 6 | Electronic handwheel mode. |
DNC_EXEC_SIMULO_TURBO_DEPRECATED | -1 | Deprecated. Treat as DNC_EXEC_OTHER. |
Program Status
Property ProgramStatus (String). The status of the NC program selected in the program run modes.
| Value | Number | Description |
|---|---|---|
DNC_PRG_STS_IDLE | 0 | A program is selected but not started. |
DNC_PRG_STS_RUNNING | 1 | The program is running. |
DNC_PRG_STS_STOPPED | 2 | The program is stopped, for example with NC stop. |
DNC_PRG_STS_INTERRUPTED | 3 | The program was interrupted (aborted). |
DNC_PRG_STS_FINISHED | 4 | The program has finished. |
DNC_PRG_STS_ERROR | 5 | The program stopped because of an error. |
DNC_PRG_STS_NOT_SELECTED | 6 | No program is selected. |
Cutter Locations
Property CutterLocations (JSON). An array with one entry per axis of channel 0.
| Field | Type | Description |
|---|---|---|
IsInch | Boolean | true when the position is in inch, false when it is in mm (or degrees for rotary axes). |
CoordinateName | String | Axis name, for example X, Y, Z, B, C. |
Position | Number | Current position of the axis. |
[
{ "IsInch": false, "CoordinateName": "X", "Position": 125.432 },
{ "IsInch": false, "CoordinateName": "Y", "Position": -40.1 },
{ "IsInch": false, "CoordinateName": "Z", "Position": 250 }
]
Program Position
Property ProgramPosition (JSONArray). The program call stack, one entry per level. The main program is level 0; each called program or cycle adds a level.
| Field | Type | Description |
|---|---|---|
ProgramName | String | Full path of the program on this level. |
BlockNumber | Integer | Number of the current NC block in this program. |
BlockContent | String | Content of the current NC block. |
CallStackLevel | Integer | Level in the call stack, starting at 0. |
[
{
"ProgramName": "TNC:\\nc_prog\\part.h",
"BlockNumber": 12,
"BlockContent": "L X+10 Y+20 R0 FMAX",
"CallStackLevel": 0
}
]
Software Version List
Property SoftwareVersionList (JSONArray). One entry per software component installed on the control.
| Field | Type | Description |
|---|---|---|
SoftwareType | Integer | Software component type. See the table below. |
Description | String | Description of the component as reported by the control. |
IdentNr | String | HEIDENHAIN ID number and version of the component. |
[
{ "SoftwareType": 0, "Description": "NC software", "IdentNr": "817625 18" }
]
Software types
| Number | Value |
|---|---|
| 0 | DNC_SW_TYPE_MC |
| 1 | DNC_SW_TYPE_CC |
| 2 | DNC_SW_TYPE_PLC |
| 3 | DNC_SW_TYPE_MP_UIMS |
| 4 | DNC_SW_TYPE_MP_ADMS |
| 5 | DNC_SW_TYPE_TNC_MODEL |
| 6 | DNC_SW_TYPE_TNC_SG |
| 7 | DNC_SW_TYPE_TNC_DSP1 |
| 8 | DNC_SW_TYPE_TNC_DSP2 |
| 9 | DNC_SW_TYPE_TNC_DSP3 |
| 10 | DNC_SW_TYPE_TNC_DSPSG1 |
| 11 | DNC_SW_TYPE_TNC_DSPSG2 |
| 12 | DNC_SW_TYPE_TNC_DSPSG3 |
| 13 | DNC_SW_TYPE_TNC_ICTL1 |
| 14 | DNC_SW_TYPE_TNC_ICTL2 |
| 15 | DNC_SW_TYPE_TNC_ICTL3 |
| 16 | DNC_SW_TYPE_TNC_OPT |
| 17 | DNC_SW_TYPE_TNC_OTHER |
| 18 | DNC_SW_TYPE_UNKNOWN |
| 19 | DNC_SW_TYPE_NCKERN |
| 20 | DNC_SW_TYPE_FCL |
| 21 | DNC_SW_TYPE_SPLC |
| 22 | DNC_SW_TYPE_FS_MCU |
| 23 | DNC_SW_TYPE_FS_CCU |
Errors
Property Errors (JSONArray). The complete list of errors currently active on the control. The whole list is sent again every time it changes; an empty array [] means there are no active errors.
| Field | Type | Description |
|---|---|---|
Number | Integer | Error number. |
NumberAsText | String | Error number as shown on the control. |
Text | String | Short error text. |
Description | String | Extended error description. |
Cause | String | Possible cause of the error. |
Action | String | Suggested action to resolve the error. |
Internals | String | Internal information for HEIDENHAIN or machine builder service. |
Channel | Integer | NC channel that raised the error. |
TimeStamp | Object | Time the error occurred, as { "Seconds": <Unix time>, "Nanos": <nanoseconds> } in UTC. |
Handle | Integer | Identifier of the error entry on the control. |
Location | Integer | Where the error is shown. See Error location. |
Group | Integer | Error group. See Error group. |
Class | Integer | Error class (severity / reaction). See Error class. |
[
{
"Cause": "...",
"Action": "...",
"Internals": "...",
"NumberAsText": "1000-0123",
"Number": 123,
"Channel": 0,
"Text": "...",
"Description": "...",
"TimeStamp": { "Seconds": 1793786400, "Nanos": 0 },
"Handle": 5,
"Location": 1,
"Group": 3,
"Class": 1
}
]
Error location
| Number | Value | Description |
|---|---|---|
| 0 | DNC_ERROR_LOCATION_NONE | No location. |
| 1 | DNC_ERROR_LOCATION_MACHINE | Machine operating mode. |
| 2 | DNC_ERROR_LOCATION_EDIT | Programming (edit) mode. |
| 3 | DNC_ERROR_LOCATION_OEM | OEM (machine builder) window. |
Error group
| Number | Value | Description |
|---|---|---|
| 0 | DNC_EG_NONE | No group. |
| 1 | DNC_EG_OPERATING | Operating error. |
| 2 | DNC_EG_PROGRAMING | Programming error. |
| 3 | DNC_EG_PLC | PLC error (machine builder). |
| 4 | DNC_EG_GENERAL | General error. |
| 5 | DNC_EG_REMOTE | Remote error. |
| 6 | DNC_EG_PYTHON | Python error. |
Error class
| Number | Value | Description |
|---|---|---|
| 0 | DNC_EC_NONE | No class. |
| 1 | DNC_EC_WARNING | Warning. The program continues. |
| 2 | DNC_EC_FEEDHOLD | Feed hold. The feed rate is stopped. |
| 3 | DNC_EC_PROGRAMHOLD | Program hold. The program run is interrupted. |
| 4 | DNC_EC_PROGRAMABORT | Program abort. The program run is aborted. |
| 5 | DNC_EC_EMERGENCY_STOP | Emergency stop. |
| 6 | DNC_EC_RESET | Reset. The control must be restarted. |
| 7 | DNC_EC_INFO | Information message. |
| 8 | DNC_EC_ERROR | Error. |
| 9 | DNC_EC_NOTE | Note. |
NC Type
Connection setting NC Type. Select the value that matches the HEIDENHAIN control. The default is ITNC.
| Value | Number | Control |
|---|---|---|
ATEKM | 0 | ATEK M |
ITNC | 1 | iTNC 530 |
MILLPLUS | 2 | MillPlus |
MILLPLUSIT | 3 | MillPlusIT |
TURNPLUS | 4 | TurnPlus |
MILLPLUSIT_NCK | 5 | MillPlusIT V600 and later (NCK-based) |
MANUALPLUS_NCK | 6 | MANUALplus 620 |
ATEKM_NCK | 7 | ATEK M (NCK-based) |
TNC320_NCK | 8 | TNC 320 |
GRINDPLUS_NCK | 9 | GrindPlus (NCK-based) |
TNC6xx_NCK | 10 | TNC 640, TNC 620 |
AR6000_NCK | 11 | AR 6000 |
CNCPILOT6xx_NCK | 12 | CNC PILOT 640 |
TNC128_NCK | 13 | TNC 128 |
GRINDPLUS640_NCK | 14 | GrindPlus 640 |
TNC7_NCK | 15 | TNC7 |