| gclib 339 Communications API for Galil controllers and PLCs |

All Data Structures Files Functions Variables Typedefs Macros Pages
gclib.h
Go to the documentation of this file.
1
6 #ifndef I_D48432D9_1FA3_4C7D_B44C_05F8B9000ADF
7 #define I_D48432D9_1FA3_4C7D_B44C_05F8B9000ADF
8
9 //set library visibility for gcc and msvc
10 #if BUILDING_GCLIB && HAVE_VISIBILITY
11 #define GCLIB_DLL_EXPORTED __attribute__((__visibility__("default")))
12 #elif BUILDING_GCLIB && defined _MSC_VER
13 #define GCLIB_DLL_EXPORTED __declspec(dllexport)
14 #elif defined _MSC_VER
15 #define GCLIB_DLL_EXPORTED __declspec(dllimport)
16 #else
17 #define GCLIB_DLL_EXPORTED
18 #endif
19
20 #include "gclib_record.h" // Galil data record structs and unions.
21 #include "gclib_errors.h" // GReturn error code values and strings.
22
23 #ifdef _WIN32
24 #define GCALL __stdcall
25 #else
26 #define GCALL
27 #endif
28
29 #ifdef __cplusplus
30 extern "C" {
31 #endif
32
33 //Constants for function arguments
34 #define G_DR 1
35 #define G_QR 0
36 #define G_BOUNDS -1
37 #define G_CR 0
38 #define G_COMMA 1
39
40 //Constants for GUtility()
41 #define G_UTIL_TIMEOUT 1
42 #define G_UTIL_TIMEOUT_OVERRIDE 2
43 #define G_USE_INITIAL_TIMEOUT -1
44 #define G_UTIL_VERSION 128
45 #define G_UTIL_INFO 129
46 #define G_UTIL_SLEEP 130
47 #define G_UTIL_ADDRESSES 131
48 #define G_UTIL_IPREQUEST 132
49 #define G_UTIL_ASSIGN 133
50 #define G_UTIL_DEVICE_INITIALIZE 134
51
52 #define G_UTIL_GCAPS_VERSION 256
53 #define G_UTIL_GCAPS_KEEPALIVE 257
54 #define G_UTIL_GCAPS_ADDRESSES 258
55 #define G_UTIL_GCAPS_IPREQUEST 259
56 #define G_UTIL_GCAPS_ASSIGN 260
57
58 //Convenience constants
59 #define G_SMALL_BUFFER 1024
60 #define G_HUGE_BUFFER 524288
61
62 typedef int GReturn;
63 typedef void* GCon;
64 typedef unsigned int GSize;
65 typedef int GOption;
66 typedef char* GCStringOut;
67 typedef const char* GCStringIn;
68 typedef char* GBufOut;
69 typedef const char* GBufIn;
70 typedef unsigned char GStatus;
71 typedef void* GMemory;
72
74 GCLIB_DLL_EXPORTED GReturn GCALL GOpen(GCStringIn address, GCon* g);
120 GCLIB_DLL_EXPORTED GReturn GCALL GClose(GCon g);
140 GCLIB_DLL_EXPORTED GReturn GCALL GRead(GCon g, GBufOut buffer, GSize buffer_len, GSize* bytes_read);
161 GCLIB_DLL_EXPORTED GReturn GCALL GWrite(GCon g, GBufIn buffer, GSize buffer_len);
178 GCLIB_DLL_EXPORTED GReturn GCALL GCommand(GCon g, GCStringIn command, GBufOut buffer, GSize buffer_len, GSize* bytes_returned);
195 GCLIB_DLL_EXPORTED GReturn GCALL GProgramDownload(GCon g, GCStringIn program, GCStringIn preprocessor);
211 GCLIB_DLL_EXPORTED GReturn GCALL GProgramUpload(GCon g, GBufOut buffer, GSize buffer_len);
224 GCLIB_DLL_EXPORTED GReturn GCALL GArrayDownload(GCon g, const GCStringIn array_name, GOption first, GOption last, GCStringIn buffer);
241 GCLIB_DLL_EXPORTED GReturn GCALL GArrayUpload(GCon g, const GCStringIn array_name, GOption first, GOption last, GOption delim, GBufOut buffer, GSize buffer_len);
258 GCLIB_DLL_EXPORTED GReturn GCALL GRecord(GCon g, union GDataRecord* record, GOption method);
285 GCLIB_DLL_EXPORTED GReturn GCALL GMessage(GCon g, GCStringOut buffer, GSize buffer_len);
318 GCLIB_DLL_EXPORTED GReturn GCALL GInterrupt(GCon g, GStatus* status_byte);
340 GCLIB_DLL_EXPORTED GReturn GCALL GFirmwareDownload(GCon g, GCStringIn filepath);
361 GCLIB_DLL_EXPORTED GReturn GCALL GUtility(GCon g, GOption request, GMemory memory1, GMemory memory2);
458 #ifdef __cplusplus
459 } //extern "C"
460 #endif
461
462 #endif //I_D48432D9_1FA3_4C7D_B44C_05F8B9000ADF
GOption
int GOption
Option integer for various formatting, etc.
Definition: gclib.h:65
GSize
unsigned int GSize
Size of buffers, etc.
Definition: gclib.h:64
GOpen
GCLIB_DLL_EXPORTED GReturn GCALL GOpen(GCStringIn address, GCon *g)
Open a connection to a Galil Controller.
GWrite
GCLIB_DLL_EXPORTED GReturn GCALL GWrite(GCon g, GBufIn buffer, GSize buffer_len)
Performs a write on the connection.
GUtility
GCLIB_DLL_EXPORTED GReturn GCALL GUtility(GCon g, GOption request, GMemory memory1, GMemory memory2)
Provides read/write access to driver settings and convenience features based on the request variable...
GMemory
void * GMemory
Pointer to untyped memory for use in GUtility().
Definition: gclib.h:71
GRead
GCLIB_DLL_EXPORTED GReturn GCALL GRead(GCon g, GBufOut buffer, GSize buffer_len, GSize *bytes_read)
Performs a read on the connection.
GBufOut
char * GBufOut
Data output from the library. No null-termination implied. Returned values may be null-terminated...
Definition: gclib.h:68
GArrayUpload
GCLIB_DLL_EXPORTED GReturn GCALL GArrayUpload(GCon g, const GCStringIn array_name, GOption first, GOption last, GOption delim, GBufOut buffer, GSize buffer_len)
Uploads array data from the controller's array table.
GMessage
GCLIB_DLL_EXPORTED GReturn GCALL GMessage(GCon g, GCStringOut buffer, GSize buffer_len)
Provides access to unsolicited messages from the controller.
gclib_record.h
GInterrupt
GCLIB_DLL_EXPORTED GReturn GCALL GInterrupt(GCon g, GStatus *status_byte)
Provides access to PCI and UDP interrupts from the controller.
GFirmwareDownload
GCLIB_DLL_EXPORTED GReturn GCALL GFirmwareDownload(GCon g, GCStringIn filepath)
Upgrade firmware.
GCon
void * GCon
Connection handle. Unique for each connection in process. Assigned a non-zero value in GOpen()...
Definition: gclib.h:63
GProgramDownload
GCLIB_DLL_EXPORTED GReturn GCALL GProgramDownload(GCon g, GCStringIn program, GCStringIn preprocessor)
Downloads a program to the controller's program buffer.
GArrayDownload
GCLIB_DLL_EXPORTED GReturn GCALL GArrayDownload(GCon g, const GCStringIn array_name, GOption first, GOption last, GCStringIn buffer)
Downloads array data to a pre-dimensioned array in the controller's array table.
GCommand
GCLIB_DLL_EXPORTED GReturn GCALL GCommand(GCon g, GCStringIn command, GBufOut buffer, GSize buffer_len, GSize *bytes_returned)
Performs a command-and-response transaction on the connection.
GProgramUpload
GCLIB_DLL_EXPORTED GReturn GCALL GProgramUpload(GCon g, GBufOut buffer, GSize buffer_len)
Uploads a program from the controller's program buffer.
GReturn
int GReturn
Every function returns a value of type GReturn. See gclib_errors.h for possible values.
Definition: gclib.h:62
GCStringIn
const char * GCStringIn
C-string input to the library. Implies null-termination.
Definition: gclib.h:67
GRecord
GCLIB_DLL_EXPORTED GReturn GCALL GRecord(GCon g, union GDataRecord *record, GOption method)
Provides a fresh copy of the controller's data record. Data is cast into a union, GDataRecord...
GBufIn
const char * GBufIn
Data input to the library. No null-termination, function will have a GSize to indicate bytes to write...
Definition: gclib.h:69
GStatus
unsigned char GStatus
Interrupt status byte.
Definition: gclib.h:70
GClose
GCLIB_DLL_EXPORTED GReturn GCALL GClose(GCon g)
Closes a connection to a Galil Controller.
GCStringOut
char * GCStringOut
C-string output from the library. Implies null-termination.
Definition: gclib.h:66
GCALL
#define GCALL
Specify calling convention for Windows.
Definition: gclib.h:24
gclib_errors.h
GDataRecord
Data record union, containing all structs and a generic byte array accessor.
Definition: gclib_record.h:1029