Libsmr - Revision history

Lvm at 12:23, 29 September 2008

2008-09-29T12:23:45Z

← Older revision		Revision as of 14:23, 29 September 2008
Line 21:		Line 21:
	[[struct smr]] [[smr_connect]](char hostname, int port);		[[struct smr]] [[smr_connect]](char hostname, int port);

	void [smr_disconnect]([struct smr] *robot);		void [[smr_disconnect]]([[struct smr]] *robot);

	int [smr_read]([struct smr] *robot);		int [[smr_read]]([[struct smr]] *robot);

	int [smr_write]([struct smr] *robot);		int [[smr_write]]([[struct smr]] *robot);

	Each function, and the smr struct datatype, is described on its own page.		Each function, and the smr struct datatype, is described on its own page.

Lvm at 12:20, 29 September 2008

2008-09-29T12:20:52Z

← Older revision		Revision as of 14:20, 29 September 2008
Line 19:		Line 19:
	</pre>		</pre>

	[[struct smr]] [smr_connect](char hostname, int port);		[[struct smr]] [[smr_connect]](char hostname, int port);

	void [smr_disconnect]([struct smr] *robot);		void [smr_disconnect]([struct smr] *robot);

Lvm at 12:19, 29 September 2008

2008-09-29T12:19:49Z

← Older revision		Revision as of 14:19, 29 September 2008
Line 15:		Line 15:
	The following summary shows the function type declarations:		The following summary shows the function type declarations:

			<pre>
	#include <smr.h>		#include <smr.h>
			</pre>

	[struct smr] [smr_connect](char hostname, int port);		[[struct smr]] [smr_connect](char hostname, int port);

	void [smr_disconnect]([struct smr] *robot);		void [smr_disconnect]([struct smr] *robot);

Lvm: New page: LibSmr is the C programming library that enables C programs to communicate with the SMR sensor daemon, [smrd]. The library provides two types of functions: smr specific and low level. ''...

2008-09-29T12:18:34Z

New page: LibSmr is the C programming library that enables C programs to communicate with the SMR sensor daemon, [smrd]. The library provides two types of functions: smr specific and low level. ''...

New page

LibSmr is the C programming library that enables C programs to communicate with the SMR sensor daemon, [smrd].

The library provides two types of functions: smr specific and low level.

'''Smr specific functions'''

The library provides four C functions: smr_connect(), smr_disconnect(), smr_read() and smr_write().
These are modelled after similarly named functions familiar to C programmers, used for other kinds of input/output.

Central to all use of the smr specific functions if a ''struct smr'' datatype.
A pointer to such a struct is returned by smr_connect(), and this pointer is used in all subsequent calls to
smr_read() and smr_write(), and must finally be provided to smr_close().

To use the library, a header file must be included.
The following summary shows the function type declarations:

#include <smr.h>

[struct smr] *[smr_connect](char *hostname, int port);

void [smr_disconnect]([struct smr] *robot);

int [smr_read]([struct smr] *robot);

int [smr_write]([struct smr] *robot);

Each function, and the smr struct datatype, is described on its own page.

'''Low level functions'''

The low level functions are not currently documented.