User Manual

EK-5209-5 Evaluation Kit User’s Guide A-5
iBeanAPI.h
iBeanAPI.h
Data Structures
1. ibApi_APIHANDLE
typedef ibApi_UINT16 ibApi_APIHANDLE;
This handle represents an API session. It is created by ibApi_Open() and used by most of
the other API functions.
2. ibApi_RESULT
typedef enum ibApi_RESULT_e ibApi_RESULT;
The API functions are standardized to return the value ibApi_RESULT, which is a signed 32-bit
integer. If the integer is negative, then it is an error code such as
ibApi_RESULT_ERR_INVALIDHANDLE or ibApi_RESULT_ERR_NOTPERMITTED. (See iBeanAPI.h
for a full listing of error codes.) Otherwise, the result can be ibApi_RESULT_SUCCESS or a
non-negative value specific to the particular function.
3. ibApi_GROUPID
struct ibApi_GROUPID_s {
ibApi_UINT8 words[4];
};
typedef struct ibApi_GROUPID_s ibApi_GROUPID;
The group ID is a 32-bit address that is used to identify a specific network of i-Bean devices
and is shared by all the devices within the network. (In the current implementation, each
i-Bean network group can only have one i-Bean Gateway.) A range of group IDs is allocated
by Millennial Net for each customer.
The API functions are standardized to return the value ibApi_RESULT, which is a signed 32-bit
integer. If the integer is negative, then it is an error code such as
ibApi_RESULT_ERR_INVALIDHANDLE or ibApi_RESULT_ERR_NOTPERMITTED. (See iBeanAPI.h
for a full listing of error codes.) Otherwise, the result can be ibApi_RESULT_SUCCESS or a
non-negative value specific to the particular function.
4. ibApi_DEVICEID
struct ibApi_DEVICEID_s {
ibApi_UINT8 words[8];
};
typedef struct ibApi_DEVICEID_s ibApi_DEVICEID;
The device ID is a 64-bit address that uniquely identifies an i-Bean network component such
as endpoint, router, or gateway.