Modules

Here is a list of all modules:

[detail level 12345]

▼Top-Level Defines
BotSense Error Codes
BotSense Uniform Resource Indentifier Attributes
BotSense bsProxy Server Compiled Default Tunables
BotSense Handle Attributes
BotSense Transaction Id Attributes
BotSense Application-Specific Message Id Attributes
BotSense Server-Wide Message Unique Id Attributes
BotSense Message Header Attributes
▼BotSense Protocol
XML Message Set
▼BotSense Server
Default Tunables
bsProxy Configuration
bsProxy Man Page
▼BotSense Client
▼libbotsense Man Pages
►Macros and Utilities
BSCLIENT_LOG_WARN	Log Warning.
BSCLIENT_LOG_ERROR	Log Error.
BSCLIENT_LOG_NM_ERROR	Log NetMsgs Error.
BSCLIENT_LOG_SYSERROR	Log System Error.
BSCLIENT_TRY_ECODE	Check if BotSense return value is not an error ( < 0).
BSCLIENT_TRY_NM_ECODE	Check if NetMsgs (un)packing return value is not an error ( < 0).
BSCLIENT_TRY_EXPR	Check if expression evaluates to true.
BSCLIENT_IS_VCONN_HANDLE	Test if the handle is in the valid client virtual connection range.
BSCLIENT_HAS_VCONN	Tests if the handle is valid and there is an established virtual connection.
bsStrError	Get the error string describing the BotSense error code.
bsPackMsgHdr	Pack BotSense bsProxy message header.
bsUnpackMsgHdr	Unpack BotSense bsProxy message header.
bsLogBuf	Log data bytes.
bsLogAsciiBuf	Log ascii data bytes.
►Client-Specific Functions
bsClientNew	Create a new unconnected proxied client.
bsClientDelete	Delete a proxied client.
bsClientTrans	Execute a request - response transaction with the server.
bsClientAttrGetName	Get client name.
bsClientAttrGetTraceState	Get client virtual connection trace state.
bsClientAttrGetVConnCount	Get the number of active virtual connections for this client.
bsClientAttrHasVConn	Test if client has a virtual connection identified by the handle.
bsClientAttrGetDevName	Get client virtual connection device name.
bsClientAttrGetModName	Get client virtual connection interface module name.
bsClientAttrSetLogging	Set client's diagnostics logging threshold.
bsClientAttrGetConnState	Get client's connection state.
bsClientFillMsgHdr	Fill in message header.
bsClientGetMsgName	Get the message name.
bsClientLogMsgHdr	Log [pre/un]packed message header.
►Client-Server Connection and Requests Functions
bsServerConnect	Connect to the bsProxy server.
bsServerDisconnect	Disconnect from the bsProxy server.
bsServerReqGetVersion	Request server to return the server's version string.
bsServerReqLoopback	Request server to loopback the requested message data.
bsServerReqSetLogging	Request server to set the server's logging level.
bsServerReqMsgTrace	Request server to enable/disable message tracing on a virtual connection.
bsServerReqOpenDev	Request server to establish a virtual connection to the device end point.
bsServerReqCloseDev	Request server to close a client's vitual connection.
bsServerReqGetVConnList	Request server to retrieve the server's list of virtual connection handles for this client.
bsServerReqGetVConnInfo	Request server to retrieve the server's information for a given virtual connection.
▼Standard PlugIn Modules
▼I2C
►Client Interfaces
►libbsclient_i2c Man Pages
bsI2CGetMsgName	Get the I2C message name.
bsI2CReqClose	Request proxy server to close client's proxied I2C device vitual connection.
bsI2CReqOpen	Request proxy server to establish a virtual connection to an I2C bus device.
bsI2CReqRead	Proxied request to read from a device attached to the I2C bus.
bsI2CReqTrans	Proxied request to execute a write-read transaction to a device attached to the I2C bus.
bsI2CReqWrite	Proxied request to write to a device attached to the I2C bus.
BotSense.bsI2C Python Module
►Server Plug-In
I2C Configuration
Default Tunables
XML Message Set
▼Null
►Client Interfaces
►libbsclient_null Man Pages
bsNullGetMsgName	Get the DevNull message name.
bsNullReqClose	Request proxy server to close client's proxied DevNull device vitual connection.
bsNullReqOpen	Request proxy server to establish a virtual connection to the /dev/null device.
bsNullReqWrite	Proxied request to write to /dev/null.
BotSense.bsNull Python Module
►Server Plug-In
Null Configuration
Default Tunables
XML Message Set
▼Serial
►Client Interfaces
►libbsclient_serial Man Pages
bsSerialGetMsgName	Get the serial message name.
bsSerialReqClose	Request proxy server to close client's proxied serial device vitual connection.
bsSerialReqOpen	Request proxy server to establish a virtual connection to an RS-232 serial device.
bsSerialReqRead	Proxied request to read from an RS-232 serial device.
bsSerialReqTrans	Proxied request to execute a write-read transaction on a RS-232 serial device.
bsSerialReqWrite	Proxied request to write to a RS-232 serial device.
BotSense.bsSerial Python Module
►Server Plug-In
Serial Configuration
Default Tunables
XML Message Set
Application-Specific PlugIn SDK
▼Example Clients
loopback.sh
▼bsUnitTest
bsUnitTest Man Page (TBW)
▼bsLoadTest
bsLoadTest Man Page
▼List of Images
BotSense Framework - Large
BotSense Architecture - Large
bsProxy Connection Flow Chart
bsProxy Open Proxied Device Flow Chart
libbotsense Requst/Response Design - Large
SkewlZone Legged Robot Pack
RoboSight Neural Camera
Khepera III Robot
Koala Robot
Hekateros Robotic Manipulator
▼Doxygen Includes
doc_param_ecode
doc_return_ecode
doc_return_std