core-c/1.0/za__serial_8h_source.html

 #if !defined(ZA_SERIAL_H)

 #define ZA_SERIAL_H


 #if defined(__cplusplus)

 extern "C"{

 #endif /* if defined(__cplusplus) */


 #include "z_common.h"


 struct za_reply {

     char message_type;

     int device_address;

     int axis_number;

     char reply_flags[3];

     char device_status[5];

     char warning_flags[3];

     char response_data[128];

 };


 int za_connect(z_port *port, const char *port_name);


 int za_disconnect(z_port port);


 int za_send(z_port port, const char *command);


 int za_receive(z_port port, char *destination, int length);


 int za_decode(struct za_reply *destination, char *reply);


 int za_setbaud(z_port port, int baud);


 int za_drain(z_port port);


 void za_set_verbose(int value);


 #if defined(__cplusplus)

 }

 #endif /* if defined(__cplusplus) */


 #endif /* if !defined(ZA_SERIAL_H) */

za_reply::message_type
char message_type
The message type will always be '@' for replies.
Definition: za_serial.h:35

za_send
int za_send(z_port port, const char *command)
Sends a command to a serial port.

za_reply
Provides programmatic access to reply data.
Definition: za_serial.h:32

za_setbaud
int za_setbaud(z_port port, int baud)
Changes the baud rate of both input and output.

za_connect
int za_connect(z_port *port, const char *port_name)
Connect to a serial port specified by port_name.

z_common.h
Defines a few things that all of the serial API has in common.

za_reply::warning_flags
char warning_flags[3]
The highest priority warning for the device, or – under normal conditions.
Definition: za_serial.h:47

za_reply::axis_number
int axis_number
The axis number: 0-9, where 0 refers to the whole device, and 1-9 refer only to that specific axis...
Definition: za_serial.h:40

za_reply::reply_flags
char reply_flags[3]
Whether a command was accepted or rejected: either "OK" or "RJ".
Definition: za_serial.h:42

za_reply::device_address
int device_address
The address of the device, an integer between 1 and 99.
Definition: za_serial.h:37

za_decode
int za_decode(struct za_reply *destination, char *reply)
Build a za_reply struct from a string pointed-to by reply.

za_reply::response_data
char response_data[128]
The response for the command executed.
Definition: za_serial.h:50

za_drain
int za_drain(z_port port)
Flushes all input received but not yet read, and attempts to drain all input that would be incoming...

z_port
HANDLE z_port
A type to represent a port connected to one or more Zaber devices.
Definition: z_common.h:31

za_reply::device_status
char device_status[5]
Either "BUSY" when the axis is moving, or "IDLE" when it isn't.
Definition: za_serial.h:44

za_receive
int za_receive(z_port port, char *destination, int length)
Reads a message from the serial port.

za_disconnect
int za_disconnect(z_port port)
Gracefully closes a connection.

za_set_verbose
void za_set_verbose(int value)
Sets whether errors and extra info are reported to stderr.