MiConnect: Plugins: Difference between revisions

From Knowledge Base
No edit summary
 
(2 intermediate revisions by 2 users not shown)
Line 4: Line 4:
The Plug-in manager allows creating, editing and deleting of Tool connect plug-ins. Any plug-ins configured are available for use in the routine editor.
The Plug-in manager allows creating, editing and deleting of Tool connect plug-ins. Any plug-ins configured are available for use in the routine editor.


== '''Parser Types''' ==
== Parser Types ==
Some plug-ins require a parser type to be selected in order to determine how the data received is processed and formatted by Tool Connect. The following parser types are available:
Some plug-ins require a parser type to be selected in order to determine how the data received is processed and formatted by Tool Connect. The following parser types are available:
*Positional: Allows parsing in sections of bytes. Each section has a start index and a length
*Positional: Allows parsing in sections of bytes. Each section has a start index and a length
Line 11: Line 11:
*JSON: Allows parsing JSON objects based on JSON V2 schema
*JSON: Allows parsing JSON objects based on JSON V2 schema


== '''RFID Reader''' ==
== RFID Reader ==
The RFID Reader plug-in configures communication between Tool Connect and RFID chip readers. Tool Connect supports the following RFID readers:
The RFID Reader plug-in configures communication between Tool Connect and RFID chip readers. Tool Connect supports the following RFID readers:
*Balluff - The following models are available:
*Balluff - The following models are available:
Line 23: Line 23:
'''Note:''' RFID Reader plug-in settings may vary per RFID reader model
'''Note:''' RFID Reader plug-in settings may vary per RFID reader model


=== '''Basic Info''' ===
=== Basic Info ===
The basic info page displays the plug-in type and RFID reader model number. The Plugin name and description can be edited here.[[File:Screen Shot 2022-09-16 at 2.32.19 PM.png|center|thumb|480x480px]]
The basic info page displays the plug-in type and RFID reader model number. The Plugin name and description can be edited here.[[File:Screen Shot 2022-09-16 at 2.32.19 PM.png|center|thumb|480x480px]]


== '''File Reader''' ==
== File Reader ==
The file reader plug-in establishes directories that Tool Connect can access to perform various file operations, including but not limited to reading and writing files. When a file event occurs, Tool Connect can automatically parse and format the file contents into a preconfigured data structure for use in Tool Connect.
The file reader plug-in establishes directories that Tool Connect can access to perform various file operations, including but not limited to reading and writing files. When a file event occurs, Tool Connect can automatically parse and format the file contents into a preconfigured data structure for use in Tool Connect.


=== '''Basic Info''' ===
=== Basic Info ===
The basic info page displays the plug-in type. The plug-in name and description can be edited here.[[File:Screen Shot 2022-09-16 at 2.41.36 PM.png|center|thumb|551x551px|File Reader - Basic Info]]
The basic info page displays the plug-in type. The plug-in name and description can be edited here.[[File:Screen Shot 2022-09-16 at 2.41.36 PM.png|center|thumb|551x551px|File Reader - Basic Info]]


=== '''Directories''' ===
=== Directories ===
The directories page is used to establish which directories Tool Connect can access to perform various file operations.[[File:Screen Shot 2022-09-16 at 2.42.50 PM.png|center|thumb|483x483px|File Reader - Directories]]
The directories page is used to establish which directories Tool Connect can access to perform various file operations.[[File:Screen Shot 2022-09-16 at 2.42.50 PM.png|center|thumb|483x483px|File Reader - Directories]]


=== '''File Watchers''' ===
=== File Watchers ===
The File Watchers page configures file watchers that monitor specified directories for any file changes. If a file pattern is specified, the file watcher will only process new files that match the file pattern. The file watcher settings are as follows:
The File Watchers page configures file watchers that monitor specified directories for any file changes. If a file pattern is specified, the file watcher will only process new files that match the file pattern. The file watcher settings are as follows:
*Name: Represents how the file watcher is displayed in Tool Connect
*Name: Represents how the file watcher is displayed in Tool Connect
Line 47: Line 47:
[[File:Screen Shot 2022-09-16 at 2.51.09 PM.png|center|thumb|553x553px|File Reader - File Watchers]]
[[File:Screen Shot 2022-09-16 at 2.51.09 PM.png|center|thumb|553x553px|File Reader - File Watchers]]


=== '''Parsers''' ===
=== Parsers ===
Parsers are used to automatically parse and format the file contents processed by the file reader into a preconfigured data structure.[[File:Screen Shot 2022-09-16 at 2.51.57 PM.png|center|thumb|553x553px|File Reader - Parsers]]
Parsers are used to automatically parse and format the file contents processed by the file reader into a preconfigured data structure.[[File:Screen Shot 2022-09-16 at 2.51.57 PM.png|center|thumb|553x553px|File Reader - Parsers]]


