RequestMessage class is used to send the request message from the GRL-USB-PD-C2/F1 controller. More...

Public Member Functions
List< uint >	GetByteData ()
	Gets Byte Data.

byte[]	GetRawData_InBytes ()

	RequestMessage (bool isEprReq=false)
	Request Message Constructor.

bool	ClearDataObjects ()
	Clears the object.

bool	AddFixedVariableRequestDataObj (uint maxOperatingCurrent_10mA_Unit, uint operatingCurrent_10mA_Unit, uint ObjPosition=1, bool UnchkExtendedMsgSupport=false, bool NoUsbSuspended=false, bool UsbCommCapable=false, bool CapMismatch=false, bool GiveBack_Flag=false, bool EprModeCapable=false)
	Allows to set Fixed Variable Request Data object.

bool	AddFixedVariableRequestDataObjwithGivebackSup (uint MinOperatingCurrent_10mA_Unit, uint OperatingCurrent_10mA_Unit, uint ObjPosition, bool UnchkExtendedMsgSupport=false, bool NoUsbSuspended=false, bool UsbCommCapable=false, bool CapMismatch=false, bool GiveBack_Flag=false)
	Allows to set Fixed Variable Request Data object with Giveback Support.

bool	AddBatteryRequestDataObj (uint MaxOperatingPower_250mW_Unit, uint OperatingPower_250mW_Unit, uint ObjPosition, bool UnchkExtendedMsgSupport=false, bool NoUsbSuspended=false, bool UsbCommCapable=false, bool CapMismatch=false, bool GiveBack_Flag=false)
	Allows to set Battery Request Data object.

bool	AddBatteryRequestDataObjwithGivebackSup (uint MinOperatingPower_250mW_Unit, uint OperatingPower_250mW_Unit, uint ObjPosition, bool UnchkExtendedMsgSupport=false, bool NoUsbSuspended=false, bool UsbCommCapable=false, bool CapMismatch=false, bool GiveBack_Flag=false)
	Allows to set the Battery Request Data object with Give =back Support.

bool	AddProgramRequestDataObj (uint OperatingCurrent_50mA_Unit, uint OutputVoltage_20mV_Unit, uint ObjPosition=1, bool UnchkExtendedMsgSupport=false, bool NoUsbSuspended=false, bool UsbCommCapable=false, bool CapMismatch=false, bool GiveBack_Flag=false)
	Allows to set Program Request Data Object.

bool	AddAVSRequestDataObj (uint OperatingCurrent_50mA_Unit, uint OutputVoltage_25mV_Unit, uint ObjPosition=1, bool UnchkExtendedMsgSupport=false, bool NoUsbSuspended=false, bool UsbCommCapable=false, bool CapMismatch=false, bool EprModeCapable=false)
	Allows to set Adjustable Voltage Supply Request Data object.

void	PDMessageHeaderNameValuePair (PDMessage pdoMessage)

void	PDMessagePDONameValuePair (PDMessage pdoMessage)

void	UpdateExtendedHeader (byte dataSize, byte requestChunk, byte chunkNumber, byte chunked)

void	UpdateHeader (uint specificationRevision, uint extended)

Public Attributes
List< uint >	m_ReqMsgPowerDataObject

List< KeyValuePair< string, string > >	Header = new List<KeyValuePair<string, string>>()

List< Dictionary< string, string > >	PDO = new List<Dictionary<string, string>>()

uint	extendedHeader

uint	msgHeader

Detailed Description

RequestMessage class is used to send the request message from the GRL-USB-PD-C2/F1 controller.

Constructor & Destructor Documentation

◆ RequestMessage()

GrlPdLib.RequestMessage.RequestMessage ( bool isEprReq = false )

Request Message Constructor.

Member Function Documentation

◆ AddAVSRequestDataObj()

bool GrlPdLib.RequestMessage.AddAVSRequestDataObj	(	uint	OperatingCurrent_50mA_Unit,
		uint	OutputVoltage_25mV_Unit,
		uint	ObjPosition = 1,
		bool	UnchkExtendedMsgSupport = false,
		bool	NoUsbSuspended = false,
		bool	UsbCommCapable = false,
		bool	CapMismatch = false,
		bool	EprModeCapable = false )

Allows to set Adjustable Voltage Supply Request Data object.

Parameters

OutputVoltage_25mV_Unit	Maximum Operating Current 25mA units.
OperatingCurrent_50mA_Unit	Operating Current 50mA units.
ObjPosition	Object Position.
UnchkExtendedMsgSupport	Unchunked Extended Messages Supported.
NoUsbSuspended	No USB Suspended.
UsbCommCapable	USB Communication Capable.
CapMismatch	Capability Mismatch.

Returns: on success returns true else false.

◆ AddBatteryRequestDataObj()

bool GrlPdLib.RequestMessage.AddBatteryRequestDataObj	(	uint	MaxOperatingPower_250mW_Unit,
		uint	OperatingPower_250mW_Unit,
		uint	ObjPosition,
		bool	UnchkExtendedMsgSupport = false,
		bool	NoUsbSuspended = false,
		bool	UsbCommCapable = false,
		bool	CapMismatch = false,
		bool	GiveBack_Flag = false )

Allows to set Battery Request Data object.

Parameters

