These functions expose a SCS::Receiver to be callable from an ANSI C application. More...

#include "dllexport.h"

Include dependency graph for ansicreceiver.h:

Typedefs
typedef void(*	funcSTS )()
	handle a State Transmission Service
typedef void(*	funcMCS )(unsigned short, unsigned short)
	handle a Module Control Service
typedef unsigned long(*	funcMIS )()
	handle a Module Information Service
typedef int(*	funcDRS )(unsigned long)
	handle a Data Request Service
Functions
DLL_PUBLIC void *	createReceiver (unsigned short required_revision)
	Open the network interfaces and announce yourself to other participants on the bus.
DLL_PUBLIC void *	createReceiverWithFunctionOverride (unsigned short required_revision, funcSTS sts, funcMCS mcs, funcMIS mis, funcDRS drs)
	Open the network interfaces and announce yourself to other participants on the bus.
DLL_PUBLIC void *	createReceiverForGroup (unsigned short required_revision, unsigned int node_id, const char *host_addr)
	Open the network interfaces and announce yourself to other participants on a specified multicast group.
DLL_PUBLIC void *	createReceiverForGroupWithFunctionOverride (unsigned short required_revision, unsigned int node_id, const char *host_addr, funcSTS sts, funcMCS mcs, funcMIS mis, funcDRS drs)
	Open the network interfaces and announce yourself to other participants on a specified multicast group.
DLL_PUBLIC void	requestDataI (void recv, unsigned long id, int id29, int i)
DLL_PUBLIC void	requestDataF (void recv, unsigned long id, int id29, float f)
DLL_PUBLIC void	requestDataD (void recv, unsigned long id, int id29, double d)
DLL_PUBLIC void	requestDataB (void recv, unsigned long id, int id29, int i)
DLL_PUBLIC void	requestDataS (void recv, unsigned long id, int id29, char c, unsigned long maxlength)
DLL_PUBLIC void	requestDataVF (void recv, unsigned long id, int id29, float f, unsigned long maxlength)
DLL_PUBLIC void	requestModule (void *recv, unsigned int node_id, unsigned int module, unsigned int mode)
DLL_PUBLIC void	sendDataI (void *recv, unsigned long id, int id29, int i)
DLL_PUBLIC void	sendDataF (void *recv, unsigned long id, int id29, float f)
DLL_PUBLIC void	sendDataD (void *recv, unsigned long id, int id29, double d)
DLL_PUBLIC void	sendDataB (void *recv, unsigned long id, int id29, int i)
DLL_PUBLIC void	sendDataS (void recv, unsigned long id, int id29, const char c, unsigned long maxlength)
DLL_PUBLIC void	sendDataVF (void recv, unsigned long id, int id29, float f, unsigned long maxlength)
DLL_PUBLIC void	run (void *recv)
DLL_PUBLIC void	freeReceiver (void *recv)

Detailed Description

These functions expose a SCS::Receiver to be callable from an ANSI C application.

Use this to connect to SCS if you can't use the C++ interface. Exposes only the most basic functions.

Function Documentation

DLL_PUBLIC void* createReceiver ( unsigned short required_revision )

Open the network interfaces and announce yourself to other participants on the bus.

Parameters:

required_software_revision revision of the CAN Aerospace distribution your application requires

Returns:: opaque pointer to Receiver

DLL_PUBLIC void* createReceiverForGroup	(	unsigned short	required_revision,
		unsigned int	node_id,
		const char *	host_addr
	)

Open the network interfaces and announce yourself to other participants on a specified multicast group.

This function should not be needed under normal circumstances. You should use it only if you need to change the mulitcast group. Don't use it to inject other IP adresses than multicast addresses. SCS in default config will NOT work if you do this

Parameters:

required_software_revision	revision of the CAN Aerospace distribution your application requires
own_node_id	your assigned node id or 255 for auto-configuration
host_addr	multicast group for SCS communication

Returns:: opaque pointer to Receiver

DLL_PUBLIC void* createReceiverForGroupWithFunctionOverride	(	unsigned short	required_revision,
		unsigned int	node_id,
		const char *	host_addr,
		funcSTS	sts,
		funcMCS	mcs,
		funcMIS	mis,
		funcDRS	drs
	)

Open the network interfaces and announce yourself to other participants on a specified multicast group.

This function should not be needed under normal circumstances. You should use it only if you need to change the mulitcast group. Don't use it to inject other IP adresses than multicast addresses. SCS in default config will NOT work if you do this

Mimics overriding the Receiver class with virtual functions. Use this if you want to ovveride the default behavior

Parameters:

required_software_revision	revision of the CAN Aerospace distribution your application requires
own_node_id	your assigned node id or 255 for auto-configuration
host_addr	multicast group for SCS communication
sts	function to be called instead of Receiver::handleSTS
mcs	function to be called instead of Receiver::handleMCS
mis	function to be called instead of Receiver::handleMIS
drs	function to be called instead of Receiver::handleDRS

