Home / Comm / EnIP / Adapter
Comm · EnIP

Adapter

Adapter API for EtherNet/IP communication. Use this page as the main reference for available functions, arguments, and expected outputs.

public API 53 functions

Import

from Xenonix.Comm.EnIP import Adapter

Adapter.Config()
Adapter.Add('Input_Data')
Adapter.Start()

Search this page

Filter functions, arguments, and configuration keys on this page.

Functions

Add

Adds a new item to the object or UI.

Add(Name, Datatype='USINT', T_O_Length=4, O_T_Length=4, Config_Length=4, T_O_Instance=100, O_T_Instance=101, Config_Instance=102, Input_Only_Instance=253, Listen_Only_Instance=254, T_O_RPI=20000, O_T_RPI=20000, Inhibit=False, O_T_Header=False, T_O_Header=False, Run=True, Honor_Originator_Instances=False, Honor_Originator_Sizes=False, Accept_Variable_Length=False, Allow_Owner_Redundant=False)

Arguments

Argument Default Accepted values What it does
Name Required Any valid value Display/name identifier.
Datatype 'USINT' Any valid value Datatype value used by the operation.
T_O_Length 4 Any valid value T O Length value used by the operation.
O_T_Length 4 Any valid value O T Length value used by the operation.
Config_Length 4 Any valid value Config Length value used by the operation.
T_O_Instance 100 Any valid value T O Instance value used by the operation.
O_T_Instance 101 Any valid value O T Instance value used by the operation.
Config_Instance 102 Any valid value Config Instance value used by the operation.
Input_Only_Instance 253 Any valid value Input Only Instance value used by the operation.
Listen_Only_Instance 254 Any valid value Listen Only Instance value used by the operation.
T_O_RPI 20000 Any valid value T O RPI value used by the operation.
O_T_RPI 20000 Any valid value O T RPI value used by the operation.
Inhibit False Any valid value Turns inhibit on or off.
O_T_Header False Any valid value Turns o t header on or off.
T_O_Header False Any valid value Turns t o header on or off.
Run True Any valid value Turns run on or off.
Honor_Originator_Instances False Any valid value Turns honor originator instances on or off.
Honor_Originator_Sizes False Any valid value Turns honor originator sizes on or off.
Accept_Variable_Length False Any valid value Turns accept variable length on or off.
Allow_Owner_Redundant False Any valid value Turns allow owner redundant on or off.

Output

Returns True/False to indicate success.

Clear_Ethernet_Counters

Clears stored data, selection, or visible content.

Clear_Ethernet_Counters()

Arguments

No arguments.

Output

Returns True/False to indicate success.

Config

Changes one or more supported settings. Pass only the configuration keys you want to update.

Config(IP='0.0.0.0', Name=None, Callback_Pool=None, Vendor_Id=None, Product_Type=None, Product_Code=None, Revision_Major=None, Revision_Minor=None, Product_Name=None, Serial_Number=None)

Arguments

Argument Default Accepted values What it does
IP '0.0.0.0' 0.0.0.0 Mode/value selector for ip.
Name None Any valid value Display/name identifier.
Callback_Pool None Any valid value Callback Pool value used by the operation.
Vendor_Id None Any valid value Vendor Id value used by the operation.
Product_Type None Any valid value Product Type value used by the operation.
Product_Code None Any valid value Product Code value used by the operation.
Revision_Major None Any valid value Revision Major value used by the operation.
Revision_Minor None Any valid value Revision Minor value used by the operation.
Product_Name None Any valid value Product Name value used by the operation.
Serial_Number None Any valid value Serial Number value used by the operation.

Output

Updates configuration values on the object.

From_Bits

Runs the From_Bits operation for Comm.EnIP.Adapter.

From_Bits(Bits, Datatype=None)

Arguments

Argument Default Accepted values What it does
Bits Required Any valid value Spatial bit depth used by Morton/Z-order organization.
Datatype None Any valid value Datatype value used by the operation.

Output

Returns the calculated result.

Get_Ethernet_Capabilities

Returns a specific value.

Get_Ethernet_Capabilities()

Arguments

No arguments.

Output

Returns the requested value.

Get_Ethernet_Control

Returns a specific value.

Get_Ethernet_Control()

Arguments

No arguments.

Output

Returns the requested value.

Get_Ethernet_Counters

Returns a specific value.

Get_Ethernet_Counters()

