User Manual
Table Of Contents
- About This Guide
- Introduction
- Kit Installation
- iB-5209 Network Monitor Operations
- iB-5209 Network Monitor Overview
- Setting Thread Priority
- Configuring a Node’s Operation
- Using Watch function to display current I/O information
- Configuring Sample Interval of Single Node
- Configuring Sample Interval of all Network Nodes
- Configuring Digital I/O Operation
- Configuring UART Operation
- Configuring AD (analog-to-digital) Converter Operation
- Configuring RS-232 Operation (RT-5209 only)
- Configuring RS-485 Operation (RT-5209 only)
- Labeling i-Bean Endpoint or i-Bean Router
- Creating an Event Log File
- Configure Persistence Attributes
- Configure Serial and ADC Data Formats
- Select Com Port on Host PC
- View Monitor Statistics
- View Contents of Event Log File
- Enable Multiple Capture
- API Functions
- Sample Application
EK-5209-5 Evaluation Kit User’s Guide A-15
iBeanAPI.h
This function implements the simplest form of event notification using the application thread
content: It causes the calling thread to sleep until a network packet has arrived (i.e., the
sequence number has incremented), and then returns the ID of the device that was updated.
If multiple devices have changed since the last call, ibApi_WaitForDeviceEvent() will
return their ID’s in sequential round-robin order. If time timeout expires and nothing has
changed, the return value ibApi_RESULT_ERR_TIMEOUT.
Parameters:
api_hdl: (input) API handle returned from ibApi_Open().
event_types: (input) This parameter is reserved for a future feature allowing the wait
condition to be restricted to a subset of the possible event types. In the
current release, the parameter should always be
ibApi_DEVICEEVENTTYPE_ALL.
timeout_ms: Number of milliseconds to wait before giving up (use -1 to wait
indefinitely).
device_id: (output) ID of the device that changed.
Return Value:
An ibApi_RESULT_SUCCESS if a device changed, ibApi_RESULT_ERR_TIMEOUT if not, or
an error code (<0) if unsuccessful.