== '''I/O Interface''' ==
== I/O Interface ==
The I/O Interface plug-in establishes communication between Tool Connect and compatible I/O devices.
The I/O Interface plug-in establishes communication between Tool Connect and compatible I/O devices.


=== '''Basic Info''' ===
=== Basic Info ===
The basic info page displays the plug-in type. The plug-in name and description can be edited here.
The basic info page displays the plug-in type. The plug-in name and description can be edited here.
[[File:Screen Shot 2022-09-16 at 3.27.28 PM.png|center|thumb|773x773px|I/O Interface - Basic Information]]
[[File:Screen Shot 2022-09-16 at 3.27.28 PM.png|center|thumb|773x773px|I/O Interface - Basic Information]]


=== '''ADU Configuration (Ontrak ADU208)''' ===
=== ADU Configuration (Ontrak ADU208) ===
The ADU configuration page determines which Ontrak ADU device that Tool Connect is communicating with. The settings are as follows:  
The ADU configuration page determines which Ontrak ADU device that Tool Connect is communicating with. The settings are as follows:  


Line 63: Line 63:
* Device Serial Number: The serial number located on the Ontrak ADU device.
* Device Serial Number: The serial number located on the Ontrak ADU device.


== '''CEI CNC Machine''' ==
== CEI CNC Machine ==
CEI CNC Machine plug-in is used to establish communications between Tool Connect and various CNC Machines. When creating a CNC machine plug-in, a server must be selected for communication to be established. The following CNC machines are compatibility with Tool Connect:


=== '''Basic Info''' ===
* Brother
* Fagor
* Fanuc
* Heidenhain
* Mazak
* Mitsubishi
* Mori
* Okuma
* Siemens


=== '''CNC Settings''' ===
=== Basic Info ===
The basic info page displays the plug-in and CNC types. The plug-in name and description can be edited here.
[[File:Screen Shot 2022-09-16 at 3.34.56 PM.png|center|thumb|589x589px|CNC Machine - Basic Information]]


=== '''Network Configuration''' ===
=== CNC Settings ===
The CNC settings page determines which CNC features from the selected CNC type are available in Tool Connect. The settings available on this page vary depending on the CNC selected.
[[File:Screen Shot 2022-09-16 at 3.35.45 PM.png|center|thumb|668x668px|CNC Machine - CNC Settings (Fanuc Settings pictured)]]
 
=== Network Configuration ===
The network configuration page establishes network communication settings for the CNC. The settings are as follows:
 
* IP Address / Host name: IP Address or host name of the CNC
* Port Number: Port number of the CNC server
* Default Timeout: The default timeout for CNC commands, input in ms
 
[[File:Screen Shot 2022-09-16 at 3.37.48 PM.png|center|thumb|644x644px|CNC Machine - Network Configuration]]
 
== Serial Port ==
 
=== Basic Info ===
The basic info page displays the plug-in and CNC types. The plug-in name and description can be edited here.
[[File:Screen Shot 2022-09-16 at 3.39.50 PM.png|center|thumb|504x504px|Serial Port - Basic Information]]
 
=== Port Configuration ===
The port configuration page establishes serial communication settings for communication via serial port. The settings are as follows:
 
* Serial Port
* Baud Rate
* Parity
* Stop Bits
* Data Bits
* Flow Control
 
[[File:Screen Shot 2022-09-16 at 3.42.22 PM.png|center|thumb|661x661px|Serial Port - Port Configuration]]
'''Note:''' The port settings must match the serial port settings on connected serial device for communication to be established.
 
=== Reading ===
The Reading page establishes the format for readable serial through the selected serial port. The settings are as follows:
 
* Enable Reading - Enables reading serial strings through the selected serial port
* Read Length - the length of characters to be read as a complete packet
* Read Timeout - The amount of time before an incomplete packet is discarded
* Start Delimiter - Determines the character(s) at the start of the serial packet
* End Delimiter - Determines the character(s) at the start of the serial packet
 
[[File:Screen Shot 2022-09-16 at 3.43.31 PM.png|center|thumb|661x661px|Serial Port - Reading]]
 
=== Writing ===
The Writing page establishes the format for writing serial strings through the selected serial port. The settings are as follows:
 
* Enable Writing - Enables writing serial strings through the selected serial port
* Start Delimiter - Determines the character(s) at the start of the serial packet
* End Delimiter - Determines the character(s) at the start of the serial packet
 
[[File:Screen Shot 2022-09-16 at 3.44.47 PM.png|center|thumb|563x563px|Serial Port - Writing]]
'''Note:''' Start and end delimiters are automatically amended to the serial string sent when writing on the serial port.
 