Returns:: opaque pointer to Receiver

DLL_PUBLIC void* createReceiverWithFunctionOverride	(	unsigned short	required_revision,
		funcSTS	sts,
		funcMCS	mcs,
		funcMIS	mis,
		funcDRS	drs
	)

Open the network interfaces and announce yourself to other participants on the bus.

Mimics overriding the Receiver class with virtual functions. Use this if you want to ovveride the default behavior

Parameters:

required_software_revision	revision of the CAN Aerospace distribution your application requires
sts	function to be called instead of Receiver::handleSTS
mcs	function to be called instead of Receiver::handleMCS
mis	function to be called instead of Receiver::handleMIS
drs	function to be called instead of Receiver::handleDRS

Returns:: opaque pointer to Receiver

DLL_PUBLIC void freeReceiver ( void * recv )

Close all connections and free memory allocated by Receiver

Parameters:

recv	opaque pointer to Receiver

DLL_PUBLIC void requestDataB	(	void *	recv,
		unsigned long	id,
		int	id29,
		int *	i
	)

Request to receive updates on the given CAN Id from the bus. The identifier distribution defines which data format is used. If the identifier distribution uses bools, this function converts it to ints

Parameters:

recv	opaque pointer to Receiver
id	CAN id of simulation data, specified in identifier distribution
id29	id width of the CAN id, 1 for 29bit, 0 for 11bit
i	Pointer to variable to be updated when value changes on the bus

DLL_PUBLIC void requestDataD	(	void *	recv,
		unsigned long	id,
		int	id29,
		double *	d
	)

Request to receive updates on the given CAN Id from the bus. The identifier distribution defines which data format is used.

Parameters:

recv	opaque pointer to Receiver
id	CAN id of simulation data, specified in identifier distribution
id29	id width of the CAN id, 1 for 29bit, 0 for 11bit
d	Pointer to variable to be updated when value changes on the bus

DLL_PUBLIC void requestDataF	(	void *	recv,
		unsigned long	id,
		int	id29,
		float *	f
	)

Request to receive updates on the given CAN Id from the bus. The identifier distribution defines which data format is used.

Parameters:

recv	opaque pointer to Receiver
id	CAN id of simulation data, specified in identifier distribution
id29	id width of the CAN id, 1 for 29bit, 0 for 11bit
f	Pointer to variable to be updated when value changes on the bus

DLL_PUBLIC void requestDataI	(	void *	recv,
		unsigned long	id,
		int	id29,
		int *	i
	)

Request to receive updates on the given CAN Id from the bus. The identifier distribution defines which data format is used.

Parameters:

recv	opaque pointer to Receiver
id	CAN id of simulation data, specified in identifier distribution
id29	id width of the CAN id, 1 for 29bit, 0 for 11bit
i	Pointer to variable to be updated when value changes on the bus

DLL_PUBLIC void requestDataS	(	void *	recv,
		unsigned long	id,
		int	id29,
		char *	c,
		unsigned long	maxlength
	)

Request to receive updates on the given CAN Id from the bus. The identifier distribution defines which data format is used.

Parameters:

recv	opaque pointer to Receiver
id	CAN id of simulation data, specified in identifier distribution
id29	id width of the CAN id, 1 for 29bit, 0 for 11bit
c	Pointer to char array to be updated when value changes on the bus
maxlength	maximum number of characters to be written to the memory specified by c

DLL_PUBLIC void requestDataVF	(	void *	recv,
		unsigned long	id,
		int	id29,
		float *	f,
		unsigned long	maxlength
	)

Request to receive updates on the given CAN Id from the bus. The identifier distribution defines which data format is used.

Parameters:

recv	opaque pointer to Receiver
id	CAN id of simulation data, specified in identifier distribution
id29	id width of the CAN id, 1 for 29bit, 0 for 11bit
f	Pointer to float array to be updated when value changes on the bus
maxlength	maximum number of floats to be written to the memory specified by f

DLL_PUBLIC void requestModule	(	void *	recv,
		unsigned int	node_id,
		unsigned int	module,
		unsigned int	mode
	)

Request another bus participant to en- or disable one of its modules.

Causes the node to be asked via MIS aboutits capabilities and enables the requested capability via MCS.

Parameters:

recv	opaque pointer to Receiver
node_id	node which owns the requested module
module	number of the module to be enabled
mode	the mode command to set

DLL_PUBLIC void run ( void * recv )

Call this repeatedly, either from the application's main loop or a separate application thread.

Will update pointers and invoke callbacks with new data. Big black magic box that makes all work as you expect, ensuring the protocol is handled following the CAN Aerospace and SCS specifications.

Parameters:

recv	opaque pointer to Receiver

DLL_PUBLIC void sendDataB	(	void *	recv,
		unsigned long	id,
		int	id29,
		int	i
	)