GrlPdLib.SinkCapabilitiesExtendedMessages Class Reference

SinkCapabilitiesExtendedMessages configuration class. More...

Public Member Functions
List< byte >	GetListOfByteData ()
byte[]	GetArrayByteData ()
bool	ClearDataObjects ()
List< byte >	AddSinkCaps (int VID, int PID, uint XID, byte FWVersion, byte HWVersion, byte SKEDBVersion, byte TouchTemp, byte BatteryInformation, byte SinkMinimumPDP, byte SinkOperationalPDP, byte SinkMaximumPDP, byte eprSnkMinPDP=0, byte eprSnkOpPDP=0, byte eprSnkMaxPDP=0)
	Sink Capabilities Extended Data Block.
byte	LoadStepConfiguration (uint loadStep=0)
	The Load Step Slew Rate and Magnitude that this Sink prefers.
byte[]	SinkLoadCharacteristicsCongiguration (uint PercentageOverload_10percent, uint OverloadPeriod_20mS, uint DutyCycle_5percent, bool VbusVoltageDroop=false)
	Preferred load characteristics.
byte	ComplianceConfiguration_Sink (bool LPS=false, bool PS1=false, bool PS2=false)
	Allows to set Compliance Value, the types of Sources the Sink has been tested and certified with.
byte	SinkModeConfiguration (bool PPSChargingSupported=false, bool VbusPowered=false, bool MainsPowered=false, bool BatteryPowered=false, bool BatteryEssentiallyUnlimited=false)
	The charging capabilities and the power sources that can be used by the Sink.
bool	ExtendedHeaderConfiguration (ushort datasize, bool Chunked=false)
	Sets Extended header configuration.

Detailed Description

SinkCapabilitiesExtendedMessages configuration class.

Member Function Documentation

AddSinkCaps()

List< byte > GrlPdLib.SinkCapabilitiesExtendedMessages.AddSinkCaps	(	int	VID,
		int	PID,
		uint	XID,
		byte	FWVersion,
		byte	HWVersion,
		byte	SKEDBVersion,
		byte	TouchTemp,
		byte	BatteryInformation,
		byte	SinkMinimumPDP,
		byte	SinkOperationalPDP,
		byte	SinkMaximumPDP,
		byte	eprSnkMinPDP = 0,
		byte	eprSnkOpPDP = 0,
		byte	eprSnkMaxPDP = 0 )

Sink 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.
FWVersion	Firmware Version number.
HWVersion	Hardware Version number.
SKEDBVersion	Version Level of Sink Capabilities Extended Data Block.
TouchTemp	The IEC standard used to determine the surface temperature of the Sink’s enclosure.
BatteryInformation	The number of batteries Sink Supports.
SinkMinimumPDP	The minimum power required by the Sink to operate all its functional modes except charging its battery if present.
SinkOperationalPDP	The manufacturer recommended PDP of the Sink.
SinkMaximumPDP	Highest amount of power the Sink consume under any operating condition including charging its battery if present.

param name="eprSnkMaxPDP" >The Maximum PDP the EPR Sink can consume to operate and charge its Battery(s) should it have one.

param name="eprSnkMinPDP">The Minimum PDP required by the EPR Sink to operate without consuming any power from its Battery(s) should it have one

param name="eprSnkOpPDP" >The PDP the EPR Sink requires to operate normally.For Sinks with a Battery, it is the PDP Rating of the charger supplied with it or recommended for it.

Returns

Returns List of Byte data of Sink Capabilities Extened Messages.

ComplianceConfiguration_Sink()

byte GrlPdLib.SinkCapabilitiesExtendedMessages.ComplianceConfiguration_Sink	(	bool	LPS = false,
		bool	PS1 = false,
		bool	PS2 = false )

Allows to set Compliance Value, the types of Sources the Sink has been tested and certified with.

Parameters

LPS	LPS Source
PS1	PS1 Source
PS2	PS2 Source

Returns

returns Complianse value set in terms of byte.

ExtendedHeaderConfiguration()

bool GrlPdLib.SinkCapabilitiesExtendedMessages.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

LoadStepConfiguration()

byte GrlPdLib.SinkCapabilitiesExtendedMessages.LoadStepConfiguration

(

uint

loadStep = 0

)

The Load Step Slew Rate and Magnitude that this Sink prefers.

Parameters

loadStep

00b: 150mA/µs Load Step (default) 01b: 500mA/µs Load Step 11b…10b: Reserved

Returns

returns Load Step Configuration in byte.

SinkLoadCharacteristicsCongiguration()

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

Preferred load characteristics.

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 Load Characteristics in 2 bytes

SinkModeConfiguration()

byte GrlPdLib.SinkCapabilitiesExtendedMessages.SinkModeConfiguration	(	bool	PPSChargingSupported = false,
		bool	VbusPowered = false,
		bool	MainsPowered = false,
		bool	BatteryPowered = false,
		bool	BatteryEssentiallyUnlimited = false )

The charging capabilities and the power sources that can be used by the Sink.

Parameters

PPSChargingSupported	PPS Source for fast charging.
VbusPowered	Sourced by Vbus.
MainsPowered	Sourced by an external mains power supply.
BatteryPowered	Sourced by Battery.
BatteryEssentiallyUnlimited	Sourced by a battery with essentially infinite energy.

Returns

returns Sink Modes in bytes.