=== Parsers ===
Parsers can be used to automatically parse and format the file contents processed by serial port into a preconfigured data structure.
[[File:Screen Shot 2022-09-16 at 3.45.38 PM.png|center|thumb|642x642px|Serial Port - Parsers]]
 
== Zebra Scanner ==
The Zebra Scanner plug-in establishes communication with a Zebra barcode scanner and establishes how the data read from the barcode is parsed in Tool Connect
 
'''Note:''' The Zebra scanner core libraries need to be installed separately for communication with the Zebra scanner to be established.
 
=== Basic Info ===
The basic info page displays the plug-in. The plug-in name and description can be edited here.
[[File:Screen Shot 2022-09-16 at 3.46.56 PM.png|center|thumb|609x609px|Zebra Scanner - Basic Information]]
 
=== Scanner Configuration ===
The Scanner configuration page determines which Zebra Scanner device that Tool Connect is communicating with. The settings are as follows:
 
* Serial Number: The serial number of the Zebra barcode scanner
* Connect to First Available device: Connects to the first available Zebra scanner that Tool Connect detects
* Default Parser: Selects a parse to automatically run when data is loaded from the barcode scanner.
* Buffer all received scanner data into a queue: When enabled, Tool Connect will buffer scanner data in a queue until it is all processed. This allows the device to continue scanning barcodes while Tool Connect is processing the data.
 
[[File:Screen Shot 2022-09-16 at 3.48.16 PM.png|center|thumb|643x643px|Zebra Scanner - Scanner Configuration]]
 
=== Parsers ===
Parsers can be used to automatically parse and format the file contents processed by serial port into a preconfigured data structure.
[[File:Screen Shot 2022-09-16 at 3.49.05 PM.png|center|thumb|661x661px|Zebra Scanner - Parsers]]
'''Note:''' The Zebra Scanner plug-in provides additional functionality that is not available when configuring a scanner through the serial port plug-in
 
{{DEFAULTSORT:Plugins}}

Latest revision as of 16:13, 7 August 2024

Back to MiConnect Categories Page

The Plug-in manager allows creating, editing and deleting of Tool connect plug-ins. Any plug-ins configured are available for use in the routine editor.

Parser Types

Some plug-ins require a parser type to be selected in order to determine how the data received is processed and formatted by Tool Connect. The following parser types are available:

  • Positional: Allows parsing in sections of bytes. Each section has a start index and a length
  • CSV: Tag data is parsed in character separated format. The separator is configurable
  • XML: Allows parsing values within basic xml documents containing elements and identifiers
  • JSON: Allows parsing JSON objects based on JSON V2 schema

RFID Reader

The RFID Reader plug-in configures communication between Tool Connect and RFID chip readers. Tool Connect supports the following RFID readers:

  • Balluff - The following models are available:
    • C6027
    • C650
    • M407
    • V6107
  • Siemens - The following models are available:
    • RF182C
    • RF200

Note: RFID Reader plug-in settings may vary per RFID reader model

Basic Info

The basic info page displays the plug-in type and RFID reader model number. The Plugin name and description can be edited here.

Screen Shot 2022-09-16 at 2.32.19 PM.png

File Reader

The file reader plug-in establishes directories that Tool Connect can access to perform various file operations, including but not limited to reading and writing files. When a file event occurs, Tool Connect can automatically parse and format the file contents into a preconfigured data structure for use in Tool Connect.

Basic Info

The basic info page displays the plug-in type. The plug-in name and description can be edited here.

File Reader - Basic Info

Directories

The directories page is used to establish which directories Tool Connect can access to perform various file operations.

File Reader - Directories

File Watchers

The File Watchers page configures file watchers that monitor specified directories for any file changes. If a file pattern is specified, the file watcher will only process new files that match the file pattern. The file watcher settings are as follows:

  • Name: Represents how the file watcher is displayed in Tool Connect
  • Directory Path: The file directory that the file watcher is monitoring for file changes.
  • File pattern: If a specific file pattern or extension is set, the file watcher will only process new files that match the specified file pattern. An asterisk "*" acts as a wildcard in the file pattern. (ex. *.csv)
  • Buffer type: Determines how results are buffered as they are processed. the following options are available:
    • Latest Only: If multiple file changes have occurred, Tool Connect only reads and processes the latest file
    • Buffer All: Tool Connect creates a buffer of files when multiple file events occur and processes the files one at a time on a first in first out basis.
  • Completion Action: Determines what happens to a file after it has been processed. Options are None, Rename, and Deletion
  • Enable Recursive Watcher Processing: When enabled, Tool Connect also monitors sub folders in the specified directory for any file changes
