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
A-4 EK-5209-5 Evaluation Kit User’s Guide
i-Bean API Functions Overview
Table A-1 provides a list of API functions (version 2.0) associated with i-Bean network products.
Table A-1. i-Bean API functions
iBeanAPI.h
Core API functions
ibApi_Open()
ibApi_Close
ibApi_GetApiVersion()
Session Management
ibApi_GetNetworkList()
ibApi_GetDeviceList()
Enumeration of network devices
ibApi_GetDeviceInfo()
ibApi_GetDeviceStatus()
Static and dynamic device attributes
iBApi_GetDeviceState()
ibApi_SetSamplingInterval()
ibApi_GetSamplingInterval()
Universally supported device properties
ibApi_WaitForDeviceEvent() Event Notification
iBeanAPI_IO.h Standard I/O peripherals
ibApi_IO_GetDeviceCaps() Static device attributes
ibApi_IO_SetADCConfig()
ibApi_IO_GetADCConfig()
ibApi_IO_ReadADC()
Analog-to-Digital conversion
ibApi_IO_SetDIOConfig()
ibApi_IO_GetDIOConfig()
ibApi_IO_WriteDIO()
ibApi_IO_ReadDIO()
Digital input/output
ibApi_IO_SetSerialConfig()
ibApi_IO_GetSerialConfig()
ibApi_IO_GetSerialBufferStatus()
ibApi_IO_WriteSerial()
ibApi_IO_ReadSerial()
Serial data interface (UART)
iBeanAPI_Utils.h Supplementary functions
ibApi_Utils_GetErrorDescription() Obtain text descriptions for error codes
ibApi_Utils_ConvertGroupIdToText()
ibApi_Utils_ConvertTextToGroupId()
ibApi_Utils_ConvertDeviceIdToText()
ibApi_Utils_ConvertTextToDeviceId()
Convert between ID structures and text
representation