Arguments

No arguments.

Output

Returns the requested value.

Get_Ethernet_States

Returns a specific value.

Get_Ethernet_States()

Arguments

No arguments.

Output

Returns the requested value.

Get_Ethernet_Status_Flags

Returns a specific value.

Get_Ethernet_Status_Flags()

Arguments

No arguments.

Output

Returns the requested value.

Get_LLDP

Returns a specific value.

Get_LLDP()

Arguments

No arguments.

Output

Returns the requested value.

Get_Port

Returns a specific value.

Get_Port()

Arguments

No arguments.

Output

Returns the requested value.

Get_Tcp_Acd

Returns a specific value.

Get_Tcp_Acd()

Arguments

No arguments.

Output

Returns the requested value.

Get_Tcp_Capabilities

Returns a specific value.

Get_Tcp_Capabilities()

Arguments

No arguments.

Output

Returns the requested value.

Get_Tcp_Interface

Returns a specific value.

Get_Tcp_Interface()

Arguments

No arguments.

Output

Returns the requested value.

Get_Tcp_Multicast

Returns a specific value.

Get_Tcp_Multicast()

Arguments

No arguments.

Output

Returns the requested value.

Get_Tcp_Port

Returns a specific value.

Get_Tcp_Port()

Arguments

No arguments.

Output

Returns the requested value.

Get_Tcp_Quick_Connect

Returns a specific value.

Get_Tcp_Quick_Connect()

Arguments

No arguments.

Output

Returns the requested value.

Get_Tcp_Safety

Returns a specific value.

Get_Tcp_Safety()

Arguments

No arguments.

Output

Returns the requested value.

Get_Tcp_Status_Info

Returns a specific value.

Get_Tcp_Status_Info()

Arguments

No arguments.

Output

Returns the requested value.

Get_Tcp_Timeout

Returns a specific value.

Get_Tcp_Timeout()

Arguments

No arguments.

Output

Returns the requested value.

Info

Runs the Info operation for Comm.EnIP.Adapter.

Info(Adapter=None)

Arguments

Argument Default Accepted values What it does
Adapter None Adapter Mode/value selector for adapter.

Output

Returns structured data such as a list or dictionary.

Inhibit

Runs the Inhibit operation for Comm.EnIP.Adapter.

Inhibit(Name='', Value=None)

Arguments

Argument Default Accepted values What it does
Name '' Any valid value Display/name identifier.
Value None Any valid value Value to set or process.

Output

Returns True/False to indicate success.

Library

Runs the Library operation for Comm.EnIP.Adapter.

Library()

Arguments

No arguments.

Output

Returns structured data such as a list or dictionary.

Log

Runs the Log operation for Comm.EnIP.Adapter.

Log(Adapter=None)

Arguments

Argument Default Accepted values What it does
Adapter None Any valid value Adapter value used by the operation.

Output

Returns the calculated result.

Pack

Runs the Pack operation for Comm.EnIP.Adapter.

Pack(Values, Datatype)

Arguments

Argument Default Accepted values What it does
Values Required Any valid value Values value used by the operation.
Datatype Required Any valid value Datatype value used by the operation.

Output

Returns the calculated result.

Read

Reads data from a file path.

Read(Name, Index=None)

Arguments

Argument Default Accepted values What it does
Name Required Any valid value Display/name identifier.
Index None Any valid value Index value used by the operation.

Output

Returns success/status or the operation result.

Register

Runs the Register operation for Comm.EnIP.Adapter.

Register(Event=None, Callback=None)

Arguments

Argument Default Accepted values What it does
Event None Any valid value Event value used by the operation.
Callback None Any valid value Optional callback function called during processing.

Output

Returns True/False to indicate success.

Remove

Removes the requested item.

Remove(Name='')

Arguments

Argument Default Accepted values What it does
Name '' Adapter Display/name identifier.

Output

Returns True/False to indicate success.

Reset

Runs the Reset operation for Comm.EnIP.Adapter.

Reset(Name='')

Arguments

Argument Default Accepted values What it does
Name '' Adapter Display/name identifier.

Output

Returns success/status or the operation result.

Run

Runs the main operation and returns the detected/calculated result.

Run(Name='', Value=None)

Arguments

Argument Default Accepted values What it does
Name '' Any valid value Display/name identifier.
Value None Any valid value Value to set or process.

Output

