OPENCNC 控制器 API OPENCNC 使用手冊 4.8.8 READ_NCMOTION:CNC Motion 狀態資訊 4 函數名稱 int READ_NCMOTION 加工中限制 無 使用權限 一般使用者 [in/out] in 說明 變數名稱 型別 ushort 查詢通道(目前為0) Channel 讀取數值單位 (參考4.3.1 CNC數值單位) Unit short in 主軸轉速 iSpSpeed uint out 切削進給 iFeed double out 主軸負載(小於0為無效值) 實際轉速 iLoad short out 實際進給 iActSpeed uint out 暫停時間 iActFeed double out 主軸刀號 iDwellTime uint out 刀庫號碼 iMCutter short out 命令刀號 引數 iCutterLib ushort out 傳回值 待命刀號 iCmdCutte ushort out 待命刀套 iStandbyCutter ushort out D data H data iStandbyCast ushort out T data M data iDData ushort out G Group (ff為無效值) iHData ushort out 倍率 F iTData ushort out 倍率 RPD iMData ushort out 倍率 S 倍率 JOG GGroup char[] out 倍率 MPG iSpeedF ushort out iSpeedRPD ushort out iSpeedS ushort out iSpeedJOG double out iSpeedMPG ushort out 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 4-24 November, 2017
OPENCNC 使用手冊 OPENCNC 控制器 API 4.8.9 READ_feed_spindle:讀取進給率/轉速 函數名稱 int READ_feed_spindle 型別 加工中限制 無 4 使用權限 一般使用者 ushort [in/out] 說明 in 引數 變數名稱 查詢通道(目前為0) 讀取數值單位 傳回值 Channel (參考4.3.1 CNC數值單位) 切削進給 Unit ushort in 轉速 實際進給 OvFeed double out 實際轉速 OvSpindle uint out ActFeed double out ActSpindle uint out 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 4.8.10 READ_gcode:讀取 G Code Data 函數名稱 int READ_gcode 使用權限 一般使用者 加工中限制 無 引數 說明 變數名稱 型別 [in/out] 傳回值 查詢通道(目前為0) Channel ushort in G Group (ff為無效值) Gdata String[] out 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 4.8.11 READ_othercode:讀取其他 Code Data 函數名稱 int READ_othercode 加工中限制 無 使用權限 一般使用者 說明 引數 變數名稱 型別 [in/out] 查詢通道(目前為0) H Data 傳回值 Channel ushort in D Data T Data HCode int out M Dat F Data DCode int out S Data TCode int out MCode int out FCode int out SCode int out 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明 November, 2017 4-25
OPENCNC 控制器 API OPENCNC 使用手冊 4.8.12 READ_CNC_HostName:讀取 NC 主機名稱 4 函數名稱 int READ_CNC_HostName 加工中限制 無 使用權限 一般使用者 說明 引數 變數名稱 型別 [in/out] NC主機名稱 傳回值 strName string out 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 4.8.13 WRITE_CNC_HostName:寫入 NC 主機名稱 函數名稱 int WRITE_CNC_HostName 使用權限 用戶權限 加工中限制 無 引數 說明 變數名稱 型別 [in/out] 傳回值 NC主機名稱 strName string in 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 4.8.14 READ_HomeStatus:寫入控制器軸回原點資訊 函數名稱 int WRITE_CNC_HostName 使用權限 一般使用者 加工中限制 無 引數 [in/out 說明 變數名稱 型別 out 回原點資訊 homeStatus ushort (X軸:bit 0…W軸:bit 8) 傳回值 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 4-26 November, 2017
OPENCNC 使用手冊 OPENCNC 控制器 API 4.9 警報資訊 4.9.1 READ_current_alarm_count:讀取全部目前警報個數 4 函數名稱 int READ_current_alarm_count 使用權限 一般使用者 加工中限制 無 引數 變數名稱 型別 [in/out] 說明 傳回值 AlarmCount uint out 警報個數 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 4.9.2 READ_alm_current:讀取目前發生警報 函數名稱 int READ_alm_current 使用權限 一般使用者 加工中限制 無 引數 變數名稱 型別 [in/out] 說明 傳回值 AlarmCount ushort out 回傳警報個數 AlarmCode ushort[] out 警報代碼 AlarmDataLen ushort[] out 警報附帶資料長度 警報附帶資料 AlarmData ushort[x,y] out (x:警報Index; y:附帶資料Index) AlarmMsg string[] out 警報資訊 AlarmDateTime string[] out 警報日期時間 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 AlarmMsg為User defined Alarm時,為使用者定義警報。 AlarmMsg為Macro defined Alarm時,為Macro定義警報。 4.9.3 READ_history_alarm_count:讀取全部歷史警報個數 函數名稱 int READ_history_alarm_count 使用權限 一般使用者 加工中限制 無 引數 變數名稱 型別 [in/out] 說明 傳回值 AlarmCount uint out 警報個數 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 November, 2017 4-27
OPENCNC 控制器 API OPENCNC 使用手冊 4.9.4 READ_alm_history_all:讀取全部歷史警報訊息 4 函數名稱 int READ_alm_history_all 型別 加工中限制 有 使用權限 一般使用者 [in/out] 說明 out 引數 變數名稱 out 回傳警報個數 out 警報代碼 傳回值 AlarmCount ushort 警報附帶資料長度 警報附帶資料 AlarmCode ushort[] (x:警報Index; y: 附帶資料Index) AlarmDataLen ushort[] 警報資訊 警報日期時間 AlarmData ushort[x,y] out AlarmMsg string[] out AlarmDateTime string[] out 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 4.9.5 READ_alm_history:讀取歷史警報訊息 函數名稱 int READ_alm_history 使用權限 一般使用者 加工中限制 無 引數 變數名稱 型別 [in/out] 說 傳回值 AlarmIndex ushort in 警報索引(由0開始) AlarmLengt ushort in 讀取警報長度 AlarmCount ushort out 回傳警報個數 AlarmCode ushort[] out 警報代碼 AlarmDataLen ushort[] out 警報附帶資料長度 警報附帶資料 AlarmData short[x,y] out (x:警報Index; y: 附帶資料Index) AlarmMsg string[] out 警報資訊 AlarmDateTime string[] out 警報日期時間 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 AlarmMsg為User defined Alarm時,為使用者定義警報。 AlarmMsg為Macro defined Alarm時,為Macro定義警報。 4-28 November, 2017
OPENCNC 使用手冊 OPENCNC 控制器 API 4.10 伺服資訊 4.10.1 READ_servo_current:讀取伺服軸負載電流 4 函數名稱 int READ_servo_current 使用權限 一般使用者 加工中限制 無 引數 變數名稱 型別 [in/out] 說明 傳回值 備註 Channel ushort in 通道(目前為0) AxisCount ushort out 回傳軸個數 AxisNr ushort[] 軸代碼 out (參考4.3.2 軸代碼) Result bool[] out 是否讀取成功 AxisValue int[] out 讀取數值 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 數值單位為伺服額定電流% 4.10.2 READ_spindle_current:讀取主軸負載電流 函數名稱 int READ_spindle_current 使用權限 一般使用者 加工中限制 無 引數 變數名稱 型別 [in/out] 說明 傳回值 備註 Channel ushort in 通道(目前為0) AxisCount ushort out 回傳軸個數 AxisNr ushort[] 軸代碼 out (參考4.3.2 軸代碼) Result bool[] out 是否讀取成功 AxisValue int[] out 讀取數值(%) 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 數值單位為伺服額定電流% November, 2017 4-29
OPENCNC 控制器 API OPENCNC 使用手冊 4.10.3 READ_servo_load:讀取伺服軸負載 4 函數名稱 int READ_servo_load 使用權限 一般使用者 加工中限制 無 引數 變數名稱 型別 [in/out] 說明 傳回值 Channel ushort in 通道(目前為0) AxisCount ushort out 回傳軸個數 AxisNr ushort[] 軸代碼 out (參考4.3.2 軸代碼) Result bool[] out 是否讀取成功 AxisValue int[] out 讀取數值(%) 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 4.10.4 READ_spindle_load:讀取主軸負載 函數名稱 int READ_spindle_load 使用權限 一般使用者 加工中限制 無 引數 變數名稱 型別 [in/out] 說明 傳回值 Channel ushort in 通道(目前為0) AxisCount ushort out 回傳軸個數 AxisNr ushort[] 軸代碼 out (參考4.3.2 軸代碼) Result bool[] out 是否讀取成功 AxisValue int[] out 讀取數值(%) 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 4.10.5 READ_servo_speed:讀取伺服軸轉速 函數名稱 int READ_servo_speed 使用權限 一般使用者 加工中限制 無 引數 變數名稱 型別 [in/out] 說明 傳回值 Channel ushort in 通道(目前為0) AxisCount ushort out 回傳軸個數 AxisNr ushort[] 軸代碼 out (參考4.3.2 軸代碼) Result bool[] out 是否讀取成功 AxisValue int[] out 讀取數值(0.1 r/min) 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 4-30 November, 2017
OPENCNC 使用手冊 OPENCNC 控制器 API 4.10.6 READ_spindle_speed:讀取主軸轉速 函數名稱 int READ_spindle_speed 4 使用權限 一般使用者 加工中限制 無 引數 變數名稱 型別 [in/out] 說明 傳回值 Channel ushort in 通道(目前為0) AxisCount ushort out 回傳軸個數 AxisNr ushort[] 軸代碼 out (參考4.3.2 軸代碼) Result bool[] out 是否讀取成功 AxisValue int[] out 讀取數值(0.1 r/min) 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 4.10.7 READ_servo_temperature:讀取伺服軸溫度 函數名稱 int READ_servo_temperature 使用權限 一般使用者 加工中限制 無 引數 變數名稱 型別 [in/out] 說明 傳回值 Channel ushort in 通道(目前為0) AxisCount ushort out 回傳軸個數 AxisNr ushort[] 軸代碼 out (參考4.3.2 軸代碼) Result bool[] out 是否讀取成功 AxisValue int[] out 讀取數值(℃) 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 4.10.8 READ_spindle_temperature:讀取主軸溫度 函數名稱 int READ_spindle_temperature 使用權限 一般使用者 加工中限制 無 引數 變數名稱 型別 [in/out] 說明 傳回值 Channel ushort in 通道(目前為0) AxisCount ushort out 回傳軸個數 AxisNr ushort[] 軸代碼 out (參考4.3.2 軸代碼) Result bool[] out 是否讀取成功 AxisValue int[] out 讀取數值(℃) 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 November, 2017 4-31
OPENCNC 控制器 API OPENCNC 使用手冊 4.11 座標資訊 4 4.11.1 READ_POSITION:CNC 各軸座標 函數名稱 int READ_POSITION 型別 加工中限制 無 使用權限 一般使用者 ushort [in/out] 說明 in 引數 變數名稱 通道(目前為0) Channel 讀取數值單位 傳回值 (參考4.3.1 CNC數值單位) Unit ushort in 各軸名稱 機械座標 AxisName string[] out 絕對座標 相對座標 Coor_Mach double[] out 剩餘座標 偏移座標 Coor_Abs double[] out Coor_Rel double[] out Coor_Res double[] out Coor_Offset double[] out 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 4.11.2 CLEAR_Relative_Coord:清除相對座標 函數名稱 int CLEAR_Relative_Coord 加工中限制 無 使用權限 一般使用者 [in/out] 說明 in 引數 變數名稱 型別 通道(目前為0) 清除軸 傳回值 Channel ushort (參考4.3.2 軸代碼) Axis ushort in 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 4.11.3 CLEAR_Relative_Coord_all:清除全部相對座標 函數名稱 int CLEAR_Relative_Coord_all 加工中限制 無 使用權限 一般使用者 說明 引數 變數名稱 型別 [in/out] 通道(目前為0) 傳回值 Channel ushort in 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 4-32 November, 2017
OPENCNC 使用手冊 OPENCNC 控制器 API 4.12 工件座標 4.12.1 READ_GPOSITION_Title:讀取工件座標標題名稱 4 函數名稱 int READ_GPOSITION_Title 使用權限 一般使用者 加工中限制 無 引數 標題名稱 變數名稱 型別 [in/out] 說明 傳回值 GPOSITION_Title String[] out 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 4.12.2 READ_GPOSITION:讀取工件座標資料 函數名稱 int READ_GPOSITION 型別 加工中限制 無 使用權限 一般使用者 ushort [in/out] 說明 in 引數 變數名稱 ushort 通道(目前為0) Channel in 讀取數值單位 傳回值 (參考4.3.1 CNC數值單位) Unit 讀取座標開始代碼 (參考4.3.4 工作座標代碼) Index ushort in 讀取座標組數 Length ushort in 讀取工件座標資料 (x:讀取座標Index; GPositionArray double[x,y] out y:各Channel使用軸) 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 November, 2017 4-33
OPENCNC 控制器 API OPENCNC 使用手冊 4.12.3 WRITE_GPOSITION:寫入工件座標資料 4 函數名稱 int WRITE_GPOSITION 型別 加工中限制 有 使用權限 用戶權限 ushort [in/out] 說明 in 引數 變數名稱 通道(目前為0) in 寫入數值單位 傳回值 Channel (參考4.3.1 CNC數值單位) 寫入座標開始代碼 Unit ushort (參考4.3.4 工作座標代碼) 寫入座標組數 Index ushort in 寫入工件座標資料 Length ushort in (x:寫入座標Index; y:各Channel使用軸) GPositionArray double[x,y] in 0或1:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 4.12.4 READ_Offset_Coord:讀取偏移座標資料 函數名稱 int READ_Offset_Coord 型別 加工中限制 無 使用權限 一般使用者 ushort [in/out] 說明 in 引數 變數名稱 通道(目前為0) 讀取數值單位 傳回值 Channel (參考4.3.1 CNC數值單位) 讀取工件座標資料 Unit ushort in CoordArray double[] out 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 4.12.5 WRITE_Offset_Coord:寫入偏移座標資料 函數名稱 int WRITE_Offset_Coord 型別 加工中限制 有 使用權限 用戶權限 ushort [in/out] 說明 in 引數 變數名稱 通道(目前為0) Channel 寫入數值單位 傳回值 (參考4.3.1 CNC數值單位) Unit ushort in 讀取工件座標資料 CoordArray double[] in 0或1:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 4-34 November, 2017
OPENCNC 使用手冊 OPENCNC 控制器 API 4.13 刀具資訊 4.13.1 READ_cutter_title:讀取刀具標題列 4 函數名稱 int READ_cutter_title 使用權限 一般使用者 加工中限制 無 引數 標題列 變數名稱 型別 [in/out] 說明 傳回值 CutterTitle string[] out 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 4.13.2 READ_cutter_count:讀取刀具總筆數 函數名稱 int READ_cutter_count 使用權限 一般使用者 加工中限制 無 引數 說明 變數名稱 型別 [in/out] 傳回值 刀具總筆數 cutter_count ushort out 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 4.13.3 READ_cutter:讀取刀具資訊 函數名稱 int READ_cutter 型別 加工中限制 無 使用權限 一般使用者 ushort [in/out] 說明 引數 變數名稱 in 讀取數值單位 (參考4.3.1 CNC數值單位) 傳回值 Unit 變數Index 備註 最小值:0 Index ushort in 最大值:刀具總筆數-1 讀取個數 Length ushort in 讀取刀具資訊陣列 (x:刀具Index; CutterData double[x,y] out y:標題列Index) 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 CutterData第二個陣列配合刀具標題列 November, 2017 4-35
OPENCNC 控制器 API OPENCNC 使用手冊 4.13.4 WRITE_cutter:寫入刀具資訊 4 函數名稱 int READ_cutter 型別 加工中限制 有 使用權限 用戶權限 ushort [in/out] 說明 引數 變數名稱 in 寫入數值單位 (參考4.3.1 CNC數值單位) 傳回值 Unit 變數Index 備註 最小值:0 Index ushort in 最大值:刀具總筆數-1 寫入個數 Length ushort in 寫入刀具資訊陣列 (x:刀具Index; CutterData double[x,y] out y:標題列Index) 0或1:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 CutterData第二個陣列配合刀具標題列 4-36 November, 2017
OPENCNC 使用手冊 OPENCNC 控制器 API 4.14 刀庫資訊 4.14.1 READ_magazine_info:讀取刀庫資訊 4 函數名稱 int READ_magazine_info 加工中限制 無 使用權限 一般使用者 [in/out] 說明 變數名稱 型別 刀庫代號 0:刀庫1 MagaID ushort in 1:刀庫2 回傳刀套個數 引數 CutterNum ushort out 命令刀號 CMDCutterID ushort out 待命刀號 StandbyCutterID ushort out 待命刀套 StandbyMagaID ushort out 主軸刀號 SPCutterID short out 刀庫內所有刀套內容 陣列長度為回傳刀套個數 CutterID short[] out 傳回值 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 CutterID值為 -10000代表空白。 CutterID值為負號代表該刀套封鎖。 4.14.2 WRITE_magazine_info:寫入刀庫資訊 函數名稱 int READ_magazine_info 使用權限 模式限制 設備權限 加工中限制 有 [in/out] [JOG] (參考4.3.5 CNC Mode) 說明 刀庫代號 變數名稱 型別 0:刀庫1 1:刀庫2 引數 MagaID ushort in 刀套代號 刀號 SetID ushort in CutterID short in 傳回值 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 November, 2017 4-37
OPENCNC 控制器 API OPENCNC 使用手冊 4.14.3 RESET_magazine_info:重置刀庫 4 函數名稱 int RESET_magazine_info 使用權限 模式限制 設備權限 加工中限制 有 [in/out] [JOG] (參考4.3.5 CNC Mode) 說明 刀庫代號 變數名稱 型別 0:刀庫1 1:刀庫2 引數 MagaID ushort in 傳回值 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 4.14.4 WRITE_lock_magazine:刀庫封鎖 函數名稱 int WRITE_lock_magazine 使用權限 模式限制 設備權限 加工中限制 有 [in/out] [JOG] (參考4.3.5 CNC Mode) 說明 刀庫代號 變數名稱 型別 0:刀庫1 1:刀庫2 引數 MagaID ushort in 刀套代號 SetID ushort in 傳回值 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 4.14.5 WRITE_unlock_magazine:刀庫解鎖 函數名稱 int WRITE_unlock_magazine 使用權限 模式限制 設備權限 加工中限制 有 [in/out] [JOG] (參考4.3.5 CNC Mode) 說明 刀庫代號 變數名稱 型別 0:刀庫1 1:刀庫2 引數 MagaID ushort in 刀套代號 SetID ushort in 傳回值 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 4-38 November, 2017
OPENCNC 使用手冊 OPENCNC 控制器 API 4.15 加工資訊 4.15.1 READ_processtime:讀取加工時間 4 函數名稱 int READ_processtime 使用權限 一般使用者 加工中限制 無 引數 說明 變數名稱 型別 [in/out] 傳回值 總加工時間(秒) TotalWorkTime uint out 單加工時間(秒) SingleWorkTime uint out 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 4.15.2 CLEAR_processtime:清除加工時間 函數名稱 int CLEAR_processtime 加工中限制 有 使用權限 用戶權限 - 引數 0或1:成功 傳回值 小於0為失敗,數值內容參考章節4.2 回傳說明。 4.15.3 READ_part_count:讀取加工數 函數名稱 int READ_part_count 加工中限制 無 使用權限 一般使用者 說明 引數 變數名稱 型別 [in/out] 目標加工數 完成加工數 傳回值 target_part_count ushort out finish_part_count ushort out 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 4.15.4 WRITE_part_count:寫入加工數 函數名稱 int WRITE_part_count 使用權限 用戶權限 加工中限制 有 引數 說明 變數名稱 型別 [in/out] 傳回值 目標加工數 target_part_count ushort out 完成加工數 finish_part_count ushort out 0或1:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 November, 2017 4-39
OPENCNC 控制器 API OPENCNC 使用手冊 4.15.5 CLEAR_part_count:清除完成加工數 函數名稱 int CLEAR_part_count 使用權限 4 用戶權限 加工中限制 有 引數 無 傳回值 0或1:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 4.16 巨集變數 4.16.1 READ_MacroVariable:讀取 Macro Variable 函數名稱 int READ_MacroVariable 使用權限 一般使用者 加工中限制 無 引數 變數名稱 型別 [in/out] 說明 傳回值 Channel ushort in 通道(目前為0) VarType uint Macro Variable Type in (參考4.3.8 巨集變數代碼) 變數Index 最小值:0 VarIndex uint in 最大值:Macro Variable總個 數-1 VarLength uint in 變數個數 RetArray double[] out 讀取Marco Variable陣列 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 4.16.2 READ_MacroVariablebyID:讀取 Macro Variable 函數名稱 int READ_MacroVariablebyID 使用權限 一般使用者 加工中限制 無 引數 變數名稱 型別 [in/out] 說明 傳回值 Channel ushort in 通道(目前為0) MacroID uint in Macro Variable ID RetValue out 讀取Marco Variable回傳值 double 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 4-40 November, 2017
OPENCNC 使用手冊 OPENCNC 控制器 API 4.16.3 WRITE_MacroVariable:寫入 Macro Variable 函數名稱 int WRITE_MacroVariable 4 使用權限 用戶權限 加工中限制 有 引數 變數名稱 型別 [in/out] 說明 傳回值 備註 Channel ushort in 通道(目前為0) VarType uint Macro Variable Type in (參考4.3.8 巨集變數代碼) 變數Index 最小值:0 VarIndex uint in 最大值:Macro Variable總個 數-1 VarLength uint in 變數個數 VarArray double[] in 寫入Marco Variable陣列 0或1:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 寫入數值需大於-100000與小於100000 4.16.4 WRITE_MacroVariablebyID:寫入 Macro Variable 函數名稱 int WRITE_MacroVariablebyID 使用權限 用戶權限 加工中限制 有 引數 變數名稱 型別 [in/out] 說明 傳回值 備註 Channel ushort in 通道(目前為0) MacroID uint in Macro Variable ID SetValue out 寫入Marco Variable回傳值 double 0或1:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 寫入數值需大於-100000與小於100000 November, 2017 4-41
OPENCNC 控制器 API OPENCNC 使用手冊 4.17 PLC 變數 4 4.17.1 READ_PLC_ADDR_BUFFSIZE:取得 PLC Variable 需要的 Buffer Size 函數名稱 int READ_PLC_ADDR_BUFFSIZE 使用權限 一般使用者 加工中限制 無 引數 變數名稱 型別 [in/out] 說明 傳回值 DevType uint in 備註 PLC Variable Type (參考4.3.9 PLC變數代碼]) DevStart 變數Index uint in 最小值:0 最大值:PLC Variable總個數-1 DevNum uint in PLC Variable個數 大於0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 Buffer Size單位為Byte 一個位元暫存器變數資料大小為2 bytes(16個位元資料)。 一個16位元暫存器變數資料大小為2 bytes。 一個32位元暫存器變數資料大小為4 bytes。 4.17.2 READ_PLC_ADDR:讀取 PLC Variable 函數名稱 int READ_PLC_ADDR 使用權限 一般使用者 加工中限制 無 引數 變數名稱 型別 [in/out] 說明 傳回值 DevType uint in 備註 PLC Variable Type (參考4.3.9 PLC變數代碼) DevStart 變數Index uint in 最小值:0 最大值:PLC Variable總個數-1 DevNum uint in PLC Variable個數 RetArray Byte[] 讀取PLC Variable區塊 out 大小符合BUFFSIZE回傳值 大於0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 位元暫存器變數資料基本大小為2 bytes(16個位元資料) 16位元暫存器變數資料基本大小為2 bytes 32位元暫存器變數資料基本大小為4 bytes 4-42 November, 2017
OPENCNC 使用手冊 OPENCNC 控制器 API 4.17.3 WRITE_PLC_ADDR:寫入 PLC Variable 函數名稱 int WRITE_PLC_ADDR 4 使用權限 設備權限 加工中限制 有 引數 變數名稱 型別 [in/out] 說明 傳回值 備註 DevType PLC Variable Type uint in (參考4.3.9 PLC變數代碼) 變數Index DevStart uint in 最小值:0 DevNum 最大值:PLC Variable總個數 -1 uint in PLC Variable個數 SetArray Byte[] 寫入PLC Variable區塊 in 大小符合BUFFSIZE回傳值 0或1:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 位元暫存器變數資料基本大小為2 bytes(16個位元資料) 16位元暫存器變數資料基本大小為2 bytes 32位元暫存器變數資料基本大小為4 bytes 4.17.4 WRITE_Customized_PLC_ADDR:寫入特定 PLC Variable 函數名稱 int WRITE_Customized_PLC_ADDR 使用權限 一般使用者 加工中限制 無 引數 變數名稱 型別 [in/out] 說明 傳回值 備註 DevType PLC Variable Type uint in (參考4.3.9 PLC變數代碼) 變數Index DevStart uint in 最小值:0 最大值:PLC Variable總個數-1 DevNum uint in PLC Variable個數 SetArray Byte[] 寫入PLC Variable區塊 in 大小符合BUFFSIZE回傳值 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 位元暫存器變數資料基本大小為2 bytes(16個位元資料) 16位元暫存器變數資料基本大小為2 bytes 32位元暫存器變數資料基本大小為4 bytes DevType與範圍限定: M 0 ~ 1023, 3024 ~ 3071 A 0 ~ 511 D 0 ~ 1023 November, 2017 4-43
OPENCNC 控制器 API OPENCNC 使用手冊 4.18 參數資訊 4 4.18.1 READ_CNCParameter_Single:讀取單筆 CNC 參數 函數名稱 int READ_CNCParameter_Single 加工中限制 無 使用權限 一般使用者 [in/out] in 說明 引數 變數名稱 型別 in 通道(目前為0) 傳回值 Channel ushort in 參數號碼 ParaID ushort 子參數 (從0開始,不指定值為-1) SubItem short 軸參數(參考4.3.2 軸代碼,不 指定值為-1) AXNr short in Group ID GroupID ushort out (內部使用,暫不開放) SubGroupID short out Sub Group ID(參考4.3.13 ParaChannel short out Sub Group Type) 子參數 ParaAxis short out (從0開始,不指定值為-1) 軸參數(參考4.3.2 軸代碼,不 DataType short out 指定值為-1) 資料型態 DataSize ushort out (參考4.3.12 Data Type) 讀取資料大小(Byte) Data Byte[] out 讀取資料 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 4-44 November, 2017
OPENCNC 使用手冊 OPENCNC 控制器 API 4.18.2 WRITE_CNCParameter_Single:寫入單筆CNC參數 函數名稱 int WRITE_CNCParameter_Single 4 使用權限 模式限制 依寫入參數區分 加工中限制 有 引數 [AUTO]與[MDI]不允許使用(參考4.3.5 CNC Mode) 傳回值 變數名稱 型別 [in/out] 說明 備註 Channel ushort in 通道(目前為0) ParaID ushort in 參數號碼 SubItem short 子參數 in (從0開始,不指定值為-1) AXNr short 軸參數(參考4.3.2 軸代碼,不 in 指定值為-1) Data Byte[32] in 寫入資料(32 Bytes) 0或1:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 參數寫入成功後,系統重新動作數值會改變。 須使用READ_status讀取新的系統重新動作數值。 (定義參考4.3.7 CNC Restart Action) November, 2017 4-45
OPENCNC 控制器 API OPENCNC 使用手冊 4.19 SF 設定 4 4.19.1 READ_SF_Limit:讀取 SF 極限值 函數名稱 int READ_SF_Limit 使用權限 一般使用者 加工中限制 無 引數 變數名稱 型別 [in/out] 說明 傳回值 MinOfS int out S設定最小值 MaxOfS int out S設定最大值 MinOfF int out F設定最小值 MaxOfF int out F設定最大值 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 4.19.2 WRITE_S_setting:設定主軸轉速 函數名稱 int WRITE_S_setting 加工中限制 無 使用權限 用戶權限 設定值 引數 變數名稱 型別 [in/out] 說明 傳回值 SetValue uint in 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 4.19.3 WRITE_F_setting:設定進給速度 函數名稱 int WRITE_F_setting 使用權限 用戶權限 加工中限制 無 引數 變數名稱 型別 [in/out] 說明 傳回值 SetValue uint in 設定值 備註 0 : 成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 1. 使用此函式前,需將[參數 10017] > [開啟進給速度設定]設定為 1。 2. F值設定後,則須等系統的緩衝區的資料處理完,才會執行新的進給速度。 4-46 November, 2017
OPENCNC 使用手冊 OPENCNC 控制器 API 4.19.4 WRITE_SF_setting:設定主軸轉速與進給速度 函數名稱 int WRITE_SF_setting 4 使用權限 用戶權限 加工中限制 無 引數 變數名稱 型別 [in/out] 說明 傳回值 S_Value uint in 主軸轉速 備註 F_Value uint in 進給速度 1:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 1. 使用此函式前,需將[參數 10017] > [開啟進給速度設定]設定為 1。 2. SF值設定後,則須等系統的緩衝區的資料處理完,才會執行新的主軸轉速與進給 速度。 4.20 系統資訊 4.20.1 READ_System_Time:讀取系統日期時間 函數名稱 int READ_System_Time 使用權限 一般使用者 加工中限制 無 引數 變數名稱 型別 [in/out] 說明 傳回值 strSystemTime string out 系統日期時間 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 系統日期時間字串格式為 Year/Month/Day Hour/Minute/Second。 4.20.2 Reset_System:Reset System 函數名稱 int Reset_System 加工中限制 無 使用權限 一般使用者 引數 - 0:成功 傳回值 小於0為失敗,數值內容參考章節4.2 回傳說明。 November, 2017 4-47
OPENCNC 控制器 API OPENCNC 使用手冊 4.20.3 READ_system_variable:讀取系統變數 4 函數名稱 int READ_system_variable 使用權限 一般使用者 加工中限制 無 引數 變數名稱 型別 [in/out] 說明 傳回值 SysVarNum ushort out 回傳全部數值類變數個數 AxisVarNum ushort out 回傳全部軸類變數個數 SysVarChannel ushort[] out 數值類變數通道值 SysVarID ushort[] out 數值類變數ID SysVarType ushort[] out 數值類變數資料型態 數值類變數數值,一個數值資 料為8 bytes SysVarValue byte[x,y] out x:數值類變數index,長度為 SysVarNum; y:數值,長度為8 AxisVarChannel ushort[] out 軸類變數通道值 AxisNum ushort[] out 軸類變數使用軸個數 AxisVarID ushort[] out 軸類變數ID AxisVarType ushort[] out 軸類變數資料型態 軸類變數軸ID AxisID ushort[x,y] out x:軸類變數index,長度為 AxisVarNum y:軸ID,長度為AxisNum 軸類變數數值,一個數值資料 為8 bytes AxisVarValue byte[x,y,z] out x:軸類變數index,長度為 AxisVarNum y:軸ID,長度為AxisNum z:數值,長度為8 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 4-48 November, 2017
OPENCNC 使用手冊 OPENCNC 控制器 API 4.20.4 READ_user_variable:讀取用戶變數 函數名稱 int READ_user_variable 加工中限制 無 4 使用權限 一般使用者 說明 引數 變數名稱 型別 [in/out] 回傳用戶變數個數 暫存器數值 傳回值 VarNum ushort out 用戶變數數值 備註 VarReg ushort[] out VarValue ushort[] out 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 回傳陣列長度為VarNum 4.20.5 WRITE_user_variable_register:寫入用戶變數暫存器數值 函數名稱 int WRITE_user_variable_register 加工中限制 無 使用權限 設備權限 說明 引數 變數名稱 型別 [in/out] 用戶變數ID 暫存器數值 傳回值 VarID ushort in VarReg ushort in 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 4.20.6 WRITE_user_variable_value:寫入用戶變數數值 函數名稱 int WRITE_user_variable_value 使用權限 用戶權限 加工中限制 無 引數 變數名稱 型別 [in/out] 說明 傳回值 備註 VarID ushort in 用戶變數ID SetValue ushort in 用戶變數數值 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 [參數12016] > [啟動MLC編輯保護]為1時,模式[AUTO]與[MDI]不允許使用API。 4.20.7 DELETE_user_variable:刪除用戶變數 函數名稱 int DELETE_user_variable 使用權限 設備權限 加工中限制 無 引數 變數名稱 型別 [in/out] 說明 傳回值 VarID ushort in 用戶變數ID 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 November, 2017 4-49
OPENCNC 控制器 API OPENCNC 使用手冊 4.20.8 READ_equip_variable:讀取設備變數 4 函數名稱 int READ_equip_variable 加工中限制 無 使用權限 一般使用者 說明 引數 變數名稱 型別 [in/out] 回傳設備變數個數 暫存器數值 傳回值 VarNum ushort out 設備變數數值 備註 VarReg ushort[] out VarValue ushort[] out 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 回傳陣列長度為VarNum 4.20.9 WRITE_equip_variable_register:寫入設備變數暫存器數值 函數名稱 int WRITE_equip_variable_register 加工中限制 無 使用權限 設備權限 說明 引數 變數名稱 型別 [in/out] 設備變數ID 暫存器數值 傳回值 VarID ushort in VarReg ushort in 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 4.20.10 WRITE_equip_variable_value:寫入設備變數數值 函數名稱 int WRITE_equip_variable_value 使用權限 設備權限 加工中限制 無 引數 變數名稱 型別 [in/out] 說明 傳回值 備註 VarID ushort in 設備變數ID SetValue ushort in 設備變數數值 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 [參數12016] > [啟動MLC編輯保護]為1時,模式[AUTO]與[MDI]不允許使用API。 4-50 November, 2017
OPENCNC 使用手冊 OPENCNC 控制器 API 4.20.11 DELETE_equip_variable:刪除設備變數 函數名稱 int DELETE_equip_variable 加工中限制 無 4 使用權限 設備權限 說明 引數 變數名稱 型別 [in/out] 設備變數ID 傳回值 VarID ushort in 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 4.20.12 READ_system_status:讀取系統狀態 函數名稱 int READ_system_status 使用權限 一般使用者 加工中限制 無 引數 變數名稱 型別 [in/out] 說明 傳回值 ParaCount ushort out 回傳系統狀態個數 ParaID ushort[] 系統狀態參數ID out 回傳陣列長度為ParaCount ParaName string[] 系統狀態參數名稱 out 回傳陣列長度為ParaCount DataType ushort[] 資料型態(參考4.3.12 Data out Type) 回傳陣列長度為ParaCount DataSize ushort[] 讀取資料大小(Byte) out 回傳陣列長度為ParaCount 讀取資料 Data byte[x,y] out x:系統狀態參數Index y:讀取資料數值 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 November, 2017 4-51
OPENCNC 控制器 API OPENCNC 使用手冊 4.20.13 READ_FW_version:讀取韌體序號 4 函數名稱 int READ_FW_version 使用權限 一般使用者 加工中限制 無 引數 變數名稱 型別 [in/out] 說明 傳回值 ParaCount ushort out 回傳韌體序號個數 ParaID ushort[] 韌體序號參數ID out 回傳陣列長度為ParaCount ParaName string[] 韌體序號參數名稱 out 回傳陣列長度為ParaCount DataType ushort[] 資料型態(參考4.3.12 Data out Type) 回傳陣列長度為ParaCount DataSize ushort[] 讀取資料大小(Byte) out 回傳陣列長度為ParaCount 讀取資料 Data byte[x,y] out x:系統狀態參數Index y:讀取資料數值 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 4.20.14 READ_HW_version:讀取硬體序號 函數名稱 int READ_HW_version 使用權限 一般使用者 加工中限制 無 引數 變數名稱 型別 [in/out] 說明 傳回值 ParaCount ushort out 回傳硬體序號個數 ParaID ushort[] 硬體序號參數ID out 回傳陣列長度為ParaCount ParaName string[] 硬體序號參數名稱 out 回傳陣列長度為ParaCount DataType ushort[] 資料型態(參考4.3.12 Data out Type) 回傳陣列長度為ParaCount DataSize ushort[] out 讀取資料大小(Byte) 回傳陣列長度為ParaCount 讀取資料 Data byte[x,y] out x:系統狀態參數Index y:讀取資料數值 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 4-52 November, 2017
OPENCNC 使用手冊 OPENCNC 控制器 API 4.20.15 READ_equip_infomation:讀取設備資訊 函數名稱 int READ_equip_infomation 4 使用權限 一般使用者 加工中限制 無 引數 變數名稱 型別 [in/out] 說明 傳回值 InfoCount ushort out 回傳設備資訊個數 EquipInfo string[] 設備資訊 out 回傳陣列長度為InfoCount 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 4.20.16 WRITE_equip_infomation:寫入設備資訊 函數名稱 int WRITE_equip_infomation 使用權限 設備權限 加工中限制 無 引數 [in/out] 說明 變數名稱 型別 out 傳回值 設備資訊ID EquipID ushort 設備資訊字串 最大字串長度25 strInfo string out 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 4.20.17 DELETE_equip_infomation:刪除設備資訊 函數名稱 int DELETE_equip_infomation 使用權限 設備權限 加工中限制 無 引數 說明 變數名稱 型別 [in/out] 傳回值 設備資訊ID EquipID ushort out 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 November, 2017 4-53
OPENCNC 控制器 API OPENCNC 使用手冊 4.21 通道設定 4 4.21.1 READ_channel_setting:讀取通道設定 函數名稱 int READ_channel_setting 加工中限制 無 使用權限 一般使用者 [in/out] 說明 in 引數 變數名稱 型別 out 通道(目前為0) out 回傳軸個數 傳回值 Channel ushort out 軸代碼(參考4.3.2 軸代碼) 備註 out 是否啟用 AxisNum ushort out 軸類別(參考4.3.14 軸類別) Port代號(代號Index由0開始) AxisID ushort[] 軸顯示名稱(長度0 ~ 2) 長度0顯示預設名稱 IsEnable bool[] AxisTypeID short[] PortID short[] AxisName string[] out 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 回傳陣列長度為AxisNum 4.21.2 WRITE_channel_setting_single:寫入單筆通道設定 函數名稱 int WRITE_channel_setting_single 使用權限 模式限制 設備權限 加工中限制 有 引數 [AUTO]與[MDI]不允許使用(參考4.3.5 CNC Mode) 傳回值 變數名稱 型別 [in/out] 說明 備註 Channel ushort in 通道(目前為0) AxisID ushort in 軸代碼(參考4.3.2 軸代碼) IsEnable bool in 是否啟用 AxisTypeID short in 軸類別(參考4.3.14 軸類別) PortID short in Port代號(代號Index由0開始) AxisName string 軸顯示名稱(長度0 ~ 2) in 長度0顯示預設名稱 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 SP軸之軸類別無作用,設定為None 4-54 November, 2017
OPENCNC 使用手冊 OPENCNC 控制器 API 4.21.3 WRITE_channel_setting_all:寫入全部通道設定 函數名稱 int WRITE_channel_setting_all 加工中限制 有 4 使用權限 設備權限 模式限制 說明 [AUTO]與[MDI]不允許使用(參考4.3.5 CNC Mode) 通道(目前為0) 引數 是否啟用 變數名稱 型別 [in/out] 軸類別(參考4.3.14 軸類別) 傳回值 Port代號(代號Index由0開始) 備註 Channel ushort in 軸顯示名稱(長度0 ~ 2) 長度0顯示預設名稱 IsEnable bool[] in AxisTypeID short[] in PortID short[] in AxisName string[] in 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 SP軸之軸類別無作用,設定為None 軸代碼代表輸入陣列Index 輸入陣列長度需為10(全部軸代碼個數) 4.21.4 READ_port_info:讀取埠設定 函數名稱 int READ_channel_setting 加工中限制 無 使用權限 一般使用者 說明 引數 變數名稱 型別 [in/out] 回傳埠個數 Port代號(代號Index由0開始) 傳回值 PortNum ushort out 是否啟用 備註 通道代號 PortID ushort[] out 軸代碼(參考4.3.2 軸代碼) 軸類別(參考4.3.14 軸類別) IsEnable bool[] out ChannelID short[] out AxisID short[] out AxisTypeID short[] out 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 回傳陣列長度為PortNum November, 2017 4-55
OPENCNC 控制器 API OPENCNC 使用手冊 4.22 RIO 設定 4 4.22.1 RIO 設定說明 欄位 數值 說明 狀態 True,False RIO埠是否連結 啟用 True,False RIO埠是否啟用 RIO型態 Port 0 ~ 3:I/O卡 極性設定 0~3 Port 4 ~ 7:AD/DA、DA、AD與I/O卡 0x0 ~ 0xFFFFFFFF RIO埠型態 斷線輸出 0:AD/DA;1:DA;2:AD;3:I/O True,False I/O卡上的極性設定 原點極限設定 0:A接點;1:B接點 濾波等級 True,False (只有Port 0可以設定極性) 0~5 RIO斷線時,輸出的狀態 False:輸出清為0 True:輸出保持原狀態 Port 1接點可當作原點極限設定 True:原點極限啟用 False:原點極限不啟用 X軸:接點0 ~ 2;Y軸:接點3 ~ 5,依此類推 RIO濾波等級 4.22.2 READ_RIO_Status:讀取 RIO 埠狀態 函數名稱 int READ_RIO_Status 使用權限 一般使用者 加工中限制 無 引數 說明 變數名稱 型別 [in/out] 傳回值 RIO埠個數 備註 IO_Num ushort out RIO埠連結狀態 RIO_Status bool[] out 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 回傳陣列長度為IO_Num 4-56 November, 2017
OPENCNC 使用手冊 OPENCNC 控制器 API 4.22.3 READ_RIO_setting_single:讀取單筆 RIO 設定 函數名稱 int READ_RIO_setting_single 4 使用權限 一般使用者 加工中限制 無 引數 變數名稱 型別 [in/out] 說明 傳回值 IO_ID ushort RIO埠代號(代號Index由0開 in 始,範圍0 ~ 7) IsEnable bool out 是否啟用 RIOType short out RIO型態(參考4.3.15 RIO Polarity uint Type) out 極性設定 IsDisc bool out 斷線輸出 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 4.22.4 READ_RIO_setting_all:讀取全部 RIO 設定 函數名稱 int READ_RIO_setting_all 使用權限 一般使用者 加工中限制 無 引數 變數名稱 型別 [in/out] 說明 傳回值 備註 IO_Num ushort out RIO埠個數 IsEnable Bool[] out 是否啟用 RIOType short[] out RIO型態(參考4.3.15 RIO Polarity uint[] Type) out 極性設定 IsDisc bool[] out 斷線輸出 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 回傳陣列長度為IO_Num November, 2017 4-57
OPENCNC 控制器 API OPENCNC 使用手冊 4.22.5 WRITE_RIO_setting_single:寫入單筆 RIO 設定 4 函數名稱 int WRITE_RIO_setting_single 使用權限 模式限制 設備權限 加工中限制 有 引數 [AUTO]與[MDI]不允許使用(參考4.3.5 CNC Mode) 傳回值 變數名稱 型別 [in/out] 說明 IO_ID ushort RIO埠代號(代號Index由0開 in 始,範圍0 ~ 7) IsEnable bool in 是否啟用 RIOType short RIO型態 in (參考4.3.15 RIO Type) Polarity uint in 極性設定 IsDisc bool in 斷線輸出 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 4.22.6 WRITE_RIO_setting_all:寫入全部 RIO 設定 函數名稱 int WRITE_RIO_setting_all 使用權限 模式限制 設備權限 加工中限制 有 引數 [AUTO]與[MDI]不允許使用(參考4.3.5 CNC Mode) 傳回值 變數名稱 型別 [in/out] 說明 備註 IsEnable bool[] in 是否啟用 RIOType short[] RIO型態 in (參考4.3.15 RIO Type) Polarity uint[] in 極性設定 IsDisc bool[] in 斷線輸出 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 RIO埠代號代表輸入陣列Index 輸入陣列長度需為8(全部RIO埠個數) 4-58 November, 2017
OPENCNC 使用手冊 OPENCNC 控制器 API 4.22.7 READ_RIO_home_limit:讀取 RIO 原點極限設定 函數名稱 int READ_RIO_home_limit 加工中限制 無 4 使用權限 一般使用者 說明 引數 變數名稱 型別 [in/out] 通道(目前為0) 軸個數 傳回值 Channel ushort in 原點極限是否啟用 備註 Port_Num ushort out Homelimit bool[] out 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 回傳陣列長度為Port_Num 軸代號代表陣列Index 4.22.8 WRITE_RIO_home_limit:寫入 RIO 原點極限設定 函數名稱 int WRITE_RIO_home_limit 加工中限制 有 使用權限 設備權限 模式限制 說明 [AUTO]與[MDI]不允許使用(參考4.3.5 CNC Mode) 通道(目前為0) 引數 原點極限是否啟用 變數名稱 型別 [in/out] 傳回值 Channel ushort in 備註 Homelimit bool[] out 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 軸代號代表陣列Index 輸入陣列長度需為9 (全部軸個數,不含SP軸) 4.22.9 READ_RIO_filter:讀取 RIO 濾波等級 函數名稱 int READ_RIO_filter 加工中限制 無 使用權限 一般使用者 濾波等級 引數 變數名稱 型別 [in/out] 說明 傳回值 FilterLevel ushort out 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 November, 2017 4-59
OPENCNC 控制器 API OPENCNC 使用手冊 4.22.10 WRITE_RIO_filter:寫入RIO濾波等級 4 函數名稱 int WRITE_RIO_filter 加工中限制 有 使用權限 設備權限 濾波等級 模式限制 [AUTO]與[MDI]不允許使用(參考4.3.5 CNC Mode) 引數 變數名稱 型別 [in/out] 說明 傳回值 FilterLevel ushort in 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 4.23 檔案程式資訊 4.23.1 READ_disk_quota:讀取磁碟剩餘空間 函數名稱 int READ_disk_quota 使用權限 一般使用者 加工中限制 無 引數 變數名稱 型別 [in/out] 說明 傳回值 disktype 查詢磁碟代號 char in (參考4.3.11 Disk Type) diskquota 磁碟剩餘空間 int out 單位:KB 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 4.23.2 READ_inter_disk_quota:讀取快閃記憶體剩餘可用空間 函數名稱 int READ_inter_disk_quota 使用權限 一般使用者 加工中限制 無 引數 變數名稱 型別 [in/out] 說明 傳回值 備註 diskquota 剩餘空間 uint out 單位:Byte 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 快閃記憶體最大可用空間為256KB 4-60 November, 2017
OPENCNC 使用手冊 OPENCNC 控制器 API 4.23.3 READ_dir_list:讀取磁碟目錄清單 函數名稱 int READ_dir_list 4 使用權限 一般使用者 加工中限制 無 引數 變數名稱 型別 [in/out] 說明 傳回值 查詢磁碟目錄路徑 strPath string in (磁碟代號參考4.3.11 Disk FileList string[,] Type) out 目錄清單 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 FileList[x,0]:Name FileList[x,1]:Size (Byte) FileList[x,2]:File/Directory FileList[x,3]:Datetime 4.23.4 UPLOAD_file:上傳檔案至 CNC 函數名稱 int UPLOAD_file 使用權限 用戶權限 加工中限制 有 引數 變數名稱 型別 [in/out] 說明 傳回值 備註 strSrc string in 來源檔案路徑名稱 儲存路徑名稱 strDst string in (磁碟代號參考4.3.11 Disk Percent uint out(ref) Type) 執行進度百分比 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 快閃記憶體使用者最大可用空間為256KB 4.23.5 DOWNLOAD_file:從 CNC 下載檔案 函數名稱 int DOWNLOAD_file 使用權限 用戶權限 加工中限制 有 引數 變數名稱 型別 [in/out] 說明 傳回值 來源檔案路徑名稱 strSrc string in (磁碟代號參考4.3.11 Disk strDst string Type) in 儲存路徑名稱 Percent uint out(ref) 執行進度百分比 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 November, 2017 4-61
OPENCNC 控制器 API OPENCNC 使用手冊 4.23.6 DELETE_file:刪除 CNC 上檔案 4 函數名稱 int DELETE_file 型別 加工中限制 有 使用權限 用戶權限 [in/out] 說明 引數 變數名稱 刪除檔案路徑名稱 (磁碟代號參考4.3.11 Disk 傳回值 strDeleteFile string in Type) 備註 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 快閃記憶體使用者最大可用空間為256KB 4.23.7 RENAME_file:修改 CNC 上檔案名稱 函數名稱 int RENAME_file 使用權限 用戶權限 加工中限制 有 引數 變數名稱 型別 [in/out] 說明 傳回值 原始檔案路徑名稱 strSrc string in (磁碟代號參考4.3.11 Disk Type) 修改檔案路徑名稱 strDst string in (磁碟代號參考4.3.11 Disk 0:成功 Type) 小於0為失敗,數值內容參考章節4.2 回傳說明。 原始檔案路徑與修改檔案路徑必須相同 4.23.8 MAKE_directory:CNC 上建立目錄 函數名稱 int MAKE_directory 使用權限 用戶權限 加工中限制 有 引數 變數名稱 型別 [in/out] 說明 傳回值 備註 目錄路徑名稱 strDirectory string in (磁碟代號參考4.3.11 Disk Type) 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 只允許一層目錄 快閃記憶體使用者最大可用空間為256KB 4-62 November, 2017
OPENCNC 使用手冊 OPENCNC 控制器 API 4.23.9 REMOVE_directory:CNC 上移除目錄 函數名稱 int REMOVE_directory 4 使用權限 用戶權限 加工中限制 有 引數 變數名稱 型別 [in/out] 說明 傳回值 備註 目錄路徑名稱 strDirectory string in (磁碟代號參考4.3.11 Disk Type) 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 只允許一層目錄,目錄內有檔案無法刪除。 快閃記憶體使用者最大可用空間為256KB 4.23.10 WRITE_nc_main:設定加工程式為主程式 函數名稱 int WRITE_nc_main 使用權限 模式限制 一般使用者 加工中限制 有 引數 [EDIT] (參考4.3.5 CNC Mode]) 說明 通道 傳回值 變數名稱 型別 [in/out] 檔案路徑名稱 Channel ushort in strFilePath string in 大於0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 4.23.11 CLOSE_nc_main:移除主程式 函數名稱 int CLOSE_nc_main 加工中限制 有 使用權限 一般使用者 通道 模式限制 [EDIT] (參考4.3.5 CNC Mode]) 引數 變數名稱 型別 [in/out] 說明 傳回值 Channel ushort in 大於0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 November, 2017 4-63
OPENCNC 控制器 API OPENCNC 使用手冊 4.23.12 READ_nc_pointer:讀取 NC 執行行號 4 函數名稱 int READ_nc_pointer 加工中限制 有 使用權限 一般使用者 說明 引數 變數名稱 型別 [in/out] NC執行行號 MDI模式執行行號 傳回值 LineNum int out MDILineNum int out 大於0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 4.23.13 READ_preview_code:讀取 NC 預讀程式內容 函數名稱 int READ_preview_code 使用權限 一般使用者 加工中限制 有 引數 說明 變數名稱 型別 [in/out] 傳回值 讀取行數,範圍1 ~ 50 備註 CodeCount ushort in 行號 程式內容 LineNo uint[] out string[] String[] out 大於0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 回傳陣列長度為CodeCount 4.23.14 READ_current_code:讀取 NC 當前程式內容 函數名稱 int READ_current_code 加工中限制 有 使用權限 一般使用者 說明 引數 變數名稱 型別 [in/out] 讀取行數,範圍1 ~ 50 行號 傳回值 CodeCount ushort in 程式內容 備註 LineNo uint[] out string[] String[] out 大於0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 回傳陣列長度為CodeCount 4-64 November, 2017
OPENCNC 使用手冊 OPENCNC 控制器 API 4.24 斷點搜尋 4.24.1 READ_CodeSearch_LineNo:讀取斷點搜尋行號 4 函數名稱 int READ_RIO_MONITOR 使用權限 用戶權限 加工中限制 無 引數 變數名稱 型別 [in/out] 通道 說明 傳回值 行號 Channel ushort in LineNo int out 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 4.24.2 READ_CodeSearch_POSITION:讀取斷點搜尋座標 函數名稱 int READ_CodeSearch_POSITION 使用權限 用戶權限 加工中限制 無 引數 變數名稱 型別 [in/out] 說明 傳回值 Channel ushort in 通道(目前為0) Unit ushort 讀取數值單位 in (參考4.3.1 CNC數值單位) AxisNum ushort out 軸個數 AxisID ushort[] out 軸代碼(參考4.3.2 軸代碼),陣 列長度為AxisNum Coor_Mach double[] out 機械座標,陣列長度為AxisNum Coor_Abs double[] out 絕對座標,陣列長度為AxisNum Coor_Rel double[] out 相對座標,陣列長度為AxisNum Coor_Res double[] out 剩餘座標,陣列長度為AxisNum Coor_Offset double[] out 偏移座標,陣列長度為AxisNum 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 November, 2017 4-65
OPENCNC 控制器 API OPENCNC 使用手冊 4.24.3 WRITE_CodeSearch_Exec:執行斷點搜尋 4 函數名稱 int WRITE_CodeSearch_Exec 加工中限制 有 使用權限 用戶權限 通道 引數 變數名稱 型別 [in/out] 搜尋行號 說明 傳回值 Channel ushort in 備註 SearchStr string in 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 1. 自動執行模式下不可設定 2. 僅可在行號 1 時執行 4.24.4 READ_CodeSearch_Status:讀取斷點搜尋狀態 函數名稱 int READ_CodeSearch_Status 使用權限 用戶權限 加工中限制 無 引數 變數名稱 型別 [in/out] 說明 傳回值 in Channel ushort 通道 0:未執行 1:執行中 4-66 November, 2017
OPENCNC 使用手冊 OPENCNC 控制器 API 4.25 手動輸入 4.25.1 WRITE_MDI_Load:MDI 載入 4 函數名稱 int WRITE_MDI_Load 型別 加工中限制 有 使用權限 一般使用者 ushort [in/out] 說明 in 引數 變數名稱 開始執行游標行號(0開始) Cursor MDI內容 傳回值 (最多14行,一行最長256) MDIBuffer string[] in 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 4.25.2 READ_MDI_code:MDI 執行內容讀取 函數名稱 int READ_MDI_code 使用權限 一般使用者 加工中限制 無 引數 變數名稱 型別 [in/out] 說明 傳回值 LineNo uint out 游標行號(0開始) strCode string[] MDI內容 out (最多14行,一行最長256) 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 4.25.3 CLEAR_MDI: MDI 清除 函數名稱 int CLEAR_MDI 加工中限制 有 使用權限 一般使用者 - 引數 0:成功 傳回值 小於0為失敗,數值內容參考章節4.2 回傳說明。 November, 2017 4-67
OPENCNC 控制器 API OPENCNC 使用手冊 4.26 系統監控 4 4.26.1 READ_RIO_MONITOR:I/O 監控 函數名稱 int READ_RIO_MONITOR 使用權限 一般使用者 加工中限制 無 引數 變數名稱 型別 [in/out] 說明 傳回值 備註 RIONum ushort out RIO個數 IsEnable bool[] out 是否啟用 IsConnect bool[] out 連線狀態 RIOType ushort[] out RIO型態(參考4.3.15 RIO 0:成功 Type) 小於0為失敗,數值內容參考章節4.2 回傳說明。 回傳陣列長度為RIONum 4.26.2 READ_SERVO_MONITOR:伺服監控 函數名稱 int READ_SERVO_MONITOR 加工中限制 無 使用權限 一般使用者 [in/out] 說明 out 引數 變數名稱 型別 out 連接埠個數 out 通道 傳回值 Num ushort out 軸代碼(參考4.3.2 軸代碼) 備註 out 連線狀態 Channel short[] out 伺服是否備妥 out 負載 AxisID short[] out 峰值 out 機械座標 IsConnect bool[] out 原點狀態 絕對歸零 IsServoOn bool[] 編碼器形式 (0:增量型; 1:絕對型) Load short[] Peak short[] MechCoord double[] IsHome bool[] AbsHomeSet bool[] EncoderType ushort[] out 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 回傳陣列長度為Num 4-68 November, 2017
OPENCNC 使用手冊 OPENCNC 控制器 API 4.26.3 WRITE_home_setting:絕對歸零設定 函數名稱 WRITE_home_setting 加工中限制 有 4 使用權限 設備權限 模式限制 說明 [JOG]與[MPG] (參考4.3.5 CNC Mode) 通道 引數 軸代碼(參考4.3.2 軸代碼) 變數名稱 型別 [in/out] 傳回值 Channel ushort in AxisID ushort in 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 4.26.4 READ_Variable_MONITOR_SysVar:系統變數監控 函數名稱 int READ_Variable_MONITOR_SysVar 使用權限 一般使用者 加工中限制 無 引數 變數名稱 型別 [in/out] 說明 傳回值 Type0_Num ushort Type0變數個數 out (ID:0 ~ 31) Type1_Num ushort Type1變數個數 out (ID:100 ~1 31) Type0_Value ushort[] out Type0變數數值,陣列長度為 Type0 Type1_Value float[] out Type1變數數值,陣列長度為 Type1_Num 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 4.26.5 READ_Variable_MONITOR_ChannelVar:通道變數監控 函數名稱 int READ_Variable_MONITOR_ChannelVar 使用權限 一般使用者 加工中限制 無 引數 變數名稱 型別 [in/out] 說明 Channel ushort in 通道 Type0_Num ushort Type0變數個數 out (ID:0 ~ 31) Type1_Num ushort Type1變數個數 out (ID:100 ~ 131) Type2_Num ushort Type2變數個數 out (ID:200 ~ 231) Type0_Value ushort[] out Type0變數數值,陣列長度為 Type1_Value float[] Type0 out Type1變數數值,陣列長度為 Type1_Num November, 2017 4-69
OPENCNC 控制器 API OPENCNC 使用手冊 Type2_Value double [] out Type2變數數值,陣列長度為 Type2_Num 4 傳回值 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 4.26.6 READ_Variable_MONITOR_AxisVar:軸變數監控 函數名稱 int READ_Variable_MONITOR_AxisVar 使用權限 一般使用者 加工中限制 無 引數 說明 變數名稱 型別 [in/out] 傳回值 通道 Channel ushort in 軸個數 軸代碼(參考4.3.2 軸代碼), AxisNum ushort out 陣列長度為AxisNum Type0變數個數 AxisID ushort[] out (ID:0 ~ 31) Type1變數個數 Type0_Num ushort out (ID:100 ~ 131) Type2變數個數 Type1_Num ushort out (ID:200 ~ 231) Type0變數數值,陣列長度x Type2_Num ushort out 為AxisNum,y為Type0_Num Type1變數數值,陣列長度x Type0_Value ushort[x,y] out 為AxisNum,y為Type1_Num Type2變數數值,陣列長度x Type1_Value float[x,y] out 為AxisNum,y為Type2_Num Type2_Value double[x,y] out 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 4-70 November, 2017
OPENCNC 使用手冊 OPENCNC 控制器 API 4.26.7 READ_Variable_MONITOR_HMIVar:介面變數監控 函數名稱 int READ_Variable_MONITOR_HMIVar 4 使用權限 一般使用者 加工中限制 無 引數 變數名稱 型別 [in/out] 說明 傳回值 Type0_Num ushort Type0變數個數 out (ID:0 ~ 31) Type1_Num ushort Type1變數個數 out (ID:200 ~ 263) Type2_Num ushort Type2變數個數 out (ID:400 ~ 431) Type3_Num ushort Type3變數個數 out (ID:800 ~ 831) Type0_Value ushort[] out Type0變數數值,陣列長度為 Type1_Value uint[] Type0 Type2_Value byte[x,y] out Type1變數數值,陣列長度為 Type1_Num Type2變數數值,陣列長度 out x為Type2_Num,y為24 Type3_Value string[] out Type3變數數值,陣列長度為 0 :成功 Type3_Num 小於0為失敗,數值內容參考章節4.2 回傳說明。 4.26.8 READ_Variable_MONITOR_MLCVar:MLC 變數監控 函數名稱 int READ_Variable_MONITOR_MLCVar 使用權限 一般使用者 加工中限制 無 引數 變數名稱 型別 [in/out] 說明 傳回值 VarNum ushort out 變數個數 MLCVar ushort[] out 變數數值,陣列長度為 0:成功 VarNum 小於0為失敗,數值內容參考章節4.2 回傳說明。 November, 2017 4-71
OPENCNC 控制器 API OPENCNC 使用手冊 4.27 通用函式 4 4.27.1 TransferUnit:公英制數值轉換 函數名稱 int TransferUnit 型別 加工中限制 無 使用權限 一般使用者 float [in/out] 說明 in 引數 變數名稱 ushort 輸入數值 value in 轉換數值單位 傳回值 (參考4.3.1 CNC數值單位) Unit 使用狀態 0:讀取 Mode ushort in 1:寫入 轉換後數值 TransferValue float out 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 4.27.2 TransferUnit:公英制數值轉換 函數名稱 int TransferUnit 型別 加工中限制 無 使用權限 一般使用者 double [in/out] 說明 in 引數 變數名稱 ushort 輸入數值 value in 轉換數值單位 傳回值 (參考4.3.1 CNC數值單位) Unit 使用狀態 0:讀取 Mode ushort in 1:寫入 轉換後數值 TransferValue double out 0:成功 小於0為失敗,數值內容參考章節4.2 回傳說明。 4.27.3 TransferToString:數值轉換字串 函數名稱 string TransferToString 型別 加工中限制 無 使用權限 一般使用者 double [in/out] 說明 ushort in 引數 變數名稱 in 輸入數值 value 顯示小數點位數 傳回值 DecPoint String 轉換後字串 4-72 November, 2017
OPENCNC 使用手冊 OPENCNC 控制器 API 4.27.4 TransferToString:數值轉換字串 函數名稱 string TransferToString 型別 加工中限制 無 4 使用權限 一般使用者 float [in/out] 說明 ushort in 引數 變數名稱 in 輸入數值 value 顯示小數點位數 傳回值 DecPoint String轉換後字串 November, 2017 4-73




