User's Manual
Table Of Contents
- MeshScape™ RK-5424-5 Reference Kit for 2.4 GHz MeshScape Systems User's Guide
- Contents
- About This Guide
- 1: Introduction
- 2: Installing the MeshScape System
- 3: Running MeshScape Network Monitor
- MeshScape Network Monitor Overview
- Configuring a Node’s Operation
- Labeling an End Node or Mesh Node
- Configuring Persistence Attributes
- Selecting a Com Port on the Host PC
- Configuring Serial and ADC Data Formats
- Turning Event Tracking On/Off
- Broadcasting Data to All Nodes.
- Creating an Event Log File
- Viewing the Contents of an Event Log File
- Viewing MeshScape Statistics
- 4: Using the MeshScape API
- A: Running the Demo Application
- B: Using MeshScape Programmer
- Glossary
- Index
4-32 Millennial Net
Using the MeshScape API
11. ibApi_IO_GetSerialConfig()
ibApi_FUNC ibApi_IO_GetSerialConfig (
ibApi_APIHANDLE api_hdl,
ibApi_DEVICEID device_id,
ibApi_IO_SERIALCONFIG *serial_config
);
This retrieves the configuration for the serial “user data” interface.
Parameters:
api_hdl: (input) API handle returned from ibApi_Open().
device_id: (input) ID of the device to be accessed.
serial_config: (output) Variable to store the result.
Return Value:
An ibApi_RESULT_SUCCESS if successful, or an error code (<0) if not.
12. 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.