代表 EtherCAT 的設定。
繼承體系
System.Object
IntervalZero.KINGSTAR.Local.Api
命名空間：IntervalZero.KINGSTAR.Local.Api
組合： IntervalZero.KINGSTAR.Local.Api (於 IntervalZero.KINGSTAR.Local.dll) 版本：4.4.0.0
語法
public class ApiPublic Class Api
Api 類別陳列了以下成員：
建構函式
| 名稱 | 說明 | |
|---|---|---|
|
Api | 初始化 Api 類別的新實例。 |
軸控制方法
讀寫與軸相關的值。
| 名稱 | 說明 | |
|---|---|---|
|
|
ForceAxisInputBit | 將一個位元寫入模擬軸的輸入。 |
|
|
ForceAxisInputByte | 將一個位元組寫入模擬軸的輸入。 |
|
|
ForceAxisInputDWord | 將一個雙字 (Double Word) 寫入模擬軸的輸入。 |
|
|
ForceAxisInputs | 將一個雙字 (Double Word) 寫入軸的輸入。 |
|
|
ForceAxisInputWord | 將一個字 (Word) 寫入模擬軸的輸入。 |
|
|
GetAxisBuffers | 提供指向軸的輸入和輸出緩衝區的指標。 |
|
|
GetAxisByIndex | 從軸取得資訊。 |
|
|
ReadAxisActualCurrent | 讀取實際電流的變數 (#x6078)。 |
|
|
ReadAxisActualPosition | 使用主編碼器讀取軸的目前位置。 |
|
|
ReadAxisActualTorque | 從軸讀取實際扭矩。 |
|
|
ReadAxisActualVelocity | 從軸讀取實際速度。 |
|
|
ReadAxisAlias | 從軸讀取別名索引。 |
|
|
ReadAxisCustomInput1 | 讀取 IntervalZeroDevices database 或 UserDevices database 中新增的第一個自定義輸入變數，您可使用 KINGSTAR ESI 匯入工具新增兩個自定義輸入變數。 |
|
|
ReadAxisCustomInput2 | 讀取 IntervalZeroDevices database 或 UserDevices database 中新增的第二個自定義輸入變數，您可使用 KINGSTAR ESI 匯入工具新增兩個自定義輸入變數。 |
|
|
ReadAxisFollowingError | 從軸讀取跟隨誤差。 |
|
|
ReadAxisInputBit | 從實體或模擬軸的輸入讀取一個位元。 |
|
|
ReadAxisInputByte | 從實體或模擬軸的輸入讀取一個位元組。 |
|
|
ReadAxisInputDWord | 從實體或模擬軸的輸入讀取一個雙字 (Double Word)。 |
|
|
ReadAxisInputs | 從軸的輸入讀取一個值。 |
|
|
ReadAxisInputWord | 從實體或模擬軸的輸入讀取一個字 (Word)。 |
|
|
ReadAxisMopDisplay | 從 PDO 讀取操作模式顯示 (Modes of Operation Display) 變數的值。 |
|
|
ReadAxisOutputBit | 從實體或模擬軸的輸出讀取一個位元。 |
|
|
ReadAxisOutputByte | 從實體或模擬軸的輸出讀取一個帶有位元組偏移量的位元組。 |
|
|
ReadAxisOutputDWord | 從實體或模擬軸的輸出讀取一個雙字 (Double Word)。 |
|
|
ReadAxisOutputs | 從軸的輸出讀取一個值。 |
|
|
ReadAxisOutputWord | 從實體或模擬軸的輸出讀取一個字 (Word)。 |
|
|
ReadAxisSecondEncoder | 使用第二編碼器從軸讀取目前位置。 |
|
|
ReadAxisStatusWord | 從軸讀取 Statusword 變數的值。 |
|
|
ReadAxisTouchProbeStatus | 讀取位置抓取狀態的變數 (#x60B9)。 |
|
|
WriteAxisAlias | 將別名索引寫入軸。 |
|
|
WriteAxisControlWord | 將 ControlWord 變數的值寫入軸。 |
|
|
WriteAxisCustomOutput1 | 將值寫入 IntervalZeroDevices database 或 UserDevices database 中新增的第一個自定義輸出變數，您可使用 KINGSTAR ESI 匯入工具新增兩個自定義輸出變數。 |
|
|
WriteAxisCustomOutput2 | 將值寫入 IntervalZeroDevices database 或 UserDevices database 中新增的第二個自定義輸出變數，您可使用 KINGSTAR ESI 匯入工具新增兩個自定義輸出變數。 |
|
|
WriteAxisMaxCurrent | 將最大電流寫入軸。 |
|
|
WriteAxisMaxTorque | 將最大扭矩寫入軸。 |
|
|
WriteAxisMop | 將操作模式 (Modes of Operation) 變數的值寫入軸。 |
|
|
WriteAxisOutputBit | 將一個位元寫入實體或模擬軸的輸出。 |
|
|
WriteAxisOutputByte | 將一個位元組寫入實體或模擬軸的輸出。 |
|
|
WriteAxisOutputDWord | 將一個雙字 (Double Word) 寫入實體或模擬軸的輸出。 |
|
|
WriteAxisOutputs | 將值寫入軸的輸出。 |
|
|
WriteAxisOutputWord | 將一個字 (Word) 寫入實體或模擬軸的輸出。 |
|
|
WriteAxisProfileAcceleration | 設定軸的曲線加速度 (Profile Acceleration)。 |
|
|
WriteAxisProfileDeceleration | 設定軸的曲線減速度 (Profile Deceleration)。 |
|
|
WriteAxisProfileVelocity | 設定軸的曲線速度 (Profile Velocity)。 |
|
|
WriteAxisTargetPosition | 設定軸的目標位置。 |
|
|
WriteAxisTargetTorque | 設定軸的目標扭矩。 |
|
|
WriteAxisTargetVelocity | 設定軸的目標速度。 |
|
|
WriteAxisTorqueOffset | 設定軸的扭矩偏移量。 |
|
|
WriteAxisTouchProbeControl | 寫入位置抓取控制的變數 (#x60B8)。 |
軸變數方法
啟用供軸使用的模式。
| 名稱 | 說明 | |
|---|---|---|
|
|
EnableActualCurrent | 新增實際電流變數至 PDO。 |
|
|
EnableActualTorque | 新增實際扭矩變數至 PDO。 |
|
|
EnableActualVelocity | 新增實際速度變數至 PDO。 |
|
|
EnableAxisInput | 新增數位輸入變數至 PDO。 |
|
|
EnableAxisOutput | 新增數位輸出變數至 PDO。 |
|
|
EnableFollowingError | 新增跟隨誤差變數至 PDO。 |
|
|
EnableMaxCurrent | 新增最大電流變數至 PDO。 |
|
|
EnableMaxTorque | 新增最大扭矩變數至 PDO。 |
|
|
EnableProfilePosition | 新增曲線速度 (Profile Velocity)、曲線加速度 (Profile Acceleration) 和曲線減速度 (Profile Deceleration) 變數至 PDO。 |
|
|
EnableSecondEncoder | 新增內部位置變數至 PDO。 |
|
|
EnableSynchronizedControlMode | 新增操作模式 (Modes of Operation) 及操作模式顯示 (Modes of Operation Display) 變數至 PDO。 |
|
|
EnableTorqueOffset | 新增扭矩偏移變數至 PDO。 |
|
|
EnableTouchProbe | 新增 TouchProbeControl 與 TouchProbeStatus 變數至 PDO。 |
|
|
SetAxisAccessMode | 為 EtherCAT 驅動器設定資料傳輸模式。 |
命令方法
等待、取消及取得函式狀態的命令。
除錯方法
傳送記錄檔訊息至您的 KINGSTAR 應用程式並識別它。
| 名稱 | 說明 | |
|---|---|---|
|
|
DebugMessage | 傳送 KINGSTAR 記錄檔訊息到 KINGSTAR 記錄檢視。 |
|
|
GetCategoryName | 取得指派給記錄檔 ID 的字串。 |
|
|
SetCategoryName | 設定關聯到記錄檔 ID 的字串。 |
Heartbeat 方法
發送週期性訊號給 KINGSTAR，以偵測運動應用程式是否正常運作。
| 名稱 | 說明 | |
|---|---|---|
|
|
PulseHeartbeat | 發送訊號以通知 KINGSTAR 運動應用程式處於正常運作。 |
|
|
SetHeartbeat | 設定 heartbeat，週期性地檢查運動應用程式是否正常運作。 |
I/O 控制方法
從 I/O 模組讀取或寫入值，或從 I/O 模組中取得資訊。
| 名稱 | 說明 | |
|---|---|---|
|
|
ForceInputBit | 將一個位元寫入模擬 I/O 模組的輸入。 |
|
|
ForceInputByte | 將一個位元組寫入模擬 I/O 模組的輸入。 |
|
|
ForceInputDWord | 將一個雙字 (Double Word) 寫入模擬 I/O 模組的輸入。 |
|
|
ForceInputWord | 將一個字 (Word) 寫入模擬 I/O 模組的輸入。 |
|
|
GetIOBuffers | 提供指向 I/O 模組的輸入和輸出緩衝區的指標。 |
|
|
GetIOByIndex | 從指定的實體 I/O 模組或模擬 I/O 模組中取得資訊。 |
|
|
ReadInputBit | 從實體 I/O 模組或模擬 I/O 模組的輸入讀取一個位元。 |
|
|
ReadInputByte | 從實體或模擬 I/O 模組的輸入讀取一個位元組。 |
|
|
ReadInputDWord | 從實體或模擬 I/O 模組的輸入讀取一個雙字 (Double Word)。 |
|
|
ReadInputWord | 從實體或模擬 I/O 模組的輸入讀取一個字 (Word)。 |
|
|
ReadIOAlias | 從實體或模擬 I/O 模組中讀取別名索引。 |
|
|
ReadOutputBit | 從實體或模擬 I/O 模組的輸出讀取一個位元。 |
|
|
ReadOutputByte | 從實體或模擬 I/O 模組的輸出讀取一個帶有位元組偏移量的位元組。 |
|
|
ReadOutputDWord | 從實體或模擬 I/O 模組的輸出讀取一個雙字 (Double Word)。 |
|
|
ReadOutputWord | 從實體或模擬 I/O 模組的輸出讀取一個字 (Word)。 |
|
|
WriteIOAlias | 將別名索引寫入實體或模擬 I/O 模組。 |
|
|
WriteOutputBit | 將一個位元寫入實體或模擬 I/O 模組的輸出。 |
|
|
WriteOutputByte | 將一個位元組寫入實體或模擬 I/O 模組的輸出。 |
|
|
WriteOutputDWord | 將一個雙字 (Double Word) 寫入實體或模擬 I/O 模組的輸出。 |
|
|
WriteOutputWord | 將一個字 (Word) 寫入實體或模擬I/O模組的輸出。 |
KINGSTAR 記憶體方法
KINGSTAR 共享記憶體的讀寫。
| 名稱 | 說明 | |
|---|---|---|
|
|
GetMemoryPointer | 取得共享記憶體中資料的串流。 |
|
|
ReadMemoryBit | 從共享記憶體讀取一個位元。 |
|
|
ReadMemoryByte | 從共享記憶體讀取一個位元組。 |
|
|
ReadMemoryDWord | 從共享記憶體讀取一個雙字 (Double Word)。 |
|
|
ReadMemoryLWord | 從共享記憶體讀取一個四倍字 (Quad Word)。 |
|
|
ReadMemoryWord | 從共享記憶體讀取一個字 (Word)。 |
|
|
WriteMemoryBit | 將一個位元寫入共享記憶體。 |
|
|
WriteMemoryByte | 將一個位元組寫入共享記憶體。 |
|
|
WriteMemoryDWord | 將一個雙字 (Double Word) 寫入共享記憶體。 |
|
|
WriteMemoryLWord | 將一個四倍字 (Quad Word) 寫入共享記憶體。 |
|
|
WriteMemoryWord | 將一個字 (Word) 寫入共享記憶體。 |
郵箱方法
進行 EtherCAT 主從站間的資料交換。
| 名稱 | 說明 | |
|---|---|---|
|
|
AoeReadCommand | 透過 AoE (ADS over EtherCAT) 讀取資料。 |
|
|
AoeReadSdoObject | 使用 AoE (ADS over EtherCAT) SDO 方法從從站讀取資料。 |
|
|
AoeReadWriteCommand | 透過 AoE (ADS over EtherCAT) 同時讀寫資料。 |
|
|
AoeWriteCommand |
透過 AoE (ADS over EtherCAT) 寫入資料。 |
|
|
AoeWriteControlCommand | 透過 AoE (ADS over EtherCAT) 傳送命令給裝置。 |
|
|
AoeWriteSdoObject | 使用 AoE (ADS over EtherCAT) SDO 方法將資料寫入從站。 |
|
|
CoeReadSdoEntryDescription | 透過 CoE (CANopen over EtherCAT) 從 SDO 物件讀取物件字典中的項目描述。 |
|
|
CoeReadSdoObject | 透過 CoE (CANopen over EtherCAT) 讀取 SDO 物件值。 |
|
|
CoeReadSdoObjectDescription | 透過 CoE (CANopen over EtherCAT) 讀取 SDO 物件描述。 |
|
|
CoeReadSdoODList | 使用 CoE (CANopen over EtherCAT) SDO 方法讀取字典表中的物件索引清單。 |
|
|
CoeWriteSdoObject | 透過 CoE (CANopen over EtherCAT) 寫入 SDO 物件值。 |
|
|
EoeSetSlaveEoeIp | 配置一個 EtherCAT 從站的 EoE (Ethernet over EtherCAT) 網路設定。 |
|
|
FoeReadFileToBuffer | 從伺服驅動器讀取檔案並將其儲存於使用者應用程式的記憶體空間中。 |
|
|
FoeReadFileToFile | 從伺服驅動器讀取檔案並將其儲存於本機電腦上。 |
|
|
FoeWriteFileFromBuffer | 從本機緩衝區讀取檔案，並將其寫入裝置中。 |
|
|
FoeWriteFileFromFile | 從本機讀取檔案，並將其寫入裝置中。 |
|
|
ReadAxisSdoObject | 從軸讀取 SDO 物件的值。 |
|
|
ReadIOSdoObject | 從 I/O 模組讀取 SDO 物件的值。 |
|
|
RegisterMailboxCallback | 註冊一個函式，當郵箱訊息進來時，KINGSTAR 子系統將呼叫此函式。 |
|
|
SoeReadSsc | 透過 SoE (Servo drive profile over EtherCAT) 將資料從 EtherCAT 從站上傳到 EtherCAT 主站。 |
|
|
SoeWriteSsc | 透過 SoE (Servo drive profile over EtherCAT) 將資料從 EtherCAT 主站下載到 EtherCAT 從站。 |
|
|
VoeWrite | 透過 VoE (Vendor-specific protocol over EtherCAT) 將資料寫入具有 VoE 功能的裝置。 |
|
|
WriteAxisSdoObject | 將 SDO 物件的值寫入軸。 |
|
|
WriteIOSdoObject | 將 SDO 物件的值寫入 I/O 模組。 |
模組式從站方法
將自動配置功能無法偵測到的裝置進行配置。
| 名稱 | 說明 | |
|---|---|---|
|
|
AddModuleConfiguration (CanOpenSetting) |
新增無法被自動配置偵測到的 CANopen 裝置。 |
|
|
AddModuleConfiguration (EcatMdpSetting) | 新增無法被自動配置偵測到的模組式裝置設定檔 (MDP)。 |
|
|
AddModuleConfiguration (El6695Setting) | 新增無法被自動配置偵測到的 EL6695 裝置。 |
|
|
AddModuleConfiguration (EsiSetting) | 手動為裝置選擇一個相容的 ESI 設定檔並覆寫 EtherCAT 自動配置。 |
|
|
AddModuleConfiguration (IoLinkSetting) | 新增無法被自動配置偵測到的 IO-Link 裝置。 |
|
|
AddModuleConfiguration (SafetySetting) | 新增無法被自動配置偵測到的安全裝置。 |
|
|
GetConfiguredModuleCount | 取得已配置裝置的數量。 |
|
|
GetModuleConfiguration | 取得已配置裝置的資訊。 |
|
|
RemoveModuleConfiguration | 移除已配置裝置。 |
模擬硬體方法
配置模擬硬體。
| 名稱 | 說明 | |
|---|---|---|
|
|
ConfigureAxis | 配置模擬軸的設定。 |
|
|
ConfigureIo | 配置模擬 I/O 模組的設定。 |
|
|
GetConfiguredAxesCount | 取得模擬軸的數量。 |
|
|
GetConfiguredIoCount | 取得模擬 I/O 模組的數量。 |
|
|
SetConfiguredAxesCount | 配置模擬軸的數量。 |
|
|
SetConfiguredIoCount | 配置模擬 I/O 模組的數量。 |
從站控制方法
從 EtherCAT 從站讀取及寫入資料。
| 名稱 | 說明 | |
|---|---|---|
|
|
GetSlaveById | 使用 ID 從指定的從站取得詳細訊息。 |
|
|
OverrideSlavePdoConfiguration | 將裝置的輸入和輸出 PDO 長度變更為新的數值。此方法允許您以編程的方式來設定裝置的配置。 |
|
|
ReadAllSlaveEEprom | 從從站讀取所有 EEPROM 資料。 |
|
|
ReadSlaveAlias | 從 EtherCAT 從站讀取別名位址。 |
|
|
ReadSlaveEEprom | 從從站的 EEPROM 讀取一個雙字 (Double Word)。 |
|
|
ReadSlaveRegister | 從 EtherCAT 從站的暫存器讀取資料。 |
|
|
ReloadSlaveEEprom | 重新載入從站的 EEPROM。 |
|
|
RequestSlaveState | 請求 EtherCAT 從站進入指定的 EtherCAT 狀態。 |
|
|
ResetSlaveEsc | 重置從站的 EtherCAT 從站控制器。 |
|
|
RestartSlave | 重啟指定的從站。 |
|
|
WriteAllSlaveEEprom | 將所有資料寫入從站的 EEPROM。 |
|
|
WriteSlaveAlias | 將別名位址寫入 EtherCAT 從站。 |
|
|
WriteSlaveEEprom | 將雙字 (Double Word) 寫入從站的 EEPROM。 |
|
|
WriteSlaveRegister | 將資料寫入 EtherCAT 從站的暫存器。 |
子系統配置方法
配置 KINGSTAR 子系統設定。
| 名稱 | 說明 | |
|---|---|---|
|
|
ConfigureDc | 配置分佈時鐘 (DC) 選項。 |
|
|
EnableAutoConfig | 允許啟用自動配置，自動為伺服驅動器配置 EtherCAT 設定。 |
|
|
EnableAutoRepair | 允許啟用自動修復。 |
|
|
EnableAutoRestart | 允許啟用自動重啟。 |
|
|
EnableHotConnect | 允許在 EtherCAT 網路運行時增加新的硬體。 |
|
|
EnableRedundancy | 啟用線纜冗餘。 |
|
|
EnableServerLog | 在 RTX64 Console 上啟用來自 KINGSTAR Runtime 的連結訊息。 |
|
|
EnableShutdownHandler | 當 EtherCAT 連結被建立時，附上一個關閉處置器 (Shutdown Handler)。 |
|
|
GetFeatureStatus | 從子系統取得某功能的目前狀態。 |
|
|
SetCycleTime | 設定 EtherCAT 週期時間。 |
|
|
SetFeatureStatus | 設定子系統的功能。 |
子系統控制方法
開始、停止和檢查 KINGSTAR 子系統狀態。
| 名稱 | 說明 | |
|---|---|---|
|
|
Create | 準備將程式連結到 KINGSTAR 子系統。 |
|
|
CreateAsync | 準備將程式以非同步作業方式連結到 KINGSTAR 子系統。 |
|
|
Destroy | 關閉與 KINGSTAR 子系統的連結並停用子系統。 |
|
|
DestroyAsync | 以非同步作業方式關閉與 KINGSTAR 子系統的連結並停用子系統。 |
|
|
Dispose | 中斷應用程式與 KINGSTAR 的連線並釋放所有未處理的資源。當不再需要使用實例時，呼叫 Dispose 方法是至關重要的。 |
|
|
EnableAliases | 在所有方法中啟用軸和 I/O 索引參數的別名索引。 |
|
|
GetAliasesStatus | 檢查程式是否已透過 EnableAliases 啟用別名。 |
|
|
GetDCSystemTime | 取得分佈時鐘 (DC) 選定的 Sync0 訊號的時間戳記。 |
|
|
GetStatus | 取得 EtherCAT 連結的狀態。 |
|
|
GetStatusEx | 取得 EtherCAT 連接的延伸狀態。 |
|
|
Log | 將指定資料記錄到記錄檔共享記憶體中。 |
|
|
RegisterCallback | 註冊一個方法，當新資料進來時，KINGSTAR 子系統會在每個週期呼叫此方法。 |
|
|
RequestState | 請求 KINGSTAR 子系統進入到一個特定的 EtherCAT 狀態。 |
|
|
Restart | 重啟 EtherCAT 主站。 |
|
|
Start | 啟動 KINGSTAR 子系統。 |
|
|
StartFromConfiguration | 使用由 KINGSTAR 設定工具 建構出的配置檔案來啟動 KINGSTAR 子系統。 |
|
|
Stop | 停用 EtherCAT 網路和 KINGSTAR 子系統。 |
|
|
StopLog | 停止將指定資料記錄到記錄共享記憶體中。 |
|
|
SubsystemIsRunning | 允許用戶在不啟動 KINGSTAR 子系統 下檢查 KINGSTAR 子系統處理程序是否正在運行，此方法可在 Create 前及 Destroy 後使用。 |
|
|
Unlink | 在不停用 KINGSTAR 子系統的情況下中斷應用程式與 KINGSTAR 的連結。 |
觸發方法
設定或取得一個用來開始一項新移動的觸發。
| 名稱 | 說明 | |
|---|---|---|
|
|
GetTrigger | 取得觸發的詳細資訊。 |
|
|
SetTrigger | 配置一個觸發。 |
變數表方法
允許使用者自定義變數，以用於使用者自己的應用程式及 KINGSTAR 工具。
| 名稱 | 說明 | |
|---|---|---|
|
|
AddVariable | 新增一個使用者定義變數。 |
|
|
GetVariable | 取得使用者定義變數的細節。 |
|
|
GetVariables | 取得使用者定義變數的清單。 |
|
|
ReadBoolVariable | 從變數中讀取 bool 值。 |
|
|
ReadByteVariable | 從變數中讀取 8 位元無符號整數值。 |
|
|
ReadDIntVariable | 從變數中讀取整數值。 |
|
|
ReadDoubleVariable | 從變數中讀取 double 值。 |
|
|
ReadDWordVariable | 從變數中讀取無符號整數值。 |
|
|
ReadFloatVariable | 從變數中讀取 float 值。 |
|
|
ReadIntVariable | 從變數中讀取短整數值。 |
|
|
ReadLIntVariable | 從變數中讀取長整數值。 |
|
|
ReadLWordVariable | 從變數中讀取無符號長整數值。 |
|
|
ReadRawVariable | 從變數中讀取一個 byte 陣列。 |
|
|
ReadSIntVariable | 從變數中讀取 8 位元整數值。 |
|
|
ReadWordVariable | 從變數中讀取無符號短整數值。 |
|
|
RemoveVariable | 移除一個使用者定義變數。 |
|
|
WriteVariable (bool) | 將一個 bool 值寫入變數。 |
|
|
WriteVariable (byte) | 將一個 8 位元無符號整數值寫入變數。 |
|
|
WriteVariable (byte[]) | 將一個 byte 陣列寫入變數。 |
|
|
WriteVariable (double) | 將一個 double 值寫入變數。 |
|
|
WriteVariable (float) | 將一個 float 值寫入變數。 |
|
|
WriteVariable (int) | 將一個 int 值寫入變數。 |
|
|
WriteVariable (long) | 將一個長整數值寫入變數。 |
|
|
WriteVariable (sbyte) | 將一個 8 位元整數值寫入變數。 |
|
|
WriteVariable (short) | 將一個短整數值寫入變數。 |
|
|
WriteVariable (uint) | 將一個無符號整數值寫入變數。 |
|
|
WriteVariable (ulong) | 將一個無符號長整數值寫入變數。 |
|
|
WriteVariable (ushort) | 將一個無符號短整數值寫入變數。 |
參見