Other Tool.

匯出日期：2025-03-06
修改日期：2020-09-16
 机床产品/Machine Tool Products
–
Other Tool.

• OKLogReader Operation Manual(CHT)

• Instruction of Remote Monitoring Application.
• SBTool Operation Manual
• Data Aggregators Application Manual
• Macro Editor Operation Manual
• AutoInitializer Operation Manual
• USB Backup Operation Manual
• USB Setup/Backup/Setting Operation Manual
• RemoteAPI Operation Manual.
• OS Transformation Tool Operation Manual
• AutoUpgrade Guidance
• Open Actions List
• AutoSDUpgrade_2021 Manual.
• AutoSDUpgrade_2022 Manual.
• FixFontFile Manual

–2
 机床产品/Machine Tool Products
–
Other Tool.

1 OKLogReader Operation Manual(CHT)

OKLogReader 操作手册

1.1 Operation Log Reader Operation Manual

1.1.1 Purpose
The operation log reader can record the user's keystrokes when operating the machine, which can help the
Machinery electrical control staff or customer service staff for troubleshooting.

1.1.2 Version Definition

Controller
• New version: 10.118.24B, 10.118.25B, 10.118.28O, 10.118.38 and above.
• Old version: Versions other than the new versions.

OKLogReader
• New version: Version 3.0.0 and above.
• Old version: versions other than the new versions.

1.1.3

How to Use

Controller-Operation Log Reader

Directory
5 Key
• ARM - F10 Next → F2 Diag. → F4 Operation Log
• X86 - F10 Next → F2 Diag. → F10 Next → F4 About → F2 Operation Log
8 Key
• ARM - F10 Next → F2 Diag. → F4 Operation Log
• X86 - F7 Diag. → F8 System manager → F6 About → F2 Operation Log

Screen Description
1. Each record shows the [Number] and [record data]. Order number 1 is the latest record.
2. Each page displays 80 records, and you can use PageUp/PageDown to see later or earlier records.
3. DOS displays up to 12 pages, while CE has no page limit.
4. Whenever you re-enter the history page, it will be updated to the latest record when you "entering the
history page".

OKLogReader Operation Manual(CHT) – 3

 机床产品/Machine Tool Products
–
Other Tool.

Basic Operations

Export Operation Logs

• They can be exported to USB disks as file name OPLOG.0, OPLOG.1, and OPLOG.2. The file name OPLOG.0 is
the latest record.
• File switch mechanism: When OPLOG.0 is full, the data in OPLOG.0 and OPLOG.1 will be moved to OPLOG.1
and OPLOG.2 (the data in OPLOG.2 will be overwritten and the system will rewrite OPLOG.0).
• The records occupy 4~6M and retain up to 1,536,000 strokes at most (buffer of 512,000 strokes).

Find Date Time

• Input format: yyyymmdd or yyyymmddhm.
• If entering 20110815, it will jump to the first record on August 15, 2011.
• If entering 201108151300, it will jump to the first record after 13:00 on August 15, 2011.
• Click "Previous" to jump to the previous timestamp.
• Click "Next" to jump to the next timestamp.
• If the input format is incorrect, a messagebox "format wrong!" will pop up.

Find Alarm
• Input format: alarm ID + alarm number.
• If entering MOT11, it will jump to where the first alarm MOT11 record is.
• If the input format is incorrect, a messagebox "format wrong!" will pop up.

Find I-Bit
• Input format: I + number.
• If entering I88, it will jump to where the first I88 ON record is.

PC - Log Reader

Download
To download the log reader, please go to SYNTEC official website → Customer Support → Software Download →
04. Application Tool → OKLogReader.

OKLogReader Operation Manual(CHT) – 4

 机床产品/Machine Tool Products
–
Other Tool.

We recommend downloading version 3.0.0 and above. Please refer to" Version Matching and Display Specifications"
for compatibility notes.

Basic Operations

• Note: OKLogReader displays the old record first and then the new record, in the opposite order of the
controller.
This operation is for OKLogReader to display operation logs and data logs in a consistent manner.
• Filtering: "Full Log" displays all operation logs, while "Alarm", "I-Bit" (second panel), "First Panel Key
Log" (first panel), and "Action" can be filtered by multiple criteria.
• Jump to the previous/next identical value: After selecting a row in the list, pressing F3 can jump to the next
row with the same RawData value, and Shift + F3 to the previous one.

OKLogReader Operation Manual(CHT) – 5

 机床产品/Machine Tool Products
–
Other Tool.

• Searching: Press "Search Log" to bring up the search window. Fill in the criteria, then press "FindNext" to
start searching from the highlighted row. It will highlight and jump to the latest record that meets the
criteria. If you want to search for the previous one, you can check the "Upwards" box on the right before
searching.
• Search DateTime: The input format is yyyymmdd or yyyymmddhm. E.g. 20150213 or 201502130900
• Search Alarm: The input format is Alarm ID+Alarm Number. E.g. MOT18
• Search I-Bit: The input format is Alarm ID+Alarm Number. E.g. I66
• Search Action: Refer to Appendix I for detailed human-machine action input format. E.g. S_MMach
• Search RawData: Refer to Appendix II for detailed RawData input format. E.g. 0x100500BC
• Search Index: The input format is Index number. E.g. 123
• Search OPLog: The input format is OPLog string name, and it can be searched with part of the string
(case as different strings). E.g. StartUp

1.1.4 Recordable data

After LogReader 4.9.0, logs will display the date for each entry regardless of the controller version. For
operations that record the date listed below, the actual date will be shown, while for the others, the date will be
"estimated."

New Version Old Version

• New version means that the controller version is 10.118.24B, 10.118.25B, 10.118.28O, 10.118.38 or above.
• In the new versions, an additional timestamp will be recorded for all operations.

OKLogReader Operation Manual(CHT) – 6

 机床产品/Machine Tool Products
–
Other Tool.

Data Display Format Example

Boot An additional timestamp will be recorded.

Format: StartUp.
No Data

1 17:07:58

2 11/04/15

3 17:07:58

4 StartUp

Date Font is yellow.

No Data
Format: [Year]/[Month]/[Day].
1 11/04/15

Time Font is yellow.

No Data
Format: [Hour]:[Minute]:[Second].
1 17:07:58

OKLogReader Operation Manual(CHT) – 7

 机床产品/Machine Tool Products
–
Other Tool.

Data Display Format Example

Alarm Font is red.

Format: [ClassID]/[AlarmID] + [ObjectID].
No Data

1 17:07:58

2 COR21

OKLogReader Operation Manual(CHT) – 8

 机床产品/Machine Tool Products
–
Other Tool.

Data Display Format Example

ClassID:

COM: Syntax Compiler Alarm

COR: Program Execute Error Alarm
MAR: MACRO Alarm
MOT: Axial Motion Alarm
OP: Operation Alarm
PLC: PLC Alarm
PLCH: PLC Hint
SPD: Spindle Alarm
MSG: Macro Message
SERVO: Servo Alarm
M2Yas: M2 Yaskawa Alarm
M2Syn: M2 SYNTEC Alarm
M3Yas: M3 Yaskawa Alarm
M3Syn: M3 SYNTEC Alarm
SPLCA: Serial PLC Axis Alarm
SRI: SRI Alarm
BGND: Background Execute Alarm
ROT: ROT Turret Alarm
LASER: Laser Alarm
ECAT_D: Delta ECAT Alarm
ECAT_P_A: Panasonic ECAT Alarm
ECAT_P_W: Panasonic ECAT Warning
RBT: Robot Alarm
RBTWRN: Robot Warning
RBTCRI: Robot Critical
INVTA: Inventor ECAT Alarm
INVTW: Inventor ECAT Warning
ECAT_SynStep_A: Syntec ECAT Step Alarm
ECAT_SynStep_W: Syntec ECAT Step
Warning

OKLogReader Operation Manual(CHT) – 9

 机床产品/Machine Tool Products
–
Other Tool.

Data Display Format Example

ClassID:

ECAT_Syn_A: Syntec ECAT Alarm

ECAT_Syn_W: Syntec ECAT Warning

ObjectID: Axis, the default value is 1.

• OKLogReader

before 4.9.0 4.9.0~

[ClassID]/ [ClassID]/[AlarmID] +
[AlarmID] + [ObjectID] [alarm
[ObjectID] string]
(start from SI and
has multilingual files
in MB/SB)

PLC Bit • Display format

• Controller
(I-bit)
• The format is one of the No Data
following:
1. [PLC Bit
Name]_[on/off] 1 17:07:58
2. The name of the
second panel 2 I63 On
keypad defined
in LogTable
• OKLogReader
• before 4.8.0~
4.8.0 1 17:07:58

I{ Num I{ Num } 2 Jog

} ={ Value },
={ Valu { Comme
e} nt }

OKLogReader Operation Manual(CHT) – 10

 机床产品/Machine Tool Products
–
Other Tool.

Data Display Format Example

C-bit Display format is same as I-bit, only C0

(CycleStart), C1 (FeedHold), C36 (Emergency
Stop) are recorded. N Data
o

1 17:07:58

2 CycleStart On

Parameter Input Format: Param [parameter number] Modified.

N Data
o

1 17:07:58

2 Param3205Modified

Tool Compensation Input Format: [Tool number]. [Tool compensation

form]( [Axis number] ).
N Data
Note: Only the wear and tool length of lathe
o
have axis number. The number is the axis of
the controller parameters, not the line on the
screen. 1 17:07:58

2 MillLengthGeometry
Modified

Workpiece Input

No Data

1 17:07:58

2 G54Modified

OKLogReader Operation Manual(CHT) – 11

 机床产品/Machine Tool Products
–
Other Tool.

Data Display Format Example

Key Format: [key name]. Please refer to

Operational Reader Keyboard Key Code Table
for detailed key description. No Data

1 17:07:58

2 Escape

CE Human-Machine Action The format is one of the following:

1. "[" CRC value of the Action name "]"
No Data
2. Action name defined in
MMIActionTable.xml.
If parameter 3251=0 (non-touch screen), only 1 17:07:58
actions "Back to home screen, Program,
Execute, Alarm, Parameter Setting, 2 [56337]
Diagnostics" will be recorded.
If parameter 3251!=0 (touch screen), all
actions will be recorded.

Action Record 1 17:07:58

S_MMach: Back to home screen 2 S_MMach

S_MProg: Program
S_MRun: Execute
S_MAlarm: Alarm
S_MParam: Parameter Setting
S_MDiag: Diagnostics

OKLogReader Operation Manual(CHT) – 12

 机床产品/Machine Tool Products
–
Other Tool.

Data Display Format Example

Home Searching Triggering:

• When C25~C28 and C230~C241
No Data
switches to On.
• Display format: Same as IBit
• When using the human-machine 1 17:07:58
screen for serial absolute type home
setting.
• Format: AbsHome_Axis 2 C25 On
number.
Available in controller versions 10.116.16H,
10.116.24A, OpLog Reader version 1.1.0.
1 17:07:58

2 AbsHome 1

User Change There are two records for one login or logout:
• One records the authority of login or
No Data
logout. (corresponds R5997)
• SyntecLogIn
• MakerLogIn 1 14:48:15
• AdminLogIn
• OtherLogIn
• LogOut 2 AdminLogIn
• The other one records the user name.
• Format: "User[CRC value of the 3 14:48:15
user name]".

4 User16320

OKLogReader Operation Manual(CHT) – 13

 机床产品/Machine Tool Products
–
Other Tool.

Data Display Format Example

ForceIO Action • DisplayFormat :

N Data
• Controller
o
• OPLo Trigger
g recording
1 14:48:15
conditions

2 EnterForceIO
EnterF Enter
orceIO ForceIO
mode 3 14:48:15

ExitFo Exit 4 ExitForceIO

rceIO ForceIO
mode
5 14:48:15

{ I bit Using
name ForceIO 6 I123ForceOff
} function to
Force force the I 7 14:48:15
Off bit Off

8 I123ForceOn
{ I bit Using
name ForceIO
} function to 9 14:48:15
Force force the I
On bit On 10 O123ForceOff

{ O bit Using 11 14:48:15

name ForceIO
} function to
Force force the O 12 O123ForceOn
Off bit Off
13 14:48:15
{ O bit Using
name ForceIO
14 ReleasI123
} function to
Force force the O
On bit On 15 14:48:15

16 ReleasO123

OKLogReader Operation Manual(CHT) – 14

 机床产品/Machine Tool Products
–
Other Tool.

Data Display Format Example

OPLo Trigger
g recording
conditions

Releas Releasi
e{ I bit ng the
name ForceIO
} state
of I
bit

Releas Releasi
e{ O ng the
bit ForceIO
name state
} of O
bit

• OKLogReader
• 3.6.0~ 4.8.0~
4.8.0

{ Ibit refer
name } to PLC
Force related
Off records
display
{ Ibit
name }
Force
On

{ Obit
name }
Force
Off

{ Obit
name }
Force
On

OKLogReader Operation Manual(CHT) – 15

 机床产品/Machine Tool Products
–
Other Tool.

Data Display Format Example

3.6.0~ 4.8.0~
4.8.0

Releas
e{ Ibit
name }

Releas
e{ Obit
name }

Available in controller versions: 10.118.32D,

10.118.40H, 10.118.45 or above.

New Version Old Version

• Old version refers to versions other than the new versions.

Data Display Format Example

Boot Record 3 records 1. 17:07:58

2. 11/04/15
Including StartUp, Date, Time.
3. StartUp

Date Font is Yellow. 11/04/15

Format:[Year]/[Month]/[Day]

Time Font is Yellow. 17:07:58

Format:[Hour]/[Minute]/[Second]

OKLogReader Operation Manual(CHT) – 16

 机床产品/Machine Tool Products
–
Other Tool.

Data Display Format Example

Alarm Font is red. 1. 17:07:58

2. COR21
Including Alarm info, Time.
The alarm info contains [ClassID]/[AlarmID] +
[ObjectID].
After version 4.9.0, if SI is enabled and a
corresponding resmap file exists in the
environment, an additional alarm string will
be displayed.

ClassID:

COM: Syntax Compiler Alarm

COR: Program Execute Error Alarm
MAR: MACRO Alarm
MOT: Axial Motion Alarm
OP: Operation Alarm
PLC: PLC Alarm
PLCH: PLC Hint
SPD: Spindle Alarm
MSG: Macro Message
SERVO: Servo Alarm
M2Yas: M2 Yaskawa Alarm
M2Syn: M2 SYNTEC Alarm
M3Yas: M3 Yaskawa Alarm
M3Syn: M3 SYNTEC Alarm
SPLCA: Serial PLC Axis Alarm
SRI: SRI Alarm
BGND: Background Execute Alarm
ROT: ROT Turret Alarm
LASER: Laser Alarm

ObjectID: Axis, the default value is 1.

• OKLogReader

OKLogReader Operation Manual(CHT) – 17

 机床产品/Machine Tool Products
–
Other Tool.

Data Display Format Example

before 4.9.0 4.9.0~

[ClassID]/ [ClassID]/[AlarmID] +
[AlarmID] + [ObjectID] [alarm
[ObjectID] string]
(start from SI and
has multilingual files
in MB/SB)

PLC Bit The format is one of the following: 1. I63 On

2. Jog
(I-bit) 1. [PLC Bit Name]_[on/off]
2. The name of the second panel keypad
defined in LogTable

C-bit Same as I-bit, only C0 (CycleStart), C1 1. CycleStart On

(FeedHold), C36 (Emergcy Stop) are recorded.

Parameter Input Format: Param [parameter number] Modified. 1. Param3205Modified

Tool Compensation Input Format: [Tool number]. [Tool compensation 1. MillLengthGeometry

form]( [Axis number] ). Modified
Note: Only the wear and tool length of lathe
have axis number. The number is the axis of
the controller parameters, not the line on the
screen.

Workpiece Input 1. G54Modified

Key Format: [key name]. Please refer to 1. Esc

Operational Reader Keyboard Key Code Table
for detailed key description.

OKLogReader Operation Manual(CHT) – 18

 机床产品/Machine Tool Products
–
Other Tool.

Data Display Format Example

CE Human-Machine Action The format is one of the following: 1. [56337]

2. S_MMach
1. "[" CRC value of the Action name "]"
2. Action name defined in
MMIActionTable.xml.
If parameter 3251=0 (non-touch screen), only
actions "Back to home screen, Program,
Execute, Alarm, Parameter Setting,
Diagnostics" will be recorded.
If parameter 3251!=0 (touch screen), all
actions will be recorded.

Action Record

S_MMach: Back to home screen

S_MProg: Program
S_MRun: Execute
S_MAlarm: Alarm
S_MParam: Parameter Setting
S_MDiag: Diagnostics

Home Searching Triggering: 1. xx：xx：xx

C25 On
• When C25~C28 and C230~C241
2. xx：xx：xx
switches to On, it will record the event
AbsHome 1
and timestamp.
• Format: "C bit name"_On.
• When using the human-machine
screen for serial absolute type home
setting.
• Format: AbsHome_Axis
number.
Available in controller versions 10.116.16H,
10.116.24A
OpLog Reader version 1.1.0.

1.1.5 Notes
1. PC simulator: Operation Log is currently not supported.
2. CE controller: Available in versions 10.115.29, 114.23 and above.
3. DOS controller: Available in versions 10.115.42, 114.37 and above.

OKLogReader Operation Manual(CHT) – 19

 机床产品/Machine Tool Products
–
Other Tool.

4. The operation log reader can only be enabled on models supporting FRAM (models without FRAM: SUPER
with PIO3/PIO4 or versions before PIO5 v5.5).
5. Please refer to the "Parameter Setting Instruction Manual" to set parameter 5 correctly. If it is set incorrectly,
the operation log function will not be enabled properly.

1.1.6 Version Matching and Display Specifications

• Software compatibility is guaranteed whether you use a new version of OKLogReader with an older version
of the controller or an older version of OKLogReader with a newer version of the controller.
• The display manners are listed below. We recommend using the new version of OKLogReader for better
display friendliness.

Controller New Version Controller Old Version

(10.118.24B, 10.118.25B, 10.118.28O,
10.118.38 and above)

OKLogReader
New Version
(3.0.0 and above)

OKLogReader Operation Manual(CHT) – 20

 机床产品/Machine Tool Products
–
Other Tool.

OKLogReader
Old Version

• After OKLogReader version 4.8.0:

• Action related records display
• The 'Description' column was added and the 'Raw data' column was hidden.：
Before 4.8.0 After 4.8.0

The action names and menu names need standard environment data to be
displayed.
You need to load MB/SB through SI and download the standard environment
data, then open OKLogReader to see the information above.
For more details: Syntec IDE Operation Manual. > SI Operation steps

• PLC related records display

• When displaying PLC related operation records, if the user has defined short comments in lad
file, display them after the data.
1. IBit On/Off
2. Specific Cbit On (C25~C28、C230~C241)

OKLogReader Operation Manual(CHT) – 21

 机床产品/Machine Tool Products
–
Other Tool.

3. ForceIO On/Off/Release
• The short comments will only be displayed in the OKLogReader under the following scenarios:
1. Opening MB, and the target MB contains a backup ladder (cnc.lad).
2. Opening SB.
3. Using SI to read MB/SB and then opening.
• Before 4.8.0 After 4.8.0

1.1.7 Operational Reader Keyboard Key Code Table

常用面板Key Code Key Code总表

Often-used screen Key Code table

Screen Key Code Screen Key Code Screen Key Code

button button button

CNCPosition Home 0

CNCProgram End 1

CNCGraphTea BackSpace 2
ch

CNCMonitor Insert 3

CNCAlarm Delete 4

OKLogReader Operation Manual(CHT) – 22

 机床产品/Machine Tool Products
–
Other Tool.

Screen Key Code Screen Key Code Screen Key Code

button button button

CNCGraphTea PageUp 5
ch

CNCHelp PageDown 6

CNCReset Space 7

Add / + Enter 8

Substract / - Up 9

\ Down .

; Left Divde or /

, Right A~Z键 A~Z

OKLogReader Operation Manual(CHT) – 23

 机床产品/Machine Tool Products
–
Other Tool.

常用面板Key Code Key Code总表

下表为目前会显示支援的OPLog键盘Key值
Below table is the current supported OPLog keyboard Key value

V Name instr V Na 说明 V Name 说明 V Name 说明

a uctio a me a a
l n l l l
u u u u
e e e e

0 None No 6 A A 1 F19 F19 1

butto 5 3 9
n is 0 5
press
ed

1 LButto Left 6 B B 1 F20 F20 1

n click 6 3 9
of 1 6
mous
e

2 RButto Right 6 C C 1 F21 F21 1

n click 7 3 9
of 2 7
mous
e

OKLogReader Operation Manual(CHT) – 24

 机床产品/Machine Tool Products
–
Other Tool.

3 Cancel CANC 6 D D 1 F22 F22 1

EL 8 3 9
3 8

4 MButto Middl 6 E E 1 F23 F23 1

n e 9 3 9
click 4 9
of
mous
e(thr
ee-
butto
n
mous
e)

5 XButto First 7 F F 1 F24 F24 2

n1 X 0 3 0
click 5 0
of
mous
e(five
-butt
on
mous
e)

6 XButto Seco 7 G G 1 2
n2 nd X 1 3 0
click 6 1
of
mous
e(five
-butt
on
mous
e)

7 7 H H 1 2
2 3 0
7 2

8 BackSp BACK 7 I I 1 2
ace SPAC 3 3 0
E 8 3

OKLogReader Operation Manual(CHT) – 25

 机床产品/Machine Tool Products
–
Other Tool.

9 Tab TAB 7 J J 1 2
4 3 0
9 4

1 LineFe LINEF 7 K K 1 2
0 ed EED 5 4 0
0 5

1 7 L L 1 2
1 6 4 0
1 6

1 Clear CLEA 7 M M 1 2
2 R 7 4 0
2 7

1 Enter ENTE 7 N N 1 2
3 R 8 4 0
3 8
Return RETU
RN

1 7 O O 1 NumLoc NUM LOCK 2

4 9 4 k 0
4 9

1 8 P P 1 Scroll SCROLL 2
5 0 4 LOCK 1
5 0

1 ShiftKe SHIFT 8 Q Q 1 2
6 y 1 4 1
6 1

1 Control CTRL 8 R R 1 2
7 Key 2 4 1
7 2

1 Menu ALT 8 S S 1 2
8 3 4 1
8 3

OKLogReader Operation Manual(CHT) – 26

 机床产品/Machine Tool Products
–
Other Tool.

1 Pause PAUS 8 T T 1 2
9 E 4 4 1
9 4

2 CapsLo CAPS 8 U U 1 2
0 ck LOCK 5 5 1
0 5
Capital

2 KanaM IME 8 V V 1 2
1 ode Kana 6 5 1
mode 1 6
key

Hangu IME
elMode Hang
uel
mode
key

Hangul IME
Mode Hang
ul
mode
key

2 8 W W 1 2
2 7 5 1
2 7

2 JunjaM IME 8 X X 1 2
3 ode Junja 8 5 1
mode 3 8
key

2 FinalM IME 8 Y Y 1 2 Oem4 OEM 4

4 ode final 9 5 1 key
mode 4 9
key

OKLogReader Operation Manual(CHT) – 27

 机床产品/Machine Tool Products
–
Other Tool.

OemOp OEM
enBrack open
ets bracket
key on
a US
standar
d
keyboar
d

2 KanjiM IME 9 Z Z 1 2 Oem5 OEM 5

5 ode Kanji 0 5 2 key
mode 5 0
key

HanjaM IME OemPip OEM

ode Hanja e pipe
mode key on
key a US
standar
d
keyboar
d

2 9 LWi left 1 2 Oem6 OEM 6

6 1 n Wind 5 2 key
ows 6 1
logo
OemClo OEM
key
seBrack close
ets bracket
key on
a US
standar
d
keyboar
d

2 Escape ESC 9 RWi right 1 2 Oem7 OEM 7

7 2 n Wind 5 2 key
ows 7 2
logo
key

OKLogReader Operation Manual(CHT) – 28

 机床产品/Machine Tool Products
–
Other Tool.

OemQu OEM
otes singled/
double
quote
key on
a US
standar
d
keyboar
d

2 IMECon IME 9 Ap appli 1 2 Oem8 OEM 8

8 vert conve 3 ps catio 5 2 key
rt key n key 8 3

2 IMENo IME 9 1 2
9 nconve nonc 4 5 2
rt onver 9 4
t key

3 IMEAce IME 9 Sle com 1 LShiftKe left SHIFT 2

0 ept accep 5 ep pute 6 y 2
t key r 0 5
sleep
key

3 IMEMo IME 9 Nu Num 1 RShiftKe right 2 Oem102 OEM

1 deCha mode 6 mP ber 6 y SHIFT 2 102 key
nge chan ad0 Pad 1 6
ge 0
OemBa OEM
key
ckslash angle
bracket
or
backsla
sh key
on the
RT 102
key
keyboar
d

3 Space SPAC 9 Nu Num 1 LContro left CTRL 2

2 EBAR 7 mP ber 6 lKey 2
ad1 Pad 2 7
1

OKLogReader Operation Manual(CHT) – 29

 机床产品/Machine Tool Products
–
Other Tool.

3 PageU PAGE 9 Nu Num 1 RContro right CTRL 2

3 p UP 8 mP ber 6 lKey 2
ad2 Pad 3 8
2

3 PageD PAGE 9 Nu Num 1 LMenu left ALT 2 Process PROCE

4 own DOW 9 mP ber 6 2 Key SS KEY
N ad3 Pad 4 9
3

3 End END 1 Nu Num 1 RMenu right ALT 2

5 0 mP ber 6 3
0 ad4 Pad 5 0
4

3 Home HOM 1 Nu Num 1 Browser browser 2

6 E 0 mP ber 6 Back back key 3
1 ad5 Pad 6 1
5

3 Left LEFT 1 Nu Num 1 Browser browser 2

7 ARRO 0 mP ber 6 Forward forward 3
W 2 ad6 Pad 7 key 2
6

3 Up UP 1 Nu Num 1 Browser browser 2 CNCRes CNC

8 ARRO 0 mP ber 6 Refresh refresh 3 et Reset
W 3 ad7 Pad 8 key 3
7

3 Right RIGH 1 Nu Num 1 Browser browser 2 CNCPos CNC

9 T 0 mP ber 6 Stop stop key 3 ition Positio
ARRO 4 ad8 Pad 9 4 n
W 8

4 Down DOW 1 Nu Num 1 Browser browser 2 CNCPro CNC

0 N 0 mP ber 7 Search search key 3 gram Progra
ARRO 5 ad9 Pad 0 5 m
W 9

4 Select SELE 1 Mul * 1 Browser browser 2 CNCGra CNC

1 CT 0 tipl 7 Favorite favorites 3 phTeac GraphT
6 y 1 s key 6 h each

OKLogReader Operation Manual(CHT) – 30

 机床产品/Machine Tool Products
–
Other Tool.

4 Print PRIN 1 Ad + 1 Browser browser 2 CNCMo CNC

2 T 0 d 7 Home home key 3 nitor Monitor
7 2 7

4 Execut EXEC 1 Sep sepa 1 Volume volume 2 CNCHel CNC

3 e UTE 0 ara rator 7 Mute mute key 3 p Help
8 tor key 3 8

4 PrintSc PRIN 1 Su - 1 Volume volume 2 CNCAlar CNC

4 reen T 0 btr 7 Down down key 3 m Alarm
SCRE 9 act 4 9
EN
Snapsh
ot

4 Insert INSE 1 Dec deci 1 Volume volume up 2 CNCGui CNC

5 RT 1 ima mal 7 Up key 4 dence Guiden
0 l key 5 0 ce

4 Delete DEL 1 Divi / 1 MediaN media 2 CNCDia CNC

6 1 de 7 extTrack next track 4 gnosis Diagnos
1 6 key 1 is

4 Help HELP 1 F1 F1 1 MediaPr media 2 CNCPar CNC

7 1 7 eviousTr previous 4 ameter Parame
2 7 ack track key 2 ter

4 D0 0 1 F2 F2 1 MediaSt media 2 CNCTab CNC

8 1 7 op Stop key 4 le Table
3 8 3

4 D1 1 1 F3 F3 1 MediaPl media 2
9 1 7 ayPause play pause 4
4 9 key 4

5 D2 2 1 F4 F4 1 Launch launch 2
0 1 8 Mail mail key 4
5 0 5

5 D3 3 1 F5 F5 1 SelectM select 2 Attn ATTN

1 1 8 edia media key 4
6 1 6

OKLogReader Operation Manual(CHT) – 31

 机床产品/Machine Tool Products
–
Other Tool.

5 D4 4 1 F6 F6 1 Launch start 2 Crsel CRSEL

2 1 8 Applicat applicatio 4
7 2 ion1 n one key 7

5 D5 5 1 F7 F7 1 Launch start 2 Exsel EXSEL

3 1 8 Applicat applicatio 4
8 3 ion2 n two key 8

5 D6 6 1 F8 F8 1 2 EraseEo ERASR
4 1 8 4 f EOF
9 4 9

5 D7 7 1 F9 F9 1 2 Play PLAY
5 2 8 5
0 5 0

5 D8 8 1 F10 F10 1 Oem1 OEM 1 key 2 Zoom ZOOM

6 2 8 5
1 6 1
OemSe OEM
micolon Semicolon
key on a
US
standard
keyboard

5 D9 9 1 F11 F11 1 Oemplu OEM plus 2 NoNam A

7 2 8 s key on any 5 e constan
2 7 country/ 2 t
region reserve
keyboard d for
future
use

5 1 F12 F12 1 Oemco OEM 2 Pa1 PA1

8 2 8 mma comma 5
3 8 key on any 3
country/
region
keyboard

5 1 F13 F13 1 OemMin OEM 2 OemCle CLEAR

9 2 8 us minus key 5 ar
4 9 on any 4
country/
region
keyboard

OKLogReader Operation Manual(CHT) – 32

 机床产品/Machine Tool Products
–
Other Tool.

6 1 F14 F14 1 OemPer OEM 2

0 2 9 iod period key 5
5 0 on any 5
country/
region
keyboard

6 1 F15 F15 1 Oem2 OEM 2 key 0 Shift SHIFT

1 2 9 X modifie
6 1 1 r key
OemQu OEM
0
estion question
0
mark key
on a US
standard
keyboard

6 1 F16 F16 1 Oem3 OEM 3 key 0 Control CTRL

2 2 9 X modifie
7 2 2 r key
Oemtild OEM tilde
0
e key on a
0
US
standard
keyboard

6 1 F17 F17 1 0 Alt ALT

3 2 9 X modifie
8 3 4 r key
0
0

6 1 F18 F18 1
4 2 9
9 4

1.2 Data Log Reader Operation Manual

1.2.1 How and When to Use

The purpose of the data log reader is to complement the operation log reader (OPLOG) in the interpretation of
abnormality detection.
For example, when the program starts to process, the data log reader will automatically record the current
machine coordinate and start line no. etc. This allows analysts to have a better grasp of the abnormal
situation.

OKLogReader Operation Manual(CHT) – 33

 机床产品/Machine Tool Products
–
Other Tool.

P.S. This feature supports version 10.116.10x or above.

1.2.2 Notes

1. The data is constantly captured, but the frequency of writing into DataLog.dat is every 10 minutes or as
soon as a MOT alarm is triggered.
2. The current data log reader is optimized for storage capacity for 3 days.
a. OKLogReader, which is window edition, can interpret the new format (corresponding to
controller versions 10.116.16 and above).
b. TransferDataRecords v1.x, which is console edition, can interpret the old format (corresponding
to the controller version below 10.116.16).

3. The events defined by the data log reader are not always issued when the state has changed, some are
detected every once in a while. The main categories are as follows.
a. Fixed time (before ID6): For example, ID6 (1sec in CS) will record the coordinate every 1000 ms.
b. PLC signal (ID7~18): For example, ID17 (Specified R On) is issued when PLC scan time (or
FastPLC scan time) detects that R value changes.
c. Processing status (ID21~25): For example, ID21 (ReadyToCS) is issued when the controller status
has changed from ready to processing during OpScan (executed every 100ms).
d. Real-time events (after ID26): For example, ID27 (Home) is issued when the controller is ready
for home searching.

1.2.3 How to Export Records

To export the records, you need to use the data backup function (only Machine Backup (MB) provides this
record). After decompressing the backup data exported from the controller, the DataLog0.dat or DataLog1.dat
in the DataLog folder will be the records of the data log reader.
The data backup path for each controller model is as follows.
1. ARM system (6/11/21)
• 8 key: F5 Maintain > F6 Backup Sys.
• 5 key: F5 Maintain> F10 Next > F1 Backup Sys.
2. x86 system (SUPER/10/20)
• 8 key: F7 Diag. > F8 System manager > F2 Backup Sys.
• 5 key: F10 next > F2 Diag. > F10 next > F5 System manager > F2 Backup Sys.

1.2.4 Operation method

Controller Software Version after 10.116.16 Controller Software Version before 10.116.16

OKLogReader Operation Manual(CHT) – 34

 机床产品/Machine Tool Products
–
Other Tool.

Download
• Please go to SYNTEC official website → Downloads → Application Tool, and download
"OKLogReader_[V].zip".

Examples

• KLog-Find Information on Specific Date

a. Select "1st item of the DAY" in the filter criteria, then the first information of each day will be
listed.
b. Click on the row in the right list, the left list will switch to the same row as well.
Since the left list shows all the information, you can see all the information on that date.

• KLog-Find Event
• An Event will usually contain multiple Arguments. If you want to sort by event, follow these
steps:
1. Select "1st item of the EVENT" in the filter criteria, then the first information of each event
will be listed.

OKLogReader Operation Manual(CHT) – 35

 机床产品/Machine Tool Products
–
Other Tool.

2. Click on the row in the right list, the left list will switch to the same row as well.
Since the left list shows all the information, you can see all the information of that event.

• KLog-Find Only the Coordinate in Processing

a. Select "Machine Pos" in the filter criteria, then the first information of each event will be
listed.
b. Click on the row in the right list, the left list will switch to the same row as well.
Since the left list shows all the information, you can see all the information of that event.

• KLog-Find Event without Coordinates in Processing

a. Select "NO Machine Pos" in the filter criteria, then the first information of each event will be
listed.

OKLogReader Operation Manual(CHT) – 36

 机床产品/Machine Tool Products
–
Other Tool.

b. Click on the row in the right list, the left list will switch to the same row as well.
Since the left list shows all the information, you can see all the information of that event.

• KLog-Find Debug Event

a. Available in OKLogReader version 2.6.0 and above.
b. Select "Debug Event" in the filter criteria, then it will show the debug events only.
c. Click on the row in the right list, the left list will switch to the same row as well.
Since the left list shows all the information, you can see all the information of that event.

Controller Software Version after 10.116.16 Controller Software Version before 10.116.16

OKLogReader Operation Manual(CHT) – 37

 机床产品/Machine Tool Products
–
Other Tool.

Download

• Index Version File Upload Modifications Uploader

Date

Console version, for controller software version below 10.116.16.

3 v1.2 TransferDataRe 2015/07/31 • Fixed the 郑礼芳

cords problem
that could
not be
executed
on some
clean
computer
s.

2 v1.1 TransferDataRe 2015/04/27 • Fixed the 谢旻翰

cords problem
that v 1.0
cannot
open files.

1 v1.0 TransferDataRe 2015/02/03 • Added v 陈丁铨

cords 1.0 file
converter.

File Interpretation
• Put the record and the converter into the same folder (please download the converter from the
"Development File Download" section), and execute the converter. Then type in that folder path,
and press enter to start the conversion. You can see the text file DataRecord.txt in the folder after it
is finished.

Content Descriptions
• There are five kinds of retrieved data separated by commas. And each line represents a separate
piece of information. The format is shown below. And the following section will explain the content
of each category.
• Event time: The event time obtained by OKLogReader, which is the same as the time
reported by the client regardless of the time zone where the OKLogReader and the
controller is located.
• Event ID: The status of the controller at that moment, from which you can understand what
the machine is doing at that time.
• Data Type: The type of data, so that you can determine what kind of data it is.
• Data content: The recorded data.

OKLogReader Operation Manual(CHT) – 38

 机床产品/Machine Tool Products
–
Other Tool.

Event List

• Even Event Dat Information of the Log Record:

t ID Description a ID
The record time is required and the K-log reader will
display it at the beginning of the line.

6 1sec in CS: every 0 Axis ID Machine

1000 ms in Coordinat
processing. e

11 Specified C On: 25 The Value

when C54 turns Specified after
from off to on. C Change

12 Specified C Off: 25 The Value

when C54 turns Specified after
from on to off. C Change

17 Specified R On: 25 The Value

when the Specified after
following R are R Change
changed and not
0.
R520, R530, R540,
R600, R609,
R612, R613,
R901~R916

OKLogReader Operation Manual(CHT) – 39

 机床产品/Machine Tool Products
–
Other Tool.

Even Event Dat Information of the Log Record:

t ID Description a ID
The record time is required and the K-log reader will
display it at the beginning of the line.

18 Specified R Off: 25 The Value

when the Specified after
following R are R Change
changed to 0.
R520, R530, R540,
R600, R609,
R612, R613,
R901~R916

19 CNC State 41 Original

Changed State
Current
State

20 Not Ready To 0 Axis ID Machine

Ready Coordinat
e

1 Axis Workpiece Axis ID G54 Offset

group ID Coordinat
e

2 Axis Axis ID External

Group ID Offset

3 Axis Axis ID G92 Offset

Group ID

4 Axis Axis ID MPG

Group ID Coordinat
e

7 Axis ID Motor
Feedback

21 Ready To Cycle 42 Processin

start g
Program

OKLogReader Operation Manual(CHT) – 40

 机床产品/Machine Tool Products
–
Other Tool.

Even Event Dat Information of the Log Record:

t ID Description a ID
The record time is required and the K-log reader will
display it at the beginning of the line.

0 Axis ID Machine
Coordinat
e

1 Axis Workpiece Axis ID G54 Offset

Group ID Coordinat
e

2 Axis Axis ID External

Group ID Offset

3 Axis Axis ID G92 Offset

Group ID

4 Axis Axis ID MPG

Group ID Coordinat
e

7 Axis ID Motor
Feedback

22 To Feedhold 0 Axis ID Machine

Coordinat
e

1 Axis Workpiece Axis ID G54 Offset

Group ID Coordinat
e

2 Axis Axis ID External

Group ID Offset

3 Axis Axis ID G92 Offset

Group ID

4 Axis Axis ID MPG

Group ID Coordinat
e

OKLogReader Operation Manual(CHT) – 41

 机床产品/Machine Tool Products
–
Other Tool.

Even Event Dat Information of the Log Record:

t ID Description a ID
The record time is required and the K-log reader will
display it at the beginning of the line.

7 Axis ID Motor
Feedback

23 Feedhold To 0 Axis ID Machine

Cycle start Coordinat
e

1 Axis Workpiece Axis ID G54 Offset

Group ID Coordinat
e

2 Axis Axis ID External

Group ID Offset

3 Axis Axis ID G92 Offset

Group ID

4 Axis Axis ID MPG

Group ID Coordinat
e

7 Axis ID Motor
Feedback

24 To B Stop 0 Axis ID Machine

Coordinat
e

1 Axis Workpiece Axis ID G54 Offset

Group ID Coordinat
e

2 Axis Axis ID External

Group ID Offset

3 Axis Axis ID G92 Offset

Group ID

OKLogReader Operation Manual(CHT) – 42

 机床产品/Machine Tool Products
–
Other Tool.

Even Event Dat Information of the Log Record:

t ID Description a ID
The record time is required and the K-log reader will
display it at the beginning of the line.

4 Axis Axis ID MPG

Group ID Coordinat
e

7 Axis ID Motor
Feedback

25 BStop To Cycle 0 Axis ID Machine

start Coordinat
e

1 Axis Workpiece Axis ID G54 Offset

Group ID Coordinat
e

2 Axis Axis ID External

Group ID Offset

3 Axis Axis ID G92 Offset

Group ID

4 Axis Axis ID MPG

Group ID Coordinat
e

7 Axis ID Motor
Feedback

26 MOT Alarm 9 Axis ID Index

Count

27 Home 8 Axis ID Index Number of

Count Grid

28 G54 Change 1 Axis Workpiece Axis ID G54 Offset

Group ID Coordinat
e

OKLogReader Operation Manual(CHT) – 43

 机床产品/Machine Tool Products
–
Other Tool.

Even Event Dat Information of the Log Record:

t ID Description a ID
The record time is required and the K-log reader will
display it at the beginning of the line.

29 G54 Setting 1 Axis Workpiece Axis ID G54 Offset

Group ID Coordinat
e

30 G92 Setting 3 Axis Axis ID G92 offset

Group ID

31 External Offset 2 Axis Axis ID External

Setting Group ID Offset

32 Tool Length 10 Axis Tool No. Axis ID Tool Leng Wea

Setting Group ID th r

33 Tool No Change 10 Axis Tool No. Axis ID Tool Wea

Group ID Length r

34 Enabled HCS 4 Axis Axis ID MPG

Group ID Coordinat
e

35 Disabled HCS 4 Axis Axis ID MPG

Group ID Coordinat
e

36 Set HCS 5 Axis Axis ID Setting

Group ID Value

37 PLC Axis Execute

38 PLC Axis Move To

92 Part Count 43 Original

Changed Part
Count
Current
Part
Count

OKLogReader Operation Manual(CHT) – 44

 机床产品/Machine Tool Products
–
Other Tool.

Even Event Dat Information of the Log Record:

t ID Description a ID
The record time is required and the K-log reader will
display it at the beginning of the line.

93 System Boot 6

94 System Running 6

95 Ready To Execute 0 Axis ID Machine

Block Coordinat
e

1 Axis Workpiece Axis ID G54 Offset

Group ID Coordinat
e

2 Axis Axis ID External

Group ID Offset

3 Axis Axis ID G92 Offset

Group ID

4 Axis Axis ID MPG

Group ID Coordinat
e

7 Axis ID Motor
Feedback

96 FeedHold To 0 Axis ID Machine

Execute Block Coordinat
e

1 Axis Workpiece Axis ID G54 Offset

Group ID Coordinat
e

2 Axis Axis ID External

Group ID Offset

3 Axis Axis ID G92 Offset

Group ID

OKLogReader Operation Manual(CHT) – 45

 机床产品/Machine Tool Products
–
Other Tool.

Even Event Dat Information of the Log Record:

t ID Description a ID
The record time is required and the K-log reader will
display it at the beginning of the line.

4 Axis Axis ID MPG

Group ID Coordinat
e

7 Axis ID Motor
Feedback

97 B Stop To 0 Axis ID Machine

Execute Block Coordinat
e

1 Axis Workpiece Axis ID G54 Offset

Group ID Coordinat
e

2 Axis Axis ID External

Group ID Offset

3 Axis Axis ID G92 Offset

Group ID

4 Axis Axis ID MPG

Group ID Coordinat
e

7 Axis ID Motor
Feedback

98 On Advanced 0 Axis ID Machine

Look-Ahead Coordinat
e

1 Axis Workpiece Axis ID G54 Offset

Group ID Coordinat
e

2 Axis Axis ID External

Group ID Offset

OKLogReader Operation Manual(CHT) – 46

 机床产品/Machine Tool Products
–
Other Tool.

Even Event Dat Information of the Log Record:

t ID Description a ID
The record time is required and the K-log reader will
display it at the beginning of the line.

3 Axis Axis ID G92 Offset

Group ID

4 Axis Axis ID MPG

Group ID Coordinat
e

7 Axis ID Motor
Feedback

Notes:
1. Axis group ID will display the data of the corresponding number and ID according to the "number
of enabled axis group".
2. Axis ID will display the data of the corresponding number and ID according to the "number of
enabled axis".
3. The unit of coordinates is "BLU".

Examples
Here are several examples to explain the meaning of the data. For detailed definition of the data, please
refer to the table "Time and Data Recorded by the Data Log Reader".
• 2014/2/5/20:0:29.479;21,0,2,-15804
Red: 8:00 p.m. 29.479 seconds, February 5, 2014.
Blue: the event ID is 21, which means to start processing.
Green : the data type is 0, which means the following data are "Axis ID, Coordinate".
• 2014/2/5/20:0:29.479;21,0,2,-15804
Red: the data type is 0, which means the following data are "Axis ID, Machine Coordinate".
Blue: the axis name 2 represents Y-axis, and the machine coordinate is -15.804.
• 2014/2/5/20:0:29.479;21,1,1,1,1,0
Red: the data type is 1, which means the following data are "Axis Group, Workpiece Coordinate, Axis
ID, G54 Setting Value".
Blue: they are the 1st axis group, the 1st Workpiece coordinate, X-Axis, and setting value is 0.
• 2014/2/5/20:0:29.479;21,2,1,1,50000
Red: the data type is 2, which means the following data are "Axis Group, Axis ID, External Offset".
Blue: they are the 1st axis group, X-Axis, and external offset is 50.
• 2014/2/5/20:0:29.479;21,1,1,1,1,0
Red: the data type is 1, which means the following data are "Axis Group, Workpiece Coordinate, Axis
ID, G54 Setting Value".
Blue: they are the 1st axis group, the 1st Workpiece coordinate, X-Axis, and setting value is 0.

OKLogReader Operation Manual(CHT) – 47

 机床产品/Machine Tool Products
–
Other Tool.

• 2014/2/5/20:0:29.479;21,7 ,2,-15804
Red: the data type is 7, which means the following data are "Axis ID, Motor Feedback".
Blue: the axis name 2 represents Y-axis, and motor feedback is -15.80.
• 2014/2/5/20:0:29.479; 30,3,1,1,50
Red: the event ID is 30, which means G92 Setting.
Blue: the data type is 3, which means the following data are "Axis Group, Axis ID, G92 Offset".
Green: they are the 1st axis group, X-Axis, and offset is 0.05.

1.2.5 QA

Q1. Why does the time displayed differ from the one in controller alarm history or operation log when reading
DataLog*.dat with a data log reader (hereinafter called Reader), such as "TransferDataRecords v2.1" or
"OKLogReader_2.0.2"?
A1: There is a time zone difference between each controller software version and Reader. The following table
shows the relationship between each version.

Type Controller version

A 10.116.6D ~
10.116.10A ~
10.116.16A ~
10.116.24A ~ 10.116.24L

B 10.116.24M ~
10.116.38A ~ 10.116.38F
10.116.54A ~ 10.116.54D
10.118.0A ~10.118.0B

C 10.116.38G ~
10.116.54E ~
10.118.0C ~

Controller Display Data Log Reader Old Reader New Reader

Time (Machine) Recording Time Display Time (User Display Time
(Machine) PC) (User PC)

Time zone When the controller is rolled out, it is set to Suppose the computer using Reader is in
Taiwan time zone UTC+8 which users cannot Taiwan, the time zone is UTC+8.
change.

A 02:00 10:00 02:00

(8 hours ahead) (Correct)
02:00

OKLogReader Operation Manual(CHT) – 48

 机床产品/Machine Tool Products
–
Other Tool.

B 10:00 18:00 10:00

(16 hours ahead) (8 hours ahead)

C 02:00 10:00 02:00

(8 hours ahead) (Correct)

T Using Reader "TransferDataRecords v2.1" or Using Reader "OKLogReader_2.0.3"

y "OKLogReader_2.0.2"
p
e

A When the time zone of Reader's computer is UTC+N, the When the time zone of Reader's
display time will be "N hours ahead" of the time computer is UTC+N, the display time
recorded by the machine. will be identical to the time recorded
by the machine.
E.g. The same DataLog0~2.dat is 8 hours ahead of the
machine recorded time in Taiwan and 5 hours behind in E.g. The DataLog0~2.dat will display the
New York. Because the time zone of Taiwan is UTC+8, and same time with the machine recorded
New York is UTC-5. time regardless of the time zone.
Related issue ISSUE-1493 Related issue MMI-3310

B When the time zone of Reader's computer is UTC+N, the When the time zone of Reader's
display time will be "8+N hours ahead" of the time computer is UTC+N, the display time
recorded by the machine. will be "N hours ahead" of the time
recorded by the machine.
E.g. The same DataLog0~2.dat is 16 hours ahead of the
machine recorded time in Taiwan and 3 hours ahead in E.g. The same DataLog0~2.dat is 8
New York. Because the time zone of Taiwan is UTC+8, and hours ahead of the machine recorded
New York is UTC-5. time in Taiwan and 5 hours behind in
New York. Because the time zone of
Related issue ISSUE-7228
Taiwan is UTC+8, and New York is
UTC-5.
Related issue MMI-3310

C When the time zone of Reader's computer is UTC+N, the When the time zone of Reader's
display time will be "N hours ahead" of the time computer is UTC+N, the display time
recorded by the machine. will be identical to the time recorded
by the machine.
E.g. The same DataLog0~2.dat is 8 hours ahead of the
machine recorded time in Taiwan and 5 hours behind in E.g. The DataLog0~2.dat will display the
New York. Because the time zone of Taiwan is UTC+8, and same time with the machine recorded
New York is UTC-5. time regardless of the time zone.
Related issue ISSUE-11215 Related issue MMI-3310

Q2. Why is the DataLog*.dat which is backed up with the latest controller software version 10.116.24 not
updated or empty?

OKLogReader Operation Manual(CHT) – 49

 机床产品/Machine Tool Products
–
Other Tool.

A2:
• The data log reader function is disabled in versions 10.116.16K (inclusive) ~ 10.116.24/10.116.26.
• It is re-enabled after 10.116.36, and the specification of machine coordinate record in processing is
changed from writing every second to writing once every 10 minutes. And if an MOT alarm is triggered
during the 10-minute period, it will compulsorily write the data to ensure that important information is
recorded.

1.3 IOLog Reader Operation Manual

中文版 Mandarin Version: IO点纪录应用手册

1.3.1 Purpuse
IOLog can record the change of input/output signal 8 second before the alarm occurs. It can be used to determine
the cause of the problem.
Supported version: 10.118.44C, 10.118.46C, 10.118.48N, 10.118.52H, 10.118.56B, 10.118.57 and after.
Note: The IOLog will record data when below alarm happend.
The alarm trigger recording
1. MOT-008 Loss Pulse
2. MOT-087 Inaccurate stop position. Please check if there are any mechanisms are stuck
3. MOT-019 Following error exceed
4. MOT-023 Fatal following error exceed
5. AL-120 Driver Over Current
6. AL-121 Power Module Failure
7. AL-202 Overload
8. AL-203 Over Torque 1
9. AL-521 Excessive Following Error
10. OP-005 I/O transmission error (Note)
11. SYS-041 RIO1 communication error (Note)
12. SYS-042 RIO2 communication error (Note)
Note: Supported version - 10.118.72I, 10.118.82T, 10.118.86M, 10.120.4V, 10.120.12T, 10.120.16M,
10.120.24C, 10.120.28 and after

1.3.2 How to use

1. Download OKLogReader. OKLogReader supports IOLog since version 4.0.0.
2. Take out the data recorded in the CNC through MB/SB function .
3. Through "File>Open>Open file" to open an IOLog data or through "File>Open>Open MB/SB" to open total
records.

OKLogReader Operation Manual(CHT) – 50

 机床产品/Machine Tool Products
–
Other Tool.

Remark: If the IOLog is opened via "Open file", the IOLogForm will open directly. If you open IOLog via "Open
MB/SB", please click "View>IOLog" to open IOLogForm.

4. The IOLog display window is as follows, the upper left is the drop-down menu, which will display the IOLog
files that can be opened. If the IOLog is opened via "Open file", only one file will appear.
After selecting the IOLog file you want to open from the drop-down menu, click "Display Settings", the
DisplaySettingsForm will pop up, and the basic information of selected IOLog will be shown on the upper
right panel.
Among them, the Input and Output are the number of I/O points recorded in the IOLog data. This number is
not always equal to the number actually used, but will be greater than or equal to the number actually used;
The Interval is the scanning time of the IO point; the Num. of Rec. is the total number of data recorded at the
same point;
The Start Rec. Time is the time when all data are started to be recorded, and the Elapsed time at the bottom
of the graph is based on the Start Rec. Time.

OKLogReader Operation Manual(CHT) – 51

 机床产品/Machine Tool Products
–
Other Tool.

5. The DisplaySettingsForm is as follows:

There are two display modes, Display together and Display parrallel. Display together can plot up to 20 IO
points at the same time and Display parrallel can plot up to 5 IO points at the same time.
The setting steps are as follows:
a. Choose whether to use "Display together" or "Display parrallel" for presentation.
b. Check the channel is going to use.
c. Choose whether the siganal is input or output.
d. Select the signal in the drop-down menu.
e. Fill in the comment. (if not filled, the signal number will be displayed, ex: O_15)
f. Press "Plot" to display the result in the IOLogForm.

6. The examples displayed in IOLogForm are as follows:

OKLogReader Operation Manual(CHT) – 52

 机床产品/Machine Tool Products
–
Other Tool.

Display together Display parrallel

OKLogReader Operation Manual(CHT) – 53

 机床产品/Machine Tool Products
–
Other Tool.

2 Instruction of Remote Monitoring Application.

中文版 Mandarin Version : 远端监控应用手册

2.1 Preface
With the development of industrial evolution, cloud intelligent network, remote monitoring becomes one of the
essential functions of the controller, to meet the diverse customer demand, this manual will introduce the remote
monitoring applications in SYNTEC's controller and related information.

2.2 Network Architecture and Common Application

Network structure in common applications are shown as follows:

2.2.1 Network Architecture

(Fig.1)
Description
1. Each controller has individually physical IP
2. Server can connect directly to controllers via IP

2.2.2 Other common applications

Factory wireless networks applications

Due to wired network is not easy to build, most of the customers want to use wireless network module to build a
more convenient network monitoring environment. To meet that demand, SYNTEC provides the wireless network
module EKI-6311GN from Advantech (Option). By using this wireless network module, the network architecture can

Instruction of Remote Monitoring Application. – 54

 机床产品/Machine Tool Products
–
Other Tool.

be created. Detailed product information can be found on the Advantech website.

Cross LAN application

For currently cross network monitoring requirements, It is recommended to install remote desktop software on
server as TeamViewer, UltraVNC, so that mobile devices can directly monitor the server screen through Remote
Desktop Software.

2.3 Related requirements and setting

2.3.1 Specifications
1. SYNTEC controller using WinCE system
2. Software version 10.114.30 (or later)

2.3.2 Setting method

1. Setup network IP according to following path:
a. ARM-8 buttons type：F8 Maintain -> F2 Network setting
b. ARM-5 buttons type：F5 Maintain -> F2 Network setting
c. X86-8 buttons type： F6 Parameter → F10 Next → F3 Network setting
d. X86-5 buttons type：F10 Next -> F1 Parameter -> F10 Next -> F4 Network setting
NOTE: Detail information about network setting, please refer to App Help with path: Mechatronic Articles ->
EMC1_Installation -> EMC1_E007 Instruction of network setting
2. Setup "Kernel server" according to following path
a. ARM-8 buttons type：F8 Maintain -> F2 Network setting -> F5 Set Kernel Server
b. ARM-5 buttons type：F5 Maintain -> F2 Network setting -> F5 Set Kernel Server
c. X86-8 buttons type： F6 Parameter → F10 Next → F7 Set Kernel Server
d. X86-5 buttons type：F10 Next -> F1 Parameter -> F10 Next -> F7 Set Kernel Server

Instruction of Remote Monitoring Application. – 55

 机床产品/Machine Tool Products
–
Other Tool.

3. After completing setup, Kernel server screen will be enabled (fig. 3)

Fig.3: Kernel Server screen

4. Select "Open" in "start server while boot" option
5. TimeOut (millisecond): exceeds this setting time that Network does not respond, the network connection
will be interrupted. Suggested setting value 300~1000
6. F3"" to save setting value after completing setup
7. Reboot controller to automatically enable Kernel server (fig.4).

Fig.4: Enable Kernel server

Instruction of Remote Monitoring Application. – 56

 机床产品/Machine Tool Products
–
Other Tool.

2.3.3 Related signal from controller

No. Name Description

S098 OCAPI Server is Running S098 is true when OCAPIServer is enabled, S098 is false
when OCAPIServer is disabled.

S099 Dipole connection in use Whether Dipole connection is used, S099 displays 1 if
there is monitoring program connecting to Kernel. If not,
S099 displays 0.

2.4 One-to-many remote monitoring software usage

2.4.1 Download software and set environment

Visit SYNTEC web, download related software as below
path: Download – CNC software- 04 Application Tool - RemoteAP

Before using this software, please setup SYNTEC CNC monitor first（Ladder Editor, MarcoDev, Cncmon32, it is
suggested to use version 10.114.56,10.116.0 or later）

Instruction of Remote Monitoring Application. – 57

 机床产品/Machine Tool Products
–
Other Tool.

2.4.2 Software operation

After the software is downloaded, unzip and click on RemoteExample.exe file inside the folder as shown below.

Main Screen Description

Main screen will show all the information about the connecting machine, user can choose "Large Icons" (Fig. 5), or
"list" (Fig.6)

Fig.5: large icons

Instruction of Remote Monitoring Application. – 58

 机床产品/Machine Tool Products
–
Other Tool.

Fig.6: List
Optional display contents

Various colors with different meanings

1. Green: Busy
2. Yellow: Feed hold
3. Red: Alarm
4. Gray: disconnected

Instruction of Remote Monitoring Application. – 59

 机床产品/Machine Tool Products
–
Other Tool.

Monitor Mode
User can open monitor mode when cncView has more than two pages, it shows each page.

Group View Mode

User can use this mode to only view the specific group

Notice：If remoteAP always shows " connecting..", you can close firewall or open 5568 and 5570 port in order to let
PC connect to CNC

Instruction of Remote Monitoring Application. – 60

 机床产品/Machine Tool Products
–
Other Tool.

Feature Overview

Host Manager-Add Host

User can set Machine Type, Machine Name, Group and Image Path (Option).
It is needed to set IP and cannot modify after setting. It must be the same with Controller's IP.

Instruction of Remote Monitoring Application. – 61

 机床产品/Machine Tool Products
–
Other Tool.

View detail machine information

On the main screen, by double-click on the single machine, user can view more detail information of that machine
as below:

Machine Infor

File transfer

Instruction of Remote Monitoring Application. – 62

 机床产品/Machine Tool Products
–
Other Tool.

Work record

Alarm Infor

Notify Alarm
Can send Prompts/Alarm to manager when alarm appears via Pipeline notification set on the alarm setting screen.

Editing screen of prompts/alarm

Instruction of Remote Monitoring Application. – 63

 机床产品/Machine Tool Products
–
Other Tool.

Pipeline notification-Mobile

Pipeline notification-Email

Pipeline notification-Skype
Method:
1. Install SKYPE in the PC Remote Monitoring Application installed, and login account A
2. Allow account A enable other process access in SKYPE advanced setting

3. Set another account B for Remote Monitoring Application alarm notification

4. Follow 3 steps above, account B will receive SKYPE message while alarm

Pipeline notification-QQ

Instruction of Remote Monitoring Application. – 64

 机床产品/Machine Tool Products
–
Other Tool.

Report table

Report table will synchronously display all machining information of each controller. Display information can be
defined by user (refer to "display content of report table"),

Authority Management
Admin can manage all of users' right of view page

Instruction of Remote Monitoring Application. – 65

 机床产品/Machine Tool Products
–
Other Tool.

2.5 Customized development

2.5.1 Standard customized method

Currently the content of remote monitoring is variety. To meet user demand, SYNTEC provides user with standard
customization including controller and remote monitoring software.

Standard customization of controller

2.5.2 Customization of work record table

Comparison of old and new specifications for work records

The work record sheet is separated by 10.118.29z, the old version is maintained by the human-machine group and
the new version is maintained by 產一.
• This chapter will introduce the customization method of the old version.
• For the new version of the customization, we do not provide external custom SOP manuals at this time,
please contact the SYNTEC product department for discussion if needed.
Old specifications：
• User records are not supported (custom work numbers required)
• Record generation time point
There are unrecorded cumulative workpieces that satisfy the following conditions
a. Profile change
b. The number of required workpieces reaches

New specifications：
• Support for user records( permission management, version 10.118.12G and later )
• Record generation time point
There are unrecorded cumulative workpieces that satisfy the following conditions
a. Profile change
b. The number of required workpieces reaches
c. Operator change

Instruction of Remote Monitoring Application. – 66

 机床产品/Machine Tool Products
–
Other Tool.

Customized work records

No Steps specifications Schematic diagram

1 First prepare the following two XML files

(copied from the standard path)
Standard path：
File 1：DiskC\OpenCnc
Shared\StdMMIRes\Screen\WorkRecord
File 2：DiskC\OpenCnc
Shared\StdMMIRes\Common\Schema

2 Put both XML files in the specified folder.

Note：The path must be consistent with
the diagram.

Instruction of Remote Monitoring Application. – 67

 机床产品/Machine Tool Products
–
Other Tool.

No Steps specifications Schematic diagram

3 Open SyntecIDE or EHMI software and

enter the standard work record page, as
shown in Figure 2.
On this page, the operations such as
adding, modifying, resizing, positioning,
etc. can be performed; for example,
creating a number of demanded
workpieces.
Note： Please be aware of the location,
width, height, and name when
customizing.

Figure 1 SyntecIDE Page

Figure 2 Standard work record page

Instruction of Remote Monitoring Application. – 68

 机床产品/Machine Tool Products
–
Other Tool.

No Steps specifications Schematic diagram

4 After the demanded workpiece is created

on the work record page, a new column
Label will be automatically added in
Brw_WorkRecord_Main.xml to display the
relevant information as shown in Figure 3.
Then a Template file needs to be created
inside that XML file (which can be copied
and pasted) as in Figure 4, and modified
for name, width, and height. Template is
where the controller generated
processing record data is displayed, and if
Figure 3 Label
it is not created, the content will not be
displayed.

Figure 4 Template

5 Then create a <Field> document in

OCRes\Common\Schema\Schema_Work
Record.xml ( which can be copied and
pasted) as shown in Figure 5, and modify
the name and R-value.
Note: <Storage>R1002 represents the
value of the number of demand
workpieces to be stored on the R1002 Figure 5 Field
register.

Instruction of Remote Monitoring Application. – 69

 机床产品/Machine Tool Products
–
Other Tool.

No Steps specifications Schematic diagram

6 Finally, turn on the controller and the

required number of workpieces for the
customization will appear, as shown in
Figure 6.
Note: (1) The name must be the same
throughout the customization process.
(2) The XML file modification and work
record page cannot be operated at the
same time. (3) Do not remove the "start
date and time" field in the customization
process, otherwise, the data will not be
able to be captured by Cloud.

Figure 6 Customized page

Auto-generation of work records

N Steps specifications Schematic diagram

o

1 The action that triggers the work record generation：

DoAddWorkRecord
Note：
(1) This action can be customized.
(2) It is recommended to use controller version
10.118.12O and later, the start time/total time after
customization of the lower version will be abnormal.

2 Automatic work record generation method. (For

reference only)
Use Backgnd.xml component and assign R5998 to
trigger the action. As shown in the figure.

Instruction of Remote Monitoring Application. – 70

 机床产品/Machine Tool Products
–
Other Tool.

N Steps specifications Schematic diagram

o

3 Place the set Backgnd.xml component in the specified

location. DiskC\OpenCnc
Shared\OCRes\Common\AppData

4 Compile MACRO, such as using G0800 to conduct the

value of R5998, where G10 is used. As shown in the
figure.

5 Place G0800 inside the NC file or other locations, and it

will trigger the action of generating work records when
G0800 is executed.

6 Set the controller M code work count, the parameter is

Pr3804.
Note: The value of Pr3804 should be consistent with
the NC program M code, for example, if Pr3804=123,
then there should be M123 in the NC program before it
carries on counting.

Instruction of Remote Monitoring Application. – 71

 机床产品/Machine Tool Products
–
Other Tool.

N Steps specifications Schematic diagram

o

7 When M123 (work count) and G800 (generating work

record) are placed in the NC program of the profile,
then when this program is executed, a machining
record will be generated. As shown in the figure.

Contents of the old documents

Word record table can be customized by XML
Available version: 10.116.3, 10.116.0D, 10.114.56C
Display content of work record table
Work record table is saved by using Cyle Editor, so it is needed to define other Schema. The standard definition
path: StdMMIRes\Common\Schema\Schema_WorkRecord.xml. User can copy that file to OCRES according path
(OCRes\Common\Schema\ Schema_WorkRecord.xml) for customization purpose.
To meet user demand, the Field in Schema is added <Storage> information that can defined register R as
follows:
<?xml version="1.0" encoding="UTF-8"?>
<Schema>
<Cycle name="CycleEdit">
<Field>
<Name>Col_User</Name>
<InputFormat>String</InputFormat>
<Length>20</Length>
<Storage>R4010</Storage>
</Field>
</Cycle>
</Schema>
Once above example is executed, it will automatically write R4010 value in work record table.

Work record table page

Work record table page is defined in "StdMMIRes\Common\AppData\XML_WorkRecord.xml", user can copy this
file to OCRes (OCRes\Common\AppData) to customize.

Condition to update work record table

User can set conditions to do ACTION for updating work record table, in which ACTION is "DoAddWorkRecord".
P.S. when part count is 0, this action is invalid.

Instruction of Remote Monitoring Application. – 72

 机床产品/Machine Tool Products
–
Other Tool.

Standard customization of remote monitoring software

Add group fields

Because group fields recorded is in remote monitoring software, so it is standard feature. When adding or
modifying machine information, it can fill in group.

Display customized information

Except picture and percentage are not customized, other remaining information can be defined according to user
demand.
Definition file
• File name: SETTING.INI (if not, please add by yourself)
• Path: the same with remote monitoring soft
• Defined method: refer to the following fig.

• Identification Title：Beginning is identified according to [MachineMonitor]

• Source: shown as left hand side
• Standard content: Beginning with STD, currently default content as bellow
Display content Corresponding resources

Machine type STD_MACHINE_TYPE_MONITOR

Machine name STD_MACHINE_NAME_MONITOR

Group STD_MACHINE_GROUP_MONITOR

Program name STD_WORK_PROGRAM_NAME

Work require part count STD_WORK_REQUIRE_PART_COUNT

Work part count STD_WORK_PART_COUNT

Instruction of Remote Monitoring Application. – 73

 机床产品/Machine Tool Products
–
Other Tool.

Work acc time STD_WORK_ACC_TIME

Time of power on STD_WORK_POWER_ON_TIME

• Customized content: Beginning with R (if value R is a string format, it is required to add ",
STR", otherwise it will be considered a digital display. ).
• String display on remote monitoring software: shown as right hand side (not support multi
language)

P.S. The display order on remote monitoring soft is according to the order of SETTING.INI.

Display content of report table

It needs to comply with work record table of controller. If no information is on controller, a blank is displayed. Each
field can be defined by user.
Definition file
• File name: SETTING.INI (if not, please add by yourself)
• Path: the same with remote monitoring soft
• Defined method: refer to the following fig.

• Identification Title：Beginning is identified according to [MachineMonitor]

• Source: shown as left hand side
• Standard content: Beginning with STD, currently default content as bellows
Display content Corresponding resources

Instruction of Remote Monitoring Application. – 74

 机床产品/Machine Tool Products
–
Other Tool.

Machine type STD_MACHINE_TYPE_MONITOR

Machine name STD_MACHINE_NAME_MONITOR

Group STD_MACHINE_GROUP_MONITOR

IP STD_MACHINE_IP_FIELD

• Work record table (Schema) content: According to content Field Name of

"Schema_WorkRecord.xml" on controller.
• String display on remote monitoring software: shown as right hand side (not support multi
language)
P.S. The display order on remote monitoring soft is according to the order of SETTING.INI.

Machine sorting function

All customized information in "Display Information customization features" can be sorted, refer to the figure below.

Export function of report table

Add the function of exporting CSV file. After exporting report table, user can use worksheets software (ex. Excel,
SpreadSheets, ... etc.) to do sort or pivot table…

Standard customization example

User demand
In production line, employee must log in ID number to operate machine. Once satisfying one of condition below,
the employee's production will be updated on record table:
• Condition 1: Total required part is completed (system updates automatically)
• Condition 2: Part count is unequal to zero and change machining program (system updates automatically)
• Condition 1: employee works off and log out (need customization)

Customized method

Instruction of Remote Monitoring Application. – 75

 机床产品/Machine Tool Products
–
Other Tool.

1. Do a corresponding input field R3510 (Format: string)

2. Do one function key (OK). Once function key is activated, the value of R3510 will be filled into R4010(self-
defined action "CUSTOMDEVSTR")。

3. Fill the value of R4010 into work record of employee. Copy the Schema
file(StdMMIRes\Common\Schema\Schema_WorkRecord.xml) to the OCRES path (OCRes\Common\Schema)
to customize. Add the below content:
<Field>
<Name>Col_User</Name>
<InputFormat>String</InputFormat>
<Length>20</Length>
<Storage>R4010</Storage>
</Field>
4. Do one function key (LOG OUT). Once activated can do following action

Instruction of Remote Monitoring Application. – 76

 机床产品/Machine Tool Products
–
Other Tool.

• action "DoAddWorkRecord"，
• Clear R4010.

Above function can be used to do the log out key that can write current part count into the work record table
(including employee ID).
=============================================================
However, there are two cases have not yet considered.
1. Syntec's controller will automatically update the work record table when one of below condition is satisfied:
• Condition 1: Total required part is completed (system updates automatically)
• Condition 2: Part count is unequal to zero and change machining program (system updates
automatically)
It is needed to avoid system update automatically and rewrite problem when employee selects logout
button
2. Previous employee forgets to log out, so when the next one logs in, it can update the work record table.

According to 2 above case, it is needed to use prediction as below (in this case, using PLC with HMI button and
R5998)

HMI HIM

PLC

R3800 = 1(Log in) R6800 = 0(Required part is not reached R5998 Corresponding action of R5998
R3800 = 2(Log out) R6800 = 1(required part is reached)
refer to note 1”Require Part Count Reached”

Instruction of Remote Monitoring Application. – 77

 机床产品/Machine Tool Products
–
Other Tool.

1 0 1 1. DoAddWorkRecord
2. Set R5998= 0
3. Set Part count 0

1 1 3 1. Set R5998=0
2. Set Part count 0

2 0 2 1. DoAddWorkRecord
2. Set R5998= 0
3. Set Part count 0
4. Set R4010= 0

2 1 4 1. Set R5998= 0
2. Set Part count 0
3. Set R4010= 0

PLC and HMI condition

Note 1:

N0. Name Description

S034 Require Part Count Reached When required part is reached, this S FLAG is ON.
Once Cycle Start or Reset, this FLOG is OFF

2.5.3 API customized method

To meet the demand of remote monitoring application from customer, SYNTEC provides open library, development
files and examples. User can visit SYNTEC website to download related data.

Instruction of Remote Monitoring Application. – 78

 机床产品/Machine Tool Products
–
Other Tool.

Path: DOWNLOADS -> CNC Software -> Open CNC Tools -> SYNTEC Remote CNC monitor.

2.6 Customization of work record table

2.6.1 Customization of work record table

Comparison of old and new specifications for work records

The work record sheet is separated by 10.118.29z, the old version is maintained by the human-machine group and
the new version is maintained by 產一.
• This chapter will introduce the customization method of the old version.
• For the new version of the customization, we do not provide external custom SOP manuals at this time,
please contact the SYNTEC product department for discussion if needed.
Old specifications：
• User records are not supported (custom work numbers required)
• Record generation time point
There are unrecorded cumulative workpieces that satisfy the following conditions
a. Profile change
b. The number of required workpieces reaches

Instruction of Remote Monitoring Application. – 79

 机床产品/Machine Tool Products
–
Other Tool.

New specifications：
• Support for user records( permission management, version 10.118.12G and later )
• Record generation time point
There are unrecorded cumulative workpieces that satisfy the following conditions
a. Profile change
b. The number of required workpieces reaches
c. Operator change

Customized work records

No Steps specifications Schematic diagram

1 First prepare the following two XML files

(copied from the standard path)
Standard path：
File 1：DiskC\OpenCnc
Shared\StdMMIRes\Screen\WorkRecord
File 2：DiskC\OpenCnc
Shared\StdMMIRes\Common\Schema

Instruction of Remote Monitoring Application. – 80

 机床产品/Machine Tool Products
–
Other Tool.

No Steps specifications Schematic diagram

2 Put both XML files in the specified folder.

Note：The path must be consistent with
the diagram.

3 Open SyntecIDE or EHMI software and

enter the standard work record page, as
shown in Figure 2.
On this page, the operations such as
adding, modifying, resizing, positioning,
etc. can be performed; for example,
creating a number of demanded
workpieces.
Note： Please be aware of the location,
width, height, and name when
customizing.

Figure 1 SyntecIDE Page

Figure 2 Standard work record page

Instruction of Remote Monitoring Application. – 81

 机床产品/Machine Tool Products
–
Other Tool.

No Steps specifications Schematic diagram

4 After the demanded workpiece is created

on the work record page, a new column
Label will be automatically added in
Brw_WorkRecord_Main.xml to display the
relevant information as shown in Figure 3.
Then a Template file needs to be created
inside that XML file (which can be copied
and pasted) as in Figure 4, and modified
for name, width, and height. Template is
where the controller generated
processing record data is displayed, and if
Figure 3 Label
it is not created, the content will not be
displayed.

Figure 4 Template

5 Then create a <Field> document in

OCRes\Common\Schema\Schema_Work
Record.xml ( which can be copied and
pasted) as shown in Figure 5, and modify
the name and R-value.
Note: <Storage>R1002 represents the
value of the number of demand
workpieces to be stored on the R1002 Figure 5 Field
register.

Instruction of Remote Monitoring Application. – 82

 机床产品/Machine Tool Products
–
Other Tool.

No Steps specifications Schematic diagram

6 Finally, turn on the controller and the

required number of workpieces for the
customization will appear, as shown in
Figure 6.
Note: (1) The name must be the same
throughout the customization process.
(2) The XML file modification and work
record page cannot be operated at the
same time. (3) Do not remove the "start
date and time" field in the customization
process, otherwise, the data will not be
able to be captured by Cloud.

Figure 6 Customized page

Auto-generation of work records

N Steps specifications Schematic diagram

o

1 The action that triggers the work record generation：

DoAddWorkRecord
Note：
(1) This action can be customized.
(2) It is recommended to use controller version
10.118.12O and later, the start time/total time after
customization of the lower version will be abnormal.

2 Automatic work record generation method. (For

reference only)
Use Backgnd.xml component and assign R5998 to
trigger the action. As shown in the figure.

Instruction of Remote Monitoring Application. – 83

 机床产品/Machine Tool Products
–
Other Tool.

N Steps specifications Schematic diagram

o

3 Place the set Backgnd.xml component in the specified

location. DiskC\OpenCnc
Shared\OCRes\Common\AppData

4 Compile MACRO, such as using G0800 to conduct the

value of R5998, where G10 is used. As shown in the
figure.

5 Place G0800 inside the NC file or other locations, and it

will trigger the action of generating work records when
G0800 is executed.

6 Set the controller M code work count, the parameter is

Pr3804.
Note: The value of Pr3804 should be consistent with
the NC program M code, for example, if Pr3804=123,
then there should be M123 in the NC program before it
carries on counting.

Instruction of Remote Monitoring Application. – 84

 机床产品/Machine Tool Products
–
Other Tool.

N Steps specifications Schematic diagram

o

7 When M123 (work count) and G800 (generating work

record) are placed in the NC program of the profile,
then when this program is executed, a machining
record will be generated. As shown in the figure.

Contents of the old documents

Word record table can be customized by XML
Available version: 10.116.3, 10.116.0D, 10.114.56C
Display content of work record table
Work record table is saved by using Cyle Editor, so it is needed to define other Schema. The standard definition
path: StdMMIRes\Common\Schema\Schema_WorkRecord.xml. User can copy that file to OCRES according path
(OCRes\Common\Schema\ Schema_WorkRecord.xml) for customization purpose.
To meet user demand, the Field in Schema is added <Storage> information that can defined register R as
follows:
<?xml version="1.0" encoding="UTF-8"?>
<Schema>
<Cycle name="CycleEdit">
<Field>
<Name>Col_User</Name>
<InputFormat>String</InputFormat>
<Length>20</Length>
<Storage>R4010</Storage>
</Field>
</Cycle>
</Schema>
Once above example is executed, it will automatically write R4010 value in work record table.

Work record table page

Work record table page is defined in "StdMMIRes\Common\AppData\XML_WorkRecord.xml", user can copy this
file to OCRes (OCRes\Common\AppData) to customize.

Condition to update work record table

User can set conditions to do ACTION for updating work record table, in which ACTION is "DoAddWorkRecord".
P.S. when part count is 0, this action is invalid.

Instruction of Remote Monitoring Application. – 85

 机床产品/Machine Tool Products
–
Other Tool.

3 SBTool Operation Manual

中文版 Mandarin Version: SBTool 操作手册

3.1 Preface

• Syntec Backup Tool (SBTool) provides:

1. Remote system backup
2. Remote system restore

3.2 Requirement

• Software version : 10.118.22H, 10.118.27 (or later)

• A Smart Machine Box (SMB) connected to CNC.

3.3 Caution

• DO NOT use SBTool when system is machining.

• DO NOT close SBTool during remote system backup or remote system restore.
• There is no prompt on CNC when doing remote system backup or doing remote system restore.
Operating CNC simultaneously is not recommended.

3.4 Contents

After unzipping SBTool.zip, the files are shown below:

SBTool Operation Manual – 86

 机床产品/Machine Tool Products
–
Other Tool.

1. Bin folder：The executable and DLL files are stored in the folder.
2. SBBackup folder：The output backup file will be stored in the folder. The backup file is named
"Backup_SB_CRC code.zip", e.g. Backup_SB_3a6b72b7.zip.
3. SBRestore folder：The input restore file needs to be stored in this folder.
4. SBBackup.bat：You can double-click the file to perform SB backup.
5. SBRestore.bat：You can double-click the file to perform SB restore.
6. IP.txt：It's a file for setting the IP address.

After execution, the files are shown below:

1. Result.txt：
The file is generated after SB backup or restore is completed.
If performed successfully, the content of this file will be "SB Backup (Restore) Successful".
Otherwise the content will be "SB backup(Restore) Fail".
2. Error.txt：
This file is generated only when SB backup or restore fails, and error messages will be recorded.

3.5 Procedure

Please download SBTool on Syntec official website：

• URL：http://www.syntecclub.com/Download.aspx
• Path：Downloads => 04.Application Tool => SBTool

Set IP address for connection initialization

1. SBTool can be used completely independently, just fill in the CNC IP in IP.txt.
2. If you place the SBTool in the specified directory in a simulator folder, it will automatically obtain the
CNC IP (by reading DipoleSettings.xml), so you will not need to set IP.

SBTool Operation Manual – 87

 机床产品/Machine Tool Products
–
Other Tool.

Here is an illustration of the path of the SBtool. Place the SBtool folder in the same directory as the
DiskC folder.

Execute SB backup：
1. Double-click SBBackup.bat, and wait for the percentage finish.
Then the screen will display "SB Backup complete!", indicating that the execution is complete.

2. The output backup file will be generated in the SBTool\SBBackup folder.

Execute SB restore：
1. Put the SB backup file under the SBTool\SBRestore folder.
2. Double-click SBBackup.bat, and wait for the percentage finish.
Then the screen will display "SB Restore complete! Please restart CNC".

3. Please restart CNC and complete SB restore.

SBTool Operation Manual – 88

 机床产品/Machine Tool Products
–
Other Tool.

3.6 Troubleshooting

If the screen displays red error messages and Error.txt is generated, please refer to the following
troubleshooting methods:
• 「Fail to get IP」：
This means that the IP address in DipoleSettings.xml or IP.txt cannot be read. Please refer to the "
Set IP address " above to reset IP and also check whether the IP format is correct.
If you re-enter the IP directly on the screen, SBTool will automatically reconnect and save the new
IP to IP.txt.
• 「Fail to connect to CNC」：
Please check the CNC network status or check whether the IP is correct.
If you re-enter the IP directly on the screen, SBTool will automatically reconnect and save the new
IP to IP.txt.
• 「SB Backup Fail」：
This means that the CNC rejected the backup request, which may be caused by the busy CNC, or
SBTool was mistakenly closed during the last execution (Please restart the CNC).
• 「SB Restore Fail」：
This means that the CNC rejected the restore request, which may be caused by the busy CNC,
or SBTool was mistakenly closed during the last execution (Please restart the CNC).
• 「SB Restore Fail: Please check Restore folder.」：
Please make sure that only one file exists in the SBRestore folder.
• 「SB Restore Fail: CRC check error」：
Please make sure the CRC code of the file name is correct.

SBTool Operation Manual – 89

 机床产品/Machine Tool Products
–
Other Tool.

4 Data Aggregators Application Manual

中文版 Mandarin Version: 资料记录器应用手册

4.1 Catalog：
Catalog：
Introduction：
Specifications：
User guide：
Constraints：
Notifications：

4.2 Introduction：
Currently, the Data Logs and Operation Logs play great roles in providing information on system status and
user operations by routine recording. When it comes to issues about troubleshooting, behavior tracking, or
long term reliability analysis, it seems nothing to do with these two recorders. It's also infuriating that analysts
have to tell the key information from massive amounts of the data files by files.
The brand new Data Aggregators make great improvement of the disadvantages above and aim for the
following three subjects.

1. 4.2.1 Problem shooting ：

ngineers

Under specific critical alarms, such as the loss pulse alarm(MOT-8) and motor overload alarm(AL-202), the
CNC machine would execute an emergency stop, and break the machining process instantly. It might be
helpful to analyze the history of data like machine position, loading factor of motors, following errors, etc.
This information can help our erecognize machine behavior and furtherly solve the problem.

2. 4.2.2 CNC Machine Runtime Diagnosis：

Supports macro operation. You can activate the service data aggregator to grasp the historic record of target
data by just adding a macro command "G10 L1100 P1007". The aggregator collects information like IGBT
temperature of motors, capacities temperature of drives, the voltage of encoders, etc. We can also provide
standard MACRO, for example, the warm-up subprogram, using the macro command, and made a warm-up
record every time it works.

3. 4.2.3 CNC Machine Reliability Data Base：

malfunction prediction, and behavior diagnosis, etc. These indicators can go a step further to help the
developers improve the design of products by showing the defects.
The daily data aggregator keeps acquiring the reliability indicators of the CNC machine minutes by minutes.
These records can serve as the database of hardware reliability analysis,

4.3 Specifications：

Data Aggregators Application Manual – 90

 机床产品/Machine Tool Products
–
Other Tool.

• These data aggregators would persist in acquiring the monitoring data as long as the controller is running
and keep the data histories for a period of time.
• For different purposes, the data aggregators have a variety of settings with each other. The following
paragraph will show you the configurations of the three different data aggregators.

Alarm Data Aggregator Service Data Aggregator Daily Data Aggregator

Period of Data Catching:

• 200 milliseconds
Maximum Recording Length:
• 4 minutes
Triggering Exportation Conditions:
• The aggregator would perform the exportation process when the following alarms arise.
Alarm Condition Alarm Info.

MOT-008 any axis Loss Pulse

MOT-087 any axis Inaccurate stop position. Please check if there

are any mechanisms stuck

MOT-019 any axis Following error exceed

MOT-023 any axis Fatal following error exceed

AL-100 Drive Alarm IGBT Overheat

AL-110 Drive Alarm Critical Over Voltage

AL-111 Drive Alarm Low Voltage

AL-120 Drive Alarm Driver Over Current

AL-121 Drive Alarm Power Module Over Current

AL-202 Drive Alarm Motor Overload

AL-203 Drive Alarm Motor Stuck

AL-521 Drive Alarm Excessive Following Error

Data Aggregators Application Manual – 91

 机床产品/Machine Tool Products
–
Other Tool.

Alarm Condition Alarm Info.

AL-550 Drive Alarm Unexpected disturbance torque

AL-910 Drive Alarm IGBT High Temperature

AL-94B Drive Alarm Position command error

AL-E30 Drive Alarm Position command error

Note: Drive alarm includes using M3 and EtherCAT communication.

Exportation Behavior：
If the controller is powered off before 2 seconds have elapsed after the alarm occurs, the file will not be
recorded.
If the controller is powered off before 80 seconds have elapsed after the alarm occurs, the file at this time
will be the data history of the past 238 seconds and the next 2 seconds (a total of 4 minutes), as well as the
alarm name of the "registered alarm" that occurred within the next 2 seconds. with absolute time.
If the controller has not been powered off for 80 seconds after the alarm occurs, the file at this time is the
data history of the past 160 seconds and the next 80 seconds (4 minutes in total), as well as the alarm
name and alarm name of the "registered alarm" that occurred in the next 80 seconds. Absolute time.
Note: Additional alarms within this 80 seconds will not trigger another recording. If the registered alarm
occurs again after 80 seconds, the next record will be triggered and output in another file.
• Whenever a registered alarm arises, the aggregator would start to backup：
a. If the controller is powered off within 2 seconds after an alarm occurs, no files will be recorded.
b. If the controller is powered off within 80 seconds after the alarm occurs, the file contain the trace
of the monitoring data from the 238 seconds before alarm to the 2 seconds after alarm (a total
of 4 minutes), as well as the alarm name and alarm occurrence time of the "registered alarm" that
occurred within 2 seconds after alarm.
c. If the controller has not been powered off within 80 seconds after the alarm occurs, the file
contain the trace of the monitoring data from the 160 seconds before alarm t to the 80 seconds
after alarm (a total of 4 minutes), as well as the alarm name and alarm occurrence time of the
"registered alarm" that occurred within the 80 seconds after alarm.
Note: Any other alarm occurs within these 80 seconds won't trigger another exportation process.
• For every exportation, the aggregator would create a new file with the triggering time written on the file
name.
• The error record includes nothing but the error message and is saved as a file individually.
Monitoring Data：
• The following table contains the monitoring data of an alarm data aggregator(1~3Axis):
No. Target Channel Target Data Source Interpretation

1 1st Axis Machine Position Controller --

2 1st Axis Torque Load Controller R Register No.5151

Data Aggregators Application Manual – 92

 机床产品/Machine Tool Products
–
Other Tool.

No. Target Channel Target Data Source Interpretation

3 1st Axis Following error Controller System Data No.8

4 2nd Axis Machine Position Controller --

5 2nd Axis Torque Load Controller R Register No.5152

6 2nd Axis Following error Controller System Data No.9

7 3rd Axis Machine Position Controller --

8 3rd Axis Torque Load Controller R Register No.5153

9 3rd Axis Following error Controller System Data No.10

10 1st Spindle Torque Load Controller R Register No.5141

11 1st Spindle DC Bus Voltage Drive Drive Status Monitoring

Variable No.D38

• The following table contains the monitoring data of an alarm data aggregator(4~6Axis):
No. Target Channel Target Data Source Interpretation

1 4st Axis Machine Position Controller --

2 4st Axis Torque Load Controller R Register No.5154

3 4st Axis Following error Controller System Data No.163

4 5nd Axis Machine Position Controller --

5 5nd Axis Torque Load Controller R Register No.5155

6 5nd Axis Following error Controller System Data No.164

Data Aggregators Application Manual – 93

 机床产品/Machine Tool Products
–
Other Tool.

No. Target Channel Target Data Source Interpretation

7 6rd Axis Machine Position Controller --

8 6rd Axis Torque Load Controller R Register No.5156

9 6rd Axis Following error Controller System Data No.165

10 2st Spindle Torque Load Controller R Register No.5142

11 2st Spindle DC Bus Voltage Drive Drive Status Monitoring

Variable No.D38

Alarm Data Aggregator Service Data Aggregator Daily Data Aggregator

Period of Data Catching:

• 1 second
Maximum Recording Length:
• 20 minutes
Triggering Exportation Conditions:
• Execute G-Code command "G10 L1100 P1007".
Exportation Behavior：
• The aggregator would backup the trace of monitoring data within the past 20 minutes and waiting for
exportation.
• The aggregator processes exporting the record at the end of a minute, thus the record will NOT be
created right after the events are triggered.
( ※ If the controller is shut down right after the trigger events, the record might not get saved. )
• For every exportation, the aggregator would create a new file with the triggering time written on the file
name.
• In multiple-triggering cases, the aggregator would export ONLY one record by the last trigger within a
minute.
• The error record includes nothing but the error message and is saved as a file individually.
Monitoring Data：
• The following table contains the monitoring data of a service data aggregator:

Data Aggregators Application Manual – 94

 机床产品/Machine Tool Products
–
Other Tool.

No. Target Target Data Source Interpretation Limitation

Channel

1 1st Axis IGBT Temperature Drive Status Monitoring

Variable No.D37

2 2nd Axis IGBT Temperature Drive Status Monitoring

Variable No.D37

3 3rd Axis IGBT Temperature Drive Status Monitoring

Variable No.D37

4 1st Spindle IGBT Temperature Drive Status Monitoring

Variable No.D37

5 1st Spindle Power Stage Main Drive Status Monitoring The drive must
Capacitance Variable No.DB0 support an MCU of the
Temperature Power Stage
Capacitance.

6 1st Spindle Encoder Internal Drive Status Monitoring

Temperature Variable No.D61

7 1st Spindle Encoder External_1 Drive Status Monitoring Syntec Encoder only.
Temperature Variable No.D62

8 1st Spindle The 5V Detection of Drive Status Monitoring Syntec Encoder only.
1st Encoder Variable No.D70

Alarm Data Aggregator Service Data Aggregator Daily Data Aggregator

Period of Data Catching:

• 1 minute
Maximum Recording Length:
• 1 day
Triggering Exportation Conditions:
• Automatically records on the hour and half hour of the local time.
Exportation Behavior：
• The aggregator would take the trace of monitoring data within the past 30 minutes and export the data
into a record.

Data Aggregators Application Manual – 95

 机床产品/Machine Tool Products
–
Other Tool.

• The data of the same date would get exported to the same record, by appending the data to the end of
previous data.
And a new record will be created when there is no file of the same date.
Both of the situations will the aggregator edits the time stamp on the file name by the recording time of
the last data.
• The error record includes no data info but the error message. It might overwrite the previous record of
the same date.
Monitoring Data：
• The following table contains the monitoring data of a daily data aggregator.(V1.1)
Software version: from 10.118.32I, 10.118.40M, 10.118.41M
No Target Target Data Source Interpretation Limitation
. Channel

1 CNC System CPU Controller System Data

Temperature (Cels No.39
ius)

2 1st Spindle DC Bus Voltage Drive Status

Monitoring
Variable No.D38

3 1st Axis IGBT Temperature Drive Status

Monitoring
Variable No.D37

4 2nd Axis IGBT Temperature Drive Status

Monitoring
Variable No.D37

5 3rd Axis IGBT Temperature Drive Status

Monitoring
Variable No.D37

6 4th Axis IGBT Temperature Drive Status

Monitoring
Variable No.D37

7 1st Axis Power Stage Main Drive Status The drive must
Capacitance Monitoring support an MCU of
Temperature Variable No.DB0 the Power Stage
Capacitance.

Data Aggregators Application Manual – 96

 机床产品/Machine Tool Products
–
Other Tool.

No Target Target Data Source Interpretation Limitation

. Channel

8 1st Spindle Encoder Drive Status Syntec Encoder only.

External_1 Monitoring
Temperature Variable No.D62

9 1st Spindle Encoder Internal Drive Status

Temperature Monitoring
Variable No.D61

10 1st Spindle feedback Speed Controller R Register No.36

11 1st Spindle Spindle Torque Controller R Register

Load No.5141

• Monitoring data for previous version

V1.0 (10.118.23X, 10.118.28L, 10.118.36 ~ 10.118.32H, 10.118.40L, 10.118.41L)

No Target Target Data Source Interpretation Limitation

. Channel

1 CNC System CPU Controller System Data

Temperature (Cel No.39
sius)

2 CNC System Substitute Controller System Data

Interpolation No.378
Execution Times

3 1st Spindle DC Bus Voltage Drive Status

Monitoring
Variable No.D38

4 1st Axis IGBT Drive Status

Temperature Monitoring
Variable No.D37

5 2nd Axis IGBT Drive Status

Temperature Monitoring
Variable No.D37

Data Aggregators Application Manual – 97

 机床产品/Machine Tool Products
–
Other Tool.

No Target Target Data Source Interpretation Limitation

. Channel

6 3rd Axis IGBT Drive Status

Temperature Monitoring
Variable No.D37

7 4th Axis IGBT Drive Status

Temperature Monitoring
Variable No.D37

8 1st Axis Power Stage Main Drive Status The drive must
Capacitance Monitoring support an MCU of
Temperature Variable No.DB0 the Power Stage
Capacitance.

9 1st Spindle Encoder Drive Status Syntec Encoder

External_1 Monitoring only.
Temperature Variable No.D62

10 1st Spindle Encoder Internal Drive Status

Temperature Monitoring
Variable No.D61

11 1st Spindle Enc CRC Error Drive Status Syntec Encoder

Count(SW) Monitoring only.
Variable No.D74

12 1st Spindle feedback Speed Controller R Register No.36

4.4 User guide：

• The records can be retrieved by Machine Backup(MB),

Data Aggregators Application Manual – 98

 机床产品/Machine Tool Products
–
Other Tool.

Directory FileName

MB\BackupOnly\Syntec FileName_MMDDhhmm.csv
MM: Month DD: Day
• \Alarm: alarm
hh: hour mm: minute
record(1~3Axis)
• \Alarm456: alarm for example:
record(4~6Axis) 。Alarm_0510093029.csv ( the time in the alarm(1~3Axis) file name
• \Service: will be recorded down to second )
service record
。Alarm456_0328164633.csv ( the time in the alarm(4~6Axis) file
• \Daily: daily
name will be recorded down to second )
record
。Service_05101730.csv
。Daily_05102359.csv
• Keep up to 10 files for each directory. Overwrite when the file name is the same.
• A guide to retrieve records from the controller and analyze by the tool: Syntec Analytics.
Steps Interpretation

Step 1. a. Run the Syntec Back-up System function to retrieve the records.
Path：【System Admin.】 → 【Backup Sys.】
Retrieve Machine Backup
b. The entrance page of the Syntec Back-Up System is
(MB)
shown below.
You can select the Syntec standard backup or a customized one
for different purposes.
It should be noticed that the records of data aggregators are
categorized as Auto-Backup Information,. That is to say, no
matter which option is chosen, the records would get backed up
as long as the backup process starts.
c. For quick back-up progress, you can choose only a few options.
Such as the History Alarms, OP Log, Diagnosis Log, or Maker Info
would be good choices.

Data Aggregators Application Manual – 99

 机床产品/Machine Tool Products
–
Other Tool.

Steps Interpretation

Step 2. a. Unzip the backup file, and you would get an overview of the
directory as shown below.
Find the records in the
The BackupOnly folder contains the records of data aggregators.
Backup.

b. Push to the directory: BackupOnly\Syntec, and you would find

four folders, named ( 1 ) Alarm ( 2 ) Service ( 3 ) Daily ( 4 )
Alarm456. Each of them contains the records of the four data
aggregators with the same name.

Data Aggregators Application Manual – 100

 机床产品/Machine Tool Products
–
Other Tool.

Steps Interpretation

c. For example, try to find a daily record by the date in which we are
interested.
The records have the timestamp of recording on its name, so it's

easy to find the record we need.

Step 3. With the Syntec Analytics - oscilloscope tool, we can import the record
directly into the oscilloscope and make the line chart easily.
Analyze the record.

Syntec Analytics - Oscilloscope

For more oscilloscope operating details, you can visit Syntec Analytics
- Oscilloscope.
※ Syntec Analytics does support the data aggregators records
interpretation from the version 2.1.16.
The version should be checked first before performing data analysis
by Syntec Analytics.

Data Aggregators Application Manual – 101

 机床产品/Machine Tool Products
–
Other Tool.

4.5 Constraints：
• Supported Controller Version: 10.118.23X, 10.118.28L, 10.118.36, and later.
• Supported Alarm record(4~6Axis) with Controller Version: 10.118.48P, 10.118.52J, 10.118.56D, 10.118.58 and
later.
• Drive Status Monitoring Variables are ONLY supported for Syntec M3 Drives.
That is to say, these variables cannot be retrieved with non-Syntec M3 Drives, and WILL always be 0 on
record.

4.6 Notifications：
• Due to limited communication bandwidth, Drive Status Monitoring Variables may not be retrieved
correctly under certain circumstances, as listed below. In such cases, data loss is recorded.
• Display Page - Fast Diag.-Axes Data -Drive comm.
• Drive Firmware update: The controller will disconnect with the drive after updating the drive
firmware, causing the Drive Status Monitoring Variables to be unavailable. A reboot is required to
regain access to Drive Status Monitoring Variables.
• Encoder Firmware update
• Encoder-related Tuning Function
• Error condition：
Up to this time, data aggregators neither have a diagnosis page nor notify runtime errors intuitively. But
there are still two fatal errors that might put the control system at risk.
Therefore, when these errors show up, data aggregators would write the error message and temporarily
inhibit themselves from exporting.
• Insufficient disk space( less than 1MB )
Before aggregators export data recorded to files, they will check the free space of the target disk first.
The aggregators will overwrite the record with an error message and inhibit the following record
exportation on the same date only if they meet the low disk space problem.
Error message: "Export Record Fail: Insufficient disk space. ( less than 1 MB )"
• Insufficient physical memories ( less than 30 MB )
At the startup of the controller, a memory protection process would be executed first before building
the data aggregators in case of running out of memories.
Once the memory lackage happened, the data aggregators will export an error message individually
and stop running until the system reboots.
Error message: "Register Kernel Scope Fail: Insufficient memory. ( less than 30 MB )"

4.7 Data Aggregators User Guide

中文版 Mandarin Version: 资料记录器-记录档操作手册
This manual will show you how to retrieve the records collected by the data aggregators.

Data Aggregators Application Manual – 102

 机床产品/Machine Tool Products
–
Other Tool.

Steps Interpretation

Step 1. 1. Run the Syntec Back-up System function to retrieve the records.
Path：【System Admin.】 → 【Backup Sys.】
Retrieve Machine Backup
2. The entrance page of the Syntec Back-Up System is shown below.
(MB)
You can select the Syntec standard backup or a customized one for different
purposes.
It should be noticed that the records of data aggregators are
categorized as Auto-Backup Information,. That is to say, no matter which
option is chosen, the records would get backed up as long as the backup
process starts.
3. For quick back-up progress, you can choose only a few options. Such as the
History Alarms, OP Log, Diagnosis Log, or Maker Info would be good choices.

Data Aggregators Application Manual – 103

 机床产品/Machine Tool Products
–
Other Tool.

Steps Interpretation

Step 2. 1. Unzip the backup file, and you would get an overview of the directory as
shown below.
Find the records in the
The BackupOnly folder contains the records of data aggregators.
Backup.

2. Push to the directory: BackupOnly\Syntec, and you would find four folders,
named ( 1 ) Alarm ( 2 ) Service ( 3 ) Daily ( 4 ) Alarm456. Each of them
contains the records of the four data aggregators with the same name.

Data Aggregators Application Manual – 104

 机床产品/Machine Tool Products
–
Other Tool.

Steps Interpretation

3. For example, try to find a daily record by the date in which we are interested.
The records have the timestamp of recording on its name, so it's easy to find

the record we need.

Data Aggregators Application Manual – 105

 机床产品/Machine Tool Products
–
Other Tool.

Steps Interpretation

Step 3. With the Syntec Analytics - oscilloscope tool, we can import the record directly
into the oscilloscope and make the line chart easily.
Analyze the record.

Syntec Analytics - Oscilloscope

For more oscilloscope operating details, you can visit Syntec Analytics -
Oscilloscope.
※ Syntec Analytics does support the data aggregators records
interpretation from the version 2.1.16.
The version should be checked first before performing data analysis by
Syntec Analytics.

Data Aggregators Application Manual – 106

 机床产品/Machine Tool Products
–
Other Tool.

5 Macro Editor Operation Manual

5.1 Marco Functions

5.1.1 Screen Description

1. Title Bar
Show the software name and whether it has been saved after modification (indicates by star sign)

2. Function Bar
Currently provide saving function only

3. Edit Area
The alarm no. and its corresponding string can be edited here

4. Status Bar
Display the current status of the data, such as "Pencil: Line being edited", "Star sign: Newline", "Arrow:
Selected line"

Macro Editor Operation Manual – 107

 机床产品/Machine Tool Products
–
Other Tool.

5.1.2 Function

Modification

Method 1: After clicking any field, input the string directly (it's more convenient to click once only)

Method 2: After double-clicking any field, enter the string (the edit cursor will appear, which is more intuitive)

Macro Editor Operation Manual – 108

 机床产品/Machine Tool Products
–
Other Tool.

Delete a Piece of Data

Click the status bar, the line will be highlighted, and it will be removed after pressing "Delete"

Add a Piece of Data

Click any row of the star sign to edit

Save File

Method 1: Click "File (F)-Save (S)"

Method 2: Press "Ctrl+S"

Macro Editor Operation Manual – 109

 机床产品/Machine Tool Products
–
Other Tool.

If there is a blank field, a prompt window will pop up and the file will not be saved

5.1.3 Suggestion

The standard/customized Macro alarm no. range has not yet been specified.
In order to avoid the conflict between the customized no. and the standard no., it is recommended that the
user set the number to "10001~20000" while setting.

5.2 Marco Overview

5.2.1 Software Introduction

Currently, provide Macro alarm string editing function only.

If there are more Marco-related editing functions, in the future they will be included in this software.

5.2.2 Environment

No restrictions

5.2.3 Installation and Removal

When using the customized command set (Macro) function through SI for the first time, this software will be
installed through SI, no need to do that by yourself.

Macro Editor Operation Manual – 110

 机床产品/Machine Tool Products
–
Other Tool.

5.2.4 Warnings and Notifications

This software must be operated with SI and is not valid when using alone (meaning double-click
MacroEditor.exe by yourself).
If used alone, there will be no file loading function.

Macro Editor Operation Manual – 111

 机床产品/Machine Tool Products
–
Other Tool.

6 AutoInitializer Operation Manual

Content

• Introduction
• Notes
• Execution Environment Requirements
• Operation
• Step 1. Download
• Step 2. Insert the software installation pack
• Step 3. Plug the USB into the controller and power on
• Initialize file content
• Log file
• Troubleshooting

6.1 Introduction

• This tool can automatically execute by plugging in the USB. It can initialize the controller and reset
related settings.
• This tool will format DISKC/DISKA, initialize Windows Registry, and remove all customized developing
files (PLC/Parameters...).
• This tool does not have built-in software installation package. The package of the corresponding
controller must be installed before use, and the recommended software version is 10.116.24Z.

6.2 Notes

• Please do not remove the USB while the tool is running, this action will cause serious damage to the
system.
• If an unexpectedly power failure occurs, user can first try to plug in the USB to reboot. The system will
try to continue the initialization operation. However, if an abnormal things occurs and the tool
cannot operate, please send the controller back to Syntec and attach the Log file of the AutoInit folder
in the USB.
• The software installation pack is to provide tools to automatically determine the version during
execution and to install automatically.
• Please make sure that there is only one installation pack in the AutoInit folder before plugging in
the USB to avoid system exceptions.
• AutoInitializer is a disposable tool, please download and use it again after use; otherwise, it will cause
problems such as the failure of the panel shortcut keys.

6.3 Execution Environment Requirements

AutoInitializer Operation Manual – 112

 机床产品/Machine Tool Products
–
Other Tool.

• Software version (must required):

• 10.116.0B
• image version (suggested):
• am35x > 7.2.0
• am3354, no restrictions
• If the image version does not match above version, a power failure or other interruption
occurs during the operation, the process may not be automatically repaired after power
on.
• CPU: Currently only supports AM335x, AM35x
• OS: WindowsCE7
• Controller must be equipped with serial number.

6.4 Operation

6.4.1 Step 1. Download

Please download the tool from the official website:

• Link: http://www.syntecclub.com/Download.aspx
• Path: Download => 06. Other Tool => AutoInitializer

Unzip the installation pack to the USB, and the files in your USB are as shown in the figure below:

AutoInitializer Operation Manual – 113

 机床产品/Machine Tool Products
–
Other Tool.

6.4.2 Step 2. Insert the software installation pack

Please go to the official website to download the installation pack of the corresponding model
• Link: http://www.syntecclub.com/Download.aspx

Put the installation pack into the AutoInit folder of USB

6.4.3 Step 3. Plug the USB into the controller and power on

Please plug the USB into the controller before power off, this tool will execute automatically.

System scanning (automatically)

AutoInitializer Operation Manual – 114

 机床产品/Machine Tool Products
–
Other Tool.

Cnc formatting (automatically)

System reboot (automatically)

Initialize (automatically)

AutoInitializer Operation Manual – 115

 机床产品/Machine Tool Products
–
Other Tool.

Prompt the user to remove the USB (manually)

When this prompt pops up, please remove the USB first, and manually power off and rest turn on, or press
"Enter" or click the OK button on the screen to reboot.

Install the software (automatically)

AutoInitializer Operation Manual – 116

 机床产品/Machine Tool Products
–
Other Tool.

After the installation is done, the initialization of the controller is complete.

6.5 Initialize file content

• After the controller is initialized, the files in DiskA / DiskC will be removed and put into the files needed
for system operation.
The following is the description of some of the inserted files.
• Ladder
• Site: AutoInit\Data\DiskC\OpenCNC\Ladder\Cnc.lad
• Source: Ladder of the company's products before shipment
• Parameter file
• Site: AutoInit\Data\DiskC\OpenCNC\Data\param.dat
• Source: 21MA product parameter default, and set "axis board no. corresponding to X
axis" to 1 (Pr21=1)
• The number of function key is restored to five keys
• If user wants to restore the customized parameter file/ladder after initialization, you can change the file
according to the above site.
• Notes:
• Replace the ladder/parameter file for initialization by yourself, please strictly confirm the
correctness of the source file, otherwise it will cause serious problems such as unable to turn on
the controller.
(If the above problem occurs after the operation, user can use the initialization tool without any
replacement to try to initialize the system again)
• Valid version: AutoInitializer_1.0.2

6.6 Log file

AutoInitializer Operation Manual – 117

 机床产品/Machine Tool Products
–
Other Tool.

• When this tool is executed, the Log file will be generated in the AutoInit folder in the USB
• Log file name: serial number_Log.txt
• Content:
• Execution time
• Execution details
• Record of execution mistakes
• Record of controller related information

Title Chinese

OS 作业系统

CPU 处理器

platform 平台

Kernel Version 软体版本

Product Version 产品版本

Machine Type 机床类别

Machine Module 机床属性

Serial number 序号

use time 使用期限

cnc option 软体功能选项

Maker ID 机械厂代码

NK Version 映像档版本

• Example:
Click to expand

2018-03-09 16:17:43 System Check

2018-03-09 16:17:43 Check OS is winodws CE...

AutoInitializer Operation Manual – 118

 机床产品/Machine Tool Products
–
Other Tool.

2018-03-09 16:17:44 Check OS OK.

2018-03-09 16:17:44 Check OS version...
2018-03-09 16:17:44 Check OS version OK.
2018-03-09 16:17:44 Check platform...
2018-03-09 16:17:52 Check platform OK.
2018-03-09 16:17:52 Check cpu...
2018-03-09 16:17:52 Check cpu OK.
2018-03-09 16:17:52 Check serial number exist...
2018-03-09 16:17:52 Check serial number OK.
2018-03-09 16:17:52 System Check-Start
2018-03-09 16:17:52 Access CNC information
2018-03-09 16:17:52 Get OS Version...
2018-03-09 16:17:52 Get OS information...
2018-03-09 16:17:52 Get CPU Type...
2018-03-09 16:17:52 Get platform information...
2018-03-09 16:17:52 Get kernel version...
2018-03-09 16:17:52 Get product version...
2018-03-09 16:17:52 Get machine type...
2018-03-09 16:17:52 Get module type...
2018-03-09 16:17:52 Get serial...
2018-03-09 16:17:52 Get usetime infomation...
2018-03-09 16:17:52 Get cnc option infomation...
2018-03-09 16:17:52 Get Maker ID...
2018-03-09 16:17:52 Get NK version...
2018-03-09 16:17:52 Record CNC information
2018-03-09 16:17:52 Write CNC Information to Log file...
2018-03-09 16:17:52 * OS= WINDOWSCE_7
2018-03-09 16:17:52 * CPU= AM335x
2018-03-09 16:17:52 * Platform= ARM
2018-03-09 16:17:52 * KrnlVer= 10.116.54E
2018-03-09 16:17:52 * PrdVer= 10.116.54E
2018-03-09 16:17:52 * MachType= Mill
2018-03-09 16:17:52 * MachModule= 220A
2018-03-09 16:17:52 * SerialNo= M9A0001
2018-03-09 16:17:52 * UseTime= No Limit
2018-03-09 16:17:52 * CncOption=
2018-03-09 16:17:52 * MakerID=
2018-03-09 16:17:52 * NKVer= 7.49
2018-03-09 16:17:53 Installation Pack Check
2018-03-09 16:17:53 Find package in USB...
2018-03-09 16:19:07 System Check
2018-03-09 16:19:08 Check OS is winodws CE...
2018-03-09 16:19:08 Check OS OK.
2018-03-09 16:19:08 Check OS version...
2018-03-09 16:19:08 Check OS version OK.
2018-03-09 16:19:08 Check platform...
2018-03-09 16:19:16 Check platform OK.
2018-03-09 16:19:16 Check cpu...
2018-03-09 16:19:16 Check cpu OK.
2018-03-09 16:19:16 Check serial number exist...

AutoInitializer Operation Manual – 119

 机床产品/Machine Tool Products
–
Other Tool.

2018-03-09 16:19:16 Check serial number OK.

2018-03-09 16:19:16 System Check-Start
2018-03-09 16:19:16 Access CNC information
2018-03-09 16:19:16 Get OS Version...
2018-03-09 16:19:16 Get OS information...
2018-03-09 16:19:16 Get CPU Type...
2018-03-09 16:19:16 Get platform information...
2018-03-09 16:19:16 Get kernel version...
2018-03-09 16:19:16 Get product version...
2018-03-09 16:19:16 Get machine type...
2018-03-09 16:19:16 Get module type...
2018-03-09 16:19:16 Get serial...
2018-03-09 16:19:16 Get usetime infomation...
2018-03-09 16:19:16 Get cnc option infomation...
2018-03-09 16:19:17 Get Maker ID...
2018-03-09 16:19:17 Get NK version...
2018-03-09 16:19:17 Record CNC information
2018-03-09 16:19:17 Write CNC Information to Log file...
2018-03-09 16:19:17 * OS= WINDOWSCE_7
2018-03-09 16:19:17 * CPU= AM335x
2018-03-09 16:19:17 * Platform= ARM
2018-03-09 16:19:17 * KrnlVer= 10.116.54E
2018-03-09 16:19:17 * PrdVer= 10.116.54E
2018-03-09 16:19:17 * MachType= Mill
2018-03-09 16:19:17 * MachModule= 220A
2018-03-09 16:19:17 * SerialNo= M9A0001
2018-03-09 16:19:17 * UseTime= No Limit
2018-03-09 16:19:17 * CncOption=
2018-03-09 16:19:17 * MakerID=
2018-03-09 16:19:17 * NKVer= 7.49
2018-03-09 16:19:17 Installation Pack Check
2018-03-09 16:19:17 Find package in USB...
2018-03-09 16:19:23 Check Package Platform...
2018-03-09 16:19:31 Check Package Platform OK.
2018-03-09 16:19:31 Check Package Model...
2018-03-09 16:19:31 Check Package Model OK.
2018-03-09 16:19:31 Check Package Machine Type...
2018-03-09 16:19:31 Check Package Machine OK.
2018-03-09 16:19:31 System Check-Finish
2018-03-09 16:19:31 System Formatting-Start
2018-03-09 16:19:31 Disk Formatting
2018-03-09 16:19:31 Format DiskA Part00...
2018-03-09 16:19:31 Find DSK2: Part00 partition...
2018-03-09 16:19:31 Find partition OK.
2018-03-09 16:19:31 Log partition information...
2018-03-09 16:19:31 * DSK2: Part00 volumeName= DiskA
2018-03-09 16:19:31 * DSK2: Part00 PartitionName= Part00
2018-03-09 16:19:31 * DSK2: Part00 FileSys= exfat.dll
2018-03-09 16:19:31 * DSK2: Part00 NumSectors= 130815
2018-03-09 16:19:31 * DSK2: Part00 PartType= 6

AutoInitializer Operation Manual – 120

 机床产品/Machine Tool Products
–
Other Tool.

2018-03-09 16:19:31 Dismount partition...

2018-03-09 16:19:31 Dismount partition OK.
2018-03-09 16:19:31 Delete partition...
2018-03-09 16:19:32 Delete partition OK.
2018-03-09 16:19:32 Create partition...
2018-03-09 16:19:32 Create partition OK.
2018-03-09 16:19:32 Format DiskC Part01...
2018-03-09 16:19:32 Find DSK1: Part01 partition...
2018-03-09 16:19:32 Find partition OK.
2018-03-09 16:19:32 Log partition information...
2018-03-09 16:19:32 * DSK1: Part01 volumeName= DiskC
2018-03-09 16:19:32 * DSK1: Part01 PartitionName= Part01
2018-03-09 16:19:32 * DSK1: Part01 FileSys= exfat.dll
2018-03-09 16:19:32 * DSK1: Part01 NumSectors= 110720
2018-03-09 16:19:32 * DSK1: Part01 PartType= 6
2018-03-09 16:19:32 Dismount partition...
2018-03-09 16:19:33 Dismount partition OK.
2018-03-09 16:19:33 Delete partition...
2018-03-09 16:19:33 Delete partition OK.
2018-03-09 16:19:33 Create partition...
2018-03-09 16:19:33 Create partition OK.
2018-03-09 16:19:33 Install System Files
2018-03-09 16:19:34 Install System File...
2018-03-09 16:19:42 Copy :
\USBDisk\AutoInit\Data\DiskC\SB.EXE
2018-03-09 16:19:42 Copy :
\USBDisk\AutoInit\Data\DiskC\WELOCK.EXE
2018-03-09 16:19:43 Copy :
\USBDisk\AutoInit\Data\DiskC\Fonts\ARIALBD.TTF
2018-03-09 16:19:43 Copy :
\USBDisk\AutoInit\Data\DiskC\Fonts\arial_1_30.ttf
2018-03-09 16:19:44 Copy :
\USBDisk\AutoInit\Data\DiskC\Fonts\COMIC.TTF
2018-03-09 16:19:44 Copy :
\USBDisk\AutoInit\Data\DiskC\Fonts\COMICBD.TTF
2018-03-09 16:19:50 Copy :
\USBDisk\AutoInit\Data\DiskC\Fonts\MINGLIU.TTC
2018-03-09 16:19:53 Copy :
\USBDisk\AutoInit\Data\DiskC\Fonts\MONA.TTF
2018-03-09 16:19:53 Copy :
\USBDisk\AutoInit\Data\DiskC\Fonts\MONACO.TTF
2018-03-09 16:20:04 Copy :
\USBDisk\AutoInit\Data\DiskC\Fonts\SIMSUN.TTC
2018-03-09 16:20:04 Copy :
\USBDisk\AutoInit\Data\DiskC\Fonts\SYMBOL.TTF
2018-03-09 16:20:05 Copy :
\USBDisk\AutoInit\Data\DiskC\Fonts\tahoma_1_07.ttf
2018-03-09 16:20:05 Copy :
\USBDisk\AutoInit\Data\DiskC\Fonts\TIMESBD.TTF

AutoInitializer Operation Manual – 121

 机床产品/Machine Tool Products
–
Other Tool.

2018-03-09 16:20:06 Copy :

\USBDisk\AutoInit\Data\DiskC\Fonts\TIMESBI.TTF
2018-03-09 16:20:06 Copy :
\USBDisk\AutoInit\Data\DiskC\Fonts\TIMESI.TTF
2018-03-09 16:20:06 Copy :
\USBDisk\AutoInit\Data\DiskC\Fonts\times_1_30.ttf
2018-03-09 16:20:07 Copy :
\USBDisk\AutoInit\Data\DiskC\Fonts\TREBUC.TTF
2018-03-09 16:20:07 Copy :
\USBDisk\AutoInit\Data\DiskC\Fonts\VERDANA.TTF
2018-03-09 16:20:09 Copy :
\USBDisk\AutoInit\Data\DiskC\Fonts\Common\MONA.TTF
2018-03-09 16:20:10 Copy :
\USBDisk\AutoInit\Data\DiskC\Fonts\Common\MONACO.TTF
2018-03-09 16:20:10 Copy :
\USBDisk\AutoInit\Data\DiskC\OpenCNC\Ladder\CNC.LAD
2018-03-09 16:20:10 Copy :
\USBDisk\AutoInit\Data\DiskC\Shared\DOTNET\OpenInstaller.exe
2018-03-09 16:20:11 Copy :
\USBDisk\AutoInit\Data\DiskC\Shared\DOTNET\SA.EXE
2018-03-09 16:20:11 System Formatting-Finish
2018-03-09 16:20:11 System Reboot
2018-03-09 16:20:11 Wait for auto reboot...
2018-03-09 16:20:51 System Restore-Start
2018-03-09 16:20:52 Install Keyboard Driver
2018-03-09 16:20:52 Install KB Driver...
2018-03-09 16:20:52 Install Software
2018-03-09 16:20:52 Find package in USB...
2018-03-09 16:20:52 Copy package to DiskC...
2018-03-09 16:21:00 Copy :
\USBDisk\AutoInit\package_ce6d6837.zip
2018-03-09 16:21:00 Creating CEINIT.xml...
2018-03-09 16:21:08 System Restore-Finish

6.7 Troubleshooting

• If the following screen appear during installation, please refer to the table below for possible
troubleshooting methods

Item Screen Method

AutoInitializer Operation Manual – 122

 机床产品/Machine Tool Products
–
Other Tool.

CPU type not support Please confirm whether the CPU of the
controller is the supported type (am35x,
am335x, am3354)
Note: For more information, please open the
AutoInit folder in the USB and refer to the internal
Log file.

The CNC model of the Please check whether the installation pack in
the USB matches the CNC model
installation pack does
Note: For more information, please open the
not match
AutoInit folder in the USB and refer to the internal
Log file.

The machine type of the Please check whether the installation pack in
the USB matches the machine type
installation pack does
Note: For more information, please open the
not match
AutoInit folder in the USB and refer to the internal
Log file.

Installation pack not Please check if the installation package is

correctly put in the USB
found

The OS of the Please confirm whether the current operating

system is WindowsCE7
installation pack does
not match

CNC Machine Module Please make sure that the USB has been
removed
is missing
Note: For more information, please open the
AutoInit folder in the USB and refer to the internal
Log file.

CNC Machine Type is Please make sure that the USB has been
removed
missing
Note: For more information, please open the
AutoInit folder in the USB and refer to the internal
Log file.

AutoInitializer Operation Manual – 123

 机床产品/Machine Tool Products
–
Other Tool.

6.8 AutoInitializer Operation Manual_Source

Content

• Introduction
• Notes
• Execution Environment Requirements
• Operation
• Step 1. Download
• Step 2. Insert the software installation pack
• Step 3. Plug the USB into the controller and power on
• Initialize file content
• Log file
• Troubleshooting

6.8.1 Introduction

• This tool can automatically execute by plugging in the USB. It can initialize the controller and reset
related settings.
• This tool will format DISKC/DISKA, initialize Windows Registry, and remove all customized developing
files (PLC/Parameters...).
• This tool does not have built-in software installation package. The package of the corresponding
controller must be installed before use, and the recommended software version is 10.116.24Z.

6.8.2 Notes

• Please do not remove the USB while the tool is running, this action will cause serious damage to the
system.
• If an unexpectedly power failure occurs, user can first try to plug in the USB to reboot. The system will
try to continue the initialization operation. However, if an abnormal things occurs and the tool
cannot operate, please send the controller back to Syntec and attach the Log file of the AutoInit folder
in the USB.
• The software installation pack is to provide tools to automatically determine the version during
execution and to install automatically.
• Please make sure that there is only one installation pack in the AutoInit folder before plugging in
the USB to avoid system exceptions.
• AutoInitializer is a disposable tool, please download and use it again after use; otherwise, it will cause
problems such as the failure of the panel shortcut keys.

6.8.3 Execution Environment Requirements

AutoInitializer Operation Manual – 124

 机床产品/Machine Tool Products
–
Other Tool.

• Software version (must required):

• 10.116.0B
• image version (suggested):
• am35x > 7.2.0
• am3354, no restrictions
• If the image version does not match above version, a power failure or other interruption
occurs during the operation, the process may not be automatically repaired after power
on.
• CPU: Currently only supports AM335x, AM35x
• OS: WindowsCE7
• Controller must be equipped with serial number.

6.8.4 Operation

Step 1. Download

Please download the tool from the official website:

• Link: http://www.syntecclub.com/Download.aspx
• Path: Download => 06. Other Tool => AutoInitializer

Unzip the installation pack to the USB, and the files in your USB are as shown in the figure below:

AutoInitializer Operation Manual – 125

 机床产品/Machine Tool Products
–
Other Tool.

Step 2. Insert the software installation pack

Please go to the official website to download the installation pack of the corresponding model
• Link: http://www.syntecclub.com/Download.aspx

Put the installation pack into the AutoInit folder of USB

Step 3. Plug the USB into the controller and power on

Please plug the USB into the controller before power off, this tool will execute automatically.

System scanning (automatically)

AutoInitializer Operation Manual – 126

 机床产品/Machine Tool Products
–
Other Tool.

Cnc formatting (automatically)

System reboot (automatically)

Initialize (automatically)

AutoInitializer Operation Manual – 127

 机床产品/Machine Tool Products
–
Other Tool.

Prompt the user to remove the USB (manually)

When this prompt pops up, please remove the USB first, and manually power off and rest turn on, or press
"Enter" or click the OK button on the screen to reboot.

Install the software (automatically)

AutoInitializer Operation Manual – 128

 机床产品/Machine Tool Products
–
Other Tool.

After the installation is done, the initialization of the controller is complete.

6.8.5 Initialize file content

• After the controller is initialized, the files in DiskA / DiskC will be removed and put into the files needed
for system operation.
The following is the description of some of the inserted files.
• Ladder
• Site: AutoInit\Data\DiskC\OpenCNC\Ladder\Cnc.lad
• Source: Ladder of the company's products before shipment
• Parameter file
• Site: AutoInit\Data\DiskC\OpenCNC\Data\param.dat
• Source: 21MA product parameter default, and set "axis board no. corresponding to X
axis" to 1 (Pr21=1)
• The number of function key is restored to five keys
• If user wants to restore the customized parameter file/ladder after initialization, you can change the file
according to the above site.
• Notes:
• Replace the ladder/parameter file for initialization by yourself, please strictly confirm the
correctness of the source file, otherwise it will cause serious problems such as unable to turn on
the controller.
(If the above problem occurs after the operation, user can use the initialization tool without any
replacement to try to initialize the system again)
• Valid version: AutoInitializer_1.0.2

6.8.6 Log file

AutoInitializer Operation Manual – 129

 机床产品/Machine Tool Products
–
Other Tool.

• When this tool is executed, the Log file will be generated in the AutoInit folder in the USB
• Log file name: serial number_Log.txt
• Content:
• Execution time
• Execution details
• Record of execution mistakes
• Record of controller related information

Title Chinese

OS 作业系统

CPU 处理器

platform 平台

Kernel Version 软体版本

Product Version 产品版本

Machine Type 机床类别

Machine Module 机床属性

Serial number 序号

use time 使用期限

cnc option 软体功能选项

Maker ID 机械厂代码

NK Version 映像档版本

• Example:
Click to expand

2018-03-09 16:17:43 System Check

2018-03-09 16:17:43 Check OS is winodws CE...

AutoInitializer Operation Manual – 130

 机床产品/Machine Tool Products
–
Other Tool.

2018-03-09 16:17:44 Check OS OK.

2018-03-09 16:17:44 Check OS version...
2018-03-09 16:17:44 Check OS version OK.
2018-03-09 16:17:44 Check platform...
2018-03-09 16:17:52 Check platform OK.
2018-03-09 16:17:52 Check cpu...
2018-03-09 16:17:52 Check cpu OK.
2018-03-09 16:17:52 Check serial number exist...
2018-03-09 16:17:52 Check serial number OK.
2018-03-09 16:17:52 System Check-Start
2018-03-09 16:17:52 Access CNC information
2018-03-09 16:17:52 Get OS Version...
2018-03-09 16:17:52 Get OS information...
2018-03-09 16:17:52 Get CPU Type...
2018-03-09 16:17:52 Get platform information...
2018-03-09 16:17:52 Get kernel version...
2018-03-09 16:17:52 Get product version...
2018-03-09 16:17:52 Get machine type...
2018-03-09 16:17:52 Get module type...
2018-03-09 16:17:52 Get serial...
2018-03-09 16:17:52 Get usetime infomation...
2018-03-09 16:17:52 Get cnc option infomation...
2018-03-09 16:17:52 Get Maker ID...
2018-03-09 16:17:52 Get NK version...
2018-03-09 16:17:52 Record CNC information
2018-03-09 16:17:52 Write CNC Information to Log file...
2018-03-09 16:17:52 * OS= WINDOWSCE_7
2018-03-09 16:17:52 * CPU= AM335x
2018-03-09 16:17:52 * Platform= ARM
2018-03-09 16:17:52 * KrnlVer= 10.116.54E
2018-03-09 16:17:52 * PrdVer= 10.116.54E
2018-03-09 16:17:52 * MachType= Mill
2018-03-09 16:17:52 * MachModule= 220A
2018-03-09 16:17:52 * SerialNo= M9A0001
2018-03-09 16:17:52 * UseTime= No Limit
2018-03-09 16:17:52 * CncOption=
2018-03-09 16:17:52 * MakerID=
2018-03-09 16:17:52 * NKVer= 7.49
2018-03-09 16:17:53 Installation Pack Check
2018-03-09 16:17:53 Find package in USB...
2018-03-09 16:19:07 System Check
2018-03-09 16:19:08 Check OS is winodws CE...
2018-03-09 16:19:08 Check OS OK.
2018-03-09 16:19:08 Check OS version...
2018-03-09 16:19:08 Check OS version OK.
2018-03-09 16:19:08 Check platform...
2018-03-09 16:19:16 Check platform OK.
2018-03-09 16:19:16 Check cpu...
2018-03-09 16:19:16 Check cpu OK.
2018-03-09 16:19:16 Check serial number exist...

AutoInitializer Operation Manual – 131

 机床产品/Machine Tool Products
–
Other Tool.

2018-03-09 16:19:16 Check serial number OK.

2018-03-09 16:19:16 System Check-Start
2018-03-09 16:19:16 Access CNC information
2018-03-09 16:19:16 Get OS Version...
2018-03-09 16:19:16 Get OS information...
2018-03-09 16:19:16 Get CPU Type...
2018-03-09 16:19:16 Get platform information...
2018-03-09 16:19:16 Get kernel version...
2018-03-09 16:19:16 Get product version...
2018-03-09 16:19:16 Get machine type...
2018-03-09 16:19:16 Get module type...
2018-03-09 16:19:16 Get serial...
2018-03-09 16:19:16 Get usetime infomation...
2018-03-09 16:19:16 Get cnc option infomation...
2018-03-09 16:19:17 Get Maker ID...
2018-03-09 16:19:17 Get NK version...
2018-03-09 16:19:17 Record CNC information
2018-03-09 16:19:17 Write CNC Information to Log file...
2018-03-09 16:19:17 * OS= WINDOWSCE_7
2018-03-09 16:19:17 * CPU= AM335x
2018-03-09 16:19:17 * Platform= ARM
2018-03-09 16:19:17 * KrnlVer= 10.116.54E
2018-03-09 16:19:17 * PrdVer= 10.116.54E
2018-03-09 16:19:17 * MachType= Mill
2018-03-09 16:19:17 * MachModule= 220A
2018-03-09 16:19:17 * SerialNo= M9A0001
2018-03-09 16:19:17 * UseTime= No Limit
2018-03-09 16:19:17 * CncOption=
2018-03-09 16:19:17 * MakerID=
2018-03-09 16:19:17 * NKVer= 7.49
2018-03-09 16:19:17 Installation Pack Check
2018-03-09 16:19:17 Find package in USB...
2018-03-09 16:19:23 Check Package Platform...
2018-03-09 16:19:31 Check Package Platform OK.
2018-03-09 16:19:31 Check Package Model...
2018-03-09 16:19:31 Check Package Model OK.
2018-03-09 16:19:31 Check Package Machine Type...
2018-03-09 16:19:31 Check Package Machine OK.
2018-03-09 16:19:31 System Check-Finish
2018-03-09 16:19:31 System Formatting-Start
2018-03-09 16:19:31 Disk Formatting
2018-03-09 16:19:31 Format DiskA Part00...
2018-03-09 16:19:31 Find DSK2: Part00 partition...
2018-03-09 16:19:31 Find partition OK.
2018-03-09 16:19:31 Log partition information...
2018-03-09 16:19:31 * DSK2: Part00 volumeName= DiskA
2018-03-09 16:19:31 * DSK2: Part00 PartitionName= Part00
2018-03-09 16:19:31 * DSK2: Part00 FileSys= exfat.dll
2018-03-09 16:19:31 * DSK2: Part00 NumSectors= 130815
2018-03-09 16:19:31 * DSK2: Part00 PartType= 6

AutoInitializer Operation Manual – 132

 机床产品/Machine Tool Products
–
Other Tool.

2018-03-09 16:19:31 Dismount partition...

2018-03-09 16:19:31 Dismount partition OK.
2018-03-09 16:19:31 Delete partition...
2018-03-09 16:19:32 Delete partition OK.
2018-03-09 16:19:32 Create partition...
2018-03-09 16:19:32 Create partition OK.
2018-03-09 16:19:32 Format DiskC Part01...
2018-03-09 16:19:32 Find DSK1: Part01 partition...
2018-03-09 16:19:32 Find partition OK.
2018-03-09 16:19:32 Log partition information...
2018-03-09 16:19:32 * DSK1: Part01 volumeName= DiskC
2018-03-09 16:19:32 * DSK1: Part01 PartitionName= Part01
2018-03-09 16:19:32 * DSK1: Part01 FileSys= exfat.dll
2018-03-09 16:19:32 * DSK1: Part01 NumSectors= 110720
2018-03-09 16:19:32 * DSK1: Part01 PartType= 6
2018-03-09 16:19:32 Dismount partition...
2018-03-09 16:19:33 Dismount partition OK.
2018-03-09 16:19:33 Delete partition...
2018-03-09 16:19:33 Delete partition OK.
2018-03-09 16:19:33 Create partition...
2018-03-09 16:19:33 Create partition OK.
2018-03-09 16:19:33 Install System Files
2018-03-09 16:19:34 Install System File...
2018-03-09 16:19:42 Copy :
\USBDisk\AutoInit\Data\DiskC\SB.EXE
2018-03-09 16:19:42 Copy :
\USBDisk\AutoInit\Data\DiskC\WELOCK.EXE
2018-03-09 16:19:43 Copy :
\USBDisk\AutoInit\Data\DiskC\Fonts\ARIALBD.TTF
2018-03-09 16:19:43 Copy :
\USBDisk\AutoInit\Data\DiskC\Fonts\arial_1_30.ttf
2018-03-09 16:19:44 Copy :
\USBDisk\AutoInit\Data\DiskC\Fonts\COMIC.TTF
2018-03-09 16:19:44 Copy :
\USBDisk\AutoInit\Data\DiskC\Fonts\COMICBD.TTF
2018-03-09 16:19:50 Copy :
\USBDisk\AutoInit\Data\DiskC\Fonts\MINGLIU.TTC
2018-03-09 16:19:53 Copy :
\USBDisk\AutoInit\Data\DiskC\Fonts\MONA.TTF
2018-03-09 16:19:53 Copy :
\USBDisk\AutoInit\Data\DiskC\Fonts\MONACO.TTF
2018-03-09 16:20:04 Copy :
\USBDisk\AutoInit\Data\DiskC\Fonts\SIMSUN.TTC
2018-03-09 16:20:04 Copy :
\USBDisk\AutoInit\Data\DiskC\Fonts\SYMBOL.TTF
2018-03-09 16:20:05 Copy :
\USBDisk\AutoInit\Data\DiskC\Fonts\tahoma_1_07.ttf
2018-03-09 16:20:05 Copy :
\USBDisk\AutoInit\Data\DiskC\Fonts\TIMESBD.TTF

AutoInitializer Operation Manual – 133

 机床产品/Machine Tool Products
–
Other Tool.

2018-03-09 16:20:06 Copy :

\USBDisk\AutoInit\Data\DiskC\Fonts\TIMESBI.TTF
2018-03-09 16:20:06 Copy :
\USBDisk\AutoInit\Data\DiskC\Fonts\TIMESI.TTF
2018-03-09 16:20:06 Copy :
\USBDisk\AutoInit\Data\DiskC\Fonts\times_1_30.ttf
2018-03-09 16:20:07 Copy :
\USBDisk\AutoInit\Data\DiskC\Fonts\TREBUC.TTF
2018-03-09 16:20:07 Copy :
\USBDisk\AutoInit\Data\DiskC\Fonts\VERDANA.TTF
2018-03-09 16:20:09 Copy :
\USBDisk\AutoInit\Data\DiskC\Fonts\Common\MONA.TTF
2018-03-09 16:20:10 Copy :
\USBDisk\AutoInit\Data\DiskC\Fonts\Common\MONACO.TTF
2018-03-09 16:20:10 Copy :
\USBDisk\AutoInit\Data\DiskC\OpenCNC\Ladder\CNC.LAD
2018-03-09 16:20:10 Copy :
\USBDisk\AutoInit\Data\DiskC\Shared\DOTNET\OpenInstaller.exe
2018-03-09 16:20:11 Copy :
\USBDisk\AutoInit\Data\DiskC\Shared\DOTNET\SA.EXE
2018-03-09 16:20:11 System Formatting-Finish
2018-03-09 16:20:11 System Reboot
2018-03-09 16:20:11 Wait for auto reboot...
2018-03-09 16:20:51 System Restore-Start
2018-03-09 16:20:52 Install Keyboard Driver
2018-03-09 16:20:52 Install KB Driver...
2018-03-09 16:20:52 Install Software
2018-03-09 16:20:52 Find package in USB...
2018-03-09 16:20:52 Copy package to DiskC...
2018-03-09 16:21:00 Copy :
\USBDisk\AutoInit\package_ce6d6837.zip
2018-03-09 16:21:00 Creating CEINIT.xml...
2018-03-09 16:21:08 System Restore-Finish

6.8.7 Troubleshooting

• If the following screen appear during installation, please refer to the table below for possible
troubleshooting methods

Item Screen Method

AutoInitializer Operation Manual – 134

 机床产品/Machine Tool Products
–
Other Tool.

CPU type not support Please confirm whether the CPU of the
controller is the supported type (am35x,
am335x, am3354)
Note: For more information, please open the
AutoInit folder in the USB and refer to the internal
Log file.

The CNC model of the Please check whether the installation pack in
the USB matches the CNC model
installation pack does
Note: For more information, please open the
not match
AutoInit folder in the USB and refer to the internal
Log file.

The machine type of the Please check whether the installation pack in
the USB matches the machine type
installation pack does
Note: For more information, please open the
not match
AutoInit folder in the USB and refer to the internal
Log file.

Installation pack not Please check if the installation package is

correctly put in the USB
found

The OS of the Please confirm whether the current operating

system is WindowsCE7
installation pack does
not match

CNC Machine Module Please make sure that the USB has been
removed
is missing
Note: For more information, please open the
AutoInit folder in the USB and refer to the internal
Log file.

CNC Machine Type is Please make sure that the USB has been
removed
missing
Note: For more information, please open the
AutoInit folder in the USB and refer to the internal
Log file.

AutoInitializer Operation Manual – 135

 机床产品/Machine Tool Products
–
Other Tool.

7 USB Backup Operation Manual

USB Backup 操作手册

7.1 Introduction

• This USB tool automatically backs up the data in the controller when it is powered on, and for
situations without a screen, it can be backed up and removed through this tool.

7.2 BackUp Item

The following items currently default to backup

Item Other

1 Parameters file \DiskC\OpenCNC\Data\Param.dat

2 Ladder \DiskC\OpenCNC\Ladder\cnc.lad

3 SB boot screen \DiskC\OCRes\Common\Image\SB_logo.bmp

4 System boot screen Bootcepc.bmp

5 Registry file \DiskA\OpenCNC\User\Registry.dat

6 Custom folders \DiskC\OCRes

7 Profile \DiskA\OpenCNC\NcFiles

7.3 Operation Method

7.3.1 STEP1. Download tools

• Please download from the official website

• https://www.syntecclub.com/Download.aspx

USB Backup Operation Manual – 136

 机床产品/Machine Tool Products
–
Other Tool.

7.3.2 STEP2. Insert the software installation package

• Unzip the installation package and put it into the USB

• The data structure in the USB is as follows

7.3.3 STEP3. Plug the USB into the controller and power it on for backup

• The backup will be done automatically after you plug in the USB and turn on the controller
• When the following screen is displayed, it means the backup operation is finished, please remove the
USB and reboot the controller

USB Backup Operation Manual – 137

 机床产品/Machine Tool Products
–
Other Tool.

• A Backup folder will be created in the USB, which will have a folder named according to the serial
number, and all the backup files will be placed in this folder

7.4 File Content Description

7.4.1 Backup configuration file( USB_BackupConfig.xml )

Introduction

• File Name： USB_BackupConfig.xml

• File Location： Under the USB root directory, as shown below

USB Backup Operation Manual – 138

 机床产品/Machine Tool Products
–
Other Tool.

• File Format： Configuration file in standard XML format

• Function：USB Backup backup tool, it will backup according to the content in the configuration file
USB_BackupConfig.xml

Content

• The default standard configuration files are as follows, as well as the contents of the backup items
provided in the upper part of the chapter

USB_BackupConfig

<Config>
<BackupFile>
<SourcePath>\DiskC\OpenCNC\Data\Param.dat</SourcePath>
<TargetPath>Param.dat</TargetPath>
</BackupFile>

<BackupFile>
<SourcePath>\DiskC\OpenCNC\Ladder\cnc.lad</SourcePath>
<TargetPath>cnc.lad</TargetPath>
</BackupFile>

<BackupFile>
<SourcePath>\DiskC\OCRes\Common\Image\SB_logo.bmp</SourcePath>
<TargetPath>SB_logo.bmp</TargetPath>
</BackupFile>

<BackupFile>
<SourcePath>\DiskC\Bootcepc.bmp</SourcePath>
<TargetPath>Bootcepc.bmp</TargetPath>
</BackupFile>

<BackupFile>

USB Backup Operation Manual – 139

 机床产品/Machine Tool Products
–
Other Tool.

<SourcePath>\DiskA\OpenCNC\User\Registry.dat</SourcePath>
<TargetPath>Registry.dat</TargetPath>
</BackupFile>

<BackupFolder>
<SourcePath>\DiskC\OCRes</SourcePath>
<TargetPath>OCRes</TargetPath>
</BackupFolder>

<BackupFolder>
<SourcePath>\DiskA\OpenCNC\NcFiles</SourcePath>
<TargetPath>NCFiles</TargetPath>
</BackupFolder>
</Config>

• The USB Backup tool will perform a software backup of the above text. For additional backups, please
refer to the following section
• Notice
• For arm series backup boot file, <SourcePath> is the same as x86, write \DiskC\Bootcepc.bmp

Related usage specifications

• USB_BackupConfig.xml Backup specifications

Item Description Remark

USB_BackupConfig.x If the file does not exist, no backup is

ml performed

If the file exists, but the content is

empty or there is no matching
element, then no backup is
performed

If the file exists and the content has

matching elements, the element
that matches the specification will
be backed up

Description of the Element for backup

USB Backup Operation Manual – 140

 机床产品/Machine Tool Products
–
Other Tool.

Item Description Remark

<SourcePath> When the <SourcePath> element

does not exist, no backup of the item
is performed

When the <SourcePath> element

exists, but the source path file does
not exist, no backup of the item is
performed

<TargetPath> When the <TargetPath> element

does not exist, no backup of the item
is performed

When <TargetPath> element exists

and the specified destination
already exists a file, force to
overwrite the file for backup

USB Backup Operation Manual – 141

 机床产品/Machine Tool Products
–
Other Tool.

Item Description Remark

Element value of <TargetPath> The backup path to USB is: USB \

Backup \ Controller serial number
\ (TargetPath)
Either the file name or the
folder+file name can be filled in as
the TargetPath

Backup to file
If the element value is

<TargetPath>
Param.dat </
TargetPath>

The backup path to USB is:

USB \ Backup \ Controller
serial number \ (TargetPath)

Backup to folder
If the element value is

<TargetPath>
NcFiles </
TargetPath>

The backup path to USB is:

USB \ Backup \ Controller
serial number \ (TargetPath)

USB Backup Operation Manual – 142

 机床产品/Machine Tool Products
–
Other Tool.

7.4.2 Backup Log ( Serial No..txt )

Log introduction

This file records basic information of the controller and the backup contents and results during backup.
• File Name：Serial No..txt
• File Location： USBDisk\Backup\Serial No.\Serial No..txt

Log content

The record of this file is divided into three main sections

1. Controller basic information
a. USB Backup backup time
b. USB Backup version
c. Controller serial number
d. Controller model
e. Controller human-machine version
f. Controller core version
g. Image file version
2. Configuration path check
a. If there is an error in the setup file, it will be logged in this section.
b. Please refer to the next Q & A section for error troubleshooting.
3. Backup result
a. In addition to recording the source and destination of the backups, the results of the backups
are also recorded, for each project.

USB Backup Operation Manual – 143

 机床产品/Machine Tool Products
–
Other Tool.

7.5 Backup Other Custom Files

7.5.1 Backup configuration file edit

• After downloading and unzipping the USB Backup, the configuration file "USB_BackupConfig.xml" can
be found.
• Open "USB_BackupConfig.xml" with the text editor software
• To backup "files", add the following XML content to the USB_BackupConfig.xml file, and fill in the
source of the files to be backed up in SourcePath and the target location to be backed up to the
USB\Backup\Serial No.\ folder in TargetPath

BackupFile

<BackupFile>
<SourcePath>the source of the files to be backed up in the controller</
SourcePath>
<TargetPath>target location to be backed up to the USB</TargetPath>
</BackupFile>

USB Backup Operation Manual – 144

 机床产品/Machine Tool Products
–
Other Tool.

• To back up the "folder", add the following XML content to the USB_BackupConfig.xml file, and fill in the
source of the folder to be backed up in SourcePath and the target location of the folder to be backed up
to USB\Backup\Serial No.\ folder in TargetPath

BackupFolder

<BackupFolder>
<SourcePath>the source of the folder to be backed up in the
controller</SourcePath>
<TargetPath>the target location of the folder to be backed up to USB</
TargetPath>
</BackupFolder>

• Archive the file after editing, the following usage is as described in the section " Operation Method "
above.
• Valid Version： USB Backup v1.1.0

7.5.2 Examples

• Example：To add new backup items as follows

Backup Type Source Path Destination path

File \DiskC\OCRes\Common\AppData\T \USB\Backup\Serial No.\Test.xml

est.xml

Folder \DiskC\OCRes\CHT\String \USB\Backup\Serial No.

\OCRes\StringTest

Backup config

<BackupFile>
<SourcePath>\DiskC\OCRes\Common\AppData\Test.xml</SourcePath>
<TargetPath>Test.xml</TargetPath>
</BackupFile>

<BackupFolder>
<SourcePath>\DiskC\OCRes\CHT\String</SourcePath>
<TargetPath>OCRes\StringTest</TargetPath>
</BackupFolder>

USB Backup Operation Manual – 145

 机床产品/Machine Tool Products
–
Other Tool.

Paste the above XML content into USB_BackupConfig.xml, as shown below

• After archiving, the backup will be completed as described in the previous section, as shown below
File： Folder：\DiskC\OCRes\CHT\String
\DiskC\OCRes\Common\AppData\Test.xml

7.6 Q＆A

7.6.1 How do I troubleshoot the backup results that are not as expected?

1. Check the log in USB, the file name is controller serial number, the path is USB\Backup\Serial No.
\Serial No..txt
Take the following picture as an example

USB Backup Operation Manual – 146

 机床产品/Machine Tool Products
–
Other Tool.

2. After opening the above file, check the Config Path Check in the second section for any errors.
a. If there are any errors, please refer to the error causes recorded below for troubleshooting
3. After checking the Config Path Check, check the results of the backup items below, if there is any item
with Backup Fail
a. Check the cause of the error after Backup Fail and troubleshoot the cause

7.6.2 Common errors and troubleshooting methods

Common errors are usually backup configuration file errors

Error message Description Troubleshooting method

\USBDisk\USB_BackupConfig.x USB_BackupConfig.xml does not • Place

ml does not exist! USB Backup exist USB_BackupConfig.xml
terminates. into the USB
• Re-download the latest
version of the USB Backup
utility from the official
website

USB_BackupConfig.xml is a USB_BackupConfig.xml does not • Check the

format error conform to XML format USB_BackupConfig.xml,
and fix the wrong format

Not exist <config> element, <config> does not exist in the • Check
please check USB_BackupConfig.xml USB_BackupConfig.xml,
USB_BackupConfig.xml and check <config> for
errors

USB Backup Operation Manual – 147

 机床产品/Machine Tool Products
–
Other Tool.

Error message Description Troubleshooting method

Unknown element: xxxx The tag that does not meet the • Remove the tag that does
specification appears in the not conform to the
USB_BackupConfig.xml specification

Path error: Source Path is empty Source Path is empty • Fill in the source of the
backup item

Path error: Target Path is empty Target Path is empty • Fill in the destination of
the backup item

Path error: Source file is not Source file is not exist • Check if the file path of the
exist backup project is incorrect

Path error: Source folder is not Source folder is not exist • Check if the folder path of
exist the backup project is
incorrect

No item need backup No item need backup • Check if the backup profile
is empty
• Check if the backup profile
is in the wrong format

Backup Fail: Copy file error, xxxx Copy file error • Check if the configuration
file format is wrong
• Power off and restart to
confirm if the problem still
exists

Backup Fail: Create Folder error, Create Folder error • Check if the configuration
xxxx file format is wrong
• Power off and restart to
confirm if the problem still
exists

USB Backup Operation Manual – 148

 机床产品/Machine Tool Products
–
Other Tool.

8 USB Setup/Backup/Setting Operation Manual

8.1 Intorduction
Provide USB Disk auto setup/backup/setting functions when the controller has no external screen or the
electronic control personnel cannot operate.

8.2 Mechanism Description

Place a file in the USBDISK root directory and name it "Setting0.ini". When booting, the controller will first
read this setting file and perform corresponding things according to different commands. After processing, it
will output a file " Setting0.out" in the root directory of USBDISK

8.3 Instruction
The format of "Setting0.ini" is as follows:

ACTION=aaa
PARAMETER=ppp
EXT=eee
OPTION=yyy

ACTION (aaa) currently provides commands as follows:

Com Description Example Remarks

man
d
(ACTI
ON)

EXE Execute the program of Parameter(ppp). If user wants to run a program *PARAMET
named CncMonCE.EXE, ER uses full
qualified
ACTION=EXE
path
PARAMETER=CncMonCE.EXE

GET_I Obtain the controller information in the output file, ACTION=GET_INFO

NFO the content includes serial number/model/product/
version number/network IP information

USB Setup/Backup/Setting Operation Manual – 149

 机床产品/Machine Tool Products
–
Other Tool.

Com Description Example Remarks

man
d
(ACTI
ON)

SET_I While setting network IP information, the content ACTION=SET_IP it will

P must be entered in Parameter(ppp), reboot
PARAMETER=0,192.168.1.10,255.
Its content is DHCPEnable, IP, SubnetMask, DNS, system
255.255.0,0.0.0.0,0.0.0.0,0.0.0.0
DefaultGateway, WINS, separated by commas, and after
contains no blanks EXT=LAN1 setting ip.
(DHCPEnable is either 0 or 1, 1 means Enable, and
Indicate the first network port.
the other setting formats follow IP standard format,
Specify IP to be 192.168.1.10
and the specifications are similar to the network
directly.
setting page of the controller)
The subnet mask is
When EXT(eee) is set to LAN2, the setting of the 255.255.255.0.
second network port can refer to the above The preset gateway of primary
information. DNS and primary WINS are both
(After 10.116.36T, 10.116.48, 10.117.48) 0.0.0.0.

SB_B Perform backup operation, the file is stored in the ACTION=SB_BACKUP

ACKU USB root directory and the file name is "serial
P number_date.zip"

SB_R Restore the file named Parameter(ppp) in the USB ACTION=SB_RESTORE

ESTO root directory
PARAMETER=M2G4314_2017012
RE
4.zip
(M2G4314_20170124.zip is the
file to be restored and must be
placed in the USB root
directory)

SW_I Install the file named Parameter(ppp) in the USB ACTION=SW_INSTALL

NSTA root directory
PARAMETER=package_dca6f689
LL
.zip
(package_dca6f689.zip is the file
to be installed and must be
placed in the USB root
directory)

USB Setup/Backup/Setting Operation Manual – 150

 机床产品/Machine Tool Products
–
Other Tool.

Com Description Example Remarks

man
d
(ACTI
ON)

IMG_I Image file update. Update the file named ACTION=IMG_INSTALL

NSTA Parameter(ppp) in the USB root directory
PARAMETER=WCE7_AM335x_7.4
LL
8.0.bin
(WCE7_AM335x_7.48.0.bin is the
image file to be installed and
must be placed in the USB root
directory)

AUTO SA screen will pop up automatically ACTION=AUTO_SA 10.116.36R,

_SA 10.116.47,
10.117.47
add new
commands

<Notes>
1. "OPTION=yyy" is the newly added extended instruction format of 10.116.16G, 10.116.24, and 10.117.24.
2. If OPTION=REPEAT is set in Setting0.ini, Setting0.out will still be generated after the corresponding
command is executed, but the corresponding ACTION will still be executed next time when it is rebooted.
The regenerated log will still be written in Setting0.out, continuing with the last time log.
3. If OPTION=REPEAT is not set in Setting0.ini, the original specifications will be maintained, which means the
"Setting0.out" file will exist, and the "Setting0.ini" command will not be executed when booting.

USB Setup/Backup/Setting Operation Manual – 151

 机床产品/Machine Tool Products
–
Other Tool.

9 RemoteAPI Operation Manual.

System Introduction Application Instruction Function Introduction

9.1 System Outline

9.1.1 Solution Framework

Syntec Dipole function separates the human machine interface from the core (Figure 1 & Figure 2),
allowing users to control the back end controller via the Internet through front end applications (such as
standard human machine interface). Users can use this framework for remote monitoring and diagnosis.
The development environment of front end applications is no longer limited to Windows CE, and general
applications of Windows XP, Windows 7,... can be developed, creating unlimited possibilities.

RemoteAPI Operation Manual. – 152

 机床产品/Machine Tool Products
–
Other Tool.

This user manual teaches users how to install CNC simulation software to the front end Windows user
terminal, and start to use the functions of RemoteCNC one-to-many API.

9.1.2 How to set the controller to turn on Dipole through the human machine
interface

Servo setting is on the human machine interface FenuBar：(The interface will be slightly different from
different controller.)
1. F6 Parameter settings → F10 Next page→ F7 Core Server(Figure 3)。
2. F5 Maintain → F2 Internet settings → F5 Core server

RemoteAPI Operation Manual. – 153

 机床产品/Machine Tool Products
–
Other Tool.

The Dipole configuration file of the back end is located in \DiskC\WinCE\Shared\DipoleSettings.xml. In

addition to editing the configuration file with a text editor (please refer to "Appendix 1 Back-end Dipole
Configuration File"), you can also directly use the human machine interface to modify the settings of
Dipole.

This FenuBar function will open the "Core Server Setting Page" (Figure 4).
The following is the description of each parameter:
• "Whether to turn on the server when booting up" is whether to automatically activate the core
Dipole function when booting up.
• "Timeout" means that when the network has no response after this time, the network connection
will be disconnected.
After the user completes the core Dipole settings, pressing "F3 Confirm" to save the settings, or press "F4
Cancel" to recover the settings. After setting, the Dipole function will be automatically activated when next
time booting up.

RemoteAPI Operation Manual. – 154

 机床产品/Machine Tool Products
–
Other Tool.

System Introduction Application Instruction Function Introduction

9.2 Project Settings

• Please refer to the attached example "SyntecRemoteExample", and attach

"Syntec.RemoteCNC.dll" to the project reference.

9.2.1 Precautions

1. Please confirm the controller version first, and check the table below to find the corresponding
RemoteAPI version.
2. If you use the v1 version of RemoteAPI, please install the 32 simulation software MacroDev first, and
its version must same as the controller.
3. Syntec.OpenCNC.dll, Syntec.RemoteCNC.dll, Syntec.RemoteObj.dll, OCAPI.dll, OCUSER.dll... and
other dlls need to be placed in the same folder as the main program.

9.2.2 Common Problem Solutions

1. The computer firewall needs to turn on port 5568, port 5570 for the controller to connect to the
computer. "In Windows environment, you can go to Firewall> Advanced Settings> Input Rules> Add
Rule> Port> TCP> Input 5568,5570> Allow all the connections"
2. Note that the computer has two network interface cards, and adjust the priority of the card
connected to the controller to a higher level, so the connection can be made. "In the Windows
environment, you can go to Internet and Sharing Center> Enter to setting of changing the interface
card> Press F10 to show the toolbar> Advanced> Advanced settings> Adjust the priority of network
interface card to a higher level"
3. If you find that the network is unstable and an error message displayed while using v4 version,
please try to connect again after ten seconds.
4. If you found that Syntec.RemoteCNC.dll and Syntec.RemoteObj.dll are missing while using
1.0.12_v1 version, please go to the official website to download the 1.0.12_v1 again.

Note: If the above Windows operation appear error, please search for related settings by yourself.

RemoteAPI Operation Manual. – 155

 机床产品/Machine Tool Products
–
Other Tool.

9.2.3 RemoteAPI Version Comparison Table

Controller Version RemoteAPI Version Note

After 10.116.54.x 1.2.2

After 10.116.54.x 1.2.1 Remove usage restrictions from the

newer version of the controller

10.116.54.x ~ 10.118.60.x 1.2.0 reference Syntec.OpenCNC.dll is

needed

10.116.54.x ~ 10.118.30.x 1.1.0

10.116.36.x 1.0.12_v4

10.116.24.x 1.0.12_v3

10.116.10.x ~ 10.116.16.x 1.0.12_v2

10.116.0.x 1.0.12_v1 Require the corresponding MacroDev

installation

System Introduction Application Instruction Function Introduction

V12

9.3 Basic Data Type & Report Error

Data Type
Type Name Size

byte 8 bits

short 16 bits

RemoteAPI Operation Manual. – 156

 机床产品/Machine Tool Products
–
Other Tool.

int 32 bits

float 32 bits

string unlimited

Error Report Descriptions

Rep Error Type Descriptions
ort
Val
ue
(sh
ort)

-18 Not supported Controller doesn't support this function.

-17 Protocol error (Ethernet Data from Ethernet Board is incorrect.Contact with the service
version only) section or the section in charge.

-16 Socket error (Ethernet Investigate CNC power supply, Ethernet cable and I/F board.
version only)

-15 DLL file error There is no DLL file for each CNC series corresponding to
specified node.

-14 USBEmpty USB is empty

-13 NoUSB No USB is pulgin

-8 Handle number error Get the library handle number.

-7 Version mismatch between The CNC/PMC version does not match that of the library.Replace
the CNC/PMC and library the library or the CNC/PMC control software.

-6 Abnormal library state An unanticipated error occurred.Contact with the section in

charge.

-2 Reset or stop request The RESET or STOP button was pressed.Call the termination
function.

RemoteAPI Operation Manual. – 157

 机床产品/Machine Tool Products
–
Other Tool.

Rep Error Type Descriptions

ort
Val
ue
(sh
ort)

-1 CNC Busy Wait until the completion of CNC processing, or retry.

0 Normal termination Execution completed without any error!

1 Error(function is not Specific function which must be executed beforehand has not
executed, or not available) been executed.Otherwise that function is not available.

2 Error(data block length Check and correct the data block length or number of data.
error, error of number of
data)

3 Error(data number error) Check and correct the data number.

4 Error(data attribute error) Check and correct the data attribute.

5 Error(data error) Check and correct the data.

6 Error(no option) There is no corresponding CNC option.

7 Error(write protection) Write operation is prohibited.

8 Error(memory overflow) CNC tape memory is overflowed.

9 Error(CNC parameter error) CNC parameter is set incorrectly.

10 Error(buffer empty/full) The buffer is empty or full.

11 Error(path number error) A path number is incorrect.

12 Error(CNC mode error) The CNC mode is incorrect.Correct the CNC mode.

13 Error(CNC execution The execution at the CNC is rejected.Check the condition of

rejection) execution.

RemoteAPI Operation Manual. – 158

 机床产品/Machine Tool Products
–
Other Tool.

Rep Error Type Descriptions

ort
Val
ue
(sh
ort)

14 Error(Data server error) Some errors occur at the data server.

15 Error(alarm) The function cannot be executed due to an alarm in

CNC.Remove the cause of alarm.

16 Error(stop) CNC status is stop or emergency.

17 Error(State of data Data is protected by the CNC data protection function.

protection)

18 Error(Not found Machine Please Check or not send CNC_CONNECTION command.

ID)

19 Error(No out) Please Check NO.

20 Error(Need to Update RemoteAPI version is too old for connected controller, need to
RemoteCnc Version) update RemoteAPI version.

9.4 Basic Function

isUSBExist ： Whether there is an USB plugged in

Function Name bool isUSBExist( )

Argument
variable name type [in/out] descriptions

N/A

Return Value True => there is an USB plugged in, False => there isn't an USB
plugged in

RemoteAPI Operation Manual. – 159

 机床产品/Machine Tool Products
–
Other Tool.

SeriesNo：Controller Series No.

Function Name string SeriesNo(…)

Argument
variable name type [in/out] descriptions

N/A

Return Value controller series number or null string

CncOption：Controller Software Option

Function Name string CncOption(…)

Argument
variable name type [in/out] descriptions

N/A

Return Value software options of controller (apart by spaces)

MainBoardPlatformName：Mainboard Model of Controller

Function Name string MainBoardPlatformName (…)

Argument
variable name type [in/out] descriptions

N/A

Return Value controller mainboard model or null string

RemoteAPI Operation Manual. – 160

 机床产品/Machine Tool Products
–
Other Tool.

READ_information：Basic Information
Function Name short READ_information(…)

Argument
variable type [in/out] descriptions
name

Axes short out number of axes

CncType string out ex :'18' : Series

180/180i

MaxAxes short out maximum

number of axes

Series string out M/T type

Nc_Ver string out NC version

AxisName string[] out coordinate name

of each axis

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

READ_status：Status Information
Function Name short READ_status(…)

RemoteAPI Operation Manual. – 161

 机床产品/Machine Tool Products
–
Other Tool.

Argument
variable type [in/out] descriptions
name

MainProg string out main program

name

CurProg string out current program

name

CurSeq x out does not support,

default = -1

Mode string out ex:"MDI", "MEM"…

Status string out ex:"STOP",

"START"…

Alarm string out ex:"ALARM", "****"

EMG string out ex:"EMG", "****"

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

Note Alarm：When an alarm occurs, "ALARM" is returned; when no

alarm occurs, "****" is returned.
EMG：When emergency stop happens, "EMG" is returned; when
no emergency stop happens, "****" is returned

READ_position：Coordinate Information
Function short READ_position(…)
Name

RemoteAPI Operation Manual. – 162

 机床产品/Machine Tool Products
–
Other Tool.

Argument
variable name type [in/out] descriptions

AxisName string[] out coordinate name of each

axis

DecPoint short out decimal places

Unit string[] out unit

Mach float[] out machine coordinate

Abs float[] out absolute coordinate

Rel float[] out relative coordinate

Dist float[] out remaining distance

Return Value 0: Operation completed, else please refer to 3-2 Return Error Descriptions

WRITE_relpos：Set the position value of relative coordinate

Function Name short WRITE_relpos(…)

Argument
variable type [in/out] descriptions
name

AxisName string in axis coordinate

name

PosValue double in position value of

relative coordinate

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

RemoteAPI Operation Manual. – 163

 机床产品/Machine Tool Products
–
Other Tool.

READ_gcode：G Code
Function Name short READ_gcode(…)

Argument
variable name type [in/out] descriptions

Gdata string[] out G Code

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

READ_othercode：Else Codes(H Code,D Code,T Code,M Code,B Code,F

Code,S Code)
Function Name short READ_othercode(…)

Argument
variable name type [in/out] descriptions

HCode int out H Code

DCode int out D Code

TCode int out T Code

MCode int out M Code

FCode int out F Code

SCode int out S Code

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

RemoteAPI Operation Manual. – 164

 机床产品/Machine Tool Products
–
Other Tool.

READ_spindle：Feedrate/Spindle Speed
Function Name short READ_spindle(…)

Argument
variable name type [in/out] descriptions

OvFeed float out Feed Rate Over

Ride

OvSpindle float out Spindle Over

Ride

ActFeed float out Actual Feedrate

ActSpindle int out Actual Spindle

Speed

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

READ_time：Time
Function Name short READ_time(…)

Argument
variable name type [in/out] descriptions

PowerOnTime int out boot time(sec)

AccumulateCutti int out cutting time(sec)

ngTime

CuttingTimePer int out cycle time(sec)

Cycle

WorkTime int out machining

time(sec)

RemoteAPI Operation Manual. – 165

 机床产品/Machine Tool Products
–
Other Tool.

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

READ_part_count：Number of Workpieces
Function Name short READ_part_count(…)

Argument
variable name type [in/out] descriptions

part_count int out number of

workpiece

require_part_c Int Out required number

ount of workpiece

Total_part_cou int out total number of

nt workpiece

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

DOWNLOAD_work_record：Download remote machining record file

Function Name short DOWNLOAD_work_record (…)

Argument
variable name type [in/out] descriptions

Destination string in download

path

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

RemoteAPI Operation Manual. – 166

 机床产品/Machine Tool Products
–
Other Tool.

IsDipoleSupported：Whether it is possible to connect via dipole within the

given timeout time

Function Name bool IsDipoleSupported (…)

Argument
variable type [in/out] descriptions
name

IPAddr string in destination IP

address

Timeout uint in given timeout

time (ms)

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

READ_MakerConfigInfo：Machinery Information
Function Name short READ_MakerConfigInfo(…)

RemoteAPI Operation Manual. – 167

 机床产品/Machine Tool Products
–
Other Tool.

Argument
variable type [in/out] descriptions
name

szModel string out machine model

szMachSN string out machine series no.

szDate string out machine

manufacturing
date

szDevSN string out device serires

number

szPhone string out machinery phone

number

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

WRITE_MakerConfigInfo：Set the information of machinery

Function Name short WRITE_MakerConfigInfo(…)

RemoteAPI Operation Manual. – 168

 机床产品/Machine Tool Products
–
Other Tool.

Argument
variable type [in/out] descriptions
name

szModel string in machine model

szMachSN string in machine series no.

szDate string in machine

manufacturing
date

szDevSN string in device serires

number

szPhone string in machinery phone

number

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

9.5 Alarm Related Funtion

READ_alm_current：Current Alarm
Function Name short READ_alm_current(…)

RemoteAPI Operation Manual. – 169

 机床产品/Machine Tool Products
–
Other Tool.

Argument
variable type [in/out] descriptions
name

IsAlarm bool out whether there is

any alarm be
triggered

AlmMsg String[] out get the

information of
current alarm

AlmTime DateTime[] out get the triggered

time of current
alarm

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

note The arrangement rule of the alarm array is from new to old.
The format of alarm message is("motion" "number"
"descriptions")

READ_alm_history：Alarm History
Function Name short READ_alm_history(…)

Argument
variable type [in/out] descriptions
name

AlmMsg string[] out alarm

message

AlmTime DateTime[] out alarm time

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

RemoteAPI Operation Manual. – 170

 机床产品/Machine Tool Products
–
Other Tool.

note The arrangement rule of the alarm array is from new to old.
The format of alarm message is("motion" "number"
"descriptions")

Function Name short READ_alm_history(…)

Argument
variable type [in/out] descriptions
name

AlmMsg string[] out alarm message

AlmTime DateTime[] out alarm time

Duration uint[] out duration, in sec

Clear bool[] out whether the

alarm(s) is
cleared

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

Notes • Only support 10.116.54Q, 10.118.0K, 10.118.11 or

after
• The arrangement rule of the alarm array is from new to
old.
The format of alarm message is("motion" "number"
"descriptions")

9.6 Tool Offset Function

READ_offset_title：Read the titles of tool offset

Function Name short READ_offset_title(…)

RemoteAPI Operation Manual. – 171

 机床产品/Machine Tool Products
–
Other Tool.

Argument
variable name type [in/out] descriptions

OffsetTitle string[] out titles

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

Notes
series return value descriptions model

Syntec M {"RADIUS GEOM","RADIUS Mill, Drill, Wood,

series WEAR","LENGTH GlassGrind
GEOM","LENGTH WEAR"}

Syntec T {"WEAR X","WEAR Lathe

series Z","WEAR A","LENGTH
X","LENGTH Y","LENGTH
A","TOOL NOSE
RADIUS","TOOL NOSE R
WEAR","TOOL NOSE"}

READ_offset_all：Read the offset of all tools

Function Name short READ_offset_all(…)

Argument
variable type [in/out] descriptions
name

OffsetData double[][] out offset data

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

Notes The second array of Offset Data, with the title name (Length
Geom...).
Get the data start from the first tool.

RemoteAPI Operation Manual. – 172

 机床产品/Machine Tool Products
–
Other Tool.

READ_offset_scope：Read the tool offset from the given range.

Function Name short READ_offset_scope(…)

Argument
variable type [in/out] descriptions
name

StartNumbe short in start no. (start

r from 1)

EndNumber short in stop no.

OffsetData double[][] out offset data

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

READ_offset_single：Read the single tool offset

Function Name short READ_offset_single(…)

Argument
variable type [in/out] descriptions
name

ofNumber short in set the offset

number

OffsetData double[] out offset data

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

WRITE_offset_all：Write offset of all tools

Function Name short WRITE_offset_all(…)

RemoteAPI Operation Manual. – 173

 机床产品/Machine Tool Products
–
Other Tool.

Argument
variable type [in/out] descriptions
name

OffsetData double[][] in set the offset

data

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

Notes Start from the first tool, until finish writing all the offset.

WRITE_offset_single：Write offset of single tool

Function Name short WRITE_offset_single(…)

Argument
variable type [in/out] descriptions
name

ofNumber short in set the offset

number

OffsetData double[] in set the offset

data

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

READ_offset_count：Read the number of offset data

Function Name short READ_offset_count(…)

Argument
variable name type [in/out] descriptions

Count short out number of offset

data

RemoteAPI Operation Manual. – 174

 机床产品/Machine Tool Products
–
Other Tool.

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

9.7 Workpiece Coordinate Function

READ_work_coord_axis：Read the title of workpiece coordinate

Function Name short READ_work_coord_title(…)

Argument
variable name type [in/out] descriptions

WorkCoordTitl string[] out title name

e

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

READ_work_coord_all：Read all the workpiece coordinate

Function Name short READ_work_coord_all(…)

Argument
variable type [in/out] descriptions
name

CoordName string[] out item ,ex:EXT,G54

,G55…

WorkCoord float[][] out workpiece

coordinate data

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

RemoteAPI Operation Manual. – 175

 机床产品/Machine Tool Products
–
Other Tool.

Notes CoordName like:

EXT,MPGShift, G54, G55, G56, G57, G58, G59 , G54P7, G54P8,
G54P100等

READ_work_coord_scope：Read the workpiece coordinate in the given

range
Function Name short READ_work_coord_scope(…)

Argument
variable type [in/out] descriptions
name

StartNumbe short in start no.

r

EndNumber short in stop no.

CoordName string[] out item,

ex:EXT,G54,G55
…

WorkCoord float[][] out workpiece

coordinate data

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

RemoteAPI Operation Manual. – 176

 机床产品/Machine Tool Products
–
Other Tool.

Notes CoordName like:

EXT,MPGShift, G54, G55, G56, G57, G58, G59 , G54P7, G54P8,
G54P100等
The number corresponds to the workpiece coordinate name as
follows

workpiece name corresponding no.

EXT 0

MPG Shift 1

G54 2

G55 3

G56 4

G57 5

G58 6

G59 7

G54 P7~P100 8~101

READ_work_coord_single：Read the single workpiece coordinate

Function Name short READ_work_coord_single(…)

RemoteAPI Operation Manual. – 177

 机床产品/Machine Tool Products
–
Other Tool.

Argument
variable type [in/out] descriptions
name

CoordName string in item,

ex:EXT,G54,G55
…

WorkCoord float[] out workpiece

coordinate data

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

WRITE_work_coord_all：Write all the workpiece coordinate

Function Name short WRITE_work_coord_all(…)

Argument
variable type [in/out] descriptions
name

CoordName string[] in setting item,

ex:EXT,G54,G55…

WorkCoord float[][] in set the workpiece

coordinate data

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

WRITE_work_coord_single：Write single workpiece coordinate

Function Name short WRITE_work_coord_single(…)

RemoteAPI Operation Manual. – 178

 机床产品/Machine Tool Products
–
Other Tool.

Argument
variable type [in/out] descriptions
name

CoordName string in setting item,

ex:EXT,G54,G55…

WorkCoord float[] in set the workpiece

coordinate data

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

READ_work_coord_count：Read the number of workpiece coordinate

Function Name short READ_work_coord_count(…)

Argument
variable type [in/out] descriptions
name

Count short out number of

workpiece
coordinate data

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

RemoteAPI Operation Manual. – 179

 机床产品/Machine Tool Products
–
Other Tool.

9.8 Macro Variable Function(Global Variable)

READ_macro_all：Read all Macro variable (global variable)

Function Name short READ_macro_all(…)

Argument
variable type [in/out] descriptions
name

MacroNumbe int[] out Macro no.

r

MacroData double[] out Macro variable

data

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

READ_macro_scope：Read Macro variable (global variable) in the given

range
Function Name short READ_macro_scope(…)

Argument
variable type [in/out] descriptions
name

StartNumbe int in start number

r (start from 1)

EndNumber int in stop number

MacroNumb int[] out Macro number

er

MacroData double[] out Macro variable

data

RemoteAPI Operation Manual. – 180

 机床产品/Machine Tool Products
–
Other Tool.

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

WRITE_macro_all：Write all the Macro variable (global varible)

Function Name short WRITE_macro_all(…)

Argument
variable type [in/out] descriptions
name

MacroNumbe int[] in set Macro

r number

MacroData double[] in set Macro

variable

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

READ_macro_single：Read single Macro variable(global variable)

Function Name short READ_macro_single(…)

Argument
variable name type [in/out] descriptions

MacroNumber int in Macro number

MacroData double out Macro variable

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

RemoteAPI Operation Manual. – 181

 机床产品/Machine Tool Products
–
Other Tool.

WRITE_macro_single：Write single Macro variable(global variable)

Function Name short WRITE_macro_single(…)

Argument
variable name type [in/out] descriptions

MacroNumber int in set Macro

number

MacroData double in set Macro

variable

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

READ_macro_variable：Read the start and end number of Macro

variable(global variable)
Function Name short READ_macro_variable(…)

Argument
variable type [in/out] descriptions
name

Variable int[][] out the start and end

number of Macro
variable

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

RemoteAPI Operation Manual. – 182

 机床产品/Machine Tool Products
–
Other Tool.

Notes Declare array：Variable[type][0]:Start Number

Variable[type][1]:End Number
如：
Variable[0][0]:100
Variable[0][1]:199
Variable[1][0]:500
Variable[1][1]:599

9.9 NC Program Function

WRITE_nc_main：Assign the specific NC program

Function Name short WRITE_nc_main(…)

Argument type 1
variable name type [in/out] descriptions

szProgName string in program name

Argument type 2
variable name type [in/out] descriptions

szProgName int in program name

nCoordID int in Path number

nLineNumber int in start line number

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

RemoteAPI Operation Manual. – 183

 机床产品/Machine Tool Products
–
Other Tool.

Notes • back-end controller support version: 10.116.10x or after

• back-end controller version: 10.116.10x-10.116.16x After
assign the NC program, the controller mode couldn't be
changed.
• API of Argument type 2 is only provided by
Syntec.RemoteCNC.Win32.dll after version 10.116.54A
• When using Argument type 2, refer to: 多轴群规划与MST
多通道应用手册

READ_nc_mem_list：Read the internal NC program list of machine

Function Name short READ_nc_mem_list(…)

Argument
variable type [in/out] descriptions
name

NcList string[][] out NC program

list

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

Notes Since the NC lists of machineries are different, the following

format is recommended:
NcList[][0]:NC Name
NcList[][1]:Size (byte)
NcList[][2]:Last Write DateTime
NcList[][3]: file / directory
Note：If there is no NC program list, return -1(CNCBUSY), please
pay attention to this.

UPLOAD_nc_mem：Upload NC program to controller

Function Name short UPLOAD_nc_mem(…)

RemoteAPI Operation Manual. – 184

 机床产品/Machine Tool Products
–
Other Tool.

Argument
variable type [in/out] descriptions
name

Source string in the full path name

of machine

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

DOWNLOAD_nc_mem：Download NC program
Function Name short UPLOAD_nc_mem(…)

Argument
variable name type [in/out] descriptions

Source string in NC program

name

Destination string in folder path

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

DEL_nc_mem：Delete the NC program in the controller

Function Name short DEL_nc_mem(…)

Argument
variable name type [in/out] descriptions

Name string in name

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

RemoteAPI Operation Manual. – 185

 机床产品/Machine Tool Products
–
Other Tool.

READ_nc_freespace：Remaining Space(k)
Function Name short READ_nc_freespace(…)

Argument
variable name type [in/out] descriptions

FreeSpace Long out remaining

space(k)

Return Value 0: Operation completed, else please refer to attachment 1.

return error descriptions

READ_nc_OPLog：Read the operation log

Function Name short READ_nc_OPLog(…)

Argument
variable name type [in/out] descriptions

OPLog string[] out operation

record

count int in/out number of

record

Return Value 0: Operation completed, else please refer to attachment 1. return

error descriptions

RemoteAPI Operation Manual. – 186

 机床产品/Machine Tool Products
–
Other Tool.

Notes 1. 'Count' input the number of the log to be read, and returns
the number of log be read.
2. When the input parameter count is 0, all operation log will
be returned.
3. When a timeout error occurs, you can use the
SynetcRemoteCNC(ip,timeout) constructor to increase the
timeout. Timeout=0 means none, and the unit of timeout is
ms.
4. The OPLog returned can refer to the appendix for relevant
information

Note：If there is no Log, return the original array and write "No
Log".
This is NOT supported for V12.

9.10 System Parameter Function

READ_param_max：Read the maximum parameter number of machine

Function Name short READ_param_max(…)

Argument
variable name type [in/out] descriptions

MaxNumber int out maximum

parameter
number

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

READ_param_schema：Read all the parameter data

Function Name short READ_param_schema(…)

RemoteAPI Operation Manual. – 187

 机床产品/Machine Tool Products
–
Other Tool.

Argument
variable type [in/out] descriptions
name

index int[] out parameter number

value int[] out parameter value

context string[] out parameter

descriptions

bound string[] out up[er limit & lower

limit of parameter

count int out parameter number

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

READ_param_data：Read the parameter data in the given range

Function Name short READ_param_data(…)

Argument
variable name type [in/out] descriptions

ParamStart int in parameter start

number

ParamEnd int in parameter end

number

ParmData int[] out parameter data

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

Notes ※ When the specified parameter number does not exist on the
controller or fails to read, ParamType will be set to -1

RemoteAPI Operation Manual. – 188

 机床产品/Machine Tool Products
–
Other Tool.

WRITE_param_single：Write the single parameter value

Function Name short WRITE_param_single(…)

Argument
variable name type [in/out] descriptions

ParamID int in parameter

number

val int in set value

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

9.11 PLC Function

READ_plc_type：Read the type of PLC address

Function Name short READ_plc_type(…)

Argument
variable type [in/out] descriptions
name

Addr string in ex:I,O,C,S,A,R

PlcType short out 0:byte 1:short

2:int

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

RemoteAPI Operation Manual. – 189

 机床产品/Machine Tool Products
–
Other Tool.

READ_plc_type2：Read the type and the size of PLC address

Function Name short READ_plc_type2(…)

Argument
variable type [in/out] descriptions
name

Addr string in ex:I,O,C,S,A,R

PlcType short out 0:byte 1:short

2:int

PlcStart int out address start

number

PlcEnd int out address end

number

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

Notes The number of input & output depends on the selected I/O card

READ_plc_addr：Read PLC address data

Function Name short READ_plc_addr(…)

RemoteAPI Operation Manual. – 190

 机床产品/Machine Tool Products
–
Other Tool.

Argument
variable name type [in/out] descriptions

Addr string in ex:I,O,C,S,A,R

PlcStart int in address start

value

PlcEnd int in address end value

PlcType short out 0:byte 1:short

2:int

PlcDataB byte[] out Plc data(byte)

PlcDataS short[] out Plc data(short)

PlcDataI int[] out Plc data(int)

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

Notes The read value will be inputed in the array of PlcData(B,S,I). If the
number fails to be read, the array value will be set to null.

WRITE_plc_addr：Write PLC address data

Function Name short WRITE_plc_addr(…)

RemoteAPI Operation Manual. – 191

 机床产品/Machine Tool Products
–
Other Tool.

Argument
variable type [in/out] descriptions
name

Addr string in ex:I,C,S,R

PlcStart int in address start

value

PlcEnd int in address end

value

PlcType short in 0:byte 1:short

2:int

PlcDataB byte[] in Plc data(byte)

PlcDataS short[] in Plc data(short)

PlcDataI int[] in Plc data(int)

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

READ_plc_ver：PLC Version
Function Name short READ_plc_ver(…)

Argument
variable type [in/out] descriptions
name

Version string out Plc version

information

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

RemoteAPI Operation Manual. – 192

 机床产品/Machine Tool Products
–
Other Tool.

DOWNLOAD_plc_ladder：Download remote ladder file

Function Name short DOWNLOAD_plc_ladder (…)

Argument
variable type [in/out] descriptions
name

Destination string in download

destination path

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

READ_plc_ibit：Read PLC I Bit address data

READ_plc_obit：Read PLC O Bit address data

READ_plc_cbit：Read PLC C Bit address data

READ_plc_sbit：Read PLC S Bit address data

READ_plc_abit：Read PLC A Bit address data

Function Name short READ_plc_ibit(…)
short READ_plc_obit(…)
short READ_plc_cbit(…)
short READ_plc_sbit(…)
short READ_plc_abit(…)

RemoteAPI Operation Manual. – 193

 机床产品/Machine Tool Products
–
Other Tool.

Argument
variable type [in/out] descriptions
name

PlcStart int in address start

value

PlcEnd int in address end

value

PlcData byte[] out Plc data(byte)

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

READ_plc_register：Read PLC Register address data

Function Name short READ_plc_register(…)

Argument
variable name type [in/out] descriptions

PlcStart int in address start

value

PlcEnd int in address end

value

PlcData int[] out Plc data(int)

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

READ_plc_register：Read PLC Register address string data

Function Name short READ_plc_register(…)

RemoteAPI Operation Manual. – 194

 机床产品/Machine Tool Products
–
Other Tool.

Argument
variable name type [in/out] descriptions

RAddress int in address

PlcData string out Plc data(string)

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

READ_plc_timer：Read PLC Timeraddress data

Function Name short READ_plc_timer(…)

Argument
variable name type [in/out] descriptions

PlcStart int in address start

value

PlcEnd int in address end

value

PlcTimerValue int[] out Plc Timer value

PlcTimerSetti int[] out Plc Timer

ng setting

PlcTimerState short[] out Plc Timer status

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

READ_plc_counter：Read PLC Counter address data

Function Name short READ_plc_timer(…)

RemoteAPI Operation Manual. – 195

 机床产品/Machine Tool Products
–
Other Tool.

Argument
variable name type [in/out] descriptions

PlcStart int in address start

value

PlcEnd int in address end

value

PlcCounterVal int[] out Plc Counter

ue value

PlcCounterSett int[] out Plc Counter

ing setting

PlcCounterStat short[] out Plc Counter

e status

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

WRITE_plc_ibit：Write PLC I BIT address data

WRITE_plc_cbit：Write PLC C BIT address data

WRITE_plc_sbit：Write PLC S BIT address data

Function Name short WRITE_plc_ibit(…)
short WRITE_plc_cbit(…)
short WRITE_plc_sbit(…)

RemoteAPI Operation Manual. – 196

 机床产品/Machine Tool Products
–
Other Tool.

Argument
variable type [in/out] descriptions
name

PlcStart int in address start

value

PlcEnd int in address end

value

PlcData byte[] in Plc data(byte)

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

WRITE_plc_register：Write PLC Registeraddress data

Function Name short WRITE_plc_register(…)

Argument
variable name type [in/out] descriptions

PlcStart int in address start

value

PlcEnd int in address end

value

PlcData int[] in Plc data (int)

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

RemoteAPI Operation Manual. – 197

 机床产品/Machine Tool Products
–
Other Tool.

9.12 System Variable Function

READ_state_variable：Read system status variable data

Function Name short READ_state_variable(...)

Argument
variable type [in/out] descriptions
name

StateStart int in address start value

StateStart int in address end value

StateVariable int[] out system status

variable data

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

READ_debug_variable：Read system diagnosis variable data

Function Name short READ_debug_variable (…)

Argument
variable name type [in/out] descriptions

DebugStart int in address start value

DebugEnd int in address end value

DebugVariable int[] out system diagnosis

variable data

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions
Notes: The system diagnostic variables 77 and 78 are specific
information of controller. For the remaining system memory, please
refer to diagnostic variable 7.

RemoteAPI Operation Manual. – 198

 机床产品/Machine Tool Products
–
Other Tool.

READ_system_variable：Read system variable data(#)

Function Name short READ_system_variable (…)

Argument
variable type [in/out] descriptions
name

SystemID int in path number

SystemStart int in address start

value

SystemEnd int in address end

value

DebugVariabl double[] out system variable

e data

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

READ_useTime：Read system usage status

Function Name short READ_useTime (…)

RemoteAPI Operation Manual. – 199

 机床产品/Machine Tool Products
–
Other Tool.

Argument
variable type [in/out] descriptions
name

Status String out current usage

time

TimeStart String out start time

TimeExpire String out expire time

TimeRemain int out remaining time

(hr)

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions
Notes：Only support the software version after 10.116.24x

Read_remoteTime ：Read system current time

Function Name short READ_remoteTime (…)

Argument
variable type [in/out] descriptions
name

remoteTime DateTime out current machine

system time

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

WRITE_remoteDate：Edit System Date

Function Name short WRITE_remoteDate (…)

RemoteAPI Operation Manual. – 200

 机床产品/Machine Tool Products
–
Other Tool.

Argument
variable name type [in/out] descriptions

Year Int out year

Month Int Out month

Day Int Out day

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

WRITE_remoteTime：Edit System Time

Function Name short WRITE_remoteTime (…)

Argument
variable name type [in/out] descriptions

Hour Int Out hour

Minute Int Out minute

Second Int Out second

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

ClearCache：Clear all the buffer in the RemoteAPI

Function Name short ClearCache ()

Argument N/A

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions
Note：Clear all the buffer (ex：series number, mainboard, model,
code, then call the related API to read the right data

RemoteAPI Operation Manual. – 201

 机床产品/Machine Tool Products
–
Other Tool.

READ_SSV_GetDeviceInfo
Function Name READ_SSV_GetDeviceInfo( ... )

Argument
variable type [in/out] descriptions
name

nAxisId int in axis ID

nFunctionCo int in read what kind of

de information
enum
DevInfoFuncCode
{
SVPackModel =
0x11,
SVPackSoftVer,
SVPackSN,
SVMotorModel,
SVMotorSN,
ENCSoftVer,
ENCResolution,
ENCSensorType,
ENCSN,
}

szInfo string out information value

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

READ_SerialStateVar_ServiceReg
Function Name READ_SerialStateVar_ServiceReg(...)

RemoteAPI Operation Manual. – 202

 机床产品/Machine Tool Products
–
Other Tool.

Argument
variable type [in/out] descriptions
name

nAxisType int in AXIS : 0

SPLCA : 1
ROT : 2

nDeviceID int in device ID

nHandle int out When the registration is

successful, the code of this
registration will be
returned, and will be used
by other SerialStateVar
functions.

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

READ_SerialStateVar_ServiceUnReg
Function Name READ_SerialStateVar_ServiceUnReg( int nHandle )

Argument
variable type [in/out] descriptions
name

nHandle int in registration code of

the specified update
service

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

READ_SerialStateVar_GetCapacity
Function Name READ_SerialStateVar_GetCapacity(...)

RemoteAPI Operation Manual. – 203

 机床产品/Machine Tool Products
–
Other Tool.

Argument
variable type [in/out] descriptions
name

nHandle int in registration code of

the specified update
service

nCapacity int out how many StateVar

variable

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

READ_SerialStateVar_Dump
Function Name READ_SerialStateVar_Dump(...)

Argument
variable type [in/ descriptions
name out]

nHandle int in registration code

of the specified
update service

nLength int in how many data

structure of state
variable
specifications to
capture

tStateVarSp List<TSerialS out every data

ecList tateVarSpec> structure of state
variable
specifications

nHexForma int out hexadecimal or

t decimal

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

RemoteAPI Operation Manual. – 204

 机床产品/Machine Tool Products
–
Other Tool.

READ_SerialStateVar_GetValue
Function Name READ_SerialStateVar_GetValue( ... )

Argument
variable type [in/ descriptions
name out]

nHandle int in registration code of

the specified
update service

nLength int in how many state

variable to capture

SerialStateV List<Int32 out every state variable

arList > value

nStatus int out results

FAIL = 0,
SUCCESS,
BUSY,
EXCEPTION,

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

RemoteAPI Operation Manual. – 205

 机床产品/Machine Tool Products
–
Other Tool.

9.13 Update Related Functions of Controller

UPLOAD_software ：update controller software

UPLOAD_ plc_file ：update controller PLC

UPLOAD_param_file ：update controller parameters

Function Name short Update_software (…)
short Update_plc_file (…)
short Update_param_file (…)

Argument
variable type [in/out] descriptions
name

Source String out Path file name

Software：
*\package_xxxx.zi
p
PLC：*\cnc.lad
parameter：
*\param.dat

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions.
Notes：After the update, the controller must be rebooted to
complete the update

9.14 Appendix

READ_nc_OPLog meaning

Log data format ( 4Bytes )

RemoteAPI Operation Manual. – 206

 机床产品/Machine Tool Products
–
Other Tool.

Name Data Type Size Descriptions

Event ID UINT16 2-byte buttons, alarms, PLC, time...etc.

Event Data UINT16 2-byte event value, such as PLC-bit value,

keyboard corresponding value, alarm
number & axis

Record column format

Event Name Event ID Event Data

StartUp 0x0002 Null

ShutDown 0x0003 Null

KeyPressed 0x0005

Date 0x0300~0x03FF Current date

00000011aaaaaaaa bbbbbbbbcccccccc
a:Year b:Month
c:Date

Time 0x0400~0x04FF Current time

00000100aaaaaaaa bbbbbbbbcccccccc
a: seconds b: hours
c: minutes

Alarm 0xWC00~0xWCFF Alarm ID

zz001100aaaaaaaa bbbbbbcccccccccc
a: ClassID b: Object ID
z:Alarm ID(10~11bit) c: Alarm ID(0~9bit)
Yaskawa servo alarm requires 12bit to
be fully recorded.

RemoteAPI Operation Manual. – 207

 机床产品/Machine Tool Products
–
Other Tool.

Event Name Event ID Event Data

I-bit off 0x0010 Index

I-bit on 0x0011 Index

O-bit off 0x0012 Index

O-bit on 0x0013 Index

C-bit off 0x0014 Index

C-bit on 0x0015 Index

S-bit off 0x0016 Index

S-bit on 0x0017 Index

R 0x0020 Index

P 0x0021 Index

@ 0x0022 Index

L 0x0023 Index

D 0x0024 Index

K 0x0025 Index

ParameterOnChange 0x0030 Param No.

WorkPieceOnChange 0x0031 WorkPieceFrame ID

ToolCompesationOnChange 0x0032 aaaaaaaabbbbcccc

a: ToolNo(which tool)
b: AxisNo(which axis)
c: ToolCompesationType

RemoteAPI Operation Manual. – 208

 机床产品/Machine Tool Products
–
Other Tool.

Event Name Event ID Event Data

UserOnChange 0x0033 0x0033XXXX

For user permissions, please refer to
R5997
0009: SyntecLogIn(R5997=9)
0063: MakerLogIn(R5997=99)
0064: AdminLogIn(R5997=100)
0065: OtherLogIn(R5997=101)
03E7: LogOut(R5997=999)
(After booting, it is in the log out
state.)
Other: XLogIn
( Convert XXXX to decimal X )

人机启动 0x1002 Null

人机关闭 0x1003 Null

Action(undefined) 0x1004 The CRC16 value of the action name

Action 0x1005 The mapping value of LogTable

9.15 RemoteAPI Application Instruction_Source

9.15.1 Project Settings

• Please refer to the attached example "SyntecRemoteExample", and attach "Syntec.RemoteCNC.dll" to

the project reference.

Precautions

1. Please confirm the controller version first, and check the table below to find the corresponding
RemoteAPI version.
2. If you use the v1 version of RemoteAPI, please install the 32 simulation software MacroDev first, and its
version must same as the controller.

RemoteAPI Operation Manual. – 209

 机床产品/Machine Tool Products
–
Other Tool.

3. Syntec.OpenCNC.dll, Syntec.RemoteCNC.dll, Syntec.RemoteObj.dll, OCAPI.dll, OCUSER.dll... and other

dlls need to be placed in the same folder as the main program.

Common Problem Solutions

1. The computer firewall needs to turn on port 5568, port 5570 for the controller to connect to the
computer. "In Windows environment, you can go to Firewall> Advanced Settings> Input Rules> Add
Rule> Port> TCP> Input 5568,5570> Allow all the connections"
2. Note that the computer has two network interface cards, and adjust the priority of the card connected
to the controller to a higher level, so the connection can be made. "In the Windows environment, you
can go to Internet and Sharing Center> Enter to setting of changing the interface card> Press F10 to
show the toolbar> Advanced> Advanced settings> Adjust the priority of network interface card to a
higher level"
3. If you find that the network is unstable and an error message displayed while using v4 version, please
try to connect again after ten seconds.
4. If you found that Syntec.RemoteCNC.dll and Syntec.RemoteObj.dll are missing while using 1.0.12_v1
version, please go to the official website to download the 1.0.12_v1 again.

Note: If the above Windows operation appear error, please search for related settings by yourself.

RemoteAPI Version Comparison Table

Controller Version RemoteAPI Version Note

After 10.116.54.x 1.2.2

After 10.116.54.x 1.2.1 Remove usage restrictions from the

newer version of the controller

10.116.54.x ~ 10.118.60.x 1.2.0 reference Syntec.OpenCNC.dll is needed

10.116.54.x ~ 10.118.30.x 1.1.0

10.116.36.x 1.0.12_v4

10.116.24.x 1.0.12_v3

10.116.10.x ~ 10.116.16.x 1.0.12_v2

RemoteAPI Operation Manual. – 210

 机床产品/Machine Tool Products
–
Other Tool.

Controller Version RemoteAPI Version Note

10.116.0.x 1.0.12_v1 Require the corresponding MacroDev

installation

9.16 RemoteAPI Function Introduction_Source

V12

9.16.1 Basic Data Type & Report Error

Data Type

Type Name Size

byte 8 bits

short 16 bits

int 32 bits

float 32 bits

string unlimited

Error Report Descriptions

Rep Error Type Descriptions

ort
Valu
e
(sho
rt)

-18 Not supported Controller doesn't support this function.

-17 Protocol error (Ethernet Data from Ethernet Board is incorrect.Contact with the service
version only) section or the section in charge.

RemoteAPI Operation Manual. – 211

 机床产品/Machine Tool Products
–
Other Tool.

Rep Error Type Descriptions

ort
Valu
e
(sho
rt)

-16 Socket error (Ethernet Investigate CNC power supply, Ethernet cable and I/F board.
version only)

-15 DLL file error There is no DLL file for each CNC series corresponding to specified
node.

-14 USBEmpty USB is empty

-13 NoUSB No USB is pulgin

-8 Handle number error Get the library handle number.

-7 Version mismatch between The CNC/PMC version does not match that of the library.Replace
the CNC/PMC and library the library or the CNC/PMC control software.

-6 Abnormal library state An unanticipated error occurred.Contact with the section in

charge.

-2 Reset or stop request The RESET or STOP button was pressed.Call the termination
function.

-1 CNC Busy Wait until the completion of CNC processing, or retry.

0 Normal termination Execution completed without any error!

1 Error(function is not Specific function which must be executed beforehand has not
executed, or not available) been executed.Otherwise that function is not available.

2 Error(data block length Check and correct the data block length or number of data.
error, error of number of
data)

3 Error(data number error) Check and correct the data number.

4 Error(data attribute error) Check and correct the data attribute.

RemoteAPI Operation Manual. – 212

 机床产品/Machine Tool Products
–
Other Tool.

Rep Error Type Descriptions

ort
Valu
e
(sho
rt)

5 Error(data error) Check and correct the data.

6 Error(no option) There is no corresponding CNC option.

7 Error(write protection) Write operation is prohibited.

8 Error(memory overflow) CNC tape memory is overflowed.

9 Error(CNC parameter error) CNC parameter is set incorrectly.

10 Error(buffer empty/full) The buffer is empty or full.

11 Error(path number error) A path number is incorrect.

12 Error(CNC mode error) The CNC mode is incorrect.Correct the CNC mode.

13 Error(CNC execution The execution at the CNC is rejected.Check the condition of

rejection) execution.

14 Error(Data server error) Some errors occur at the data server.

15 Error(alarm) The function cannot be executed due to an alarm in CNC.Remove

the cause of alarm.

16 Error(stop) CNC status is stop or emergency.

17 Error(State of data Data is protected by the CNC data protection function.

protection)

18 Error(Not found Machine ID) Please Check or not send CNC_CONNECTION command.

19 Error(No out) Please Check NO.

RemoteAPI Operation Manual. – 213

 机床产品/Machine Tool Products
–
Other Tool.

Rep Error Type Descriptions

ort
Valu
e
(sho
rt)

20 Error(Need to Update RemoteAPI version is too old for connected controller, need to
RemoteCnc Version) update RemoteAPI version.

9.16.2 Basic Function

isUSBExist ： Whether there is an USB plugged in

Function Name bool isUSBExist( )

Argument
variable name type [in/out] descriptions

N/A

Return Value True => there is an USB plugged in, False => there isn't an USB
plugged in

SeriesNo：Controller Series No.

Function Name string SeriesNo(…)

Argument
variable name type [in/out] descriptions

N/A

Return Value controller series number or null string

RemoteAPI Operation Manual. – 214

 机床产品/Machine Tool Products
–
Other Tool.

CncOption：Controller Software Option

Function Name string CncOption(…)

Argument
variable name type [in/out] descriptions

N/A

Return Value software options of controller (apart by spaces)

MainBoardPlatformName：Mainboard Model of Controller

Function Name string MainBoardPlatformName (…)

Argument
variable name type [in/out] descriptions

N/A

Return Value controller mainboard model or null string

READ_information：Basic Information

Function Name short READ_information(…)

RemoteAPI Operation Manual. – 215

 机床产品/Machine Tool Products
–
Other Tool.

Argument
variable type [in/out] descriptions
name

Axes short out number of axes

CncType string out ex :'18' : Series

180/180i

MaxAxes short out maximum number

of axes

Series string out M/T type

Nc_Ver string out NC version

AxisName string[] out coordinate name

of each axis

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

READ_status：Status Information

Function Name short READ_status(…)

RemoteAPI Operation Manual. – 216

 机床产品/Machine Tool Products
–
Other Tool.

Argument
variable name type [in/out] descriptions

MainProg string out main program

name

CurProg string out current program

name

CurSeq x out does not support,

default = -1

Mode string out ex:"MDI", "MEM"…

Status string out ex:"STOP",

"START"…

Alarm string out ex:"ALARM", "****"

EMG string out ex:"EMG", "****"

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

Note Alarm：When an alarm occurs, "ALARM" is returned; when no alarm

occurs, "****" is returned.
EMG：When emergency stop happens, "EMG" is returned; when no
emergency stop happens, "****" is returned

READ_position：Coordinate Information

Function short READ_position(…)

Name

RemoteAPI Operation Manual. – 217

 机床产品/Machine Tool Products
–
Other Tool.

Argument
variable name type [in/out] descriptions

AxisName string[] out coordinate name of each

axis

DecPoint short out decimal places

Unit string[] out unit

Mach float[] out machine coordinate

Abs float[] out absolute coordinate

Rel float[] out relative coordinate

Dist float[] out remaining distance

Return Value 0: Operation completed, else please refer to 3-2 Return Error Descriptions

WRITE_relpos：Set the position value of relative coordinate

Function Name short WRITE_relpos(…)

Argument
variable type [in/out] descriptions
name

AxisName string in axis coordinate

name

PosValue double in position value of

relative coordinate

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

RemoteAPI Operation Manual. – 218

 机床产品/Machine Tool Products
–
Other Tool.

READ_gcode：G Code

Function Name short READ_gcode(…)

Argument
variable name type [in/out] descriptions

Gdata string[] out G Code

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

READ_othercode：Else Codes(H Code,D Code,T Code,M Code,B Code,F Code,S Code)

Function Name short READ_othercode(…)

Argument
variable name type [in/out] descriptions

HCode int out H Code

DCode int out D Code

TCode int out T Code

MCode int out M Code

FCode int out F Code

SCode int out S Code

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

READ_spindle：Feedrate/Spindle Speed

Function Name short READ_spindle(…)

RemoteAPI Operation Manual. – 219

 机床产品/Machine Tool Products
–
Other Tool.

Argument
variable name type [in/out] descriptions

OvFeed float out Feed Rate Over

Ride

OvSpindle float out Spindle Over Ride

ActFeed float out Actual Feedrate

ActSpindle int out Actual Spindle

Speed

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

READ_time：Time

Function Name short READ_time(…)

Argument
variable name type [in/out] descriptions

PowerOnTime int out boot time(sec)

AccumulateCutti int out cutting time(sec)

ngTime

CuttingTimePerC int out cycle time(sec)

ycle

WorkTime int out machining

time(sec)

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

RemoteAPI Operation Manual. – 220

 机床产品/Machine Tool Products
–
Other Tool.

READ_part_count：Number of Workpieces

Function Name short READ_part_count(…)

Argument
variable name type [in/out] descriptions

part_count int out number of

workpiece

require_part_co Int Out required number of

unt workpiece

Total_part_cou int out total number of

nt workpiece

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

DOWNLOAD_work_record：Download remote machining record file

Function Name short DOWNLOAD_work_record (…)

Argument
variable name type [in/out] descriptions

Destination string in download path

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

IsDipoleSupported：Whether it is possible to connect via dipole within the given timeout

time

Function Name bool IsDipoleSupported (…)

RemoteAPI Operation Manual. – 221

 机床产品/Machine Tool Products
–
Other Tool.

Argument
variable name type [in/out] descriptions

IPAddr string in destination IP

address

Timeout uint in given timeout

time (ms)

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

READ_MakerConfigInfo：Machinery Information

Function Name short READ_MakerConfigInfo(…)

Argument
variable type [in/out] descriptions
name

szModel string out machine model

szMachSN string out machine series no.

szDate string out machine

manufacturing
date

szDevSN string out device serires

number

szPhone string out machinery phone

number

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

WRITE_MakerConfigInfo：Set the information of machinery

Function Name short WRITE_MakerConfigInfo(…)

RemoteAPI Operation Manual. – 222

 机床产品/Machine Tool Products
–
Other Tool.

Argument
variable type [in/out] descriptions
name

szModel string in machine model

szMachSN string in machine series no.

szDate string in machine

manufacturing
date

szDevSN string in device serires

number

szPhone string in machinery phone

number

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

9.16.3 Alarm Related Funtion

READ_alm_current：Current Alarm

Function Name short READ_alm_current(…)

RemoteAPI Operation Manual. – 223

 机床产品/Machine Tool Products
–
Other Tool.

Argument
variable type [in/out] descriptions
name

IsAlarm bool out whether there is

any alarm be
triggered

AlmMsg String[] out get the information

of current alarm

AlmTime DateTime[] out get the triggered

time of current
alarm

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

note The arrangement rule of the alarm array is from new to old.
The format of alarm message is("motion" "number"
"descriptions")

READ_alm_history：Alarm History

Function Name short READ_alm_history(…)

Argument
variable name type [in/out] descriptions

AlmMsg string[] out alarm

message

AlmTime DateTime[] out alarm time

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

note The arrangement rule of the alarm array is from new to old.
The format of alarm message is("motion" "number"
"descriptions")

RemoteAPI Operation Manual. – 224

 机床产品/Machine Tool Products
–
Other Tool.

Function Name short READ_alm_history(…)

Argument
variable type [in/out] descriptions
name

AlmMsg string[] out alarm message

AlmTime DateTime[] out alarm time

Duration uint[] out duration, in sec

Clear bool[] out whether the

alarm(s) is cleared

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

Notes • Only support 10.116.54Q, 10.118.0K, 10.118.11 or after

• The arrangement rule of the alarm array is from new to
old.
The format of alarm message is("motion" "number"
"descriptions")

9.16.4 Tool Offset Function

READ_offset_title：Read the titles of tool offset

Function Name short READ_offset_title(…)

Argument
variable name type [in/out] descriptions

OffsetTitle string[] out titles

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

RemoteAPI Operation Manual. – 225

 机床产品/Machine Tool Products
–
Other Tool.

Notes
series return value descriptions model

Syntec M {"RADIUS GEOM","RADIUS Mill, Drill, Wood,

series WEAR","LENGTH GlassGrind
GEOM","LENGTH WEAR"}

Syntec T {"WEAR X","WEAR Lathe

series Z","WEAR A","LENGTH
X","LENGTH Y","LENGTH
A","TOOL NOSE
RADIUS","TOOL NOSE R
WEAR","TOOL NOSE"}

READ_offset_all：Read the offset of all tools

Function Name short READ_offset_all(…)

Argument
variable name type [in/out] descriptions

OffsetData double[][] out offset data

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

Notes The second array of Offset Data, with the title name (Length
Geom...).
Get the data start from the first tool.

READ_offset_scope：Read the tool offset from the given range.

Function Name short READ_offset_scope(…)

RemoteAPI Operation Manual. – 226

 机床产品/Machine Tool Products
–
Other Tool.

Argument
variable type [in/out] descriptions
name

StartNumber short in start no. (start

from 1)

EndNumber short in stop no.

OffsetData double[][] out offset data

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

READ_offset_single：Read the single tool offset

Function Name short READ_offset_single(…)

Argument
variable type [in/out] descriptions
name

ofNumber short in set the offset

number

OffsetData double[] out offset data

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

WRITE_offset_all：Write offset of all tools

Function Name short WRITE_offset_all(…)

RemoteAPI Operation Manual. – 227

 机床产品/Machine Tool Products
–
Other Tool.

Argument
variable type [in/out] descriptions
name

OffsetData double[][] in set the offset

data

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

Notes Start from the first tool, until finish writing all the offset.

WRITE_offset_single：Write offset of single tool

Function Name short WRITE_offset_single(…)

Argument
variable type [in/out] descriptions
name

ofNumber short in set the offset

number

OffsetData double[] in set the offset

data

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

READ_offset_count：Read the number of offset data

Function Name short READ_offset_count(…)

Argument
variable name type [in/out] descriptions

Count short out number of offset

data

RemoteAPI Operation Manual. – 228

 机床产品/Machine Tool Products
–
Other Tool.

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

9.16.5 Workpiece Coordinate Function

READ_work_coord_axis：Read the title of workpiece coordinate

Function Name short READ_work_coord_title(…)

Argument
variable name type [in/out] descriptions

WorkCoordTitle string[] out title name

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

READ_work_coord_all：Read all the workpiece coordinate

Function Name short READ_work_coord_all(…)

Argument
variable type [in/out] descriptions
name

CoordName string[] out item ,ex:EXT,G54,

G55…

WorkCoord float[][] out workpiece

coordinate data

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

RemoteAPI Operation Manual. – 229

 机床产品/Machine Tool Products
–
Other Tool.

Notes CoordName like:

EXT,MPGShift, G54, G55, G56, G57, G58, G59 , G54P7, G54P8,
G54P100等

READ_work_coord_scope：Read the workpiece coordinate in the given range

Function Name short READ_work_coord_scope(…)

Argument
variable type [in/out] descriptions
name

StartNumber short in start no.

EndNumber short in stop no.

CoordName string[] out item,

ex:EXT,G54,G55…

WorkCoord float[][] out workpiece

coordinate data

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

RemoteAPI Operation Manual. – 230

 机床产品/Machine Tool Products
–
Other Tool.

Notes CoordName like:

EXT,MPGShift, G54, G55, G56, G57, G58, G59 , G54P7, G54P8,
G54P100等
The number corresponds to the workpiece coordinate name as
follows

workpiece name corresponding no.

EXT 0

MPG Shift 1

G54 2

G55 3

G56 4

G57 5

G58 6

G59 7

G54 P7~P100 8~101

READ_work_coord_single：Read the single workpiece coordinate

Function Name short READ_work_coord_single(…)

Argument
variable type [in/out] descriptions
name

CoordName string in item,

ex:EXT,G54,G55…

WorkCoord float[] out workpiece

coordinate data

RemoteAPI Operation Manual. – 231

 机床产品/Machine Tool Products
–
Other Tool.

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

WRITE_work_coord_all：Write all the workpiece coordinate

Function Name short WRITE_work_coord_all(…)

Argument
variable type [in/out] descriptions
name

CoordName string[] in setting item,

ex:EXT,G54,G55…

WorkCoord float[][] in set the workpiece

coordinate data

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

WRITE_work_coord_single：Write single workpiece coordinate

Function Name short WRITE_work_coord_single(…)

Argument
variable type [in/out] descriptions
name

CoordName string in setting item,

ex:EXT,G54,G55…

WorkCoord float[] in set the workpiece

coordinate data

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

RemoteAPI Operation Manual. – 232

 机床产品/Machine Tool Products
–
Other Tool.

READ_work_coord_count：Read the number of workpiece coordinate

Function Name short READ_work_coord_count(…)

Argument
variable type [in/out] descriptions
name

Count short out number of

workpiece
coordinate data

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

9.16.6 Macro Variable Function(Global Variable)

READ_macro_all：Read all Macro variable (global variable)

Function Name short READ_macro_all(…)

Argument
variable type [in/out] descriptions
name

MacroNumbe int[] out Macro no.

r

MacroData double[] out Macro variable

data

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

RemoteAPI Operation Manual. – 233

 机床产品/Machine Tool Products
–
Other Tool.

READ_macro_scope：Read Macro variable (global variable) in the given range

Function Name short READ_macro_scope(…)

Argument
variable type [in/out] descriptions
name

StartNumber int in start number

(start from 1)

EndNumber int in stop number

MacroNumbe int[] out Macro number

r

MacroData double[] out Macro variable

data

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

WRITE_macro_all：Write all the Macro variable (global varible)

Function Name short WRITE_macro_all(…)

Argument
variable name type [in/out] descriptions

MacroNumber int[] in set Macro

number

MacroData double[] in set Macro

variable

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

RemoteAPI Operation Manual. – 234

 机床产品/Machine Tool Products
–
Other Tool.

READ_macro_single：Read single Macro variable(global variable)

Function Name short READ_macro_single(…)

Argument
variable name type [in/out] descriptions

MacroNumber int in Macro number

MacroData double out Macro variable

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

WRITE_macro_single：Write single Macro variable(global variable)

Function Name short WRITE_macro_single(…)

Argument
variable name type [in/out] descriptions

MacroNumber int in set Macro

number

MacroData double in set Macro

variable

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

READ_macro_variable：Read the start and end number of Macro variable(global variable)

Function Name short READ_macro_variable(…)

RemoteAPI Operation Manual. – 235

 机床产品/Machine Tool Products
–
Other Tool.

Argument
variable type [in/out] descriptions
name

Variable int[][] out the start and end

number of Macro
variable

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

Notes Declare array：Variable[type][0]:Start Number

Variable[type][1]:End Number
如：
Variable[0][0]:100
Variable[0][1]:199
Variable[1][0]:500
Variable[1][1]:599

9.16.7 NC Program Function

WRITE_nc_main：Assign the specific NC program

Function Name short WRITE_nc_main(…)

Argument type 1
variable name type [in/out] descriptions

szProgName string in program name

RemoteAPI Operation Manual. – 236

 机床产品/Machine Tool Products
–
Other Tool.

Argument type 2
variable name type [in/out] descriptions

szProgName int in program name

nCoordID int in Path number

nLineNumber int in start line number

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

Notes • back-end controller support version: 10.116.10x or after

• back-end controller version: 10.116.10x-10.116.16x After
assign the NC program, the controller mode couldn't be
changed.
• API of Argument type 2 is only provided by
Syntec.RemoteCNC.Win32.dll after version 10.116.54A
• When using Argument type 2, refer to: 多轴群规划与MST多
通道应用手册

READ_nc_mem_list：Read the internal NC program list of machine

Function Name short READ_nc_mem_list(…)

Argument
variable name type [in/out] descriptions

NcList string[][] out NC program

list

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

RemoteAPI Operation Manual. – 237

 机床产品/Machine Tool Products
–
Other Tool.

Notes Since the NC lists of machineries are different, the following format
is recommended:
NcList[][0]:NC Name
NcList[][1]:Size (byte)
NcList[][2]:Last Write DateTime
NcList[][3]: file / directory
Note：If there is no NC program list, return -1(CNCBUSY), please
pay attention to this.

UPLOAD_nc_mem：Upload NC program to controller

Function Name short UPLOAD_nc_mem(…)

Argument
variable type [in/out] descriptions
name

Source string in the full path name

of machine

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

DOWNLOAD_nc_mem：Download NC program

Function Name short UPLOAD_nc_mem(…)

Argument
variable name type [in/out] descriptions

Source string in NC program

name

Destination string in folder path

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

RemoteAPI Operation Manual. – 238

 机床产品/Machine Tool Products
–
Other Tool.

DEL_nc_mem：Delete the NC program in the controller

Function Name short DEL_nc_mem(…)

Argument
variable name type [in/out] descriptions

Name string in name

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

READ_nc_freespace：Remaining Space(k)

Function Name short READ_nc_freespace(…)

Argument
variable name type [in/out] descriptions

FreeSpace Long out remaining

space(k)

Return Value 0: Operation completed, else please refer to attachment 1. return

error descriptions

READ_nc_OPLog：Read the operation log

Function Name short READ_nc_OPLog(…)

Argument
variable name type [in/out] descriptions

OPLog string[] out operation record

count int in/out number of

record

Return Value 0: Operation completed, else please refer to attachment 1. return

error descriptions

RemoteAPI Operation Manual. – 239

 机床产品/Machine Tool Products
–
Other Tool.

Notes 1. 'Count' input the number of the log to be read, and returns the
number of log be read.
2. When the input parameter count is 0, all operation log will be
returned.
3. When a timeout error occurs, you can use the
SynetcRemoteCNC(ip,timeout) constructor to increase the
timeout. Timeout=0 means none, and the unit of timeout is ms.
4. The OPLog returned can refer to the appendix for relevant
information

Note：If there is no Log, return the original array and write "No Log".
This is NOT supported for V12.

9.16.8 System Parameter Function

READ_param_max：Read the maximum parameter number of machine

Function Name short READ_param_max(…)

Argument
variable name type [in/out] descriptions

MaxNumber int out maximum

parameter number

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

READ_param_schema：Read all the parameter data

Function Name short READ_param_schema(…)

RemoteAPI Operation Manual. – 240

 机床产品/Machine Tool Products
–
Other Tool.

Argument
variable type [in/out] descriptions
name

index int[] out parameter number

value int[] out parameter value

context string[] out parameter

descriptions

bound string[] out up[er limit & lower

limit of parameter

count int out parameter number

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

READ_param_data：Read the parameter data in the given range

Function Name short READ_param_data(…)

Argument
variable name type [in/out] descriptions

ParamStart int in parameter start

number

ParamEnd int in parameter end

number

ParmData int[] out parameter data

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

Notes ※ When the specified parameter number does not exist on the
controller or fails to read, ParamType will be set to -1

RemoteAPI Operation Manual. – 241

 机床产品/Machine Tool Products
–
Other Tool.

WRITE_param_single：Write the single parameter value

Function Name short WRITE_param_single(…)

Argument
variable name type [in/out] descriptions

ParamID int in parameter

number

val int in set value

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

9.16.9 PLC Function

READ_plc_type：Read the type of PLC address

Function Name short READ_plc_type(…)

Argument
variable name type [in/out] descriptions

Addr string in ex:I,O,C,S,A,R

PlcType short out 0:byte 1:short

2:int

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

RemoteAPI Operation Manual. – 242

 机床产品/Machine Tool Products
–
Other Tool.

READ_plc_type2：Read the type and the size of PLC address

Function Name short READ_plc_type2(…)

Argument
variable name type [in/out] descriptions

Addr string in ex:I,O,C,S,A,R

PlcType short out 0:byte 1:short

2:int

PlcStart int out address start

number

PlcEnd int out address end

number

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

Notes The number of input & output depends on the selected I/O card

READ_plc_addr：Read PLC address data

Function Name short READ_plc_addr(…)

RemoteAPI Operation Manual. – 243

 机床产品/Machine Tool Products
–
Other Tool.

Argument
variable name type [in/out] descriptions

Addr string in ex:I,O,C,S,A,R

PlcStart int in address start

value

PlcEnd int in address end value

PlcType short out 0:byte 1:short 2:int

PlcDataB byte[] out Plc data(byte)

PlcDataS short[] out Plc data(short)

PlcDataI int[] out Plc data(int)

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

Notes The read value will be inputed in the array of PlcData(B,S,I). If the
number fails to be read, the array value will be set to null.

WRITE_plc_addr：Write PLC address data

Function Name short WRITE_plc_addr(…)

RemoteAPI Operation Manual. – 244

 机床产品/Machine Tool Products
–
Other Tool.

Argument
variable name type [in/out] descriptions

Addr string in ex:I,C,S,R

PlcStart int in address start

value

PlcEnd int in address end

value

PlcType short in 0:byte 1:short

2:int

PlcDataB byte[] in Plc data(byte)

PlcDataS short[] in Plc data(short)

PlcDataI int[] in Plc data(int)

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

READ_plc_ver：PLC Version

Function Name short READ_plc_ver(…)

Argument
variable name type [in/out] descriptions

Version string out Plc version

information

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

RemoteAPI Operation Manual. – 245

 机床产品/Machine Tool Products
–
Other Tool.

DOWNLOAD_plc_ladder：Download remote ladder file

Function Name short DOWNLOAD_plc_ladder (…)

Argument
variable name type [in/out] descriptions

Destination string in download

destination path

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

READ_plc_ibit：Read PLC I Bit address data

READ_plc_obit：Read PLC O Bit address data

READ_plc_cbit：Read PLC C Bit address data

READ_plc_sbit：Read PLC S Bit address data

READ_plc_abit：Read PLC A Bit address data

Function Name short READ_plc_ibit(…)

short READ_plc_obit(…)
short READ_plc_cbit(…)
short READ_plc_sbit(…)
short READ_plc_abit(…)

Argument
variable name type [in/out] descriptions

PlcStart int in address start

value

PlcEnd int in address end value

PlcData byte[] out Plc data(byte)

RemoteAPI Operation Manual. – 246

 机床产品/Machine Tool Products
–
Other Tool.

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

READ_plc_register：Read PLC Register address data

Function Name short READ_plc_register(…)

Argument
variable name type [in/out] descriptions

PlcStart int in address start

value

PlcEnd int in address end value

PlcData int[] out Plc data(int)

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

READ_plc_register：Read PLC Register address string data

Function Name short READ_plc_register(…)

Argument
variable name type [in/out] descriptions

RAddress int in address

PlcData string out Plc data(string)

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

READ_plc_timer：Read PLC Timeraddress data

Function Name short READ_plc_timer(…)

RemoteAPI Operation Manual. – 247

 机床产品/Machine Tool Products
–
Other Tool.

Argument
variable name type [in/out] descriptions

PlcStart int in address start

value

PlcEnd int in address end

value

PlcTimerValue int[] out Plc Timer value

PlcTimerSettin int[] out Plc Timer setting

g

PlcTimerState short[] out Plc Timer status

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

READ_plc_counter：Read PLC Counter address data

Function Name short READ_plc_timer(…)

Argument
variable name type [in/out] descriptions

PlcStart int in address start

value

PlcEnd int in address end

value

PlcCounterValu int[] out Plc Counter

e value

PlcCounterSetti int[] out Plc Counter

ng setting

PlcCounterStat short[] out Plc Counter

e status

RemoteAPI Operation Manual. – 248

 机床产品/Machine Tool Products
–
Other Tool.

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

WRITE_plc_ibit：Write PLC I BIT address data

WRITE_plc_cbit：Write PLC C BIT address data

WRITE_plc_sbit：Write PLC S BIT address data

Function Name short WRITE_plc_ibit(…)

short WRITE_plc_cbit(…)
short WRITE_plc_sbit(…)

Argument
variable name type [in/out] descriptions

PlcStart int in address start

value

PlcEnd int in address end value

PlcData byte[] in Plc data(byte)

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

WRITE_plc_register：Write PLC Registeraddress data

Function Name short WRITE_plc_register(…)

RemoteAPI Operation Manual. – 249

 机床产品/Machine Tool Products
–
Other Tool.

Argument
variable name type [in/out] descriptions

PlcStart int in address start

value

PlcEnd int in address end value

PlcData int[] in Plc data (int)

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

9.16.10 System Variable Function

READ_state_variable：Read system status variable data

Function Name short READ_state_variable(...)

Argument
variable name type [in/out] descriptions

StateStart int in address start value

StateStart int in address end value

StateVariable int[] out system status

variable data

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

RemoteAPI Operation Manual. – 250

 机床产品/Machine Tool Products
–
Other Tool.

READ_debug_variable：Read system diagnosis variable data

Function Name short READ_debug_variable (…)

Argument
variable name type [in/out] descriptions

DebugStart int in address start value

DebugEnd int in address end value

DebugVariable int[] out system diagnosis

variable data

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions
Notes: The system diagnostic variables 77 and 78 are specific
information of controller. For the remaining system memory, please
refer to diagnostic variable 7.

READ_system_variable：Read system variable data(#)

Function Name short READ_system_variable (…)

Argument
variable type [in/out] descriptions
name

SystemID int in path number

SystemStart int in address start

value

SystemEnd int in address end

value

DebugVariabl double[] out system variable

e data

RemoteAPI Operation Manual. – 251

 机床产品/Machine Tool Products
–
Other Tool.

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

READ_useTime：Read system usage status

Function Name short READ_useTime (…)

Argument
variable name type [in/out] descriptions

Status String out current usage

time

TimeStart String out start time

TimeExpire String out expire time

TimeRemain int out remaining time

(hr)

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions
Notes：Only support the software version after 10.116.24x

Read_remoteTime ：Read system current time

Function Name short READ_remoteTime (…)

Argument
variable type [in/out] descriptions
name

remoteTime DateTime out current machine

system time

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

RemoteAPI Operation Manual. – 252

 机床产品/Machine Tool Products
–
Other Tool.

WRITE_remoteDate：Edit System Date

Function Name short WRITE_remoteDate (…)

Argument
variable name type [in/out] descriptions

Year Int out year

Month Int Out month

Day Int Out day

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

WRITE_remoteTime：Edit System Time

Function Name short WRITE_remoteTime (…)

Argument
variable name type [in/out] descriptions

Hour Int Out hour

Minute Int Out minute

Second Int Out second

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

ClearCache：Clear all the buffer in the RemoteAPI

Function Name short ClearCache ()

Argument N/A

RemoteAPI Operation Manual. – 253

 机床产品/Machine Tool Products
–
Other Tool.

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions
Note：Clear all the buffer (ex：series number, mainboard, model,
code, then call the related API to read the right data

READ_SSV_GetDeviceInfo

Function Name READ_SSV_GetDeviceInfo( ... )

Argument
variable type [in/out] descriptions
name

nAxisId int in axis ID

nFunctionCod int in read what kind of

e information
enum
DevInfoFuncCode
{
SVPackModel =
0x11,
SVPackSoftVer,
SVPackSN,
SVMotorModel,
SVMotorSN,
ENCSoftVer,
ENCResolution,
ENCSensorType,
ENCSN,
}

szInfo string out information value

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

RemoteAPI Operation Manual. – 254

 机床产品/Machine Tool Products
–
Other Tool.

READ_SerialStateVar_ServiceReg

Function Name READ_SerialStateVar_ServiceReg(...)

Argument
variable type [in/out] descriptions
name

nAxisType int in AXIS : 0

SPLCA : 1
ROT : 2

nDeviceID int in device ID

nHandle int out When the registration is

successful, the code of this
registration will be returned,
and will be used by other
SerialStateVar functions.

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

READ_SerialStateVar_ServiceUnReg

Function Name READ_SerialStateVar_ServiceUnReg( int nHandle )

Argument
variable type [in/out] descriptions
name

nHandle int in registration code of the

specified update
service

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

RemoteAPI Operation Manual. – 255

 机床产品/Machine Tool Products
–
Other Tool.

READ_SerialStateVar_GetCapacity

Function Name READ_SerialStateVar_GetCapacity(...)

Argument
variable type [in/out] descriptions
name

nHandle int in registration code of the

specified update
service

nCapacity int out how many StateVar

variable

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

READ_SerialStateVar_Dump

Function Name READ_SerialStateVar_Dump(...)

RemoteAPI Operation Manual. – 256

 机床产品/Machine Tool Products
–
Other Tool.

Argument
variable type [in/ descriptions
name out]

nHandle int in registration code

of the specified
update service

nLength int in how many data

structure of state
variable
specifications to
capture

tStateVarSp List<TSerialSt out every data

ecList ateVarSpec> structure of state
variable
specifications

nHexFormat int out hexadecimal or

decimal

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

READ_SerialStateVar_GetValue

Function Name READ_SerialStateVar_GetValue( ... )

RemoteAPI Operation Manual. – 257

 机床产品/Machine Tool Products
–
Other Tool.

Argument
variable type [in/out] descriptions
name

nHandle int in registration code of

the specified update
service

nLength int in how many state

variable to capture

SerialStateVa List<Int32 out every state variable

rList > value

nStatus int out results

FAIL = 0,
SUCCESS,
BUSY,
EXCEPTION,

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions

9.16.11 Update Related Functions of Controller

UPLOAD_software ：update controller software

UPLOAD_ plc_file ：update controller PLC

UPLOAD_param_file ：update controller parameters

Function Name short Update_software (…)

short Update_plc_file (…)
short Update_param_file (…)

RemoteAPI Operation Manual. – 258

 机床产品/Machine Tool Products
–
Other Tool.

Argument
variable type [in/out] descriptions
name

Source String out Path file name

Software：
*\package_xxxx.zip
PLC：*\cnc.lad
parameter：
*\param.dat

Return Value 0: Operation completed, else please refer to 3-2 Return Error
Descriptions.
Notes：After the update, the controller must be rebooted to
complete the update

9.16.12 Appendix

READ_nc_OPLog meaning

Log data format ( 4Bytes )

Name Data Type Size Descriptions

Event ID UINT16 2-byte buttons, alarms, PLC, time...etc.

Event Data UINT16 2-byte event value, such as PLC-bit value,

keyboard corresponding value, alarm
number & axis

Record column format

Event Name Event ID Event Data

StartUp 0x0002 Null

RemoteAPI Operation Manual. – 259

 机床产品/Machine Tool Products
–
Other Tool.

Event Name Event ID Event Data

ShutDown 0x0003 Null

KeyPressed 0x0005

Date 0x0300~0x03FF Current date

00000011aaaaaaaa bbbbbbbbcccccccc
a:Year b:Month
c:Date

Time 0x0400~0x04FF Current time

00000100aaaaaaaa bbbbbbbbcccccccc
a: seconds b: hours
c: minutes

Alarm 0xWC00~0xWCFF Alarm ID

zz001100aaaaaaaa bbbbbbcccccccccc
a: ClassID b: Object ID
z:Alarm ID(10~11bit) c: Alarm ID(0~9bit)
Yaskawa servo alarm requires 12bit to
be fully recorded.

I-bit off 0x0010 Index

I-bit on 0x0011 Index

O-bit off 0x0012 Index

O-bit on 0x0013 Index

C-bit off 0x0014 Index

C-bit on 0x0015 Index

S-bit off 0x0016 Index

S-bit on 0x0017 Index

RemoteAPI Operation Manual. – 260

 机床产品/Machine Tool Products
–
Other Tool.

Event Name Event ID Event Data

R 0x0020 Index

P 0x0021 Index

@ 0x0022 Index

L 0x0023 Index

D 0x0024 Index

K 0x0025 Index

ParameterOnChange 0x0030 Param No.

WorkPieceOnChange 0x0031 WorkPieceFrame ID

ToolCompesationOnChange 0x0032 aaaaaaaabbbbcccc

a: ToolNo(which tool)
b: AxisNo(which axis)
c: ToolCompesationType

UserOnChange 0x0033 0x0033XXXX

For user permissions, please refer to
R5997
0009: SyntecLogIn(R5997=9)
0063: MakerLogIn(R5997=99)
0064: AdminLogIn(R5997=100)
0065: OtherLogIn(R5997=101)
03E7: LogOut(R5997=999)
(After booting, it is in the log out state.)
Other: XLogIn
( Convert XXXX to decimal X )

人机启动 0x1002 Null

人机关闭 0x1003 Null

RemoteAPI Operation Manual. – 261

 机床产品/Machine Tool Products
–
Other Tool.

Event Name Event ID Event Data

Action(undefined) 0x1004 The CRC16 value of the action name

Action 0x1005 The mapping value of LogTable

9.17 RemoteAPI System Introduction_Source

9.17.1 System Outline

Solution Framework

Syntec Dipole function separates the human machine interface from the core (Figure 1 & Figure 2), allowing
users to control the back end controller via the Internet through front end applications (such as standard
human machine interface). Users can use this framework for remote monitoring and diagnosis. The
development environment of front end applications is no longer limited to Windows CE, and general
applications of Windows XP, Windows 7,... can be developed, creating unlimited possibilities.

RemoteAPI Operation Manual. – 262

 机床产品/Machine Tool Products
–
Other Tool.

This user manual teaches users how to install CNC simulation software to the front end Windows user
terminal, and start to use the functions of RemoteCNC one-to-many API.

How to set the controller to turn on Dipole through the human machine interface

Servo setting is on the human machine interface FenuBar：(The interface will be slightly different from
different controller.)
1. F6 Parameter settings → F10 Next page→ F7 Core Server(Figure 3)。
2. F5 Maintain → F2 Internet settings → F5 Core server

RemoteAPI Operation Manual. – 263

 机床产品/Machine Tool Products
–
Other Tool.

The Dipole configuration file of the back end is located in \DiskC\WinCE\Shared\DipoleSettings.xml. In

addition to editing the configuration file with a text editor (please refer to "Appendix 1 Back-end Dipole
Configuration File"), you can also directly use the human machine interface to modify the settings of Dipole.

This FenuBar function will open the "Core Server Setting Page" (Figure 4).
The following is the description of each parameter:
• "Whether to turn on the server when booting up" is whether to automatically activate the core Dipole
function when booting up.
• "Timeout" means that when the network has no response after this time, the network connection will
be disconnected.
After the user completes the core Dipole settings, pressing "F3 Confirm" to save the settings, or press "F4
Cancel" to recover the settings. After setting, the Dipole function will be automatically activated when next
time booting up.

RemoteAPI Operation Manual. – 264

 机床产品/Machine Tool Products
–
Other Tool.

10 OS Transformation Tool Operation Manual

平台转换工具操作手册

Abstract Installation DosTox86 x86ToARM CEToLinux

SYNTEC controller has upgraded from the early DOS system to CE6 system (also known as x86 system), and
now it has been converted to CE7 system (also known as ARM system), and the hardware has been
improved from the initial need to use CF card to no CF card.
During this process, no matter the software or hardware changes, it is accompanied by changes in system
architecture and human-machine screen, so the simple backup action can no longer cope with the
maintenance needs.
To simplify SOP for front-line personnel during maintenance, a software tool has been provided to assist
front-line personnel in data conversion, which is also packaged into an installation package that can be
installed on the controller panel.
This tool includes two items:
• Dos to x86
• x86 to ARM
The relevant instructions are detailed in this manual.

Abstract Installation DosTox86 x86ToARM CEToLinux

• Please download the tool software from our website :

• https://www.syntecclub.com/Download.aspx

It is a portable application and can be used after unzipping.

OS Transformation Tool Operation Manual – 265

 机床产品/Machine Tool Products
–
Other Tool.

1. DOS2CE contents can be seen after unpacking.

2. Double click on DOS2CE\Dos2CE.exe to use.

3. Remark：To set it to "Execute as system administrator"

a. Right-click on Dos2CE.exe and click on "Content".
b. Select "Compatibility" and check the box "Run this program as system administrator".
c. Press OK
d. Then Dos2CE.exe will be executed automatically as a system administrator.

Abstract Installation DosTox86 x86ToARM CEToLinux

OS Transformation Tool Operation Manual – 266

 机床产品/Machine Tool Products
–
Other Tool.

10.1 Operation method

1. Insert the CF card to be backed up.

2. Open the tool and select "DOS to CE".

3. Select the drive where the CF card is located in the interface. Only the removable device will be
displayed in the interface.

4. The Log window will notify which type of CF card is in the disk when it is selected.

OS Transformation Tool Operation Manual – 267

 机床产品/Machine Tool Products
–
Other Tool.

5. Check the boxes for the files to be backed up, and uncheck the boxes for the files not to be backed
up.

6. Options that cannot be backed up will turn into grayscale.

OS Transformation Tool Operation Manual – 268

 机床产品/Machine Tool Products
–
Other Tool.

7. Select the directory in which to save the resulting installation package.

OS Transformation Tool Operation Manual – 269

 机床产品/Machine Tool Products
–
Other Tool.

8. Press the "Backup" button.

If the registry is checked, the profile will pop up with the following prompt to insert a second CF
card for backup.
The prompt window will automatically detect the insertion of the CF card and an OK button will
appear for the user to confirm.
If the file is not on the second CF card, then click Cancel to back up the first CF card.

LOG screen will show the current packing progress and results.

OS Transformation Tool Operation Manual – 270

 机床产品/Machine Tool Products
–
Other Tool.

9. Then, take the installation package to the controller to install the software.

10.2 x86-CF card backup

This software can also be used to back up the CF card contents of x86 systems. The procedure is the same
as for DOS to x86, and a zip file will be generated at the end of the process for the controller to install.

10.3 DOS to x86 Backup

OS Transformation Tool Operation Manual – 271

 机床产品/Machine Tool Products
–
Other Tool.

Item DOS file name, position x86 file name, position

Parameter CNC\APP\param.dat OpenCNC\Data\param.dat

Ladder CNC\APP\cnc.lad OpenCNC\Ladder\cnc.lad

Extended Parameter CNC\Data\ParamExt.pxt Merge pxt and pin files into a single
file(The pxt file content has higher
priority)
CNC\Data\ParamExt.pin
OpenCNC\Res\ParamExt.pxt

CNC\Data\ParamChiExt.pxt Merge pxt and pin files into a single

file(The pxt file content has higher
priority), and not included in the
CNC\Data\ParamChiExt.pin
installation package.
ParamExt\ParamChiExt.pxt

CNC\Data\ParamEngExt.pxt Merge pxt and pin files into a single

file(The pxt file content has higher
priority), and not included in the
CNC\Data\ParamEngExt.pin
installation package.
ParamExt\ParamEngExt.pxt

The .pxt of OCRes\Common\String\ParamExt_COM.

[OpenCnc\Country\0] in xml
MMIBase.ini

The .pxt of OCRes\CHT\String\ParamExt_CHT.xml

[OpenCnc\Country\1] in
MMIBase.ini

OS Transformation Tool Operation Manual – 272

 机床产品/Machine Tool Products
–
Other Tool.

The .pxt of OCRes\CHS\String\ParamExt_CHS.xml

[OpenCnc\Country\2] in
MMIBase.ini

The .pxt of No conversion to xml

[OpenCnc\Country\3] in
MMIBase.ini

Customized alert string CNC\APP\appchi.str OCRes\CHT\String\AlarmPLC_CHT.xml

OCRes\CHS\String\AlarmPLC_CHS.xml

CNC\APP\appeng.str OCRes\Common\String\AlarmPLC_COM.
xml

CNC\EXE\Appdata.res的 OCRes\CHT\String\AlarmMacro_CHT.xm
CNCCHI.STR l
OCRes\CHT\String\AlarmMacro_CHS.xm
l

CNC\EXE\Appdata.res的 OCRes\CHT\String\AlarmMacro_COM
CNCENG.STR

Customized MACRO CNC\MACRO OpenCNC\Macro

Customized description CNC\Data\HelpCHI.txt OCRes\CHT\Help\HelpPLCAlarm.htm

OCRes\CHS\Help\HelpPLCAlarm.htm

CNC\Data\HelpENG.txt OCRes\Common\Help\HelpPLCAlarm.ht
m

Profile CNC\Ncfiles\ (Pr3219)\OpenCnc\Ncfiles\

Registry CNC\User\Registry.dat (Pr3219)\OpenCNC\User\Registry.dat

CNC\LKN\Registry.lkn (Pr3219)\OpenCNC\LKN\Registry.lkn

CNC\MIR\Registry.mir (Pr3219)\OpenCNC\MIR\Registry.mir

Note:

OS Transformation Tool Operation Manual – 273

 机床产品/Machine Tool Products
–
Other Tool.

1. Customized alert string : The format must adhere to the specifications; otherwise, the alarm string
will fail to convert.
• Content format: 24xxx="1;MSG=Alarm content"
2. Profile:Pr3219=(0 → DiskA, 1→ No backup, 2→ DiskA, 3→ DiskA)
3. Registry: Pr3219=(0 → DiskA, 1→ No backup, 2→ No backup, 3→ DiskA)

10.4 Compatibility

Item Description

Parameter When the DOS parameter Pr3209 is set to 3 (Dos Simplified), the tool
will process the compatibility and convert it to 119 (CE Simplified) to
maintain the system with the same language.

The DOS parameter Pr3219 is always converted to 3 (DiskA) by the tool

to match the system configuration of Arm.

Abstract Installation DosTox86 x86ToARM CEToLinux

10.5 Notifications

• Bootcepc is not included in the generated installation package, please refer to step 5 to update
it.

• The boot screen must match the screen resolution in length and width when updating. If it is not
possible to perform the installation, please recreate the boot image file.
• Reference: Update Boot Image File
• File size:
• 800x600：1.37MB （1,440,054 bytes）
• 1024x768：2.25MB （2,359,350 bytes）
• Please make sure the PC can read the file normally through the file manager after inserting the CF
card.

• Please note that the following items cannot be backed up:

• Prospective System Interface(PrdMMIRes)
• Please backup manually first because of the version compatibility issue that no
backup will be performed during the process.
• Currently, only manual modification of interface and fenubar can be done through
EHMI and other tools.

OS Transformation Tool Operation Manual – 274

 机床产品/Machine Tool Products
–
Other Tool.

• IP Settings
• Backup restore is not available, please redo the settings.
• Reference: Dipole Setting Manual.
• Font File
• Currently, there is no font file backup function available, if there is any need, please
contact SYNTEC technical center.

10.6 Operation Method

STEP 1

• Insert CF1 (DiskC) first. And insert CF2 (DiskA) in step 5 if Pr3219 is set to 3.

STEP 2

• Turn on and select the conversion from x86 to ARM.

OS Transformation Tool Operation Manual – 275

 机床产品/Machine Tool Products
–
Other Tool.

STEP 3

• Selecting a card reader.

• The list will show all removable devices.
• The capacity and status of the current device will be displayed in the back for identification.

STEP 4

• Select the output folder of the installation package.

• Press to start the conversion.

OS Transformation Tool Operation Manual – 276

 机床产品/Machine Tool Products
–
Other Tool.

STEP 5

• The current status of the execution is displayed above once the conversion starts.

• When the tool reads that Pr3219 is 3, it will prompt the user to insert CF2 (DiskA).

OS Transformation Tool Operation Manual – 277

 机床产品/Machine Tool Products
–
Other Tool.

• After the tool is executed, the file manager will be opened and the current output of the
installation package will be displayed.

• A log file will be generated at the same time next to the installation file.

OS Transformation Tool Operation Manual – 278

 机床产品/Machine Tool Products
–
Other Tool.

• If the window is displayed, please check if the CF card is inserted correctly through the Windows file
browser.

STEP 6

• If necessary, the boot image file can be restored manually.

OS Transformation Tool Operation Manual – 279

 机床产品/Machine Tool Products
–
Other Tool.

• The detailed operation can be found in the following documents.

• Update Boot Image File
• File location：
• Under the selected output folder, there will be a boot image file of bootcepc.bmp.
• The boot screen must match the screen resolution in length and width when updating. If it is not
possible to perform the installation, please recreate the boot image file.
• Reference: Update Boot Image File
• Confirm the file size：
• 800x600：1.37MB （1,440,054 Bytes）
• 1024x768：2.25MB （2,359,350 Bytes）

STEP 7

• Perform the software installation.

• For detailed operation, please refer to the following documents.
• Software Installation
• File Location：
• Under the selected output folder, there will be a package_xxx.zip archive.

10.7 x86 to ARM Backup

Item File Address Remark

SB Boot Image • \DiskC\OCRes\Common\Image\SB_logo.bmp

Parameter • \DiskC\OpenCNC\Data\PARAM.DAT

Extended Parameter • \DiskC\OpenCnc\Res\paramext.pxt

Extended Parameter • \DiskC\OCRes\Common\String\ParamExt_COM.xml Valid Version:

Multilingual String • \DiskC\OCRes\CHT\String\ParamExt_CHT.xml 1.3.1
• \DiskC\OCRes\CHS\String\ParamExt_CHS.xml

Extended Parameter • \DiskC\OCRes\Common\String\ParamExt_Rbit_CO Valid Version:

Bit Multilingual M.xml 1.3.1
String • \DiskC\OCRes\CHT\String\ParamExt_Rbit_CHT.xml
• \DiskC\OCRes\CHS\String\ParamExt_Rbit_CHS.xml

OS Transformation Tool Operation Manual – 280

 机床产品/Machine Tool Products
–
Other Tool.

Item File Address Remark

Serial PLC-axis • \DiskC\OpenCNC\Data\SerialPLC\Param\SerialPLC

Parameter Param[1-32].dat

Serial PLC-axis • \DiskC\OpenCNC\Data\SerialPLC\Registry\SerialPL

Registry CReg[1-32].dat

ROT Turret • \DiskC\OpenCNC\Data\RotParam.dat

Parameter

ROT Turret Registry • \DiskC\OpenCNC\Data\RotReg.dat

Ladder • \DiskC\OpenCNC\Ladder\CNC.LAD

PLC Alarm • \DiskC\OCRes\Common\String\AlarmPLC_COM.xml

Multilingual String • \DiskC\OCRes\CHT\String\AlarmPLC_CHT.xml
• \DiskC\OCRes\CHS\String\AlarmPLC_CHS.xml

Macro • \DiskC\OpenCnc\MACRO\*

Macro Alarm • \DiskC\OCRes\Common\String\AlarmMacro_COM.x

Multilingual String ml
• \DiskC\OCRes\CHT\String\AlarmMacro_CHT.xml
• \DiskC\OCRes\CHS\String\AlarmMacro_CHS.xml

OnlineHelp • \DiskC\OCRes\Lang\Help\*.htm
• \DiskC\OCRes\Lang\Help\*.help

Dipole Client • \DiskC\StdMMIRes\Common\DipoleSettings.xml

Settings

Dipole Server • \DiskC\Shared\donet\DipoleSettings.xml

Settings

Network Folder • \DiskC\OCRes\Common\ConfigInfo.xml

Settings

Maker Information • \DiskC\OpenCNC\Data\MakerConfigInfo.xml

IO Mapping • \DiskC\OpenCNC\Data\IoMap_Customer.xml

OS Transformation Tool Operation Manual – 281

 机床产品/Machine Tool Products
–
Other Tool.

Item File Address Remark

Authority Data • \DiskC\OpenCNC\Data\Autho.xml

Profile • (Pr3219)\OpenCNC\Ncfiles\profile
• (Pr3219)\OpenCNC\Ncfiles\profile

Registry • (Pr3219)\OpenCNC\User\Registry.dat
• (Pr3219)\OpenCNC\User\Registry.dat

Gncfile • (Pr3219)\OpenCNC\GNcfiles\*.*

XMLDB Schema • OCRes\Common\Schema\*.*

Tool Length Data • Before(include) 10.116.24Q, 10.116.34, 10.117.34:

(Pr3219)\OpenCNC\User\ToolTable.dat

• After(include) 10.116.24R, 10.116.35, 10.117.35:

(Pr3219)\SysData\CNC\ToolTable.dat

M Code Grouping • Before(include) 10.116.24Q, 10.116.34, 10.117.34:

Settings (Pr3219)\OpenCNC\User\ScanTable.dat

• After(include) 10.116.24R, 10.116.35, 10.117.35:

(Pr3219)\SysData\CNC\ScanTable.dat

MMI Config • \DiskC\OCRes\Common\MMIConfig_Customer.xml

Bootcepc • \DiskC\Bootcepc.bmp
• Must do a bootcepc renew when bootup.

Prospective System • \DiskC\PrdMMIRes\*

Interface(PrdMMIRes • Currently, Fenu has a style conflict between
) (No backup) x86 and Arm, so no backup is performed.

IP Settings (No • Registry

backup) • This information is stored in the system
registry and is not available when the
system is not powered on through the CF
card.

OS Transformation Tool Operation Manual – 282

 机床产品/Machine Tool Products
–
Other Tool.

Item File Address Remark

Font File (No • \DiskC\Fonts\*

backup) • Registry
• The font file settings are also stored in the
system registry, which cannot be accessed
when the system is not powered on through
the CF card.

Note : Pr3219 = (0→ No backup, 1→No backup, 2→DiskA, 3→DiskA, 4→No backup)

10.8 Compatibility

Item Description

Parameter If the x86 system parameter Pr3219 is 0, 1, or 2, it is always converted

to 3 (DiskA) by the tool to conform to the ARM system configuration.

Abstract Installation DosTox86 x86ToARM CEToLinux

This tool does not support CE to Linux related conversions.

Please refer to the CE to Linux related functionalities for CE to Linux related functionalities.

OS Transformation Tool Operation Manual – 283

 机床产品/Machine Tool Products
–
Other Tool.

11 AutoUpgrade Guidance
11.1 AutoUpgrade Guidance
According to different situations, there are two AutoUpgrade tools currently. The differences between two tools are
below.

Tool name AutoUpgrade AutoUpgrade_iMX6

Version 2.x 3.x

rules

Applicable Mainboard is 35x Mainboard is i.MX6

models
Mainboard is 335x

Using time When problems are caused by DiskA If the image file version is before 9.16 (included), it
malfunction, use this tool to perform easily causes lag for human machine or all-in-one
hardware reforming. driver occasionally send out the MOT-11 alarm,
Upgrade version 9.17 to solve it.

Image file 35x：7.21 9.17

version
335x：7.59

Software 10.116.24Z 10.116.56K

version

Link to AutoUpgrade Manual AutoUpgrade_iMX6 Manual

Operation
Manual

Official website download path: Customer Support > Downloads > Other Tool > AU or AU_iMX6

AutoUpgrade Guidance – 284

 机床产品/Machine Tool Products
–
Other Tool.

11.2 AutoUpgrade_iMX6 Manual

• Introduction
• Precautions
• Instructions
• Steps
• Confirmation
• Troubleshooting

11.2.1 Introduction
This tool is for models with motherboard i.MX6 to install image files and software which the target versions are 9.17
and 10.116.56K respectively.
When to use:
If the image file version is before 9.16 (included), it is often that the HMI freezes or the all-in-one drive occasionally
triggers the alarm MOT-11. Upgrading to 9.17 can solve the problem, and compared with installing an image file on
the HMI, this tool can ensure a higher completion rate.

11.2.2 Precautions
• This tool is only applicable to models with motherboard i.MX6 and will not have any effect on models with
other ones.
• Please make sure that the remaining space of the USB is greater than 1 G after inserting AutoUpgrade.
• Please pay attention to the prompts on the controller and remove the USB before the first reboot to avoid
starting the installation process again at the next boot.

11.2.3 Instructions

Steps
1. Please log in to SYNTEC official website and download AutoUpgrade_iMX6 via the path: Customer Support>
Downloads> Other Tool.

AutoUpgrade Guidance – 285

 机床产品/Machine Tool Products
–
Other Tool.

2. After decompressing the downloaded file AutoUpgrade_iMX6_{version number}.zip, put all the files in the
USB root directory. (It is recommended that this USB is dedicated to AutoUpgrade, and stores AutoUpgrade
related files only.)
3. Plug the USB into the controller.
4. Reboot the controller.
5. When the controller turns on, AutoUpgrade will be executed automatically.
6. After installation is completed, the controller will display "remove the USB and reboot". (First prompt)
7. After removing the USB, reboot the controller.
8. The controller will prompt to reboot for the second times. Reboot the controller again.
9. Continuing on point 8, there is a certain probability that the controller will directly complete booting
up, which means that the second prompt will not appear. Please note that you still have to reboot, no
matter that it prompts or not.
10. After successfully booting up, AutoUpgrade is completed.

Confirmation
1. Go to the "System Information" page and check whether the image file version is 9.17 and the software
version is 10.116.56K.

11.2.4 Troubleshooting
• If AutoUpgrade is not executed, please check the following:
a. Please make sure that the decompressed file is placed in the "root directory" of the USB, not in any
other folders. If the path is wrong, please move the file to the USB root directory and try again.
b. Please make sure that the controller motherboard is i.MX6. You may look up this information on the
controller "System Information" page. If the motherboard model is not i.MX6, this tool is not
applicable to this controller.
c. If all of the above are confirmed to be correct, please provide the log file for problem analysis.
-Log file location: USB Disk/Backup/{controller serial number}/{controller serial number}.txt
-E.g. E:\Backup\M7A0001\M7A0001.txt

11.3 AutoUpgrade Manual

• Preface
• Note
• Operation
• Preparation
• Steps
• Confirmation
• Troubleshoot

11.3.1 Preface
The purpose of this tool is to perform hardware reforming (update the image file) when DiskA encounters a
problem. During the process, it will automatically back up the system files and restore the files after the reforming.

AutoUpgrade Guidance – 286

 机床产品/Machine Tool Products
–
Other Tool.

11.3.2 Note
1. For the complete AutoUpgrade process, the controller needs to be restarted at least three times. Therefore,
if an abnormal thing occurs after the execution of AutoUpgrade, such as a panel malfunction, please restart
the controller several times to restore the function.
2. After executing AutoUpgrade, a folder with the same name as the serial number of the controller will be
generated in the backup folder of the USB, and there is a txt file (Log file) with the same name as the serial
number of the controller.
a. If AutoUpgrade has not completed normally, please provide this txt file so that the technology center
can analyze the problem.
3. If the image file version is older than 7.21 / 7.42, user can only use AutoUpgrade to upgrade the image file, do
not use the controller human-machine to upgrade.
4. After upgrading the image file with AutoUpgrade, please do not degrade to the older version.
5. By default, AutoUpgrade only supports 6/11/21/21-H/eHMC series controllers. If there's need for other
models, please refer to the steps below.
a. Please download the installation package of the required model and unzip it, remove the software
version number , and put it in the Setup folder. For example, change 60CPrintCE7_ARM from
60PrintCE7_ARM_10.116.54T.
6. Please use AutoUpgrade when the controller can boot normally.
7. After AutoUpgrade is completed, it is recommended to reload all processing files to avoid using the
damaged processing files, which may cause the risk of collision.

11.3.3 Operation

Preparation
1. Please make sure that the remaining space of the USB is greater than 1G after inserting AutoUpgrade.
2. AutoUpgrade only supports the controller software version 10.116.x or after. If the original version is
10.114.x, please manually upgrade to version at least 10.116.x before using the AutoUpgrade.
3. If the controller cannot boot normally, please try to repair it (for example, format DiskA first), and then use
AutoUpgrade. If it cannot be repaired, please send it for repair directly.
4. If the OP-022 or OP-003 alarm has appeared on the controller, please try to back up the important files (login
files and processing files) in DiskA first, then enter SA to format DiskA, and then use AutoUpgrade. .
5. In addition, if the backup cannot be completed, please format DiskA directly, and then use AutoUpgrade.

Steps
1. Go to Syntec official website and download the latest version of AutoUpgrade. (Classified as "Other Tool")
2. Unzip the file and put all files in the USB root directory. (It is recommended that this USB dedicates only for
AutoUpgrade, do not put other files.)

3. Plug the USB into the controller.

AutoUpgrade Guidance – 287

 机床产品/Machine Tool Products
–
Other Tool.

4. Reboot and start the AutoUpgrade process.

5. A reboot prompt appears and the controller reboots for the first time. (Refer to the picture below)

6. While booting up next time, whether a reboot prompt appears (refer to the figure below), or it has
successfully entered the HMI, user must reboot for the second time to ensure the complete execution of
AutoUpgrade.

7. The auto upgrade is completed.

Confirmation
1. After the upgrade is completed, go to the system information screen and confirm that the controller
software version and image file version are correct.
a. Image file version: 7.21 / 7.59
b. Software version: Built-in version is 10.116.24Z, if the initial version is later than this version, no
software upgrade will be needed.
i. If there are other versions, please confirm by yourself.
2. If user wants to confirm the execution result of AutoUpgrade, you can open the log file (*.txt file) with the
same name as the controller serial number in the backup folder, and drag it to the bottom to confirm
whether there is a string in the figure below. If it does, it means the upgrade is successful. .

3. After AutoUpgrade is completed, if the OP-022 or OP-003 alarm still appears afterwards, it means that the
hardware is seriously damaged. Please replace the controller directly.

11.3.4 Troubleshoot
The following figure shows the operation of AutoUpgrade. Please refer to the flowchart and the following QA while
handling your problems.

AutoUpgrade Guidance – 288

 机床产品/Machine Tool Products
–
Other Tool.

QA1：
Problem:
• The screen shows that the remaining space of the USB Disk is less than 1G, please replace the USB Disk
and reboot
Solution:
• Please replace a USB with a free space greater than 1G, and then execute again.

QA2：
Problem:
• The screen shows that insufficient files required for low-level formatting, please replace the USB Disk
and run again
Solution:
• Check whether all files of AutoUpgrade have been put into the USB, and then run it again.
• Replacing the USB then execute it again.

AutoUpgrade Guidance – 289

 机床产品/Machine Tool Products
–
Other Tool.

QA3：
Problem:
• The screen shows that DiskA file system read failure. This is a serious error. Please format DiskA
manually before executing AutoUpgrade
Solution:
• Please try to manually back up important files in DiskA, such as login files, processing files, etc. If some files
cannot even be backed up manually, it means that the file is damaged and user can give up the backup.
• After the manual backup is completed, please enter the SA to format DiskA, and then execute AutoUpgrade
again.
• Continuing, if the version is too old, SA does not provide formatting function. Please refer to Handling of
abnormalities in ARM second sector, ask for the USB formatting password from Syntec Taiwan Technology
Center.

QA4：
Problem:
• The screen shows that DiskC file system read failure, this is a serious error, please stop executing
AutoUpgrade.
Solution:
• Please manually install the controller software version (the same version or a later one), and execute
AutoUpgrade again after installation.
• After completing the previous step, if the same situation still occurs, it means that AutoUpgrade cannot be
executed on this controller.
• If the controller can still operate normally, please evaluate the on-site conditions to see whether to use it
continuously or to replace the controller.

QA5：
Problem:
• The screen shows that the drive file backup is incomplete, please check the update record and re-run
AutoUpgrade after troubleshooting (the screen text is still based on the system).
Solution:
• Please find the backup folder in the USB, there is a folder with the same name as the serial number of the
controller, and there is a txt file with the same name as the serial number of the controller in this folder.
• Open the txt file and drag it directly to the bottom to check which file failed to back up.
• If the backup of the parameter, PLC, or login file fails, please confirm whether there is a previous backup file
that can be restored, or try to directly export the file from the controller and then import it.
• If the file that failed to backup is at the core system file level, please refer to the Q4 solution.

QA6：
Problem:
• The following picture appears.

AutoUpgrade Guidance – 290

 机床产品/Machine Tool Products
–
Other Tool.

Solution:
• Please reboot. If the controller continues to perform AutoUpgrade after rebooting, just wait for AutoUpgrade
to complete.
• If it is stuck on the Syntec Logo screen after rebooting, it means that the reforming has failed. Please replace
the controller.

Others
• If user encounters booting problem during the AutoUpgrade process, please try the following steps first:
power off> plug and unplug the USB> reboot. If this action works, it means that the cause of the problem is
USB read failure, and can continue to execute AutoUpgrade at this time.

AutoUpgrade Guidance – 291

 机床产品/Machine Tool Products
–
Other Tool.

12 Open Actions List

The following table lists the actions that can be openly used
Because the old action cannot directly determine whether it is open to use from the name itself, and checking the
table is very inconvenient .
Therefore, since 10.118.11, actions that are not open externally will all start with "$$" as the identification.
Only the actions do not starting with $$ have to check this table for confirmation.
※ Note: After the PopupAlarm window pops up, most actions will be restricted. You need to close the
PopupAlarm window before executing an action.

12.1 Action without argument

The arguments of this type of action will become part of the action name, so you can check the arguments in the
action list.
For example, "Switch to CustomXml", if the target XML name is ABC.xml, then the action name will be
CUSTOMXML_Abc.xml.

Action name Example Description Restriction Sup

port
ed
vers
ion

CUSTOMACT_EXEC_??? CUSTOMACT_EXEC_HMI call execution

This example will call HMI.exe file(exe)
The path of the
execution file
(exe) is stored in
DiskC\Shared\d
otnet

Open Actions List – 292

 机床产品/Machine Tool Products
–
Other Tool.

Action name Example Description Restriction Sup

port
ed
vers
ion

CUSTOMACT_ASSIGN_ CUSTOMACT_ASSIGN_MAIN=Mickey.c specify profile This Action does

MAIN=??? ncC not support
loading
machining
CUSTOMACT_ASSIGN_ CUSTOMACT_ASSIGN_MAIN_STORAG Specify a string 10.1
programs
MAIN_STORAGE=??? E=L4070 stored in the 16.6
located in the
storage and E,
Macro folder
assign it as the 10.1
main program Version 16.9,
file name 10.116.26D, 10.1
10.116.36P 17.9
a. before, only
the first axis
group main
program will be
specified,
b. after, the
main program
will be specified
according to the
number of axis
groups been
opened.

Version :
10.118.60 M,
10.118.66G,
10.118.70A,
10.118.71
• If the file
name is
Chinese,
the value
of device
must be
encoded
with
ANSI

CUSTOMDEV_??=?? CUSTOMDEV_R5998=10 specify how for R/P/@/#/L,

much the device only supports
is equal to integer values.

Open Actions List – 293

 机床产品/Machine Tool Products
–
Other Tool.

Action name Example Description Restriction Sup

port
ed
vers
ion

CUSTOMDEV_??++ CUSTOMDEV_R5998++ specify the for R/P/@/#/L

device value to
plus 1

CUSTOMDEV_??-- CUSTOMDEV_R5998-- specify the for R/P/@/#/L

device value to
minus 1

CUSTOMDEV_ADD_AX+ CUSTOMDEV_ADD_R100+3 add and for R/P/@/#/L 10.1

Y subtract 16.2
The effect of use is: R100=R100+3
integers to 4U,
CUSTOMDEV_MINUS_A
variables 10.1
X-Y
16.3
where A is a
6A,
variable, X and Y
10.1
are positive
16.3
integers
7,
10.1
17.3
7

CUSTOMDEV_BLU ?? CUSTOMDEV_BLU @12345 convert the for @ only 10.1

integer value 16.5,
stored in the 10.1
storage to the 17.5
corresponding (1st)
value with a ,
decimal point 10.1
according to the 16.6,
value set by the 10.1
precision 17.6
control (2nd
)

CUSTOMDEV_ON ?? CUSTOMDEV_ON R200.1 for R/P/@/#/L

CUSTOMDEV_OFF ?? CUSTOMDEV_OFF R200.1 for R/P/@/#/L

CUSTOMDEV_INV ?? CUSTOMDEV_INV R200.1 for R/P/@/#/L

Open Actions List – 294

 机床产品/Machine Tool Products
–
Other Tool.

Action name Example Description Restriction Sup

port
ed
vers
ion

CUSTOMDEVSTR_??=?? CUSTOMDEVSTR_R1000=ABC for R/P/@/#/L 10.1

16.3,
10.1
17.3

Open Actions List – 295

 机床产品/Machine Tool Products
–
Other Tool.

Action name Example Description Restriction Sup

port
ed
vers
ion

CUSTOMSIP_CUSTOM_ display Syntec • The Befo

KEYPAD_ON keyboard paramet re
er Pr3251 10.1
must be 16.3
Note: The set to a 6I,
original name of touch 10.1
this action is screen, 16.4
"open the such as 1 2,
system small or 2. ( For 10.1
keyboard". details, 17.4
please 2
refer to versi
Pr3251 ons:
*Touch Disp
(screen) ) lay
Win
• Version dow
10.120.16 s
O, num
10.120.24 eric
D, keyp
10.120.28 ad.
A,
After
10.120.29
10.1
(inclusive
16.3
) support
6I,
setting
10.1
EnableKe
16.4
yBoard in
2,
MMISetti
10.1
ng to
17.4
enable
2
the
(incl
keyboard
usiv
( For
e)
details,
versi
please
ons:
refer to
Disp
Keyboar
lay
d
Synt
Customiz
ec
ation
keyb
Manual )
oard
.

Open Actions List – 296

 机床产品/Machine Tool Products
–
Other Tool.

Action name Example Description Restriction Sup

port
ed
vers
ion

CUSTOMSIP_CUSTOM_ display 10.1

KEYPAD_LG_ON Windows 16.4,
keyboard 10.1
17.4

Note: The
original name of
this action is
"open the
system large
keyboard".

CUSTOMSIP_CUSTOM_ hide Syntec

KEYPAD_OFF keyboard /
Windows
keyboard

CUSTOMFENU_?? <action>CUSTOMFENU_Abc</action> switch the FENU Fenu Name

must be
Abc: Fenu Name to be switched
consistent

CUSTOMXML_?? <action>CUSTOMXML_Abc.xml</ switch the It is strongly

action> screen recommended
that the upper
Abc.xml: The browser to be switched
and lower case
of the browser
names must be
consistent.

CUSTOMPLUGIN_?? <action>CUSTOMPLUGIN_Abc</ switch to plugin plugin must be

action> defined in
plugin.config file
Abc：PlugIn name

Open Actions List – 297

 机床产品/Machine Tool Products
–
Other Tool.

Action name Example Description Restriction Sup

port
ed
vers
ion

POPUPXML_?? <action>POPUPXML_Abc.xml_W=300 pop-up window It is strongly

_H=200_X=200_Y=200_T=0</action> recommended
<action>POPUPXML_Abc.xml_250_40 that the upper
0</action> and lower case
of the browser
Abc.xml is the browser of pop-up
names must be
window
consistent.
W: window width, H: window height,
X, Y: window position, T: title
display(0 means no display)
default(W=400_H=400_X=192_Y=100_
T=1)
In the second format mode, 250 is the
window width, 400 is window height,
and the window position is the same
as above

DoExitPopupWithoutF <action>DoExitPopupWithoutFenu</ close the pop- Used to close

enu action> up window the pop-up
window called
by
POPUPXML_??

FENUBTNATTR_?? FENUBTNATTR_GCodeDisplaySwitch. Modify the key

Enabled=true attributes of
Fenubar
--> The string format is
"FENUBTNATTR_{0}.{1}={2}",
ButtonName, ButtonAttribute,
ButtonAttrValue
--> Program processing
CustomApi.ChangeFenuBtnAttr( Butt
onName, ButtonAttribute,
ButtonAttrValue );

Open Actions List – 298

 机床产品/Machine Tool Products
–
Other Tool.

Action name Example Description Restriction Sup

port
ed
vers
ion

BACKGNDATTR_?? BACKGNDATTR_Lab_PendingAlarm.Vi Modify

sible=True OCB_Backgnd
object
--> The string format is
attributes
"BACKGNDATTR_{0}.{1}={2}",
ComponentName,
ComponentAttr,ComponentAttrValue
--> Program processing
OCB_Backgnd.ComponentProperty[ "
ComponentName.ComponentAttr" ] =
ComponentAttrValue;

CUSTOMATTR_?? --> The string format Modify object Only works on

is "CUSTOMATTR_{0}.{1} attributes custom pages
={2}", CustomComponentName , Cust (pages called by
omComponentAttribute, CustomCom customxml_??)
ponentValue
--> Program
processing OCB_CustomXml.Compon
entProperty[ CustomComponentNam
e + "." + CustomComponentAttribute ]
= CustomComponentValue;

CUSTOMFILE_DIR_?? Modify the data dosen't support

bas dir of the version after
XMLDB 10.116.14,
10.117.15. ref:
MMI-1113

LOADCYCFILE_NAME=? <action>LOADCYCFILE_NAME=Test</ LOADCYCFILE_N According to the 10.1

? action> AME=FileName definition 16.9,
load in Test.cyc Load the setting settings of 10.1
file stored in CycleName=Cus 17.9
FileName.cyc tomXMLDBData
which in the
folder of ~/
Common/
Schema/

Open Actions List – 299

 机床产品/Machine Tool Products
–
Other Tool.

Action name Example Description Restriction Sup

port
ed
vers
ion

LOADCYCFILE_STORAG <action>LOADCYCFILE_STORAGE=R50 LOADCYCFILE_S same as above

E=?? </action> TORAGE=Device
If R50 = 1234, load 1234.cyc Same as above,
except that the
file name is
stored in Device,
and Device
currently only
provides R in
digital form

SAVECYCFILE_NAME=? <action>SAVECYCFILE_NAME=Test</ SAVECYCFILE_N same as

? action> AME=FileName LOADCYCFILE_N
Save the current setting file in will pop up the AME
Test.cyc asking window
"whether to
save the
settings in
FileName.cyc"

Choose Yes,
according to the
Schema
definition, save
the current
settings in
FileName.cyc
Choose No,
nothing will
happen

SAVECYCFILE_STORAG <action>SAVECYCFILE_STORAGE=R50 SAVECYCFILE_S same as

E=?? </action> TORAGE=Device LOADCYCFILE_S
If R50 = 1234, save the setting in Same as above, TORAGE
1234.cyc but the file
name refers to
the value stored
in Device

Open Actions List – 300

 机床产品/Machine Tool Products
–
Other Tool.

Action name Example Description Restriction Sup

port
ed
vers
ion

KEYCODE_?? <action>KEYCODE_A</action> trigger the same special

Trigger the "A" key of the keyboard key code characters：
1. semicolo
n(;)：
KEYCODE
_SEMICO
LON

DOTOUCHADJUST <action>DoTouchAdjust</action> trigger touch case must

screen match exactly
calibration only valid in CE
procedure

CUSTOMXML_CUSTOM display file

FILESYSTEM management
screen (for cycle
data)

CUSTOMFILE_OPENFIL LoadXMLDBFile automatically

E load the
selected XMLDB
file in the file list
(will save the
current file, and
then load)

CUSTOMFILE_LOADFIL CUSTOMFILE_LOADFILE, need to load the data in

E cooperate with defining the file where
"CustomXMLDBData" the file
management
cursor is located
(will NOT save
the current file,
and directly
load)

CUSTOMFILE_SAVEFIL CUSTOMFILE_SAVEFILE, need to save the data

E cooperate with defining currently in use
"CustomXMLDBData" to the file

Open Actions List – 301

 机床产品/Machine Tool Products
–
Other Tool.

Action name Example Description Restriction Sup

port
ed
vers
ion

CUSTOMFILE_SAVETO CUSTOMFILE_SAVETO, need to save the data

cooperate with defining currently in use
"CustomXMLDBData" to the file where
the cursor is
located

CUSTOMFILE_SAVEAS CUSTOMFILE_SAVEAS, need to save the data

cooperate with defining currently in use
"CustomXMLDBData" to the newly
entered file
name

CUSTOMFILE_COPYFIL CUSTOMFILE_COPYFILE copy the file

E where the file
management
cursor is located
to another file

CUSTOMFILE_DELFILE CUSTOMFILE_DELFILE delete the file

where the file
management
cursor is located

CUSTOMFILE_RENFILE CUSTOMFILE_RENFILE change the file

name which the
file
management
cursor located
on to another
file name

Open Actions List – 302

 机床产品/Machine Tool Products
–
Other Tool.

Action name Example Description Restriction Sup

port
ed
vers
ion

CUSTOMFILE_IMPORTF <action>CUSTOMFILE_IMPORTFILE</ pop up the in addition to <aft

ILE action> import screen the extension er
defined in 10.1
MMIConfig.xml, 16.3
the default 6L,
extension *.cyc 10.1
will be added 16.4
3,
10.1
17.4
3
versi
on
(incl
ude)
>
displ
ay
*.cyc
file
by
defa
ult

Open Actions List – 303

 机床产品/Machine Tool Products
–
Other Tool.

Action name Example Description Restriction Sup

port
ed
vers
ion

CUSTOMFILE_EXPORT <action>CUSTOMFILE_EXPORTFILE</ pop up the in addition to <aft

FILE action> export screen the extension er
defined in 10.1
MMIConfig.xml, 16.3
the default 6L,
extension *.cyc 10.1
will be added 16.4
3,
10.1
17.4
3
versi
on
(incl
ude)
>
displ
ay
*.cyc
file
by
defa
ult

Open Actions List – 304

 机床产品/Machine Tool Products
–
Other Tool.

Action name Example Description Restriction Sup

port
ed
vers
ion

CUSTOMFILE_CYCLE1 <action>CUSTOMFILE_CYCLE1</ 1. Specify a. suitable for 10.1

action> the using multiple 16.3
existing sets of XMLDB 6O,
CycleNa cycleName, 10.1
me as please specify 16.4
"Custom the 5,
XMLDBD corresponding 10.1
ata" cycleName 17.4
2. Specify through action 5
the file before opening/
storage archiving cyc
location related files
as
b. The Func
"GNcFile
capitalization of tion
s"
CycleName 2
must be and
consistent usag
e
c. Before it is
restr
specified, the
ictio
system defaults
ns f
CycleName is
will
still
be
CustomXMLDBD
prov
ata
ided
e. The robot after
software the
occupies the follo
first group of wing
CYCLE by versi
default. For ons
robot custom (incl
developers, usiv
please start with e)
the second 10.1
group of CYCLE 16.3
6S,
f.
10.1
CUSTOMTABLE_
16.4
related actions
7,
also switch the
10.1
storage location
17.4
7

Open Actions List – 305

 机床产品/Machine Tool Products
–
Other Tool.

Action name Example Description Restriction Sup

port
ed
vers
ion

g. Please note
CUSTOMFILE_CYCLE2 <action>CUSTOMFILE_CYCLE2</ 1. Specify
that this custom
action> the
Action will
existing
change the file
CycleNa
location where
me
the system
as "Cust
reads XMLDB,
omXMLD
such as
BData2"
DBOPEN/
2. Specify
DBLOAD
the file
storage
location
as
"GNcFile
s\CYCLE2
"

CUSTOMFILE_CYCLE3 <action>CUSTOMFILE_CYCLE3</ 1. Specify

action> the
existing
CycleNa
me
as "Cust
omXMLD
BData3"
2. Specify
the file
storage
location
as
"GNcFile
s\CYCLE3
"

Open Actions List – 306

 机床产品/Machine Tool Products
–
Other Tool.

Action name Example Description Restriction Sup

port
ed
vers
ion

CUSTOMFILE_CYCLE4 <action>CUSTOMFILE_CYCLE4</ 1. Specify

action> the
existing
CycleNa
me
as "Cust
omXMLD
BData4"
2. Specify
the file
storage
location
as
"GNcFile
s\CYCLE4
"

CUSTOMFILE_CYCLE5 <action>CUSTOMFILE_CYCLE5</ 1. Specify

action> the
existing
CycleNa
me
as "Cust
omXMLD
BData5"
2. Specify
the file
storage
location
as
"GNcFile
s\CYCLE5
"

CUSTOMFILE_MULTISE <action>CUSTOMFILE_MULTISELECT= True: Multiple 10.1

LECT=?? TRUE</action> selection 18.6
8,
<action>CUSTOMFILE_MULTISELECT= False: radio
10.1
FALSE</action> selection
18.6
6D,
CUSTOMFILE_DELSELE <action>CUSTOMFILE_DELSELECTFIL delete selected 10.1
CTFILE E</action> files 18.6
0J

Open Actions List – 307

 机床产品/Machine Tool Products
–
Other Tool.

Action name Example Description Restriction Sup

port
ed
vers
ion

CUSTOMFILE_SELECTA <action>CUSTOMFILE_SELECTALL</ select all

LL action>

CUSTOMFILE_CANCEL <action>CUSTOMFILE_CANCELSELEC cancel selection

SELECT T</action>

CUSTOMFILE_SELECTF <action>CUSTOMFILE_SELECTFILE</ select

ILE action>

DOI_E_EXIT close the export

and import
screen

CUSTOMFILE_NEWFILE <action>CUSTOMFILE_NEWFILE</ the CycleData

action> file adding
window pops up

CUSTOMFILE_NEWFILE <action>CUSTOMFILE_NEWFILE_A=Ac the CycleData

_A=??,?? tion1,Action2...</action> file adding
window pops up
and able to
execute Actions
after
successfully
adding files

CUSTOMTABLE_SAVEFI <action>CUSTOMTABLE_SAVEFILE</ Save file: Save The name of the 10.1

LE action> the content of currently 17.2,
the currently opened file is 10.1
opened recorded in 16.2
customized L3980, and the
table and the maximum
related field length is 80
values set by characters.
XMLDB Schema.

Open Actions List – 308

 机床产品/Machine Tool Products
–
Other Tool.

Action name Example Description Restriction Sup

port
ed
vers
ion

CUSTOMTABLE_LOADF <action>CUSTOMTABLE_LOADFILE</ Load file: Load The files

ILE action> the selected managed by the
data file on the file system are
file system stored in
page, including GNcFiles or its
table content subfolders
and related field under the disk
values set by designated by
XMLDB Schema, Pr3219, and the
and display the file extension
corresponding type is .cyc.
Page Schema.

CUSTOMTABLE_RELOA <action>CUSTOMTABLE_RELOADFILE Reload file: same as above

DFILE </action> reload the data
file opened by
the file system,
including table
content and
related field
values set by
XMLDB Schema,
and display the
corresponding
Page Schema.

CUSTOMTABLE_APPEN <action>CUSTOMTABLE_APPENDLINE add row: add a

DLINE </action> row of Template
column
corresponding
to xxx Schema
after the table
cursor.

CUSTOMTABLE_INSER <action>CUSTOMTABLE_INSERTLINE insert row:

TLINE </action> insert a row of
Template
column
corresponding
to xxx Schema
after the table
cursor.

Open Actions List – 309

 机床产品/Machine Tool Products
–
Other Tool.

Action name Example Description Restriction Sup

port
ed
vers
ion

CUSTOMTABLE_DELET <action>CUSTOMTABLE_DELETELINE delete row:

ELINE </action> delete the row
where the table
cursor is
located.

CUSTOMTABLE_EDITM <action>CUSTOMTABLE_EDITMODE</ edit mode: set

ODE action> the customized
table to edit
mode. At this
time, each field
can be focused
and the input
can be edited.

CUSTOMTABLE_MONIT <action>CUSTOMTABLE_MONITORM monitor mode:

ORMODE ODE</action> set the
customized
table to monitor
mode. At this
time, the value
of each field can
only be viewed,
and cannot be
entered or
focus.

CUSTOMTABLE_BROW <action>CUSTOMTABLE_BROWSERM switch the 10.1

SERMODE ODE</action> custom page 16.5,
table to "browse 10.1
mode". 17.5
The fields on the (1st)
form can be ,
focused, but 10.1
cannot be 16.6,
entered 10.1
17.6
(2nd
)

Open Actions List – 310

 机床产品/Machine Tool Products
–
Other Tool.

Action name Example Description Restriction Sup

port
ed
vers
ion

CUSTOMTABLE_NEWFI <action>CUSTOMTABLE_NEWFILE=xx add CycleData

LE=?? x</action>
add xxx.cyc

CUSTOMTABLE_NEWFI <action>CUSTOMTABLE_NEWFILE=xx add CycleData,

LE=_A=??,?? x_A=Action1,Action2</action> and execute
add xxx.cyc, then execute Action1 and Action in
Action2 in sequence sequence

DoRunSimRefresh <action>DoRunSimRefresh</action> force the Please pay 10.1

graphics attention to 16.0
simulation to capitalization R,
redo again 10.1
16.6,
10.1
17.6

SAVECYCLE=?? SAVECYCLE=CycleName store the 10.1

corresponding 16.5,
Storage data of 10.1
the Schema 17.5
corresponding (1st)
to the specified ,
CycleName in 10.1
the header of 16.6,
currently 10.1
opened cyc file 17.6
(L3980) (2nd
)
LOADCYCLE=?? LOADCYCKE=CycleName read the header
of the currently
opened cyc file
(L3980) which
meet the
Storage data
corresponding
to the specified
CycleName in
the system

Open Actions List – 311

 机床产品/Machine Tool Products
–
Other Tool.

Action name Example Description Restriction Sup

port
ed
vers
ion

PushAnchorScreen <action>PushAnchorScreen</action> Push the current Take screen as 10.1

page to the the unit, 18.3
screen queue CustomXML 9
customized
pages cannot
switch through
this action. If the
similar functions
are required,
please use the
new screen
template
customization
method instead.

PopAnchorScreen <action>PopAnchorScreen</action> Switch to the same as above 10.1

top screen of 18.3
the screen 9
queue

Dynamic table related actions

CTNewFile <action>CTNewFile</action> Create a new 10.1

table file 16.5
4K,
When triggered,
10.1
it will pop up
18.0
the dialog
F,
window for the
10.1
user to
18.6
customize the
file name

Open Actions List – 312

 机床产品/Machine Tool Products
–
Other Tool.

Action name Example Description Restriction Sup

port
ed
vers
ion

CTLoadFile <action>CTLoadFile</action> Load the table file name

file variable
applicable R/@/
Load file name:
L
Defined in the
table variable
"File name
variable"

Notice
Conditions for
uploading files
using the file
management
screen
1. The file
name
storage
device used
by
CycleTable,
need to be
the same as
the file
managemen
t screen
L39XX
correspond
ing to the
file
manageme
nt screen

Open Actions List – 313

 机床产品/Machine Tool Products
–
Other Tool.

Action name Example Description Restriction Sup

port
ed
vers
ion

Open the
CYCLEX
folder on
the file
manage
ment
screen,
and the
correspo
ndence
between
the file
name
storage
device
L39XX
• If
C
Y
C
L
E
1
is
t
u
r
n
e
d
o
n,
t
h
e
u
s
e
r
s
el
e
ct
s

Open Actions List – 314

 机床产品/Machine Tool Products
–
Other Tool.

Action name Example Description Restriction Sup

port
ed
vers
ion

t
h
e
st
o
r
a
g
e
d
e
vi
c
e
L
3
9
8
0
c
o
rr
e
s
p
o
n
di
n
g
t
o
t
h
e
fil
e
n
a
m
e
• If
C
Y
C

Open Actions List – 315

 机床产品/Machine Tool Products
–
Other Tool.

Action name Example Description Restriction Sup

port
ed
vers
ion

L
E
2
is
t
u
r
n
e
d
o
n,
t
h
e
u
s
e
r
s
el
e
ct
s
t
h
e
st
o
r
a
g
e
d
e
vi
c
e
L
3
9
6
0
c
o

Open Actions List – 316

 机床产品/Machine Tool Products
–
Other Tool.

Action name Example Description Restriction Sup

port
ed
vers
ion

rr
e
s
p
o
n
di
n
g
t
o
t
h
e
fil
e
n
a
m
e
• ...
• If
C
Y
C
L
E
5
is
t
u
r
n
e
d
o
n,
t
h
e
u
s
e
r
s

Open Actions List – 317

 机床产品/Machine Tool Products
–
Other Tool.

Action name Example Description Restriction Sup

port
ed
vers
ion

el
e
ct
s
t
h
e
st
o
r
a
g
e
d
e
vi
c
e
L
3
9
0
0
c
o
rr
e
s
p
o
n
di
n
g
t
o
t
h
e
fil
e
n
a
m
e

Open Actions List – 318

 机床产品/Machine Tool Products
–
Other Tool.

Action name Example Description Restriction Sup

port
ed
vers
ion

2. Need to
operate
during the
file
managemen
t screen is
opening
The CTLoadFile
issued only at
this time can
load the file
selected in the
file
management
screen
In other cases,
the issued
CTLoadFile will
directly load the
file according to
the "file name
variable"

CTSaveFile <action>CTSaveFile</action> Save table file name

content in data variable
file applicable R/@/
L

CTInsertFocusLine <action>CTInsertFocusLine</action> Insert a new focus line

data in the number variable
focused line applicable R/@

CTInsertLine <action>CTInsertLine</action> Insert a new operation line

data in the number variable
specific line applicable R/@
Specified line
number:
defined in the
table variable
"operation line
number
variable"

Open Actions List – 319

 机床产品/Machine Tool Products
–
Other Tool.

Action name Example Description Restriction Sup

port
ed
vers
ion

CTDeleteFocusLine <action>CTDeleteFocusLine</action> Delete focus focus line

data number variable
applicable R/@

CTDeleteLine <action>CTDeleteLine</action> Delete specific operation line

data number variable
applicable R/@
Specified line
number:
defined in the
table variable
"operation line
number
variable"

CTReadFocusLine <action>CTReadFocusLine</action> Read the focus focus line

line data to the number variable
value register applicable R/@

CTReadLine <action>CTReadLine</action> Read the line operation line

data to the number variable
value register applicable R/@
Specified line
number:
defined in the
table variable
"operation line
number
variable"

CTWriteFocusLine <action>CTWriteFocusLine</action> Write the focus line

register data to number variable
the focus line applicable R/@

Open Actions List – 320

 机床产品/Machine Tool Products
–
Other Tool.

Action name Example Description Restriction Sup

port
ed
vers
ion

CTWriteLine <action>CTWriteLine</action> Write the operation line

register data to number variable
the specific line applicable R/@
Specified line
number:
defined in the
table variable
"operation line
number
variable"

CTPageUp <action>CTPageUp</action> turn previous

page of table
data

CTPageDown <action>CTPageDown</action> turn next page

of table data

12.2 Action with argument

The arguments of this type of action will be stored independently, so the arguments will not be displayed in the
action list.
If you want to check the arguments, please click the target action in the action list first, and then you can find the
required information in the argument setting area in the middle.

Action name Example Description Restriction Supported

version

Switch Screen <Action Display the screen with 10.118.39

name="ShowScreen" the specified name.
Arg1: ScreenName
>
If the screen is made in
<Arg
the form of screen
index="1">EDTOpera
template, this action is
tion</Arg>
required to switch
</Action>
screen.

Open Actions List – 321

 机床产品/Machine Tool Products
–
Other Tool.

Action name Example Description Restriction Supported

version

MMI Variant set value <Action fill up the value of • Only VAR/ 10.118.39
name="SetVariantVal device STR are
Arg1: Variant type
ue"> supported
(VAR/STR)
<Arg
Arg2: Variant number index="1">STR</Arg>
(ex: 100) <Arg
index="2">100</Arg>
Arg3: Variant value
<Arg
(ex: G01)
index="3">G01</Arg>
</Action>

Assign Main Program <Action Assign Line No. of • O888800 is 10.118.52H

Start Line No Name="AssignMainPr current main program. not ,
ogramStartLineNo"> supported. 10.118.56B,
Arg1_type:：Type of
<Arg Index="1" • "Type of Axis 10.118.57
Axis Group (VAR/
Type="CONSTNUM"> Group" only
CONSTNUM)
1</Arg> supports
Arg1_value:：Axis <Arg Index="2" VAR/
Group No. (ex: 1) Type="VAR">258</ CONSTNUM
Arg> • "Type of Line
Arg2_type： Type of
</Action> No." only
Line No. (VAR)
supports VAR
Arg2_value:： Line • Assign Line
No. (ex: 258) No. while
machine
state is
"ready".

12.3 Software panel action

• requirement description
The special machines in some industry (such as automation, woodworking machines, etc.), in order to save
costs, ease of operation and other factors, most of the hardware is not equipped with a hardkey operation
panel.
Syntec provides a solution to replace the traditional physical buttons, and provides a HMI standard software
panel dedicated to various industries (this software panel can be customized through eHMI according to
different needs), so that the user only needs to trigger the software button display on the HMI software
panel without using the hardkey operation panel to achieve various machining operations. (Such as: trigger
cycle start, pause, JOG, machining mode switching, etc.).

• [function operation framework]

Open Actions List – 322

 机床产品/Machine Tool Products
–
Other Tool.

Take the most commonly used cycle start as an example. The traditional operation method is to press the
cycle start button on the HardKey. This button will trigger a specific I point, so when the PLC scans, it will be
based on the logic written by the PLC, detecting whether the I point On. If on, it will trigger C0 On to notify the
core, and when the core finds C0 On, it will execute the cycle start action accordingly. However, in the above
process, not only a hardware operation panel (HardKey) is required, but also the PLC must cooperate with
writing related logic to correctly notify the core to execute the cycle start action.
Using the software panel function to trigger the software buttons displayed on the HMI software panel
directly informs the core to execute the cycle start action, instead of notifying the core through the PLC
first.

• [corresponding list of Action name and R value of software panel function]

support version number: after 10.116.34, 10.117.34

short action name No. Name function description action PLC

description
type read &
(note) edit rules

machining start _CycleStart R160 Trigger This R value One- read

00 Software corresponds to the Shot
[example]
Panel _CycleStart action of
_CycleStart the software panel.
_CycleStart
stands for start
Action When the user
machining
triggers the software
panel _CycleStart,
this R value is equal
to 1.

Open Actions List – 323

 机床产品/Machine Tool Products
–
Other Tool.

short action name No. Name function description action PLC

description
type read &
(note) edit rules

R160 Disable If the R value is - read /edit

01 Direct Cycle equal to 0, the
Start by _CycleStart of the
Software software panel is
Panel triggered, and the
system will directly
notify to start
machining;
If the R value is not 0,
the _CycleStart of
the software panel is
triggered, and the
system will not
notify to start
machining.

machining _FeedHold R160 Trigger This R value One- read

pause 02 Software corresponds to the Shot
[example]
Panel _FeedHold action of
_FeedHold stands the software panel.
_FeedHold A
for pause
ction When the user
machining
triggers the
_FeedHold of the
software panel, the R
value is equal to 1.

R160 Disable If the R value is - read /edit

03 Direct Feed equal to 0, the
Hold by _FeedHold of the
Software software panel is
Panel triggered, and the
system will directly
notify to pause
machining;
If the R value is not 0,
the _FeedHold of the
software panel is
triggered, and the
system will not
notify to pause
machining.

Open Actions List – 324

 机床产品/Machine Tool Products
–
Other Tool.

short action name No. Name function description action PLC

description
type read &
(note) edit rules

specific axis _Jog+Axis_N, R160 Trigger Hold read

start/end _StopJog+Axis_N 04 Software
This R value
Panel
positive JOG _Jog-Axis_N, corresponds to the
_StopJog-Axis_N _Jog+Axis_1, _Jog+Axis_1,
specific axis
_StopJog+Ax _StopJog+Axis_1
start/end [argument] N is
is_1 Action actions of the
the axis ID, only
negative JOG software panel.
integers 1~16 are
accepted When the user
triggers _Jog+Axis_1
[example]
on the software
_Jog+Axis_2 panel, the R value is
represents the equal to 1.
specified second
When the user
axis to start
triggers
positive JOG
_StopJog+Axis_1 on
_StopJog+Axis_2 the software panel,
represents the the R value is equal
specified second to 0.
axis to end
positive JOG
R160 Disable If the R value is - read /edit
_Jog-Axis_3 05 Direct X Axis equal to 0, the
represents the JOG + by _Jog+Axis_1 of the
specified third Software software panel is
axis to start Panel triggered, and the
negative JOG system will directly
notify the system X
_StopJog-Axis_3
Axis JOG +;
represents the
specified third If the R value is not 0,
axis to end of the the _Jog+Axis_1 of
negative JOG the software panel is
triggered, and the
system will not
notify the system X
Axis JOG +;

Open Actions List – 325

 机床产品/Machine Tool Products
–
Other Tool.

short action name No. Name function description action PLC

description
type read &
(note) edit rules

R160 Trigger This R value Hold read

06 Software corresponds to
Panel the_Jog-Axis_1,
_StopJog-Axis_1
_Jog-Axis_1 ,
action of the
_StopJog-
software panel.
Axis_1 Action
When the user
triggers _Jog-Axis_1
on the software
panel, the R value is
equal to 1.
When the user
triggers _StopJog-
Axis_1 on the
software panel, the R
value is equal to 0.

R160 Disable If the R value is - read /edit

07 Direct X Axis equal to 0, the _Jog-
JOG - by Axis_1 of the
Software software panel is
Panel triggered, and will
directly notify the
system X Axis JOG -;
If the R value is not
0, the _Jog-Axis_1 of
the software panel is
triggered, and will
not notify the
system X Axis JOG -;

Open Actions List – 326

 机床产品/Machine Tool Products
–
Other Tool.

short action name No. Name function description action PLC

description
type read &
(note) edit rules

R160 Trigger This R value Hold read

08 Software corresponds to
Panel _Jog+Axis_2,
_StopJog+Axis_2
_Jog+Axis_2
action of the
,
software panel.
_StopJog+Ax
is_2 Action When the user
triggers_Jog+Axis_2
on the software
panel, the R value is
equal to 1.
When the user
triggers_StopJog+Ax
is_2 on the software
panel, the R value is
equal to 0.

R160 Disable If the R value is - read /edit

09 Direct Y Axis equal to 0,
JOG + by the_Jog+Axis_2 of
Software the software panel is
Panel triggered, and will
directly notify the
system Y Axis JOG
+；
If the R value is not
0, the _Jog-Axis_1 of
the software panel is
triggered,
_Jog+Axis_2, and
will not notify the
system Y Axis JOG
+。

Open Actions List – 327

 机床产品/Machine Tool Products
–
Other Tool.

short action name No. Name function description action PLC

description
type read &
(note) edit rules

R160 Trigger This R value Hold read

10 Software corresponds to _Jog-
Panel Axis_2, _StopJog-
Axis_2 action of the
_Jog-Axis_2 ,
software panel.
_StopJog-
Axis_2 When the user
triggers_Jog-Axis_2
Action
on the software
panel, the R value is
equal to 1.
When the user
triggers_StopJog-
Axis_2 on the
software panel, the R
value is equal to 0.

R160 Disable If the R value is - read /edit

11 Direct Y Axis equal to 0, the_Jog-
JOG - by Axis_2 of the
Software software panel is
Panel triggered, and will
directly notify the
system Y Axis JOG -
；
If the R value is not
0, the _Jog-Axis_2 of
the software panel is
triggered, and will
not notify the
system Y Axis JOG -
。

Open Actions List – 328

 机床产品/Machine Tool Products
–
Other Tool.

short action name No. Name function description action PLC

description
type read &
(note) edit rules

R160 Trigger This R value Hold read

12 Software corresponds to
Panel _Jog+Axis_3,
_StopJog+Axis_3
_Jog+Axis_3,
action of the
_StopJog+Ax
software panel.
is_3 Action
When the user
triggers_Jog+Axis_3
on the software
panel, the R value is
equal to 1.
When the user
triggers_StopJog+Ax
is_3 on the software
panel, the R value is
equal to 0.

R160 Disable If the R value is - read /edit

13 Direct Z Axis equal to 0, the
JOG + by _Jog+Axis_3 of the
Software software panel is
Panel triggered, and will
directly notify the
system Z Axis JOG
+；
If the R value is not
0, the _Jog+Axis_3
of the software panel
is triggered, and will
not notify the
system Z Axis JOG
+。

Open Actions List – 329

 机床产品/Machine Tool Products
–
Other Tool.

short action name No. Name function description action PLC

description
type read &
(note) edit rules

R160 Trigger This R value Hold read

14 Software corresponds to _Jog-
Panel Axis_3, _StopJog-
Axis_3 action of the
_Jog-Axis_3 ,
software panel.
_StopJog-
Axis_3 When the user
triggers_Jog-Axis_3
Action
on the software
panel, the R value is
equal to 1.
When the user
triggers_StopJog-
Axis_3 on the
software panel, the R
value is equal to 0.

R160 Disable If the R value is - read /edit

15 Direct Z Axis equal to 0, the _Jog-
JOG - by Axis_3 of the
Software software panel is
Panel triggered, and will
directly notify the
system Z Axis JOG -
；
If the R value is not
0, the _Jog-Axis_3 of
the software panel is
triggered, and will
not notify the
system Z Axis JOG -
。

R160 Trigger same as above Hold read

16~R Software
1606 Panel
7
_Jog+/-
Axis_4~16 ,
_StopJog+/-
Axis_4~16
Action

Open Actions List – 330

 机床产品/Machine Tool Products
–
Other Tool.

short action name No. Name function description action PLC

description
type read &
(note) edit rules

Disable - read /edit

Direct
4th~16th Axi
s JOG + / - by
Software
Panel

MPG simulation _MPGSimuOn , R160 Trigger This R value Hold read

_MPGSimuOff 68 Software corresponds to
Panel _MPGSimuOn ,
[example]
_MPGSimuOff action
_MPGSimuO
_ of the software
n,
panel.
_MPGSimuOn _MPGSimuOf
represents f Action When the user
entering the MPG triggers
simulation _MPGSimuOn on the
software panel, the R
_MPGSimuOff
value is equal to 1.
represents leaving
the MPG When the user
simulation triggers
_MPGSimuOff on the
software panel, the R
value is equal to 0.

R160 Disable If the R value is - read /edit

69 Direct MPG equal to 0, the
Simulation b _MPGSimuOn of the
y Software software panel is
Panel triggered, and will
directly notify the
system to enter MPG
Simulation ；
If the R value is not
0, the _MPGSimuOn
of the software panel
is triggered, and will
not notify the
system to enter MPG
Simulation

Open Actions List – 331

 机床产品/Machine Tool Products
–
Other Tool.

short action name No. Name function description action PLC

description
type read &
(note) edit rules

Set the machine _SetMachinePos R160 Trigger This R value One- read
coordinates of Axis_N 70 Software corresponds to Shot
the specified Panel _SetMachinePosAxi
[argument] N is
axis (refer to s_1 action of the
the axis ID, only _SetMachine
R38) software panel.
integers 1~16 are PosAxis_1
accepted Action When the user
triggers_SetMachine
[example]
PosAxis_1 on the
_SetMachinePos software panel, the R
Axis_16 value equal to 1.
represents to set
the mechine
R160 Disable If the R value is - read /edit
coordinate of the
71 Direct Set X equal to 0, the
sixteenth axis to
Axis Machine _SetMachinePosAxi
the value of R38
Position by s_1 of the software
Software panel is triggered
Panel and will directly
notify the
system Set X Axis
Machine Position；
If the R value is not
0, the
_SetMachinePosAxi
s_1 of the software
panel is triggered,
and will not notify
the system Set X Axis
Machine Position。

R160 Trigger This R value One- read

72 Software corresponds to Shot
Panel _SetMachinePosAxi
s_2 action of the
_SetMachine
software panel.
PosAxis_2
Action When the user
triggers_SetMachine
PosAxis_2 on the
software panel, the R
value equal to 1.

Open Actions List – 332

 机床产品/Machine Tool Products
–
Other Tool.

short action name No. Name function description action PLC

description
type read &
(note) edit rules

R160 Disable If the R value is - read /edit

73 Direct Set Y equal to 0, the
Axis Machine _SetMachinePosAxi
Position by s_2 of the software
Software panel is triggered,
Panel and will directly
notify the
system Set Y Axis
Machine Position；
If the R value is not
0, the
_SetMachinePosAxi
s_2 of the software
panel is triggered,
and will not notify
the system Set Y Axis
Machine Position。

R160 Trigger This R value One- read

74 Software corresponds to Shot
Panel _SetMachinePosAxi
s_3 of the software
_SetMachine
panel.
PosAxis_3
Action When the user
triggers_SetMachine
PosAxis_3 on the
software panel, the R
value equal to 1.

Open Actions List – 333

 机床产品/Machine Tool Products
–
Other Tool.

short action name No. Name function description action PLC

description
type read &
(note) edit rules

R160 Disable If the R value is - read /edit

75 Direct Set Z equal to 0, the
Axis Machine _SetMachinePosAxi
Position by s_3 of the software
Software panel is triggered,
Panel and will directly
notify the
system Set Z Axis
Machine Position；
If the R value is not
0, the
_SetMachinePosAxi
s_3 of the software
panel is triggered,
and will not notify
the system Set Z Axis
Machine Position。

R160 Trigger same as above One- read

76~R Software Shot
1610 Panel
1
_SetMachine
PosAxis_4~1
6th Action

Disable - read /edit

Direct Set
4th~16th Axi
s
Machine Posi
tion by
Software
Panel

Open Actions List – 334

 机床产品/Machine Tool Products
–
Other Tool.

short action name No. Name function description action PLC

description
type read &
(note) edit rules

Enter/exit _ManualControl R161 Trigger This R value Hold read

manual control OnAxis_N , 02 Software corresponds to
Panel _ManualControlOnA
_ManualControl
xis_1 ,
OffAxis_N _ManualCon
_ManualControlOff
trolOnAxis_1
[argument] N is Axis_1 action of the
,
the axis ID, only software panel.
integers 1~16 are _ManualCon
When the user
accepted trolOffAxis_
triggers_ManualCon
1
[example] trolOnAxis_1 on the
Action software panel, the R
_ManualControl
value is equal to 1.
OnAxis_1
represents When the user
specify the first triggers_ManualCon
axis to enter the trolOffAxis_1 on the
manual control software panel, the R
value is equal to 0.
_ManualControl
OffAxis_1
represents R161 Disable If the R value is - read /edit
specify the first 03 Direct X Axis equal to 0, the
axis to exit the MANUAL _ManualControlOnA
manual control CONTROL by xis_1 of the software
Software panel is triggered,
Panel and will directly
notify the system to
enter X Axis MANUAL
CONTROL ；
If the R value is not
0, the
_ManualControlOnA
xis_1 of the software
panel is triggered, ,
and will not notify
the system to enter
X Axis MANUAL
CONTROL。

Open Actions List – 335

 机床产品/Machine Tool Products
–
Other Tool.

short action name No. Name function description action PLC

description
type read &
(note) edit rules

R161 Trigger This R value Hold read

04 Software corresponds to
Panel
_ManualControlOnA
_ManualCon xis_2,
trolOnAxis_2 _ManualControlOff
, Axis_2 action of the
software panel.
_ManualCon
trolOffAxis_ When the user
2 triggers_ManualCon
trolOnAxis_2 on the
Action
software panel, the R
value is equal to 1.
When the user
triggers_ManualCon
trolOffAxis_2 on the
software panel, the R
value is equal to 0.

R161 Disable If the R value is - read /edit

05 Direct Y Axis equal to 0, the
MANUAL _ManualControlOnA
CONTROL by xis_2 of the software
Software panel is triggered,
Panel and will directly
notify the system to
enter Y Axis MANUAL
CONTROL ；
If the R value is not
0, the
_ManualControlOnA
xis_2 of the software
panel is triggered,
will not notify the
system to enter
Y Axis MANUAL
CONTROL。

Open Actions List – 336

 机床产品/Machine Tool Products
–
Other Tool.

short action name No. Name function description action PLC

description
type read &
(note) edit rules

R161 Trigger This R value Hold read

06 Software corresponds to
Panel
_ManualControlOnA
_ManualCon xis_3,
trolOnAxis_3 _ManualControlOff
, Axis_3 action of the
software panel.
_ManualCon
trolOffAxis_ When the user
3 triggers_ManualCon
trolOnAxis_3 on the
Action
software panel, the R
value is equal to 1.
When the user
triggers_ManualCon
trolOffAxis_3 on the
software panel, the R
value is equal to 0.

R161 Disable If the R value is - read /edit

07 Direct Z Axis equal to 0, the
MANUAL _ManualControlOnA
CONTROL by xis_3 of the software
Software panel is triggered,
Panel and will directly
notify the system to
enter Z Axis MANUAL
CONTROL ；
If the R value is not
0, the
_ManualControlOnA
xis_3 of the software
panel is triggered,
will not notify the
system to enter
Z Axis MANUAL
CONTROL。

Open Actions List – 337

 机床产品/Machine Tool Products
–
Other Tool.

short action name No. Name function description action PLC

description
type read &
(note) edit rules

R161 Trigger same as above Hold read

08~R Software
1613 Panel
3
_ManualCon
trolOnAxis_4
~16 ,
_ManualCon
trolOffAxis_
4~16
Action

Disable - read /edit

Direct 4th~16
th Axis
MANUAL
CONTROL by
Software
Panel

Reset _Reset R161 Trigger This R value One- read

34 Software corresponds to Shot
[example]
Panel _Reset action of the
_Reset represents software panel.
_Reset Actio
reset
n When the user
triggers _Reset on
the software panel,
the R value is equal
to 1.

R161 Disable If the R value is - read /edit

35 Direct Reset equal to 0, triggers
_Reset on the
by Software
software panel, and
Panel
will directly notify
the system Reset ；
If the R value is not
0, triggers _Reset on
the software panel,
and will not notify
the system Reset。

Open Actions List – 338

 机床产品/Machine Tool Products
–
Other Tool.

short action name No. Name function description action PLC

description
type read &
(note) edit rules

Single block _SingleBlockOn, R161 Trigger This R value Hold read

execution 36 Software corresponds to
_SingleBlockOff
Panel
_SingleBlockOn,
[example]
_SingleBlock _SingleBlockOff
_SingleBlockOn On, action of the
represents _SingleBlock software panel.
enter single block Off
When the user
execution
Action triggers
_SingleBlockOff _SingleBlockOn on
represents the software panel,
exit single block the R value is equal
execution to 1.
When the user
triggers
_SingleBlockOff on
the software panel,
the R value is equal
to 0.

R161 Disable If the R value is - read /edit

37 Direct Single equal to 0, the
Block _SingleBlockOn of
the software panel is
by Software
triggered, and will
Panel
directly notify the
system to enter
Single Block；
If the R value is not
0, the
_SingleBlockOn of
the software panel is
triggered, will not
notify the system to
enter Single Block
。

Open Actions List – 339

 机床产品/Machine Tool Products
–
Other Tool.

short action name No. Name function description action PLC

description
type read &
(note) edit rules

machining mode _Mode_N R161 Software This R value Hold read

selection 38 Panel Mode corresponds to the
[argument] N is
Selection argument value of
the mode
_Mode_N Action, and
number, only
corresponds to the
integers 1~7 are
machining mode:
accepted
1: program editing
[example]
2: automatic
_Mode_1
execution
represents
enter the 3: MDI
"program editing"
4: JOG
mode
5: INCJOG
_Mode_2
represents 6: MPG
enter the
7: home searching
"automatic
execution" mode For example: If
_Mode_2 is triggered,
_Mode_3
the R value is equal
represents
to 2 and it represents
enter the "MDI"
that the trigger
mode
switching machining
_Mode_4 mode is "automatic
represents execution".
enter the "JOG"
mode
R161 Disable If the R value is - read /edit
_Mode_5 39 Direct Chang equal to 0, the
represents e Mode _Mode_N of the
enter the Selection by software panel is
"INCJOG" mode Software triggered, and will
Panel directly notify the
_Mode_6
system to enter
represents
Switch machining
enter the "MPG"
mode；
mode
If the R value is not
_Mode_7
0, the of the
represents
software panel is
enter the "home
triggered, _Mode_N,
searching" mode
and will not notify
the system to enter
Switch machining
mode。

Open Actions List – 340

 机床产品/Machine Tool Products
–
Other Tool.

short action name No. Name function description action PLC

description
type read &
(note) edit rules

The gain of the _IncrementFeed R161 Software This R value Hold read
first MPG and _N 40 Panel Increm corresponds to the
JOG settings ent Feed argument value of
[argument] N is
_IncrementFeed_N
the override, only
Action, and
integers are
corresponding to the
accepted
gain of the first MPG
[example]
and JOG.
_IncrementFeed
For example: if
_10 represents
_IncrementFeed_10
the gain of the
is triggered, the R
first MPG and JOG
value is equal to 10
is 1
and represents the
the gain of the first
MPG and JOG is 10.
The movement
distance of JOG
changes from 0.001
to 0.010.

R161 Disable If the R value is - read /edit

41 Direct equal to 0, the
Change Incre _IncrementFeed_N
ment of the software panel
Feed by is triggered, and will
Software directly notify the
Panel system to modify the
gain of the first MPG
and JOG.
If the R value is not
0, the
_IncrementFeed_N
of the software panel
is triggered, and will
not notify the
system to modify
the gain of the first
MPG and JOG.

Open Actions List – 341

 机床产品/Machine Tool Products
–
Other Tool.

short action name No. Name function description action PLC

description
type read &
(note) edit rules

Spindle override _SpindleOverrid R161 Software This R value Hold read

settings e_N 42 Panel Spindl corresponds to the
e Override argument value of
[argument] N is
_SpindleOverride_N
the override, only
Action, and
integers are
corresponds to the
accepted
spindle override.
[example]
For example, If
_SpindleOverrid _SpindleOverride_5
e_50 represents 0 is triggered, the R
value is equal to 50
spindle override
and it means that the
50%
spindle override
have been changed
to 50%.

R161 Disable If the R value is - read /edit

43 Direct Chang equal to 0,
e Spindle the_SpindleOverrid
Override by e_N of the software
Software panel is triggered,
Panel and will directly
notify the system to
modify spindle
override；
If the R value is not
0, the
_SpindleOverride_N
of the software panel
is triggered, and will
not notify the
system to modify
spindle override

Open Actions List – 342

 机床产品/Machine Tool Products
–
Other Tool.

short action name No. Name function description action PLC

description
type read &
(note) edit rules

G01 override _FeedrateOverri R161 Software This R value Hold read

settings de_N 44 Panel Feedra corresponds to the
te Override argument value of
[argument] N is
_FeedrateOverride_
the override, only
N Action, and
integers are
corresponding to
accepted
G01 feedrate
[example] override.
_FeedrateOverri For example, if
de_50 represents _FeedrateOverride_
50 is triggered, the R
G01 override 50%
value is equal to 50
and it means that the
G01 override is 50%.

R161 Disable If the R value is - read /edit

45 Direct Chang equal to 0, the
e Feedrate _FeedrateOverride_
Override by N of the software
Software panel is triggered,
Panel and will directly
notify the system to
modify G01
feedrate override；
If the R value is not
0, the
_FeedrateOverride_
N of the software
panel is triggered,
will not notify the
system to modify
G01 feedrate
override.

Open Actions List – 343

 机床产品/Machine Tool Products
–
Other Tool.

short action name No. Name function description action PLC

description
type read &
(note) edit rules

JOG override _JOGOverride_N R161 Software This R value Hold read

settings 46 Panel JOG corresponds to the
[argument] N is
Override argument value of
the override, only
_JOGOverride_N
integers are
Action, and
accepted
correspond to JOG
[example] override.
_JOGOverride_5 For example, If
0 represents _JOGOverride_N is
triggered, the R
JOG override 50%
value is equal to 50
and it means that the
JOG override is
50%.

R161 Disable If the R value is - read /edit

47 Direct Chang equal to 0, the
e JOG _JOGOverride_N of
Override by the software panel is
Software triggered, and will
Panel directly notify the
system modify JOG
override ；
If the R value is not
0, the
_JOGOverride_N of
the software panel is
triggered, will not
notify the system to
modify JOG
override.

Open Actions List – 344

 机床产品/Machine Tool Products
–
Other Tool.

short action name No. Name function description action PLC

description
type read &
(note) edit rules

G00 override _RapidTravelOve R161 Software This R value Hold read

settings rride_N 48 Panel Rapid corresponds to the
Traverse argument value of
[argument] N is
Override _RapidTravelOverri
the override, only
de_N Action, and
integers are
corresponds to G00
accepted
override.
[example]
For example, If
_RapidTravelOve _RapidTravelOverri
rride_50 de_N is triggered, the
represents R value is equal to
50 and it means that
G00 override 50%
the G00 override is
50%.

R161 Disable If the R value is - read /edit

49 Direct equal to 0, the
Change Rapi _RapidTravelOverri
d Traverse de_N of the software
Override by panel is triggered,
Software will directly notify
Panel the system modify
G00 override；
If the R value is not
0, the
_RapidTravelOverri
de_N of the software
panel is triggered,
will not notify the
system to modify
G00 override

Note:
[Action type]
One-Shot: the software panel design needs to be rising edge triggered ( ex: cycle start, feedhold, reset, ...)
Hold: the software panel design needs to maintain the state after triggering( ex: Axis JOG +/-, mode selection,
Feedrate Override, Rapid Traverse Override, Axis MANUAL CONTROL, ...)
• Precautions
• When there is a need for customized machining actions, please use the R value corresponding to
the software button function to close the software button and directly trigger the
corresponding machining operation.
• At present, for the selection of machining mode & override, Jog, this type of regularly used button,
if there are hardware buttons and software buttons both existing, or the software buttons

Open Actions List – 345

 机床产品/Machine Tool Products
–
Other Tool.

conflict with the logic in the PLC, please use the R value corresponding to software button
function to close the software button and directly trigger the corresponding machining
operation.
• When using this function, please first check whether the function already has a physical key, and
whether the PLC has the logic to trigger the same action. If there is the above situation, please set
the corresponding R value equal to 1. Turn off the HMI and directly notify the core to perform various
machining actions to avoid unexpected actions.
• The R value switch corresponding to the software button function requires some waiting time after
being triggered and cannot take effect immediately. Therefore, it is recommended to avoid
dynamic switching in the application to avoid unexpected misoperation due to update timing
issues.
• The override of software button function, only supports percentage, not the levels.
• [When there is requirement for customized machining actions, how to meet it?]
For example, before Cycle Start, you need to trigger a certain O point to release the brake, or check
that the safety door I point must be On before machining can be performed.
If you press the button on the HMI to directly notify the core Cycle Start, the above protection
cannot be provided, which may cause the machine error and cause problems such as collision.
Please be careful.
In this application scenario, the user must edit the relevant protection logic through the PLC and
set the corresponding R value equal to 1 and turn off the mechanism that HMI directly notify the
core start cycle. For details, please refer to the Action name and R value of the software panel
function table.
For example, I7 represents the safety door I point. If the requirement is to check the safety door, the
I point must be on to start cycle. Then the PLC must be protected as follows. First, R16001 must be
set to 1, and the mechanism that the HMI directly notify the core to start cycle must be turned off.
Then judged R16000 signal that will be filled in when the cycle start API is called and the
corresponding safety door I point I7 On are established at the same time, and then C0 can be
triggered to notify the core to start cycle.
If the mechanism that HMI directly notifies the core Cycle Start is not properly turned off, the
required protection will not be achieved, which may cause the machine error and cause
problems such as collision. Please be careful.

Open Actions List – 346

 机床产品/Machine Tool Products
–
Other Tool.

• [If the hardware button and software button both exist or the software button conflicts with
the PLC logic]
Please be sure to set the corresponding R value equal to 1, turn off the mechanism that the HMI
directly informs the core to perform machining actions. For details, please refer to the Action
name and R value of the software panel function table, otherwise it may cause the machine error
and cause problems such as collision. Please be careful.
For example, there is a machining mode selection in both the hardware button and the software
button, or the machining mode selected in the PLC is different from the machining mode set by the
software.
Assuming that the hardware buttons or PLC logic is set to automatic mode, and the software
buttons are set to MPG mode, there is a conflict between the two modes, and the system will not
operate normally.

Open Actions List – 347

 机床产品/Machine Tool Products
–
Other Tool.

Therefore, please select the corresponding R16038 equal to 1 of the machining mode, and turn
off the path of software directly notifying the core to switch the machining mode.
Same as other situations, such as cycle start or JOG, which may cause twice trigger.
All in all, when using this function, please first check whether the function corresponding to
the software already has a physical key, and whether the PLC has logic to trigger the same
action.
Please be sure to set the corresponding R value equal to 1, turn off the mechanism that the HMI
directly informs the core to perform machining actions, avoid unexpected actions happen.

Open Actions List – 348

 机床产品/Machine Tool Products
–
Other Tool.

13 AutoSDUpgrade_2021 Manual.
中文版 Mandarin Version: AutoSDUpgrade_2021 操作手冊
• Introduction
• Note
• Operation Guide
• Preparation
• Steps
• Result

13.1 Introduction
This tool helps to upgrade the controllers/servo drives to a stable version which has fixed problems listed below.

Name AutoSDUpgrade_2021（version 2.0.1） AutoSDUpgrade_2021 (v3.0.0)

When to use • Servo-drive: • Servo-drive:

• If AL930 alarm is not triggered • If AL930 alarm is not triggered
while the battery voltage is too while the battery voltage is too
low, please upgrade the drives low, please upgrade the drives
using this tool. using this tool.
• Encountered AL133 frequently. • Encountered AL133 frequently.
• Controller: • Controller:
• Versions between • Versions between
10.118.30H~10.118.30L、 10.118.30H~10.118.30N、
10.118.32H~10.118.32L may 10.118.32H~10.118.32N may
encounter problems listed encounter problems listed
below: below:
• ATEST-2169 OQC not • ATEST-2169 OQC not
working working
• ATEST-2190 Threads • ATEST-2190 Threads
stop when change stop when change day、
day、many unstable many unstable datas
datas within the same within the same day.
day.
Use this tool to fix problems above.
Use this tool to fix problems above.

Restrictions 1. Image restrictions

a. AM35x only support image version above 7.21(included).
b. AM335x only support image version above 7.42(included).

2. Software restrictions
• Only support software version between 10.116.36P and 10.118.48.x.
( 10.116.54.x、10.118.12.x ...etc. are all included )

3. Product restriction
• This tool does not support Laser product(70CA, 70CB, 70CB-5, 710CA, 70SA,
70SB, 71SA, 710SA)

AutoSDUpgrade_2021 Manual. – 349

 机床产品/Machine Tool Products
–
Other Tool.

Contorller- • Original version at • Original version at

Upgrade 10.118.30H~10.118.30L : will be 10.118.30H~10.118.30N : will be
target upgraded to 10.118.32N upgraded to 10.118.32O
versions • Original version at • Original version at
10.118.32H~10.118.32L : will be 10.118.32H~10.118.32N : will be
upgraded to 10.118.32N upgraded to 10.118.32O
If version is not in the range above, If version is not in the range above,
upgradation will not be execute but will still upgradation will not be execute but will still
process servo-drive check. process servo-drive check.

Cloud N/A If software upgraded, cloud software v2.5 will

software be installed.
target
version

Servo-drive- Only take normal axes as fix targets Only take normal axes version as check targets
Upgrade If any normal axis needs to be upgraded, every
• Original version at 2.4.0~2.14.14 : will
target Syntec servo drive will be upgraded.
be upgraded to 2.14.15
versions
• Original version at 3.0.0~3.0.20 : will • Versions need to be upgraded
be upgraded to 3.0.21 • 2.4.0~2.14.14
• Original version at 4.0.0~4.0.9 : will • 3.0.0~3.0.22
be upgraded to 4.0.10 • 4.0.0~4.0.10
If version is not in the range above,
• Upgradation target(According to
upgradation will not be execute.
hardware)
• 3.0.23
• 4.0.11

Image(BSP) N/A If software/servo-drives are upgraded, image

target will be upgraded to enhence reliability.
versions
• 335x : image 7.47~7.69→ 7.70

13.2 Note
1. Before using the tool, please make sure that the controller is under servo-off status(ATC/ROT...etc. axes that
can be controlled by PLC, please make sure servo-off R-bit is triggered, too.).
2. After executing the tool，there will be a log-file named "AutoSDUpgrade.log" in the root folder of the USB.
a. If the tool do not function normally，Please provide this log file and contact with Syntec.

3. After executing the tool , please remove the USB and restart the controller.
4. Please do not remove USB or restart before any message start with "***" to prevent damage.
5. Please do not replace any file under tool folder to prevent any damage to the drive or the controller.

6. If encounter "Space not enough" hint, please wait until drives check finished and restart to fix by steps:
a. Check and clean up Macro files.
b. Check and simplify OCRes/PrdMMIRes/ESI, backup them and remove them via SA first before reinstall
a newer version.

AutoSDUpgrade_2021 Manual. – 350

 机床产品/Machine Tool Products
–
Other Tool.

c. If steps above can not fix the problem, please contact with Syntec.

13.3 Operation Guide

13.3.1 Preparation
1. Check the controller's image version is available. If image version too old, please upgrade via
AutoUpgrade_DiskA_2018 tool first.
2. Make sure that the controller's software version fit the rules listed in the introduction.
3. Please check that the controller parameter works right and the connection with the servo drive is
established correctly.

13.3.2 Steps
1. Download the newest tool from https://www.syntecclub.com/Download.aspx（under category "Other
Tool"）
a. This tool provides packages with different product group, please download according to product
type.
b. Package bane machine machine model 模擬器
type

ToolName_Mill_GG.zi Mill 6MA-E, 6MA, 6MB-E, 6MB,

p 6MD-H, 6MD
11MA, 11MB, 21MA-E, 21MA-
H, 21MA, 22MA
210MA-E5, 210MA-E, 210MA-
H5, 210MA-H
210MB-E5, 210MB-E, 210MB-
H5, 210MB-H
220MA-5, 220MA, 220MB-5,
220MB, 610MA-E5, 610MA-H5

GlassGrind 6GA-E, 21GA-E

ToolName_Lathe.zip Lathe 6TA-E, 6TA, 6TB, 11TA, 11TB

21TA-E, 21TA-H, 21TA, 21TB,
21TB-E, 21TB-H
22TA, 22TB, 210TB-E5,
210TB-H5, 210TB-H, 220TB-5,
220TB

ToolName_WOOD.zip WOOD 60CA, 60PA, 60WA, 60CB, The front-end software is

60PE, 60W-E placed under "Monitor"
600WA, 610WA-H, 610WB-H folder.

AutoSDUpgrade_2021 Manual. – 351

 机床产品/Machine Tool Products
–
Other Tool.

Package bane machine machine model 模擬器

type

ToolName_Other.zip eHMC HC-7C, HC-8A, HC-8B, HC-8C,

HC-8E, HC-8S
HC-10A, HC-10B, HC-10C,
HC-10E, HC-15B, HC-15C,
HC-15E

FC FCA, FCB, FCC

Laser 70CB, 70CB-5, 71SA, 710CA,

710SA

Robot 81RG

ToolName_All.zip All above All above All above

2. Unzip the package and copy all the contents to USB root. (recommend: keep the USB clean without any
other files excepts tool data)

* WOOD package will contain an extra folder "Monitor" to provide font-end software.

3. Plug the USB to the controller.

4. Make sure the controller is under servo-off status.
5. Restart the controller.
6. This tool will print the process log on the screen. No need to do any operation.
7. Wait until any restart hint shows up on the screen.

13.3.3 Result
1. After the upgrading process, check the software version in System info. screen.
Make sure that the controller version is not in version range with problem.

AutoSDUpgrade_2021 Manual. – 352

 机床产品/Machine Tool Products
–
Other Tool.

a. If the log file present text below, means the upgradation succeeded.

The controller's version has been updated to 10.118.32N successfully.

b. If the log file present text below, means the controller is fine without upgradation.

There's no need to upgrade the controller.

2. After the upgrading process, check the servo drive version in DeviceManager screen.
Make sure that the servo drives are not in version range with problem.

a. Check the whole process by log file. If the final message as below, means the process was finished
successfully.

*** The whole upgradation succeeded, please remove the USB and restart the controller. ***

b. If log file or message on the screen show the message as below, means there is no servo drive need to
be upgraded.

*** No upgradable Syntec servo drive, please remove the USB and restart the servo drives and
the controller. ***

3. If using SDPatch_2021_3.0.0
a. After the upgrading process, check the image version in System info. screen.
b. Check Cloud Software by checking R8=1; R9=205

i. R9 revord CncCloudAgent version，rules: "major version * 100 + minor version". -1 if

version read failed.
ii. R8 record CncCloudAgent execution result
R8 Description

1 Execute CncCloudAgent succeeded.

0 Not execute CncCloudAgent because software version not support.

-1 CncCloudAgent.exe not exist

-2 Execute CncCloudAgent failed.

Flow chart
detail

AutoSDUpgrade_2021 Manual. – 353

 机床产品/Machine Tool Products
–
Other Tool.

AutoSDUpgrade_2021 Manual. – 354

 机床产品/Machine Tool Products
–
Other Tool.

14 AutoSDUpgrade_2022 Manual.
• Introduction
• Note
• Operation Guide
• Preparation
• Steps
• Result

14.1 Introduction
This tool helps to upgrade the controllers/servo drives to a stable version which has fixed problems listed below.

Name AutoSDUpgrade_2022（v1.0.x） AutoSDUpgrade_2022 ( v2.0.x )

When to use • Servo-drive: • Servo-drive:

• If AL930 alarm is not triggered • If AL930 alarm is not triggered
while the battery voltage is too while the battery voltage is too
low, please upgrade the drives low, please upgrade the drives
using this tool. using this tool.
• Encountered AL133 frequently. • Encountered AL133 frequently.
• Controller: • Controller:
• Versions between • Versions between
10.118.30H~10.118.30L、 10.118.30H~10.118.30N、
10.118.32H~10.118.32L may 10.118.32H~10.118.32N may
encounter problems listed encounter problems listed
below: below:
• ATEST-2169 OQC not • ATEST-2169 OQC not
working working
• ATEST-2190 Threads • ATEST-2190 Threads
stop when change stop when change day、
day、many unstable many unstable datas
datas within the same within the same day.
day.
Use this tool to fix problems above.
Use this tool to fix problems above.

Restrictions 1. Image restrictions

a. AM35x only support image version above 7.21(included).
b. AM335x only support image version above 7.42(included).

2. Software restrictions
• Only support software version between 10.116.36P and 10.118.48.x.
( 10.116.54.x、10.118.12.x ...etc. are all included )

3. Product restriction
• This tool does not support Laser product (70SA, 70SB, 71SA, 710SA)

AutoSDUpgrade_2022 Manual. – 355

 机床产品/Machine Tool Products
–
Other Tool.

Contorller- • Original version at • Original version at

Upgrade 10.118.30H~10.118.30L : will be 10.118.30H~10.118.30N : will be
target upgraded to 10.118.32N upgraded to 10.118.32O
versions • Original version at • Original version at
10.118.32H~10.118.32L : will be 10.118.32H~10.118.32N : will be
upgraded to 10.118.32N upgraded to 10.118.32O
If version is not in the range above, If version is not in the range above,
upgradation will not be execute but will still upgradation will not be execute but will still
process servo-drive check. process servo-drive check.

Servo-drive- Only take normal axes as fix targets Only take normal axes version as check targets
Upgrade If any normal axis needs to be upgraded, every
• Original version at 2.4.0~2.14.14 : will
target Syntec servo drive will be upgraded.
be upgraded to 2.14.15
versions
• Original version at 3.0.0~3.0.20 : will • Versions need to be upgraded
be upgraded to 3.0.21 • 2.4.0~2.14.14
• Original version at 4.0.0~4.0.9 : will • 3.0.0~3.0.22
be upgraded to 4.0.10 • 4.0.0~4.0.10
If version is not in the range above,
• Upgradation target(According to
upgradation will not be execute.
hardware)
• 3.0.23
• 4.0.11

14.2 Note
1. Before using the tool, please make sure that the controller is under servo-off status(ATC/ROT...etc. axes that
can be controlled by PLC, please make sure servo-off R-bit is triggered, too.).
2. After executing the tool，there will be a log-file named "AutoSDUpgrade.log" in the root folder of the USB.
a. If the tool do not function normally，Please provide this log file and contact with Syntec.

3. After executing the tool , please remove the USB and restart the controller.
4. Please do not remove USB or restart before any message start with "***" to prevent damage.
5. Please do not replace any file under tool folder to prevent any damage to the drive or the controller.

6. If encounter "Space not enough" hint, please wait until drives check finished and restart to fix by steps:
a. Check and clean up Macro files.
b. Check and simplify OCRes/PrdMMIRes/ESI, backup them and remove them via SA first before reinstall
a newer version.
c. If steps above can not fix the problem, please contact with Syntec.

14.3 Operation Guide

14.3.1 Preparation
1. Check the controller's image version is available. If image version too old, please upgrade via
AutoUpgrade_DiskA_2018 tool first.
2. Make sure that the controller's software version fit the rules listed in the introduction.

AutoSDUpgrade_2022 Manual. – 356

 机床产品/Machine Tool Products
–
Other Tool.

3. Please check that the controller parameter works right and the connection with the servo drive is
established correctly.

14.3.2 Steps
1. Download the newest tool from https://www.syntecclub.com/Download.aspx（under category "Other
Tool"）
a. This tool provides packages with different product group, please download according to product
type.
b. Package bane machine machine model 模拟器
type

ToolName_Mill_GG.zi Mill 6MA-E, 6MA, 6MB-E, 6MB,

p 6MD-H, 6MD
11MA, 11MB, 21MA-E, 21MA-
H, 21MA, 22MA
210MA-E5, 210MA-E, 210MA-
H5, 210MA-H
210MB-E5, 210MB-E, 210MB-
H5, 210MB-H
220MA-5, 220MA, 220MB-5,
220MB, 610MA-E5, 610MA-H5

GlassGrind 6GA-E, 21GA-E

ToolName_Lathe.zip Lathe 6TA-E, 6TA, 6TB, 11TA, 11TB

21TA-E, 21TA-H, 21TA, 21TB,
21TB-E, 21TB-H
22TA, 22TA PLUS, 22TB, 22TB
PLUS, 210TB-E5, 210TB-H5,
210TB-H, 220TB, 220TB
PLUS, 220TB-5, 220TB-5
PLUS

ToolName_WOOD.zip WOOD 60CA, 60PA, 60WA, 60CB, The front-end software is

60PE, 60W-E placed under "Monitor"
600WA, 610WA-H, 610WB-H folder.

ToolName_Other.zip eHMC HC-7C, HC-8A, HC-8B, HC-8C,

HC-8E, HC-8S
HC-10A, HC-10B, HC-10C,
HC-10E, HC-15B, HC-15C,
HC-15E

FC FCA, FCB, FCC

AutoSDUpgrade_2022 Manual. – 357

 机床产品/Machine Tool Products
–
Other Tool.

Package bane machine machine model 模拟器

type

Laser 70CB, 70CB-5, 71SA, 710CA,

710SA

Robot 81RG

ToolName_All.zip All above All above All above

2. Unzip the package and copy all the contents to USB root. (recommend: keep the USB clean without any
other files excepts tool data)

* WOOD package will contain an extra folder "Monitor" to provide font-end software.

3. Plug the USB to the controller.

4. Make sure the controller is under servo-off status.
5. Restart the controller.
6. This tool will print the process log on the screen. No need to do any operation.
7. Wait until any restart hint shows up on the screen.

14.3.3 Result
1. After the upgrading process, check the software version in System info. screen.
Make sure that the controller version is not in version range with problem.

a. If the log file present text below, means the upgradation succeeded.

The controller's version has been updated to 10.118.32N successfully.

b. If the log file present text below, means the controller is fine without upgradation.

There's no need to upgrade the controller.

2. After the upgrading process, check the servo drive version in DeviceManager screen.
Make sure that the servo drives are not in version range with problem.

AutoSDUpgrade_2022 Manual. – 358

 机床产品/Machine Tool Products
–
Other Tool.

a. Check the whole process by log file. If the final message as below, means the process was finished
successfully.

*** The whole upgradation succeeded, please remove the USB and restart the controller. ***

b. If log file or message on the screen show the message as below, means there is no servo drive need to
be upgraded.

*** No upgradable Syntec servo drive, please remove the USB and restart the servo drives and
the controller. ***

3. If using SDPatch_2021_3.0.0
a. After the upgrading process, check the image version in System info. screen.
b. Check Cloud Software by checking R8=1; R9=205

i. R9 revord CncCloudAgent version，rules: "major version * 100 + minor version". -1 if

version read failed.
ii. R8 record CncCloudAgent execution result
R8 Description

1 Execute CncCloudAgent succeeded.

0 Not execute CncCloudAgent because software version not support.

-1 CncCloudAgent.exe not exist

-2 Execute CncCloudAgent failed.

AutoSDUpgrade_2022 Manual. – 359

 机床产品/Machine Tool Products
–
Other Tool.

15 FixFontFile Manual
中文版 Mandarin Version : FixFontFile 操作手册

Content

• Introduction
• Notes
• Environment Requirement
• Operation
• Trouble shootings

15.1 Introduction
• This tool is applied to the character issue because of the broken file of IQC fixture ( G1K00006 ).
• This tool can automatically execute by plugging in the USB, it can fix the character issue of controller.
• This tool will replace the broken font file in the controller ( MINGLIU.TTC, COMICBD.TTF, MONACO.TTF ).
Supported version Log

1.0.0 support for replacing font files MINGLIU.TTC, COMICBD.TTF

1.0.1 support for replacing font files MONACO.TTF

15.2 Notes
• Please do not remove the USB while the tool is running, this action will cause serious damage to the
system.
• If an unexpectedly power failure occurs, user can first try to remove the USB and reboot completely, then
plug the USB back in and reboot the controller again. The system will try to process font fix again.
However, if an abnormal phenomenon occurs and the tool cannot replace the font file normally, Please
contact Syntec Customer Service.

15.3 Environment Requirement

• Operating System : WindowsCE

15.4 Operation
1. Please download the tool from the official website:
a. Link : http://www.syntecclub.com/Download.aspx
b. Path : Download => 06. Other Tool => FixFontFile

FixFontFile Manual – 360

 机床产品/Machine Tool Products
–
Other Tool.

2. Unzip the installation pack to the USB, and the files in your USB are as shown in the figure below:

3. Plug the USB into the controller and power on

4. System scanning (automatically)
5. Fix Font (automatically)

FixFontFile Manual – 361

 机床产品/Machine Tool Products
–
Other Tool.

6. Prompt the user to remove the USB and reboot (manually)

7. After reboot, the file replacement of the controller is complete.

15.5 Trouble shootings

• If the following screen appear during installation, please refer to the table below for possible
troubleshooting methods
Item Screen Method

The OS does not match Please confirm whether the current operating
system is WindowsCE7

Failed to move the font file Please try to remove the USB and reboot
in controller completely, then plug the USB back in and reboot
the controller again.

FixFontFile Manual – 362

 机床产品/Machine Tool Products
–
Other Tool.

Item Screen Method

Failed to import the font file a. Please check the following files in
from USB the folder of FontFixTool.
• Data
• MINGLIU.TTC
• COMICBD.TTF
• MONACO.TTF
• FontFixTool.exe
b. Please try to remove the USB and
reboot completely, then plug the
USB back in and reboot the
controller again.

15.6 FixFontFile Manual_Source

中文版 Mandarin Version : FixFontFile 操作手册

Content

• Introduction
• Notes
• Environment Requirement
• Operation
• Trouble shootings

15.6.1 Introduction
• This tool is applied to the character issue because of the broken file of IQC fixture ( G1K00006 ).
• This tool can automatically execute by plugging in the USB, it can fix the character issue of controller.
• This tool will replace the broken font file in the controller ( MINGLIU.TTC, COMICBD.TTF, MONACO.TTF ).
Supported version Log

1.0.0 support for replacing font files MINGLIU.TTC, COMICBD.TTF

1.0.1 support for replacing font files MONACO.TTF

15.6.2 Notes
• Please do not remove the USB while the tool is running, this action will cause serious damage to the
system.

FixFontFile Manual – 363

 机床产品/Machine Tool Products
–
Other Tool.

• If an unexpectedly power failure occurs, user can first try to remove the USB and reboot completely, then
plug the USB back in and reboot the controller again. The system will try to process font fix again.
However, if an abnormal phenomenon occurs and the tool cannot replace the font file normally, Please
contact Syntec Customer Service.

15.6.3 Environment Requirement

• Operating System : WindowsCE

15.6.4 Operation
1. Please download the tool from the official website:
a. Link : http://www.syntecclub.com/Download.aspx
b. Path : Download => 06. Other Tool => FixFontFile
2. Unzip the installation pack to the USB, and the files in your USB are as shown in the figure below:

3. Plug the USB into the controller and power on

4. System scanning (automatically)

FixFontFile Manual – 364

 机床产品/Machine Tool Products
–
Other Tool.

5. Fix Font (automatically)

6. Prompt the user to remove the USB and reboot (manually)

7. After reboot, the file replacement of the controller is complete.

FixFontFile Manual – 365

 机床产品/Machine Tool Products
–
Other Tool.

15.6.5 Trouble shootings

• If the following screen appear during installation, please refer to the table below for possible
troubleshooting methods
Item Screen Method

The OS does not match Please confirm whether the current operating
system is WindowsCE7

Failed to move the font file Please try to remove the USB and reboot
in controller completely, then plug the USB back in and reboot
the controller again.

Failed to import the font file a. Please check the following files in
from USB the folder of FontFixTool.
• Data
• MINGLIU.TTC
• COMICBD.TTF
• MONACO.TTF
• FontFixTool.exe
b. Please try to remove the USB and
reboot completely, then plug the
USB back in and reboot the
controller again.

FixFontFile Manual – 366