OBDNet SDK

• 1. Overview
• 2. Getting Started
• 2.1 Initializing
• 2.2 Getting Connected
• 2.3 Data Logging
• 3. API Data Types
• 3.1. OBDNET_PID_VALUE
• 3.2. OBDNET_PID_INFO
• 4. API Callbacks
• 4.1 OBDNET_CALLBACK_PID_LIST_ITEM
• 4.2 OBDNET_CALLBACK_SELECTED_PID_ITEM
• 4.3 OBDNET_CALLBACK_STREAMING_PID_VALUE
• 5. API Function Reference
• 5.1 Initialization functions
• 5.1.1 OBDNetInitialize
• 5.1.2 OBDNetUninitialize
• 5.2 Creation functions
• 5.2.1 OBDNetCreate
• 5.2.2 OBDNetDestroy
• 5.3 Status functions
• 5.3.1 OBDNetStatusGetErrorCodeString
• 5.4 Debugging functions
• 5.4.1 OBDNetEnableDebugMode
• 5.4.2 OBDNetEnableSequentialWriting
• 5.4.3 OBDNetDisableDebugMode
• 5.5 Connectoin functions
• 5.5.1 OBDNetOpenConnection
• 5.5.2 OBDNetCloseConnection
• 5.5.3 OBDNetIsConnected
• 5.6 Misc. functions
• 5.6.1 OBDNetWorker
• 5.6.2 OBDNetSetCallback
• 5.6.3 OBDNetSetWorkerTimeout
• 5.6.4 OBDNetSetFunctionCallTimeout
• 5.7 Parameter functions
• 5.7.1 OBDNetParameterGetCount
• 5.7.2 OBDNetParameterGetUniqueId
• 5.7.3 OBDNetParameterGetPidList
• 5.7.4 OBDNetParameterGetInfo
• 5.7.5 OBDNetParameterGetCurrentValue
• 5.8 Logging functions
• 5.8.1 OBDNetLoggingGetSelectedPidList
• 5.8.2 OBDNetLoggingClearSelectedPidList
• 5.8.3 OBDNetLoggingAddSelectedPid
• 5.8.4 OBDNetLoggingRemoveSelectedPid
• 5.8.5 OBDNetLoggingGetMode
• 5.8.6 OBDNetLoggingSetMode
• 5.8.7 OBDNetLoggingStartStreamingPid
• 5.8.8 OBDNetLoggingStopStreamingPid
• 5.8.9 OBDNetLoggingStopStreamingAllPids

OBDNet overview here.

2.1 Initializing

You must initialize OBDNet before using it. You initialize OBDNet by calling OBDNetInitialize. OBDNetInitialize takes into account what programming language you are using, in order to correctly return data.

After initializing, you need to create an OBDNET_HANDLE to identify the connection. This enables you to connect to more than one OBDNet server at once. Call OBDNetCreate to create a handle. You also need to call OBDNetWorker often, using the newly created handle.

2.2 Getting Connected

Now you have completely initialized OBDNet, you need to connect. OBDNetOpenConnection will connect you to an OBDNet server. It requires an active OBDNET_HANDLE.

2.3 Datalogging

Now that you are connected, it's time to get some data! To get the list of availble PIDs, use OBDNetGetPidList. This will call the OBDNET_CALLBACK_PID_LIST_ITEM callback for each PID.

typedef struct
{
	unsigned long	PidValueType;
	unsigned long	TimeStamp;
	double		EnglishValue;
	double		MetricValue;
	const char *	EnglishValueString;
	const char *	MetricValueString;
	const char *	UniqueId;
} OBDNET_PID_VALUE;

typedef struct
{
	unsigned long Supported;
	unsigned long Priority;
	const char * UniqueId;
	const char * Name;
	const char * Category;
	const char * EnglishUnits;
	const char * MetricUnits;
} OBDNET_PID_INFO;

#define OBDNET_CALLBACK_PID_LIST_ITEM		0
#define OBDNET_CALLBACK_SELECTED_PID_ITEM	1
#define OBDNET_CALLBACK_STREAMING_PID_VALUE	2

typedef void (OBDNET_CALLBACK * OBDNET_CALLBACK_PID_LIST_ITEM_PROTOTYPE) (OBDNET_HANDLE OBDNetHandle, const char * lpszPidUniqueId);

typedef void (OBDNET_CALLBACK * OBDNET_CALLBACK_SELECTED_PID_ITEM_PROTOTYPE) (OBDNET_HANDLE OBDNetHandle, const char * lpszPidUniqueId);

