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-6 Millennial Net
Using the MeshScape API
ibApi_IO_SetSerialConfig()
ibApi_IO_GetSerialConfig()
ibApi_IO_GetSerialBufferStatus()
ibApi_IO_WriteSerial()
ibApi_IO_ReadSerial()
ibApi_IO_SetDeviceConfigAndData()
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()
ibApi_Utils_ConvertRawBatteryReadingToVoltage()
ibApi_Utils_ConvertRawAdcReadingToVoltage()
Convert between ID structures and
text representation
iBeanAPI_LPR.h Ultra-Low Power Functions
ibApi_LPR_SetClock() Set the Coordinated Universal Time
(UTC) clock for all devices
ibApi_LPR_GetClock() Retrieves the UTC clock value used
for all devices
ibApi_LPR_SetWakeupAndDutyRatio() Sets the low power mesh node
wakeup interval and duty ratio for
all devices
ibApi_LPR_GetWakeupAndDutyRatio() Retrieves the wakeup interval and
duty ratio for all devices
iBeanAPI_performance.h Performance Statistics
ibApi_GetStatisticData() Retrieve statistical data for a given
device.
Table 4-1. MeshScape API functions (continued)