GrlPdLib.SourceCapabilitiesExtendedMessages Class Reference

Source Capabilities Extended Messages configuration class. More...

Public Member Functions
List< byte >	GetListOfByteData ()
bool	ClearDataObjects ()
bool	AddSrcCap (int VID, int PID, uint XID, byte FW_Version, byte HW_Version, byte Holdup_Time, byte Touch_Temperature, byte NumberofBatteries, byte SPRSourcePDP, byte EPRSourcePDP)
	Source Capabilities Extended Data Block.
byte	VoltageRegulationConfiguration (uint loadStep=0, uint IoC=0)
	Allows to set Voltage Regulations, which contains bits covering Load Step Slew Rate and Magnitude.
byte	ComplianceConfiguration (bool LPS=false, bool PS1=false, bool PS2=false)
	Allows to set Compliance Value, which contain the standards the Source is compliant with.
byte	TouchCurrentConfiguration (bool LowTouch=false, bool GroundPinSupported=false, bool GroundPinforEarth=false)
	Allows to set whether the Source meets certain leakage current levels and if it has a ground pin.
byte[]	PeakCurrent_1_Configuration (uint PercentageOverload_10percent, uint OverloadPeriod_20mS, uint DutyCycle_5percent, bool VbusVoltageDroop=false)
	Allows to set the combinations of Peak Current that the Source supports.
byte[]	PeakCurrent_2_Configuration (uint PercentageOverload_10percent, uint OverloadPeriod_20mS, uint DutyCycle_5percent, bool VbusVoltageDroop=false)
	Allows to set the combinations of Peak Current that the Source supports.
byte[]	PeakCurrent_3_Configuration (uint PercentageOverload_10percent, uint OverloadPeriod_20mS, uint DutyCycle_5percent, bool VbusVoltageDroop=false)
	Allows to set the combinations of Peak Current that the Source supports.
byte	SoucreInputsConfiguration (bool externalSupply=false, bool externalSupplyConstrained=false, bool InternalBattery=false)
	Identify the possible inputs that provide power to the Source.
bool	ExtendedHeaderConfiguration (ushort datasize, bool Chunked=false)
	Sets Extended header configuration.

Detailed Description

Source Capabilities Extended Messages configuration class.

Member Function Documentation

AddSrcCap()

bool GrlPdLib.SourceCapabilitiesExtendedMessages.AddSrcCap	(	int	VID,
		int	PID,
		uint	XID,
		byte	FW_Version,
		byte	HW_Version,
		byte	Holdup_Time,
		byte	Touch_Temperature,
		byte	NumberofBatteries,
		byte	SPRSourcePDP,
		byte	EPRSourcePDP )

Source Capabilities Extended Data Block.

Parameters

VID	Vendor ID (assigned by the USB-IF).
PID	Product ID (assigned by the manufacturer).
XID	Value provided by the USB-IF assigned to the product.
FW_Version	Firmware Version number.
HW_Version	Hardware Version number.
Voltage_Reg	Load Step Slew Rate and Magnitude.
Holdup_Time	The Source’s holdup time.
Compliance	The standards the Source is compliant.
Touch_Current	The Source meets certain leakage current levels and if it has a ground pin.
Touch_Temperature	The IEC standard used to determine the surface temperature of the Source’s enclosure. Temperature conforms to: 0 = [IEC 60950-1] (default) 1 = [IEC 62368-1] TS1 2 = [IEC 62368-1] TS2
SourceInputs	The possible inputs that provide power to the Source.
NumberofBatteries	The number of batteries the source supports.
SourcePDP	Source rated PDP.

Returns

ComplianceConfiguration()

byte GrlPdLib.SourceCapabilitiesExtendedMessages.ComplianceConfiguration	(	bool	LPS = false,
		bool	PS1 = false,
		bool	PS2 = false )

Allows to set Compliance Value, which contain the standards the Source is compliant with.

Parameters

LPS	LPS Complaint
PS1	PS1 Complaint
PS2	PS2 Complaint

Returns

returns Complianse value set in terms of byte.

ExtendedHeaderConfiguration()

bool GrlPdLib.SourceCapabilitiesExtendedMessages.ExtendedHeaderConfiguration	(	ushort	datasize,
		bool	Chunked = false )

