Home/Comm/EnIP/Scanner
Comm · EnIP

Scanner

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

public API19 functions

Import

from Xenonix.Comm.EnIP import Scanner

Scanner.Config()
Scanner.Add('Robot_Data')
Scanner.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, IP, Datatype='USINT', T_O_Length=4, O_T_Length=4, Config_Length=4, T_O_Instance=100, O_T_Instance=101, Config_Instance=102, Config_Data=None, Connection_Type='Exclusive_Owner', T_O_RPI=20000, O_T_RPI=20000, Inhibit=False, T_O_Header=False, O_T_Header=True, Run=True, Unicast=True, Implicit=True, Connected_Explicit=False, Connected_Explicit_Time=False, Timeout_Multiplier=16, Trigger='Cyclic', Priority=2, Variable_Size=False, Owner_Redundant=False, Vendor_ID=0, Device_Type=0, Product_Code=0, Major_Revision=0, Minor_Revision=0, Key_Format=0)

Arguments

Argument Default Accepted values What it does
Name Required Any valid value Display/name identifier.
IP Required Any valid value IP value used by the operation.
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.
Config_Data None Any valid value Config Data value used by the operation.
Connection_Type 'Exclusive_Owner' Listen_Only Mode/value selector for connection type.
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.
T_O_Header False Any valid value Turns t o header on or off.
O_T_Header True Any valid value Turns o t header on or off.
Run True Any valid value Turns run on or off.
Unicast True Any valid value Turns unicast on or off.
Implicit True Any valid value Turns implicit on or off.
Connected_Explicit False Any valid value Turns connected explicit on or off.
Connected_Explicit_Time False Any valid value Turns connected explicit time on or off.
Timeout_Multiplier 16 Any valid value Timeout Multiplier value used by the operation.
Trigger 'Cyclic' Any valid value Trigger value used by the operation.
Priority 2 Any valid value Priority value used by the operation.
Variable_Size False Any valid value Turns variable size on or off.
Owner_Redundant False Any valid value Turns owner redundant on or off.
Vendor_ID 0 Any valid value Vendor ID value used by the operation.
Device_Type 0 Any valid value Device Type value used by the operation.
Product_Code 0 Any valid value Product Code value used by the operation.
Major_Revision 0 Any valid value Major Revision value used by the operation.
Minor_Revision 0 Any valid value Minor Revision value used by the operation.
Key_Format 0 Any valid value Key Format value used by the operation.

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.Scanner.

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.

Info

Runs the Info operation for Comm.EnIP.Scanner.

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.Scanner.

Inhibit(Name, Value=None)

Arguments

Argument Default Accepted values What it does
Name Required 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.Scanner.

Library()

Arguments

No arguments.

Output

Returns structured data such as a list or dictionary.

Log

Runs the Log operation for Comm.EnIP.Scanner.

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.

Message

Runs the Message operation for Comm.EnIP.Scanner.

Message(Name, Class, Instance, Attribute, Value=None)

Arguments

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

Output

Returns structured data such as a list or dictionary.

Pack

Runs the Pack operation for Comm.EnIP.Scanner.

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.

Register

Runs the Register operation for Comm.EnIP.Scanner.

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 Required Any valid value Display/name identifier.

Output

Returns True/False to indicate success.

Reset

Runs the Reset operation for Comm.EnIP.Scanner.

Reset(Name=None)

Arguments

Argument Default Accepted values What it does
Name None Any valid value 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.

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.Scanner.

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.Scanner.

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.Scanner.

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.