MaxOperatingPower_250mW_Unit	Maximum Operating Power 250mW units.
OperatingPower_250mW_Unit	Operating Power 250mW units.
ObjPosition	Object Position
UnchkExtendedMsgSupport	Unchunked Extended Messages Supported.
NoUsbSuspended	No USB Suspended.
UsbCommCapable	USB Communication Capable.
CapMismatch	Capability Mismatch.
GiveBack_Flag	Giveback Flag.

Returns: On success returns true else false.

◆ AddBatteryRequestDataObjwithGivebackSup()

bool GrlPdLib.RequestMessage.AddBatteryRequestDataObjwithGivebackSup	(	uint	MinOperatingPower_250mW_Unit,
		uint	OperatingPower_250mW_Unit,
		uint	ObjPosition,
		bool	UnchkExtendedMsgSupport = false,
		bool	NoUsbSuspended = false,
		bool	UsbCommCapable = false,
		bool	CapMismatch = false,
		bool	GiveBack_Flag = false )

Allows to set the Battery Request Data object with Give =back Support.

Parameters

MinOperatingPower_250mW_Unit	Minimum Operating Power 250mW units.
OperatingPower_250mW_Unit	Operating Power 250mW units.
UnchkExtendedMsgSupport	Unchunked Extended Messages Supported.
NoUsbSuspended	No USB Suspended.
UsbCommCapable	USB Communication Capable.
CapMismatch	Capability Mismatch.
GiveBack_Flag	Giveback Flag.

Returns: Returns true on success else false.

◆ AddFixedVariableRequestDataObj()

bool GrlPdLib.RequestMessage.AddFixedVariableRequestDataObj	(	uint	maxOperatingCurrent_10mA_Unit,
		uint	operatingCurrent_10mA_Unit,
		uint	ObjPosition = 1,
		bool	UnchkExtendedMsgSupport = false,
		bool	NoUsbSuspended = false,
		bool	UsbCommCapable = false,
		bool	CapMismatch = false,
		bool	GiveBack_Flag = false,
		bool	EprModeCapable = false )

Allows to set Fixed Variable Request Data object.

Parameters

MaxOperatingCurrent_10mA_Unit	Maximum Operating Current 10mA units.
OperatingCurrent_10mA_Unit	Operating Current 10mA units.
ObjPosition	Object Position.
UnchkExtendedMsgSupport	Unchunked Extended Messages Supported.
NoUsbSuspended	No USB Suspended.
UsbCommCapable	USB Communication Capable.
CapMismatch	Capability Mismatch.
GiveBack_Flag	GiveBack Flag.

Returns: on success returns true else false.

◆ AddFixedVariableRequestDataObjwithGivebackSup()

bool GrlPdLib.RequestMessage.AddFixedVariableRequestDataObjwithGivebackSup	(	uint	MinOperatingCurrent_10mA_Unit,
		uint	OperatingCurrent_10mA_Unit,
		uint	ObjPosition,
		bool	UnchkExtendedMsgSupport = false,
		bool	NoUsbSuspended = false,
		bool	UsbCommCapable = false,
		bool	CapMismatch = false,
		bool	GiveBack_Flag = false )

Allows to set Fixed Variable Request Data object with Giveback Support.

Parameters

MinOperatingCurrent_10mA_Unit	Minimum Operating Current 10mA units.
OperatingCurrent_10mA_Unit	Operating Current 10mA Unit.
UnchkExtendedMsgSupport	Unchunked Extended Messages Supported.
NoUsbSuspended	No USB Suspended.
UsbCommCapable	USB Communication Capable.
CapMismatch	Capability Mismatch.
GiveBack_Flag	GiveBack Flag.

Returns: On success Returns True else False

◆ AddProgramRequestDataObj()

bool GrlPdLib.RequestMessage.AddProgramRequestDataObj	(	uint	OperatingCurrent_50mA_Unit,
		uint	OutputVoltage_20mV_Unit,
		uint	ObjPosition = 1,
		bool	UnchkExtendedMsgSupport = false,
		bool	NoUsbSuspended = false,
		bool	UsbCommCapable = false,
		bool	CapMismatch = false,
		bool	GiveBack_Flag = false )

Allows to set Program Request Data Object.

Parameters

OperatingCurrent_50mA_Unit	Operating Current 50mA units.
OutputVoltage_20mV_Unit	Output Voltage 20mV units.
UnchkExtendedMsgSupport	Unchunked Extended Messages Supported.
NoUsbSuspended	No USB Suspended.
UsbCommCapable	USB Communication Capable.
CapMismatch	Capability Mismatch.
GiveBack_Flag	GiveBack Flag.

Returns: returns true on success else false.

◆ ClearDataObjects()

bool GrlPdLib.RequestMessage.ClearDataObjects ( )

Clears the object.

Returns: Returns true.

◆ GetByteData()

List< uint > GrlPdLib.RequestMessage.GetByteData ( )

Gets Byte Data.

Returns: returns the PDO Payload along with buffer.

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ RequestMessage()

Member Function Documentation

◆ AddAVSRequestDataObj()

◆ AddBatteryRequestDataObj()

◆ AddBatteryRequestDataObjwithGivebackSup()

◆ AddFixedVariableRequestDataObj()

◆ AddFixedVariableRequestDataObjwithGivebackSup()

◆ AddProgramRequestDataObj()

◆ ClearDataObjects()

◆ GetByteData()