File Reader - File Watchers

Parsers

Parsers are used to automatically parse and format the file contents processed by the file reader into a preconfigured data structure.

File Reader - Parsers

I/O Interface

The I/O Interface plug-in establishes communication between Tool Connect and compatible I/O devices.

Basic Info

The basic info page displays the plug-in type. The plug-in name and description can be edited here.

I/O Interface - Basic Information

ADU Configuration (Ontrak ADU208)

The ADU configuration page determines which Ontrak ADU device that Tool Connect is communicating with. The settings are as follows:

  • Connect to First Available device: When enabled, Tool Connect establishes connection for the I/O plug-in to the first available I/O device on system startup. If disabled, a device serial number must be entered for connection to the device to be established.
  • Device Serial Number: The serial number located on the Ontrak ADU device.

CEI CNC Machine

CEI CNC Machine plug-in is used to establish communications between Tool Connect and various CNC Machines. When creating a CNC machine plug-in, a server must be selected for communication to be established. The following CNC machines are compatibility with Tool Connect:

  • Brother
  • Fagor
  • Fanuc
  • Heidenhain
  • Mazak
  • Mitsubishi
  • Mori
  • Okuma
  • Siemens

Basic Info

The basic info page displays the plug-in and CNC types. The plug-in name and description can be edited here.

CNC Machine - Basic Information

CNC Settings

The CNC settings page determines which CNC features from the selected CNC type are available in Tool Connect. The settings available on this page vary depending on the CNC selected.

CNC Machine - CNC Settings (Fanuc Settings pictured)

Network Configuration

The network configuration page establishes network communication settings for the CNC. The settings are as follows:

  • IP Address / Host name: IP Address or host name of the CNC
  • Port Number: Port number of the CNC server
  • Default Timeout: The default timeout for CNC commands, input in ms
CNC Machine - Network Configuration

Serial Port

Basic Info

The basic info page displays the plug-in and CNC types. The plug-in name and description can be edited here.

Serial Port - Basic Information

Port Configuration

The port configuration page establishes serial communication settings for communication via serial port. The settings are as follows:

  • Serial Port
  • Baud Rate
  • Parity
  • Stop Bits
  • Data Bits
  • Flow Control
Serial Port - Port Configuration

Note: The port settings must match the serial port settings on connected serial device for communication to be established.

Reading

The Reading page establishes the format for readable serial through the selected serial port. The settings are as follows:

  • Enable Reading - Enables reading serial strings through the selected serial port
  • Read Length - the length of characters to be read as a complete packet
  • Read Timeout - The amount of time before an incomplete packet is discarded
  • Start Delimiter - Determines the character(s) at the start of the serial packet
  • End Delimiter - Determines the character(s) at the start of the serial packet
Serial Port - Reading

Writing

The Writing page establishes the format for writing serial strings through the selected serial port. The settings are as follows:

  • Enable Writing - Enables writing serial strings through the selected serial port
  • Start Delimiter - Determines the character(s) at the start of the serial packet
  • End Delimiter - Determines the character(s) at the start of the serial packet
Serial Port - Writing

Note: Start and end delimiters are automatically amended to the serial string sent when writing on the serial port.

Parsers

Parsers can be used to automatically parse and format the file contents processed by serial port into a preconfigured data structure.

Serial Port - Parsers

Zebra Scanner

The Zebra Scanner plug-in establishes communication with a Zebra barcode scanner and establishes how the data read from the barcode is parsed in Tool Connect

Note: The Zebra scanner core libraries need to be installed separately for communication with the Zebra scanner to be established.

Basic Info

The basic info page displays the plug-in. The plug-in name and description can be edited here.

Zebra Scanner - Basic Information

Scanner Configuration

The Scanner configuration page determines which Zebra Scanner device that Tool Connect is communicating with. The settings are as follows:

  • Serial Number: The serial number of the Zebra barcode scanner
  • Connect to First Available device: Connects to the first available Zebra scanner that Tool Connect detects
  • Default Parser: Selects a parse to automatically run when data is loaded from the barcode scanner.
  • Buffer all received scanner data into a queue: When enabled, Tool Connect will buffer scanner data in a queue until it is all processed. This allows the device to continue scanning barcodes while Tool Connect is processing the data.
Zebra Scanner - Scanner Configuration

Parsers

Parsers can be used to automatically parse and format the file contents processed by serial port into a preconfigured data structure.

Zebra Scanner - Parsers

Note: The Zebra Scanner plug-in provides additional functionality that is not available when configuring a scanner through the serial port plug-in


Retrieved from "https://kb.wolframmfg.com/index.php?title=MiConnect:_Plugins&oldid=2068"