core-c/1.0/zb__serial_8h_source.html

 #if !defined(ZB_SERIAL_H)

 #define ZB_SERIAL_H


 #if defined(__cplusplus)

 extern "C"{

 #endif /* if defined(__cplusplus) */


 #include "z_common.h"


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


 int zb_disconnect(z_port port);


 int zb_send(z_port port, const uint8_t *command);


 int zb_receive(z_port port, uint8_t *destination);


 int zb_encode(uint8_t *destination, uint8_t device_number,

         uint8_t command_number, int32_t data);


 int zb_decode(int32_t *destination, const uint8_t *reply);


 int zb_drain(z_port port);


 int zb_set_timeout(z_port port, int milliseconds);


 void zb_set_verbose(int value);


 #if defined(__cplusplus)

 }

 #endif /* if defined(__cplusplus) */


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


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

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

zb_set_timeout
int zb_set_timeout(z_port port, int milliseconds)
Change the duration zb_receive() will wait before timing out and returning without having read anythi...

zb_send
int zb_send(z_port port, const uint8_t *command)
Sends a command to a serial port.

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

zb_encode
int zb_encode(uint8_t *destination, uint8_t device_number, uint8_t command_number, int32_t data)
Encodes a command according to Zaber's Binary Protocol Manual.

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

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

zb_receive
int zb_receive(z_port port, uint8_t *destination)
Receives a message from the serial port.

zb_decode
int zb_decode(int32_t *destination, const uint8_t *reply)
Decodes the last 4 bytes of a 6-byte (complete) reply.

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