Sets Extended header configuration.

Parameters

datasize	Size of the Source or Sink Extended Messages.
Chunked	Series of Data Blocks. true : Chunked , false : unchunked

Returns

true:Extended Header configured properly, false : Failure in extended header configuration

PeakCurrent_1_Configuration()

byte[] GrlPdLib.SourceCapabilitiesExtendedMessages.PeakCurrent_1_Configuration	(	uint	PercentageOverload_10percent,
		uint	OverloadPeriod_20mS,
		uint	DutyCycle_5percent,
		bool	VbusVoltageDroop = false )

Allows to set the combinations of Peak Current that the Source supports.

Parameters

PercentageOverload_10percent	Percent overload in 10% increments Values higher than 25 (11001b) are clipped to 250%.
OverloadPeriod_20mS	Overload period in 20ms.
DutyCycle_5percent	Duty Cycle in 5% increments.
VbusVoltageDroop	VBUS Voltage droop.

Returns

returns Peak Current Set in bytes.

PeakCurrent_2_Configuration()

byte[] GrlPdLib.SourceCapabilitiesExtendedMessages.PeakCurrent_2_Configuration	(	uint	PercentageOverload_10percent,
		uint	OverloadPeriod_20mS,
		uint	DutyCycle_5percent,
		bool	VbusVoltageDroop = false )

Allows to set the combinations of Peak Current that the Source supports.

Parameters

PercentageOverload_10percent	Percent overload in 10% increments Values higher than 25 (11001b) are clipped to 250%.
OverloadPeriod_20mS	Overload period in 20ms.
DutyCycle_5percent	Duty Cycle in 5% increments.
VbusVoltageDroop	VBUS Voltage droop.

Returns

returns Peak Current Set in bytes.

PeakCurrent_3_Configuration()

byte[] GrlPdLib.SourceCapabilitiesExtendedMessages.PeakCurrent_3_Configuration	(	uint	PercentageOverload_10percent,
		uint	OverloadPeriod_20mS,
		uint	DutyCycle_5percent,
		bool	VbusVoltageDroop = false )

Allows to set the combinations of Peak Current that the Source supports.

Parameters

PercentageOverload_10percent	Percent overload in 10% increments Values higher than 25 (11001b) are clipped to 250%.
OverloadPeriod_20mS	Overload period in 20ms.
DutyCycle_5percent	Duty Cycle in 5% increments.
VbusVoltageDroop	VBUS Voltage droop.

Returns

returns Peak Current Set in bytes.

SoucreInputsConfiguration()

byte GrlPdLib.SourceCapabilitiesExtendedMessages.SoucreInputsConfiguration	(	bool	externalSupply = false,
		bool	externalSupplyConstrained = false,
		bool	InternalBattery = false )

Identify the possible inputs that provide power to the Source.

Parameters

externalSupply	The Source can be sourced by an external power supply.
externalSupplyConstrained	The Source can be sourced by an external power supply which is assumed to be effectively “infinite”.
InternalBattery	The Source can be sourced by an internal Battery.

Returns

returns the Source inputs in byte data.

TouchCurrentConfiguration()

byte GrlPdLib.SourceCapabilitiesExtendedMessages.TouchCurrentConfiguration	(	bool	LowTouch = false,
		bool	GroundPinSupported = false,
		bool	GroundPinforEarth = false )

Allows to set whether the Source meets certain leakage current levels and if it has a ground pin.

Parameters

LowTouch	Low touch Current EPS
GroundPinSupported	Ground pin supported
GroundPinforEarth	Ground pin intended for protective earth

Returns

returns Touch Current set in terms of byte.

VoltageRegulationConfiguration()

byte GrlPdLib.SourceCapabilitiesExtendedMessages.VoltageRegulationConfiguration	(	uint	loadStep = 0,
		uint	IoC = 0 )

Allows to set Voltage Regulations, which contains bits covering Load Step Slew Rate and Magnitude.

Parameters

loadStep	00b: 150mA/µs Load Step (default) 01b: 500mA/µs Load Step 11b…10b: Reserved
IoC	0b: 25% IoC (default) 1b: 90% IoC

Returns

return Voltage regulation data set in terms of byte.