 |
gclib 2.4.0
Galil Communications Library
|
|
gclib 2.4.0
Galil Communications Library
|
Topics | |
| Connection | |
| Discover available controllers and open connections | |
| Controller | |
| Manage a Galil controller | |
Classes | |
| struct | gclib_interrupt_t |
| An interrupt generated by the controller. More... | |
Typedefs | |
| typedef struct Context * | gclib_handle |
| A handle to an open connection given by gclib_open() for use in future API calls. | |
| typedef struct DataRecord * | gclib_data_record_handle |
| A handle to a data record, for use in Data Record API calls. | |
| typedef enum gclib_result | gclib_result |
| All gclib function return values. | |
| typedef enum gclib_interrupt_type | gclib_interrupt_type |
| All interrupt status types. | |
| typedef struct gclib_interrupt_t | gclib_interrupt_t |
| An interrupt generated by the controller. | |
| typedef enum gclib_digital_input_flags | gclib_digital_input_flags |
| Flags to enable or disable GCLIB_DIGITAL_INPUT_LOW interrupts per digital input, for use in gclib_set_interrupts(). | |
| typedef enum gclib_axis_flags | gclib_axis_flags |
| Flags for building an axis mask, for example in gclib_set_interrupts(). | |
Functions | |
| gclib_result | gclib_version (char *version, size_t len) |
| Get library version. | |
| gclib_result | gclib_gcaps_version (char *gcaps_version, size_t len) |
| Get library version used by current gcaps server. | |
Variables | |
| gclib_interrupt_type | gclib_interrupt_t::type |
| char gclib_interrupt_t::axis | |
| If type is GCLIB_MOTION_COMPLETE, holds the axis that triggered the interrupt. More... | |
| uint8_t gclib_interrupt_t::digital_input | |
| If type is GCLIB_DIGITAL_INPUT_LOW, holds the digital input that triggered the interrupt. More... | |
| uint8_t gclib_interrupt_t::user_interrupt | |
| If type is GCLIB_USER_INTERRUPT, holds the user input that was triggered. More... | |
| union { | |
| char gclib_interrupt_t::axis | |
| If type is GCLIB_MOTION_COMPLETE, holds the axis that triggered the interrupt. More... | |
| uint8_t gclib_interrupt_t::digital_input | |
| If type is GCLIB_DIGITAL_INPUT_LOW, holds the digital input that triggered the interrupt. More... | |
| uint8_t gclib_interrupt_t::user_interrupt | |
| If type is GCLIB_USER_INTERRUPT, holds the user input that was triggered. More... | |
| }; | |
| uint8_t | gclib_interrupt_t::status |
| The raw status byte generated by the controller. See the EI command reference for all possible values. | |
| typedef struct Context* gclib_handle |
A handle to an open connection given by gclib_open() for use in future API calls.
| typedef struct DataRecord* gclib_data_record_handle |
A handle to a data record, for use in Data Record API calls.
| typedef enum gclib_result gclib_result |
All gclib function return values.
See gclib_error() for a more detailed error string.
| typedef enum gclib_interrupt_type gclib_interrupt_type |
All interrupt status types.
Used in gclib_set_interrupts() to configure which interrupts should be generated by the controller, and in gclib_interrupt_t once an interrupt has been read from the controller.
| typedef struct gclib_interrupt_t gclib_interrupt_t |
An interrupt generated by the controller.
| typedef enum gclib_digital_input_flags gclib_digital_input_flags |
Flags to enable or disable GCLIB_DIGITAL_INPUT_LOW interrupts per digital input, for use in gclib_set_interrupts().
| typedef enum gclib_axis_flags gclib_axis_flags |
Flags for building an axis mask, for example in gclib_set_interrupts().
| enum gclib_result |
All gclib function return values.
See gclib_error() for a more detailed error string.
| Enumerator | |
|---|---|
| GCLIB_SUCCESS | |
| GCLIB_INVALID_ARGUMENT | |
| GCLIB_INTERNAL_ERROR | |
| GCLIB_TIMEOUT | |
| GCLIB_COMMAND_ERROR | |
| GCLIB_BUFFER_TOO_SMALL | |
| GCLIB_NOT_CONNECTED | |
| GCLIB_NOT_SUBSCRIBED | |
| enum gclib_interrupt_type |
All interrupt status types.
Used in gclib_set_interrupts() to configure which interrupts should be generated by the controller, and in gclib_interrupt_t once an interrupt has been read from the controller.
| Enumerator | |
|---|---|
| GCLIB_NO_INTERRUPTS | |
| GCLIB_USER_INTERRUPT | |
| GCLIB_MOTION_COMPLETE | |
| GCLIB_ALL_AXES_MOTION_COMPLETE | |
| GCLIB_EXCESS_POSITION_ERROR | Must be reenabled with gclib_set_interrupts() after occurrence. |
| GCLIB_LIMIT_SWITCH | Must be reenabled with gclib_set_interrupts() after each occurrence. |
| GCLIB_WATCHDOG_TIMER | |
| GCLIB_PROGRAM_STOPPED | If multiple threads are running, this interrupt is only triggered when all threads are finished. |
| GCLIB_COMMAND_DONE | |
| GCLIB_DIGITAL_INPUT_LOW | Must be reenabled with gclib_set_interrupts() after each occurrence. |
| GCLIB_ALL_INTERRUPTS | |
Flags to enable or disable GCLIB_DIGITAL_INPUT_LOW interrupts per digital input, for use in gclib_set_interrupts().
| enum gclib_axis_flags |
Flags for building an axis mask, for example in gclib_set_interrupts().
| Enumerator | |
|---|---|
| GCLIB_NO_AXES | |
| GCLIB_AXIS_A | |
| GCLIB_AXIS_B | |
| GCLIB_AXIS_C | |
| GCLIB_AXIS_D | |
| GCLIB_AXIS_E | |
| GCLIB_AXIS_F | |
| GCLIB_AXIS_G | |
| GCLIB_AXIS_H | |
| GCLIB_ALL_AXES | |
| gclib_result gclib_version | ( | char * | version, |
| size_t | len ) |
Get library version.
| version | Output buffer for gclib library version. |
| len | Length of output buffer. |
| gclib_result gclib_gcaps_version | ( | char * | gcaps_version, |
| size_t | len ) |
Get library version used by current gcaps server.
| gcaps_version | Output buffer for gcaps library version. |
| len | Length of output buffer. |
| gclib_interrupt_type gclib_interrupt_t::type |
| char gclib_interrupt_t::axis |
If type is GCLIB_MOTION_COMPLETE, holds the axis that triggered the interrupt.
| char { ... } ::axis |
If type is GCLIB_MOTION_COMPLETE, holds the axis that triggered the interrupt.
| uint8_t gclib_interrupt_t::digital_input |
If type is GCLIB_DIGITAL_INPUT_LOW, holds the digital input that triggered the interrupt.
| uint8_t { ... } ::digital_input |
If type is GCLIB_DIGITAL_INPUT_LOW, holds the digital input that triggered the interrupt.
| uint8_t gclib_interrupt_t::user_interrupt |
If type is GCLIB_USER_INTERRUPT, holds the user input that was triggered.
| uint8_t { ... } ::user_interrupt |
If type is GCLIB_USER_INTERRUPT, holds the user input that was triggered.
| union { ... } gclib_interrupt_t |
| uint8_t gclib_interrupt_t::status |
The raw status byte generated by the controller. See the EI command reference for all possible values.
1.14.0