Api 类别

代表 EtherCAT 的设定。

继承体系

System.Object
IntervalZero.KINGSTAR.OpcUa.Api

命名空间：IntervalZero.KINGSTAR.OpcUa.Api

组合： IntervalZero.KINGSTAR.OpcUa.Api (于 IntervalZero.KINGSTAR.OpcUa.Client.dll) 版本：4.4.0.0

语法

C#VB

public class Api

Public 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 驱动器设定资料传输模式。

命令方法

等待、取消及取得函式状态的命令。

	名称	说明
	AbortCommand	取消命令。
	AbortCommand (byte[])	取消命令。
	AbortCommand (byte)	取消命令。
	AbortCommand (double)	取消命令。
	AbortCommand (int)	取消命令。
	AbortCommand (long)	取消命令。
	AbortCommand (SdoEntryDescription)	取消命令。
	AbortCommand (SdoObjectDescription)	取消命令。
	AbortCommand (short)	取消命令。
	AbortCommand (uint)	取消命令。
	AbortCommand (ulong)	取消命令。
	AbortCommand (ushort[])	取消命令。
	AbortCommand (ushort)	取消命令。
	GetCommandsStatus	取得命令状态。
	GetCommandStatus	取得命令状态。
	GetCommandStatus (byte[])	取得命令状态。
	GetCommandStatus (byte)	取得命令状态。
	GetCommandStatus (double)	取得命令状态。
	GetCommandStatus (int)	取得命令状态。
	GetCommandStatus (long)	取得命令状态。
	GetCommandStatus (SdoEntryDescription)	取得命令状态。
	GetCommandStatus (SdoObjectDescription)	取得命令状态。
	GetCommandStatus (short)	取得命令状态。
	GetCommandStatus (uint)	取得命令状态。
	GetCommandStatus (ulong)	取得命令状态。
	GetCommandStatus (ushort[])	取得命令状态。
	GetCommandStatus (ushort)	取得命令状态。
	WaitForCommand	等待命令完成。
	WaitForCommand (byte[])	等待命令完成。
	WaitForCommand (byte)	等待命令完成。
	WaitForCommand (double)	等待命令完成。
	WaitForCommand (int)	等待命令完成。
	WaitForCommand (long)	等待命令完成。
	WaitForCommand (SdoEntryDescription)	等待命令完成。
	WaitForCommand (SdoObjectDescription)	等待命令完成。
	WaitForCommand (short)	等待命令完成。
	WaitForCommand (uint)	等待命令完成。
	WaitForCommand (ulong)	等待命令完成。
	WaitForCommand (ushort[])	等待命令完成。
	WaitForCommand (ushort)	等待命令完成。
	WaitForCommandAsync	以非同步作业等待命令完成。
	WaitForCommandAsync (byte[])	以非同步作业等待命令完成。
	WaitForCommandAsync (byte)	以非同步作业等待命令完成。
	WaitForCommandAsync (double)	以非同步作业等待命令完成。
	WaitForCommandAsync (int)	以非同步作业等待命令完成。
	WaitForCommandAsync (long)	以非同步作业等待命令完成。
	WaitForCommandAsync (SdoEntryDescription)	以非同步作业等待命令完成。
	WaitForCommandAsync (SdoObjectDescription)	以非同步作业等待命令完成。
	WaitForCommandAsync (short)	以非同步作业等待命令完成。
	WaitForCommandAsync (uint)	以非同步作业等待命令完成。
	WaitForCommandAsync (ulong)	以非同步作业等待命令完成。
	WaitForCommandAsync (ushort[])	以非同步作业等待命令完成。
	WaitForCommandAsync (ushort)	以非同步作业等待命令完成。

除错方法

传送记录档讯息至您的 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 子系统状态。

	名称	说明
	Connect	连接到 Runtime 电脑。第一个呼叫的 API。
	Create	准备将程式连结到 KINGSTAR 子系统。
	CreateAsync	准备将程式以非同步作业方式连结到 KINGSTAR 子系统。
	Destroy	关闭与 KINGSTAR 子系统的连结并停用子系统。
	DestroyAsync	以非同步作业方式关闭与 KINGSTAR 子系统的连结并停用子系统。
	Disconnect	停止连接到 Runtime 电脑。
	EnableAliases	在所有方法中启用轴和 I/O 索引参数的别名索引。
	GetAliasesStatus	检查程式是否已透过 EnableAliases 启用别名。
	GetDCSystemTime	取得分布时钟 (DC) 选定的 Sync0 讯号的时间戳记。
	GetStatus	取得 EtherCAT 连结的状态。
	GetStatusEx	取得 EtherCAT 连接的延伸状态。
	Log	将指定资料记录到记录档共享记忆体中。
	ReadLogData	此方法被定义在远端介面中，可使用此方法从 Runtime 电脑读取已记录的资料。
	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)	将一个无符号短整数值写入变数。

参见

IntervalZero.KINGSTAR.OpcUa.Api 命名空间