typedef void (OBDNET_CALLBACK * OBDNET_CALLBACK_STREAMING_PID_VALUE_PROTOTYPE) (OBDNET_HANDLE OBDNetHandle, const OBDNET_PID_VALUE * pPidValue);

OBDNET_STATUS OBDNET_API OBDNetInitialize(
	unsigned long ApiType,
	void * lpReserved
);

OBDNET_STATUS OBDNET_API OBDNetUninitialize(
	void
);

OBDNET_STATUS OBDNET_API OBDNetCreate(
	void
);

OBDNET_STATUS OBDNET_API OBDNetDestroy(
	OBDNET_HANDLE OBDNetHandle
);

const char * OBDNET_API OBDNetStatusGetErrorCodeString(
	OBDNET_STATUS ErrorCode
);

OBDNET_STATUS OBDNET_API OBDNetEnableDebugMode(
	const char * lpszTechlogFileName,
	unsigned long DebugLevel,
	BOOL EnableDebugTracing
);

OBDNET_STATUS OBDNET_API OBDNetEnableSequentialWriting(
	BOOL EnableSequentialWriting
);

OBDNET_STATUS OBDNET_API OBDNetDisableDebugMode(
	void
);

POBDII_STATUS POBDII_API OBDNetOpenConnection(
			OBDNET_HANDLE OBDNetHandle,
			const char * lpszServer,
			unsigned long Port,
			unsigned long TimeoutInMilliseconds
);

OBDNET_STATUS OBDNET_API OBDNetCloseConnection(
	OBDNET_HANDLE OBDNetHandle
);

BOOL OBDNET_API OBDNetIsConnected(
	OBDNET_HANDLE OBDNetHandle
);

OBDNET_STATUS OBDNET_API OBDNetWorker(
	OBDNET_HANDLE OBDNetHandle
);

OBDNET_STATUS OBDNET_API OBDNetSetCallback(
	unsigned long CallbackNumber,
	void * pCallback
);

OBDNET_STATUS OBDNET_API OBDNetSetWorkerTimeout(
	OBDNET_HANDLE OBDNetHandle,
	unsigned long TimeoutInMilliseconds
);

OBDNET_STATUS OBDNET_API OBDNetSetWorkerTimeout(
	OBDNET_HANDLE OBDNetHandle,
	unsigned long TimeoutInMilliseconds
);

unsigned long OBDNET_API OBDNetParameterGetCount(
	OBDNET_HANDLE OBDNetHandle
);

const char * OBDNET_API OBDNetParameterGetUniqueId(
	OBDNET_HANDLE OBDNetHandle,
	unsigned long PidIndex
);

OBDNET_STATUS OBDNET_API OBDNetParameterGetPidList(
	OBDNET_HANDLE OBDNetHandle
);

OBDNET_STATUS OBDNET_API OBDNetParameterGetInfo(
	OBDNET_HANDLE OBDNetHandle,
	const char * lpszUniqueId,
	OBDNET_PID_INFO * lpPidInfo
);

OBDNET_STATUS OBDNET_API OBDNetParameterGetCurrentValue(
	OBDNET_HANDLE OBDNetHandle,
	const char * lpszUniqueId,
	OBDNET_PID_VALUE * lpPidValue
);

OBDNET_STATUS OBDNET_API OBDNetLoggingGetSelectedPidList(
	OBDNET_HANDLE OBDNetHandle
);

OBDNET_STATUS OBDNET_API OBDNetLoggingClearSelectedPidList(
	OBDNET_HANDLE OBDNetHandle
);

OBDNET_STATUS OBDNET_API OBDNetLoggingAddSelectedPid(
	OBDNET_HANDLE OBDNetHandle,
	const char * lpszPid
);

OBDNET_STATUS OBDNET_API OBDNetLoggingRemoveSelectedPid(
	OBDNET_HANDLE OBDNetHandle,
	const char * lpszPid
);

unsigned long OBDNET_API OBDNetLoggingGetMode(
	OBDNET_HANDLE OBDNetHandle
);

OBDNET_STATUS OBDNET_API OBDNetLoggingSetMode(
	OBDNET_HANDLE OBDNetHandle,
	unsigned long LoggingMode
);

OBDNET_STATUS OBDNET_API OBDNetLoggingStartStreamingPid(
	OBDNET_HANDLE OBDNetHandle,
	const char * lpszPid
);

OBDNET_STATUS OBDNET_API OBDNetLoggingStopStreamingPid(
	OBDNET_HANDLE OBDNetHandle,
	const char * lpszPid
);

OBDNET_STATUS OBDNET_API OBDNetLoggingStopStreamingAllPids(
	OBDNET_HANDLE OBDNetHandle
);