Extensions.ComInterface.GetBatteryVoltageFromComInterface

From emotive
Jump to navigation Jump to search

Classification

Name GetBatteryVoltageFromComInterface
Short Description The battery voltage (as measured in Volts on the VCI module's VCI connector) as a float value.
Class Term
Extension OTX ComInterface extension
Group ComInterface related Terms
Exceptions NotConnectedException
Checker Rules
Standard Compliant Yes

OTL Syntax

FloatTerm ComInterface.GetBatteryVoltageFromComInterface(ComInterfaceTerm comInterface);

Description

It will return the battery voltage (as measured in Volts on the VCI module's VCI connector) as a float value.

Icons Note.png The appropriate MVCI system operation is MCDInterface::getBatteryVoltage()

Return Value

The Term returns the value, see table below.

Icons Note.png In OTX, Terms are categorized according to its return data type!
Data Type Description
Float The battery voltage (as measured in Volts on the VCI module's VCI connector) as a float value

Properties

Name Data Type Class Default Cardinality Description
comInterface ComInterface Term - [1..1] This element identifies the communication interface.

OTL Examples

	/// Local Declarations

	ComInterface.ComInterface ComInterface1;
	DiagCom.ComChannel ComChannel1;
	Float Float1;

	/// Flow

	ComInterface.ConnectComInterface(ConInterface1);
	Float1 = ComInterface.GetBatteryVoltageFromComInterface(ComInterface1);

See also

CloseComInterface
ConnectComInterface
DeactivateEthernet
CreateComChannelFromComInterface
GetComChannelFromComInterface
GetComInterface
GetComInterfaceNameListFromEthernet
GetComInterfaceProperties
GetComInterfaceResourceNameList
GetIgnitionStateFromComInterface
IsEthernetActivated
IsInterfaceConnected
GetComInterfaceNameList
GetDefaultComInterfaceName