eoMSCHelper Class Reference

contains static Helper Functions More...

#include <eoMSCHelper.h>

Public Member Functions
eoReturn	GetMSCmanufacturer (MANUFACTURER_LIST *manufacturer, eoMessage &msg)
eoReturn	GetMSCpayload (uint8_t *payload, uint8_t maxDataCount, eoMessage &msg)
eoReturn	SetMSCmanufacturer (const MANUFACTURER_LIST manufacturer, eoMessage &msg)
eoReturn	SetMSCpayload (const uint8_t *payload, uint8_t dataCount, eoMessage &msg)

Detailed Description

contains static Helper Functions

The eoMSCHelper allows you to easily integrate MSC telegrams into your program.

Member Function Documentation

GetMSCmanufacturer()

eoReturn eoMSCHelper::GetMSCmanufacturer	(	MANUFACTURER_LIST *	manufacturer,
		eoMessage &	msg
	)

Get the MSC manufacturer

Parameters

[out]	manufacturer	Pointer to the variable where the manufacturer ID should be returned
	msg	eoTelegram which needs to be converted

Returns

EO_OK or EO_ERROR

GetMSCpayload()

eoReturn eoMSCHelper::GetMSCpayload	(	uint8_t *	payload,
		uint8_t	maxDataCount,
		eoMessage &	msg
	)

Get the MSC payload

Parameters

[out]	payload	Pointer to an array
	maxDataCount	The size of the payload array
	msg	eoTelegram which needs to be converted

Returns

EO_OK or EO_ERROR

SetMSCmanufacturer()

eoReturn eoMSCHelper::SetMSCmanufacturer	(	const MANUFACTURER_LIST	manufacturer,
		eoMessage &	msg
	)

Set the MSC manufacturer

Parameters

manufacturer
msg

Returns

EO_OK

SetMSCpayload()

eoReturn eoMSCHelper::SetMSCpayload	(	const uint8_t *	payload,
		uint8_t	dataCount,
		eoMessage &	msg
	)

Set the MSC paylod

Parameters

payload
dataCount
msg

Returns

EO_OK or WRONG_PARAM