Returns success/status or the operation result.

Set_Ethernet_Capabilities

Sets a specific value.

Set_Ethernet_Capabilities(Capability=None, Capability_Type=None)

Arguments

Argument Default Accepted values What it does
Capability None Any valid value Capability value used by the operation.
Capability_Type None Any valid value Capability Type value used by the operation.

Output

Sets the value and returns the updated object or status.

Set_Ethernet_Control

Sets a specific value.

Set_Ethernet_Control(Auto_Negotiate=None, Duplex_Mode=None, Forced_Speed=None, Interface_Speed=None)

Arguments

Argument Default Accepted values What it does
Auto_Negotiate None Any valid value Auto Negotiate value used by the operation.
Duplex_Mode None Any valid value Duplex Mode value used by the operation.
Forced_Speed None Any valid value Forced Speed value used by the operation.
Interface_Speed None Any valid value Interface Speed value used by the operation.

Output

Sets the value and returns the updated object or status.

Set_Ethernet_States

Sets a specific value.

Set_Ethernet_States(Admin_State=None, Interface_State=None)

Arguments

Argument Default Accepted values What it does
Admin_State None Any valid value Admin State value used by the operation.
Interface_State None Any valid value Interface State value used by the operation.

Output

Sets the value and returns the updated object or status.

Set_Ethernet_Status_Flags

Sets a specific value.

Set_Ethernet_Status_Flags(Link_Status=None, Duplex_Status=None, Negotiation_Status=None, Manual_Reset=None, Hardware_Fault=None)

Arguments

Argument Default Accepted values What it does
Link_Status None Any valid value Link Status value used by the operation.
Duplex_Status None Any valid value Duplex Status value used by the operation.
Negotiation_Status None Any valid value Negotiation Status value used by the operation.
Manual_Reset None Any valid value Manual Reset value used by the operation.
Hardware_Fault None Any valid value Hardware Fault value used by the operation.

Output

Sets the value and returns the updated object or status.

Set_LLDP

Sets a specific value.

Set_LLDP(Enable_Length=None, Enable=None, Tx_Interval=None, Tx_Hold_Multiplier=None)

Arguments

Argument Default Accepted values What it does
Enable_Length None Any valid value Enable Length value used by the operation.
Enable None Any valid value Enable value used by the operation.
Tx_Interval None Any valid value Tx Interval value used by the operation.
Tx_Hold_Multiplier None Any valid value Tx Hold Multiplier value used by the operation.

Output

Sets the value and returns the updated object or status.

Set_Tcp_Acd

Sets a specific value.

Set_Tcp_Acd(Select=None, Activity=None, Remote_Mac=None, Hw_Type=None, Protocol=None, Hw_Size=None, Prot_Size=None, Opcode=None, Sender_Mac=None, Sender_Ip=None, Target_Mac=None, Target_Ip=None)

Arguments

Argument Default Accepted values What it does
Select None Any valid value Select value used by the operation.
Activity None Any valid value Activity value used by the operation.
Remote_Mac None Any valid value Remote Mac value used by the operation.
Hw_Type None Any valid value Hw Type value used by the operation.
Protocol None Any valid value Protocol value used by the operation.
Hw_Size None Any valid value Hw Size value used by the operation.
Prot_Size None Any valid value Prot Size value used by the operation.
Opcode None Any valid value Opcode value used by the operation.
Sender_Mac None Any valid value Sender Mac value used by the operation.
Sender_Ip None Any valid value Sender Ip value used by the operation.
Target_Mac None Any valid value Target Mac value used by the operation.
Target_Ip None Any valid value Target Ip value used by the operation.

Output

Sets the value and returns the updated object or status.

Set_Tcp_Capabilities

Sets a specific value.

Set_Tcp_Capabilities(Bootp=None, Dhcp=None, Field_Settable=None, Hardware_Switch=None, Config_Settable=None, Acd=None)

Arguments

Argument Default Accepted values What it does
Bootp None Any valid value Bootp value used by the operation.
Dhcp None Any valid value Dhcp value used by the operation.
Field_Settable None Any valid value Field Settable value used by the operation.
Hardware_Switch None Any valid value Hardware Switch value used by the operation.
Config_Settable None Any valid value Config Settable value used by the operation.
Acd None Any valid value Acd value used by the operation.

Output

Sets the value and returns the updated object or status.

Set_Tcp_Interface

