User Manual

4-30 Millennial Net
Using the MeshScape API
11. ibApi_IO_GetSerialBufferStatus()
ibApi_FUNC ibApi_IO_GetSerialBufferStatus (
ibApi_APIHANDLE api_hdl,
ibApi_DEVICEID device_id,
ibApi_IOMODE io_mode
);
For the given device, this function retrieves the status of the out going serial data buffer. The
return value gives the number of empty packet slots in the buffer. A negative return value
denotes an error and a zero return value means there is currently no out going empty packet
slots.
Parameters:
api_hdl: (input) API handle returned from ibApi_Open().
device_id: (input) ID of the device to be accessed.
io_mode: (input) Data direction to be accessed.
Return Value:
The number of empty out going packet slots if successful, or an error code (<0) if not.
12. ibApi_IO_WriteSerial()
ibApi_FUNC ibApi_IO_WriteSerial (
ibApi_APIHANDLE api_hdl,
ibApi_DEVICEID device_id,
ibApi_UINT8 buffer[],
ibApi_UINT16 buffer_size
);
This function writes buffer_size bytes pointed to by the buffer pointer to the specified device
handle. Prior to use, the ibApi_FIELDID_USERDATAMODE field must have been configured
for serial operation. The specific contents of the user data block and its maximum size are
application defined but must be equal to or smaller than that the maximum payload size
supported. Maximum payload size supported is returned when the function
ibApi_WriteSerialData() is called with buffer_size=0.
Parameters:
api_hdl: (input) API handle returned from ibApi_Open().
device_id: (input) ID of the device to be accessed.
buffer: (input) Pointer to packet to transmit.
buffer_size: (input) Number of bytes in user data packet to transmit.
Return Value:
Bytes sent if successful, or an error code (<0) if not.