Logger: Datawell WaveBuoy / Receiver support

Collaboration diagram for Logger: Datawell WaveBuoy / Receiver support:

Modules
	Logger: Datawell WaveBuoy channel numbering

Classes
struct	dw_params
	Configuration is as per simple network sources. More...

Functions
void *	dw_setup (void *ptargs)
	Datawell thread setup. More...
void *	dw_logging (void *ptargs)
	Datawell source main logging loop. More...
void *	dw_shutdown (void *ptargs)
	Datawell source shutdown. More...
bool	dw_net_connect (void *ptargs)
	DW Network connection helper. More...
void *	dw_channels (void *ptargs)
	Channel map. More...
void	dw_push_message (log_thread_args_t *args, uint8_t sNum, uint8_t cNum, float data)
	Create and push messages to queue. More...
device_callbacks	dw_getCallbacks (void)
	Fill out device callback functions for logging. More...
dw_params	dw_getParams (void)
	Fill out default MP source parameters. More...
bool	dw_parseConfig (log_thread_args_t *lta, config_section *s)
	Take a configuration section and parse parameters. More...

Detailed Description

Adds support for reading data from Datawell Wavebuoys in HXV format

Function Documentation

dw_channels()

void* dw_channels

(

void *

ptargs

)

Channel map.

Populate list of channels and push to queue as a map message

Parameters

[in]

ptargs

Pointer to log_thread_args_t

Returns

NULL - terminates thread on error

Definition at line 396 of file LoggerDW.c.

dw_getCallbacks()

device_callbacks dw_getCallbacks

(

void

)

Fill out device callback functions for logging.

Returns

device_callbacks for WaveRider type devices

Definition at line 369 of file LoggerDW.c.

dw_getParams()

dw_params dw_getParams

(

void

)

Fill out default MP source parameters.

Returns

Waverider specific defaults

Definition at line 380 of file LoggerDW.c.

dw_logging()

void* dw_logging

(

void *

ptargs

)

Datawell source main logging loop.

Reads messages from the connection established by dw_setup(), and pushes them to the queue. As messages are already in the right format, no further processing is done here.

Parameters

[in]

ptargs

Pointer to log_thread_args_t

Returns

NULL - thread terminated on error.

Definition at line 65 of file LoggerDW.c.

dw_net_connect()

bool dw_net_connect

(

void *

ptargs

)

DW Network connection helper.

Network connection helper.

Parameters

[in]

ptargs

Pointer to log_thread_args_t

Returns

True on success, false on failure

Definition at line 311 of file LoggerDW.c.

dw_parseConfig()

bool dw_parseConfig	(	log_thread_args_t *	lta,
		config_section *	s
	)

Take a configuration section and parse parameters.

Parameters

[in]	lta	Pointer to log_thread_args_t
[in]	s	Pointer to config_section to be parsed

Returns

True on success, false on error

Definition at line 470 of file LoggerDW.c.

dw_push_message()

void dw_push_message	(	log_thread_args_t *	args,
		uint8_t	sNum,
		uint8_t	cNum,
		float	data
	)

Create and push messages to queue.

Generate a single message for specified source and channel.

Terminates thread in the event of an error

Parameters

[in]	args	Pointer to log_thread_args_t
[in]	sNum	Source number
[in]	cNum	Channel number.

See also

Logger: Datawell WaveBuoy channel numbering

Parameters

[in]

data

Message value

Definition at line 265 of file LoggerDW.c.

dw_setup()

void* dw_setup

(

void *

ptargs

)

Datawell thread setup.

Opens a network connection

It is assumed that no other setup is required for these devices.

Parameters

[in]

ptargs

Pointer to log_thread_args_t

Returns

NULL - Error code set in ptargs->returnCode if required

Definition at line 43 of file LoggerDW.c.

dw_shutdown()

void* dw_shutdown

(

void *

ptargs

)

Datawell source shutdown.

Cleanly shutdown network connection

Parameters

[in]

ptargs

Pointer to log_thread_args_t

Returns

NULL

Definition at line 286 of file LoggerDW.c.