Sets a specific value.

Set_Tcp_Interface(Status=None, Control_Method=None, Control_DNS=None, Domain_Name=None, Hostname=None, Netmask=None, Gateway=None, Primary_Dns=None, Secondary_Dns=None)

Arguments

Argument Default Accepted values What it does
Status None Any valid value Status value used by the operation.
Control_Method None Any valid value Control Method value used by the operation.
Control_DNS None Any valid value Control DNS value used by the operation.
Domain_Name None Any valid value Domain Name value used by the operation.
Hostname None Any valid value Hostname value used by the operation.
Netmask None Any valid value Netmask value used by the operation.
Gateway None Any valid value Gateway value used by the operation.
Primary_Dns None Any valid value Primary Dns value used by the operation.
Secondary_Dns None Any valid value Secondary Dns value used by the operation.

Output

Sets the value and returns the updated object or status.

Set_Tcp_Multicast

Sets a specific value.

Set_Tcp_Multicast(Alloc_Control=None, Num_Addrs=None, Start_Addr=None, TTL=None)

Arguments

Argument Default Accepted values What it does
Alloc_Control None Any valid value Alloc Control value used by the operation.
Num_Addrs None Any valid value Num Addrs value used by the operation.
Start_Addr None Any valid value Start Addr value used by the operation.
TTL None Any valid value TTL value used by the operation.

Output

Sets the value and returns the updated object or status.

Set_Tcp_Port

Sets a specific value.

Set_Tcp_Port(Port_Number=None)

Arguments

Argument Default Accepted values What it does
Port_Number None Any valid value Port Number value used by the operation.

Output

Sets the value and returns the updated object or status.

Set_Tcp_Quick_Connect

Sets a specific value.

Set_Tcp_Quick_Connect(Enabled=None)

Arguments

Argument Default Accepted values What it does
Enabled None Any valid value Enabled value used by the operation.

Output

Sets the value and returns the updated object or status.

Set_Tcp_Safety

Sets a specific value.

Set_Tcp_Safety(Network_Number_List=None, Network_Number_Int=None)

Arguments

Argument Default Accepted values What it does
Network_Number_List None Any valid value Network Number List value used by the operation.
Network_Number_Int None Any valid value Network Number Int value used by the operation.

Output

Sets the value and returns the updated object or status.

Set_Tcp_Status_Info

Sets a specific value.

Set_Tcp_Status_Info(Mcast_Config=None, Acd_Status=None)

Arguments

Argument Default Accepted values What it does
Mcast_Config None Any valid value Mcast Config value used by the operation.
Acd_Status None Any valid value Acd Status value used by the operation.

Output

Sets the value and returns the updated object or status.

Set_Tcp_Timeout

Sets a specific value.

Set_Tcp_Timeout(Seconds=None)

Arguments

Argument Default Accepted values What it does
Seconds None Any valid value Seconds value used by the operation.

Output

Sets the value and returns the updated object or status.

Start

Starts the process or connection.

Start()

Arguments

No arguments.

Output

Returns success/status or the operation result.

Stop

Stops the process or connection.

Stop()

Arguments

No arguments.

Output

Returns success/status or the operation result.

To_Bits

Runs the To_Bits operation for Comm.EnIP.Adapter.

To_Bits(Value, Datatype=None)

Arguments

Argument Default Accepted values What it does
Value Required Any valid value Value to set or process.
Datatype None Any valid value Datatype value used by the operation.

Output

Returns the calculated result.

Unpack

Runs the Unpack operation for Comm.EnIP.Adapter.

Unpack(Blob, Datatype)

Arguments

Argument Default Accepted values What it does
Blob Required Any valid value Blob value used by the operation.
Datatype Required Any valid value Datatype value used by the operation.

Output

Returns structured data such as a list or dictionary.

Update

Runs the Update operation for Comm.EnIP.Adapter.

Update(Name, **kwargs)

Arguments

Argument Default Accepted values What it does
Name Required Any valid value Display/name identifier.
kwargs **kwargs Any valid value Additional values passed to the operation.

Output

Updates the object or visible UI state.

Write

Writes the current data to a file path.

Write(Name, Value, Index=None)

Arguments

Argument Default Accepted values What it does
Name Required Any valid value Display/name identifier.
Value Required Any valid value Value to set or process.
Index None Any valid value Index value used by the operation.

Output

Returns success/status or the operation result.