gclib  1.36.3
Communications API for Galil controllers and PLCs
gclibo.h File Reference
#include "gclib.h"

Go to the source code of this file.

Macros

#define GCLIB_DLL_EXPORTED
 
#define GCALL   __stdcall
 
#define MALLOCBUF   G_HUGE_BUFFER
 Malloc used for large program and array uploads.
 
#define MAXPROG   MALLOCBUF
 Maximum size for a program.
 
#define MAXARRAY   MALLOCBUF
 Maximum size for an array table upload.
 
#define POLLINGINTERVAL   100
 Interval, in milliseconds, for polling commands, e.g. GWaitForBool().
 
#define G_USE_GCAPS
 Use the GCAPS server in GAddresses(), GAssign(), GIpRequests(), and GVersion(). To avoid GCAPS, comment out this line and recompile, http://galil.com/sw/pub/all/doc/gclib/html/gclibo.html.
 

Functions

GCLIB_DLL_EXPORTED void GCALL GSleep (unsigned int timeout_ms)
 Uses GUtility() and G_UTIL_SLEEP to provide a blocking sleep call which can be useful for timing-based chores. More...
 
GCLIB_DLL_EXPORTED GReturn GCALL GVersion (GCStringOut ver, GSize ver_len)
 Uses GUtility(), G_UTIL_VERSION and G_UTIL_GCAPS_VERSION to provide the library and gcaps version numbers. More...
 
GCLIB_DLL_EXPORTED GReturn GCALL GAddresses (GCStringOut addresses, GSize addresses_len)
 Uses GUtility(), G_UTIL_GCAPS_ADDRESSES or G_UTIL_ADDRESSES to provide a listing of all available connection addresses. More...
 
GCLIB_DLL_EXPORTED GReturn GCALL GInfo (GCon g, GCStringOut info, GSize info_len)
 Uses GUtility() and G_UTIL_INFO to provide a useful connection string. More...
 
GCLIB_DLL_EXPORTED GReturn GCALL GTimeout (GCon g, short timeout_ms)
 Uses GUtility() and G_UTIL_TIMEOUT_OVERRIDE to set the library timeout. More...
 
GCLIB_DLL_EXPORTED GReturn GCALL GCmd (GCon g, GCStringIn command)
 Wrapper around GCommand for use when the return value is not desired. More...
 
GCLIB_DLL_EXPORTED GReturn GCALL GCmdT (GCon g, GCStringIn command, GCStringOut trimmed_response, GSize response_len, GCStringOut *front)
 Wrapper around GCommand that trims the response. More...
 
GCLIB_DLL_EXPORTED GReturn GCALL GCmdI (GCon g, GCStringIn command, int *value)
 Wrapper around GCommand that provides the return value of a command parsed into an int. More...
 
GCLIB_DLL_EXPORTED GReturn GCALL GCmdD (GCon g, GCStringIn command, double *value)
 Wrapper around GCommand that provides the return value of a command parsed into a double. More...
 
GCLIB_DLL_EXPORTED GReturn GCALL GWaitForBool (GCon g, GCStringIn predicate, int trials)
 Blocking call that returns when the controller evaluates the predicate as true. More...
 
GCLIB_DLL_EXPORTED GReturn GCALL GMotionComplete (GCon g, GCStringIn axes)
 Blocking call that returns once all axes specified have completed their motion. More...
 
GCLIB_DLL_EXPORTED GReturn GCALL GRecordRate (GCon g, double period_ms)
 Sets the asynchronous data record to a user-specified period via DR. More...
 
GCLIB_DLL_EXPORTED GReturn GCALL GProgramDownloadFile (GCon g, GCStringIn file_path, GCStringIn preprocessor)
 Program download from file. More...
 
GCLIB_DLL_EXPORTED GReturn GCALL GProgramUploadFile (GCon g, GCStringIn file_path)
 Program upload to file. More...
 
GCLIB_DLL_EXPORTED GReturn GCALL GArrayDownloadFile (GCon g, GCStringIn file_path)
 Array download from file. More...
 
GCLIB_DLL_EXPORTED GReturn GCALL GArrayUploadFile (GCon g, GCStringIn file_path, GCStringIn names)
 Array upload to file. More...
 
GCLIB_DLL_EXPORTED GReturn GCALL GIpRequests (GCStringOut requests, GSize requests_len)
 Uses GUtility(), G_UTIL_GCAPS_IPREQUEST or G_UTIL_IPREQUEST to provide a list of all Galil controllers requesting IP addresses via BOOT-P or DHCP. More...
 
GCLIB_DLL_EXPORTED GReturn GCALL GSetServer (GCStringIn server_name)
 Uses GUtility(), G_UTIL_GCAPS_SET_SERVER to set the new active server. More...
 
GCLIB_DLL_EXPORTED GReturn GCALL GListServers (GCStringOut servers, GSize servers_len)
 Uses GUtility(), G_UTIL_GCAPS_LIST_SERVERS to provide a list of all available gcaps services on the local network. More...
 
GCLIB_DLL_EXPORTED GReturn GCALL GPublishServer (GCStringIn name, GOption publish, GOption save)
 Uses GUtility(), G_UTIL_GCAPS_PUBLISH_SERVER to publish local gcaps server to the local network. More...
 
GCLIB_DLL_EXPORTED GReturn GCALL GServerStatus (GCStringOut status, GSize status_len)
 Uses GUtility(), G_UTIL_GCAPS_SERVER_STATUS to get information on the local server name and if it is published to the local network. More...
 
GCLIB_DLL_EXPORTED GReturn GCALL GRemoteConnections (GCStringOut connections, GSize connections_length)
 Uses GUtility(), G_UTIL_GCAPS_REMOTE_CONNECTIONS to get a list of remote addresses connected to the local server. More...
 
GCLIB_DLL_EXPORTED GReturn GCALL GAssign (GCStringIn ip, GCStringIn mac)
 Uses GUtility(), G_UTIL_GCAPS_ASSIGN or G_UTIL_ASSIGN to assign an IP address over the Ethernet to a controller at a given MAC address. More...
 
GCLIB_DLL_EXPORTED void GCALL GError (GReturn rc, GCStringOut error, GSize error_len)
 Provides a human-readable description string for return codes. More...
 
GCLIB_DLL_EXPORTED GReturn GCALL GSetupDownloadFile (GCon g, GCStringIn file_path, GOption options, GCStringOut info, GSize info_len)
 Download a saved controller configuration from a file. More...
 

Detailed Description

Open-source convenience functions for Galil C Lib. Please email softw.nosp@m.aref.nosp@m.eedba.nosp@m.ck@g.nosp@m.alil..nosp@m.com with suggestions for useful/missing functions.

Definition in file gclibo.h.