gclib  2.0.8
Communications API for Galil controllers and PLCs
gclib Class Reference

Provides a class that binds to gclib's unmanaged dll. Wraps each call and provides a more user-friendly interface for use in C#. More...

Data Structures

class  GclibError
 
interface  GDataRecord
 
struct  GDataRecord1802
 Data record struct for DMC-1802 controllers. More...
 
struct  GDataRecord1806
 Data record struct for DMC-1806 controller. More...
 
struct  GDataRecord2103
 Data record struct for DMC-2103 controllers. More...
 
struct  GDataRecord30000
 Data record struct for DMC-30010 controllers. More...
 
struct  GDataRecord4000
 Data record struct for DMC-4000 controllers, including 4000, 4200, 4103, and 500x0. More...
 
struct  GDataRecord47000_ENC
 Data record struct for RIO-471xx and RIO-472xx PLCs. Includes encoder fields. More...
 
struct  GDataRecord47162
 Data record struct for RIO-47162. More...
 
struct  GDataRecord47300_24EX
 Data record struct for RIO-47300 with 24EX I/O daughter board. More...
 
struct  GDataRecord47300_ENC
 Data record struct for RIO-47300. Includes encoder fields. More...
 
struct  GDataRecord52000
 Data record struct for DMC-52000 controller. Same as DMC-4000, with bank indicator added at byte 40. More...
 
class  py
 

Public Member Functions

 gclib ()
 Constructor of the gclib wrapper class. More...
 
string[] GAddresses ()
 Return a string array of available connection addresses. More...
 
void GArrayDownload (string array_name, ref List< double > data, Int16 first=-1, Int16 last=-1)
 Downloads array data to a pre-dimensioned array in the controller's array table. More...
 
void GArrayDownloadFile (string Path)
 Allows downloading of a program array file to the controller. More...
 
List< double > GArrayUpload (string array_name, Int16 first=-1, Int16 last=-1)
 Uploads array data from the controller's array table. More...
 
void GArrayUploadFile (string Path, string Names)
 Allows uploading of a program array file from the controller to an array CSV file. More...
 
void GAssign (string ip, string mac)
 Assigns IP address over the Ethernet to a controller at a given MAC address. More...
 
void GClose ()
 Used to close a connection to Galil hardware. More...
 
string GCommand (string Command, bool Trim=true)
 Used for command-and-response transactions. More...
 
Int16 GCmdI (string Command)
 Used for command-and-response transactions. More...
 
double GCmdD (string Command)
 Used for command-and-response transactions. More...
 
void GFirmwareDownload (string filepath)
 Upgrade firmware. More...
 
string GInfo ()
 Provides a useful connection string. More...
 
byte GInterrupt ()
 Provides access to PCI and UDP interrupts from the controller. More...
 
string[] GIpRequests ()
 Provides a list of all Galil controllers requesting IP addresses via BOOT-P or DHCP. More...
 
string GMessage ()
 Provides access to unsolicited messages. More...
 
void GMotionComplete (string axes)
 Blocking call that returns once all axes specified have completed their motion. More...
 
void GOpen (string address)
 Used to open a connection to Galil hardware. More...
 
void GProgramDownload (string program, string preprocessor="")
 Allows downloading of a DMC program from a string buffer. More...
 
void GProgramDownloadFile (string file_path, string preprocessor="")
 Allows downloading of a DMC program from file. More...
 
string GProgramUpload ()
 Allows uploading of a DMC program to a string. More...
 
void GProgramUploadFile (string file_path)
 Allows uploading of a DMC program to a file. More...
 
byte[] GRead ()
 Performs a read on the connection. More...
 
GRecord< T > (bool async)
 Used for retrieving data records from the controller. More...
 
void GRecordRate (double period_ms)
 Sets the asynchronous data record to a user-specified period via DR. More...
 
void GTimeout (Int16 timeout_ms)
 Set the timeout of communication transactions. Use -1 to set the original timeout from GOpen(). More...
 
string GVersion ()
 Used to get the gclib version. More...
 
void GWrite (string buffer)
 Performs a write on the connection. More...
 
string[] GSetupDownloadFile (string path, Int32 options)
 Allows downloading of a Galil compressed backup (gcb) file to the controller. More...
 
void GSetServer (string server_name)
 Connects gclib to a new gcaps server More...
 
string GServerStatus ()
 Retrieves the name of your local gcaps server and whether or not it is currently published More...
 
string[] GListServers ()
 Retrieves a list of gcaps servers that are advertising themselves on the local network More...
 
void GPublishServer (string server_name, bool publish, bool save)
 Publishes or removes local gcaps server from the network More...
 
string[] GRemoteConnections ()
 Returns a list of IP Addresses that currently have an open connection to your hardware. More...
 

Data Fields

 argtypes
 
 restype
 

Detailed Description

Provides a class that binds to gclib's unmanaged dll. Wraps each call and provides a more user-friendly interface for use in C#.

The Gclib class assumes the default installation of gclib, "C:\Program Files (x86)\Galil\gclib\". If the dlls are elsewhere, change the path strings GclibDllPath_, and GcliboDllPath_.

Definition at line 67 of file gclib.cs.


The documentation for this class was generated from the following files: