Skip to main content

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.

NameAddressTypeCategoryValue
NC UptimeNcUptimeIntUptimeTime the NC software has been running, in seconds.
Machine UptimeMachineUptimeIntUptimeTime the machine has been powered on, in seconds.
Machine Running TimeMachineRunningTimeIntUptimeTime the machine has been executing programs, in seconds.
StateStateStringStateConnection/machine state. See State.
Cutter LocationsCutterLocationsJSONCutter LocationsAxis positions of channel 0. See Cutter Locations.
Execution ModeExecutionModeStringExecution ModeActive operating mode. See Execution Mode.
Current CallCurrentCallStringExecution StackPath of the program currently being called, e.g. TNC:\nc_prog\part.h.
Program PositionProgramPositionJSONArrayExecution StackProgram call stack. See Program Position.
Program StatusProgramStatusStringProgram StatusStatus of the selected NC program. See Program Status.
COM Interface VersionComInterfaceVersionStringIdentificationVersion of the HEIDENHAIN DNC COM interface.
SIKSikStringIdentificationSerial number of the System Identification Key (SIK) of the control.
Software Version ListSoftwareVersionListJSONArrayIdentificationInstalled software components. See Software Version List.
Feed OverrideFeedOverrideIntOverride InfoFeed rate override as reported by the control.
Speed OverrideSpeedOverrideIntOverride InfoSpindle speed override as reported by the control.
Rapid OverrideRapidOverrideIntOverride InfoRapid traverse override as reported by the control.
ErrorsErrorsJSONArrayError ListActive errors on the control. See Errors.

:::note Data formats

  • String enum properties (State, ExecutionMode, ProgramStatus) contain the HEIDENHAIN enum name, for example DNC_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.

ValueNumberDescriptionConnector health
DNC_EVT_STATE_NOT_INITIALIZED-1No state received yet. Initial value inside the connector.Transient
DNC_EVT_STATE_HOST_NOT_AVAILABLE0The control cannot be reached on the network.Error
DNC_EVT_STATE_HOST_AVAILABLE1The control is reachable; the DNC connection is being set up.Transient
DNC_EVT_STATE_WAIT_PERMISSION2Waiting for the control to grant DNC access.Transient
DNC_EVT_STATE_DNC_AVAILABLE3The DNC server on the control is available.Transient
DNC_EVT_STATE_MACHINE_BOOTED4The control software has booted.Transient
DNC_EVT_STATE_MACHINE_INITIALIZING5The NC software is initializing.Transient
DNC_EVT_STATE_MACHINE_AVAILABLE6The machine is fully available. All data interfaces can be read.Operational
DNC_EVT_STATE_MACHINE_SHUTTING_DOWN7The control is shutting down.Transient
DNC_EVT_STATE_DNC_STOPPED8The DNC server on the control was stopped.Error
DNC_EVT_STATE_HOST_STOPPED9The control was stopped.Error
DNC_EVT_STATE_CONNECTION_LOST10The connection to the control was lost.Error
DNC_EVT_STATE_PERMISSION_DENIED11The 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.

ValueNumberDescription
DNC_EXEC_MANUAL0Manual operation.
DNC_EXEC_MDI1Positioning with Manual Data Input (MDI).
DNC_EXEC_RPF2Traversing the reference points.
DNC_EXEC_SINGLESTEP3Program run, single block.
DNC_EXEC_AUTOMATIC4Program run, full sequence.
DNC_EXEC_OTHER5Any other mode, for example programming or test run.
DNC_EXEC_HANDWHEEL6Electronic handwheel mode.
DNC_EXEC_SIMULO_TURBO_DEPRECATED-1Deprecated. Treat as DNC_EXEC_OTHER.

Program Status​

Property ProgramStatus (String). The status of the NC program selected in the program run modes.

ValueNumberDescription
DNC_PRG_STS_IDLE0A program is selected but not started.
DNC_PRG_STS_RUNNING1The program is running.
DNC_PRG_STS_STOPPED2The program is stopped, for example with NC stop.
DNC_PRG_STS_INTERRUPTED3The program was interrupted (aborted).
DNC_PRG_STS_FINISHED4The program has finished.
DNC_PRG_STS_ERROR5The program stopped because of an error.
DNC_PRG_STS_NOT_SELECTED6No program is selected.

Cutter Locations​

Property CutterLocations (JSON). An array with one entry per axis of channel 0.

FieldTypeDescription
IsInchBooleantrue when the position is in inch, false when it is in mm (or degrees for rotary axes).
CoordinateNameStringAxis name, for example X, Y, Z, B, C.
PositionNumberCurrent 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.

FieldTypeDescription
ProgramNameStringFull path of the program on this level.
BlockNumberIntegerNumber of the current NC block in this program.
BlockContentStringContent of the current NC block.
CallStackLevelIntegerLevel 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.

FieldTypeDescription
SoftwareTypeIntegerSoftware component type. See the table below.
DescriptionStringDescription of the component as reported by the control.
IdentNrStringHEIDENHAIN ID number and version of the component.
[
{ "SoftwareType": 0, "Description": "NC software", "IdentNr": "817625 18" }
]

Software types​

NumberValue
0DNC_SW_TYPE_MC
1DNC_SW_TYPE_CC
2DNC_SW_TYPE_PLC
3DNC_SW_TYPE_MP_UIMS
4DNC_SW_TYPE_MP_ADMS
5DNC_SW_TYPE_TNC_MODEL
6DNC_SW_TYPE_TNC_SG
7DNC_SW_TYPE_TNC_DSP1
8DNC_SW_TYPE_TNC_DSP2
9DNC_SW_TYPE_TNC_DSP3
10DNC_SW_TYPE_TNC_DSPSG1
11DNC_SW_TYPE_TNC_DSPSG2
12DNC_SW_TYPE_TNC_DSPSG3
13DNC_SW_TYPE_TNC_ICTL1
14DNC_SW_TYPE_TNC_ICTL2
15DNC_SW_TYPE_TNC_ICTL3
16DNC_SW_TYPE_TNC_OPT
17DNC_SW_TYPE_TNC_OTHER
18DNC_SW_TYPE_UNKNOWN
19DNC_SW_TYPE_NCKERN
20DNC_SW_TYPE_FCL
21DNC_SW_TYPE_SPLC
22DNC_SW_TYPE_FS_MCU
23DNC_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.

FieldTypeDescription
NumberIntegerError number.
NumberAsTextStringError number as shown on the control.
TextStringShort error text.
DescriptionStringExtended error description.
CauseStringPossible cause of the error.
ActionStringSuggested action to resolve the error.
InternalsStringInternal information for HEIDENHAIN or machine builder service.
ChannelIntegerNC channel that raised the error.
TimeStampObjectTime the error occurred, as { "Seconds": <Unix time>, "Nanos": <nanoseconds> } in UTC.
HandleIntegerIdentifier of the error entry on the control.
LocationIntegerWhere the error is shown. See Error location.
GroupIntegerError group. See Error group.
ClassIntegerError 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​

NumberValueDescription
0DNC_ERROR_LOCATION_NONENo location.
1DNC_ERROR_LOCATION_MACHINEMachine operating mode.
2DNC_ERROR_LOCATION_EDITProgramming (edit) mode.
3DNC_ERROR_LOCATION_OEMOEM (machine builder) window.

Error group​

NumberValueDescription
0DNC_EG_NONENo group.
1DNC_EG_OPERATINGOperating error.
2DNC_EG_PROGRAMINGProgramming error.
3DNC_EG_PLCPLC error (machine builder).
4DNC_EG_GENERALGeneral error.
5DNC_EG_REMOTERemote error.
6DNC_EG_PYTHONPython error.

Error class​

NumberValueDescription
0DNC_EC_NONENo class.
1DNC_EC_WARNINGWarning. The program continues.
2DNC_EC_FEEDHOLDFeed hold. The feed rate is stopped.
3DNC_EC_PROGRAMHOLDProgram hold. The program run is interrupted.
4DNC_EC_PROGRAMABORTProgram abort. The program run is aborted.
5DNC_EC_EMERGENCY_STOPEmergency stop.
6DNC_EC_RESETReset. The control must be restarted.
7DNC_EC_INFOInformation message.
8DNC_EC_ERRORError.
9DNC_EC_NOTENote.

NC Type​

Connection setting NC Type. Select the value that matches the HEIDENHAIN control. The default is ITNC.

ValueNumberControl
ATEKM0ATEK M
ITNC1iTNC 530
MILLPLUS2MillPlus
MILLPLUSIT3MillPlusIT
TURNPLUS4TurnPlus
MILLPLUSIT_NCK5MillPlusIT V600 and later (NCK-based)
MANUALPLUS_NCK6MANUALplus 620
ATEKM_NCK7ATEK M (NCK-based)
TNC320_NCK8TNC 320
GRINDPLUS_NCK9GrindPlus (NCK-based)
TNC6xx_NCK10TNC 640, TNC 620
AR6000_NCK11AR 6000
CNCPILOT6xx_NCK12CNC PILOT 640
TNC128_NCK13TNC 128
GRINDPLUS640_NCK14GrindPlus 640
TNC7_NCK15TNC7