Inheritance diagram for Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >:

Public Member Functions
Boolean	Connect (Int32 comPortNumber, Int32 baudRate)
	Connect to a device via a dedicated serial/UART port.

Boolean	Connect (Int32 comPortNumber, Int32 baudRate, Int32 timeout)
	Connect to a device via a dedicated serial/UART port.

Boolean	Connect (String targetIpAddress, UInt16 targetPortNumber)
	Connect to a device via a dedicated IP address and port.

Boolean	Connect (String targetIpAddress, UInt16 targetPortNumber, Int32 timeout)
	Connect to a device via a dedicated IP address and port.

Boolean	Connect (String targetIpAddress, UInt16 targetPortNumber, String hostIpAddress, UInt16 hostPortNumber)
	Connect to a device via a dedicated IP address and port.

Boolean	Connect (String targetIpAddress, UInt16 targetPortNumber, String hostIpAddress, UInt16 hostPortNumber, Int32 timeout)
	Connect to a device via a dedicated IP address and port.

Boolean	IsConnected ()
	Check if a device is connected.

Boolean	Disconnect ()
	Disconnect from a device.

SystemCharacteristics	GetCharacteristics ()
	Get a instance of SystemCharacteristics.

ReferenceValues	GetReferenceValues ()
	Get an instance of ReferenceValues.

Sensing	GetSensing ()
	Get an instance of Sensing.

SystemReversePolarityProtection	GetSystemReversePolarityProtection ()

ActualSystemValues	GetActualValues ()
	Get an instance of ActualSystemValues.

Commands	GetCommands ()
	Get an instance of SystemCommands.

DataExchange	GetDataExchange ()
	Get an instance of DataExchange.

FunctionGenerator	GetFunctionGenerator ()
	Get an instance of FunctionGenerator.

SolarArraySimulation	GetSolarArraySimulation ()
	Get an instance of SolarArraySimulation.

BatteryControl	GetBatteryControl ()
	Get an instance of BatteryControl.

LoadProtection	GetLoadProtection ()
	Get an instance of LoadProtection.

SystemState	GetState ()
	Get an instance of SystemState.

EthernetConfiguration	GetEthernetConfiguration ()
	Get an instance of EthernetConfiguration.

SystemInformation	GetInformation ()
	Get an instance of SystemInformation.

LicenseInformation	GetLicenseInformation ()
	Get an instance of LicenseInformation.

OutputControl	GetOutputControl ()
	Get an instance of OutputControl.

Safety	GetSafety ()
	Get an instance of Safety.

ReferenceValueSource	GetReferenceValueSource ()
	Get an instance of ReferenceValueSource.

ParameterSetConfiguration	GetParameterSetConfiguration ()
	Gets an instance of ParameterSetConfiguration.

ActiveInterface	GetActiveInterface ()
	Get an instance of ActiveInterface.

OutputMeasurement	GetOutputMeasurement ()
	Get an instance of OutputMeasurement.

List< TDevice >	GetDeviceList ()

TDevice	GetDevice (UInt16 deviceId)

TDevice	GetConnectedDevice ()

Static Public Attributes
static bool	InitializeLogging = true
	Use this to suppress "reinitialization" of the logging in case of the WebAPI or any other caller that also uses log4net logging.

Events
G5ConnectionChangedDelegate	ConnectionChanged
	Informs whether or not there is a connection to the G5 device. In case of disconnection this can be: a) The user made the disconnection, b) Unexpected connection interruption.

Member Function Documentation

◆ Connect() [1/6]

Boolean Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.Connect	(	Int32	comPortNumber,
		Int32	baudRate )

inline

Connect to a device via a dedicated serial/UART port.

Parameters

comPortNumber	Number of the COM port (1 = COM1, 2 = COM2, ...)
baudRate	Baud rate. Supported values: 230400, 38400

Exceptions

ArgumentException
G5ApiException

◆ Connect() [2/6]

Boolean Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.Connect	(	Int32	comPortNumber,
		Int32	baudRate,
		Int32	timeout )

inline

Connect to a device via a dedicated serial/UART port.

Parameters

comPortNumber	Number of the COM port (1 = COM1, 2 = COM2, ...).
baudRate	Baud rate. Supported values: 230400, 38400.
timeout	Communication timeout.

Exceptions

ArgumentException
G5ApiException

◆ Connect() [3/6]

Boolean Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.Connect	(	String	targetIpAddress,
		UInt16	targetPortNumber )

inline

Connect to a device via a dedicated IP address and port.

Parameters

targetIpAddress	IP Address of the target device in IPv4 format (e.g. "192.168.1.20").
targetPortNumber	Port number of the target. Default: 2000.

Exceptions

ArgumentNullException
ArgumentException
G5ApiException

◆ Connect() [4/6]

Boolean Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.Connect	(	String	targetIpAddress,
		UInt16	targetPortNumber,
		Int32	timeout )

inline

Connect to a device via a dedicated IP address and port.

Parameters

targetIpAddress	IP Address of the target device in IPv4 format (e.g. "192.168.1.20").
targetPortNumber	Port number of the target. Default: 2000.
timeout	Port number of the target. Default: 2000.

Exceptions

ArgumentNullException
ArgumentException
G5ApiException

◆ Connect() [5/6]

Boolean Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.Connect	(	String	targetIpAddress,
		UInt16	targetPortNumber,
		String	hostIpAddress,
		UInt16	hostPortNumber )

inline

Connect to a device via a dedicated IP address and port.

Parameters

targetIpAddress	IP Address of the target device in IPv4 format (e.g. "192.168.1.20").
targetPortNumber	Port number of the target. Default: 2000.
hostIpAddress	IP Address of the host in IPv4 format (e.g. "192.168.1.10").
hostPortNumber	Port number of the host.

Exceptions

ArgumentNullException
ArgumentException
G5ApiException

◆ Connect() [6/6]

Boolean Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.Connect	(	String	targetIpAddress,
		UInt16	targetPortNumber,
		String	hostIpAddress,
		UInt16	hostPortNumber,
		Int32	timeout )

inline

Connect to a device via a dedicated IP address and port.

Parameters

targetIpAddress	IP Address of the target device in IPv4 format (e.g. "192.168.1.20").
targetPortNumber	Port number of the target. Default: 2000.
hostIpAddress	IP Address of the host in IPv4 format (e.g. "192.168.1.10").
hostPortNumber	Port number of the host.
timeout	Communication timeout.

Exceptions

ArgumentNullException
ArgumentException
G5ApiException

◆ Disconnect()

Boolean Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.Disconnect ( )

inline

Disconnect from a device.

Exceptions

G5ApiException

◆ GetActiveInterface()

ActiveInterface Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.GetActiveInterface ( )

inline

Get an instance of ActiveInterface.

Returns: System.ActiveInterface

◆ GetActualValues()

ActualSystemValues Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.GetActualValues ( )

inline

Get an instance of ActualSystemValues.

Returns: System.ActualSystemValues

◆ GetBatteryControl()

BatteryControl Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.GetBatteryControl ( )

inline

Get an instance of BatteryControl.

Returns: System.BatteryControl

◆ GetCharacteristics()

SystemCharacteristics Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.GetCharacteristics ( )

inline

Get a instance of SystemCharacteristics.

Returns: System.SystemCharacteristics

◆ GetCommands()

Commands Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.GetCommands ( )

inline

Get an instance of SystemCommands.

Returns: System.SystemCommands

◆ GetConnectedDevice()

TDevice Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.GetConnectedDevice ( )

abstract

◆ GetDataExchange()

DataExchange Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.GetDataExchange ( )

inline

Get an instance of DataExchange.

Returns: System.DataExchange

◆ GetDevice()

TDevice Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.GetDevice ( UInt16 deviceId )

abstract

◆ GetDeviceList()

List< TDevice > Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.GetDeviceList ( )

abstract

◆ GetEthernetConfiguration()

EthernetConfiguration Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.GetEthernetConfiguration ( )

inline

Get an instance of EthernetConfiguration.

Returns: System.EthernetConfiguration

◆ GetFunctionGenerator()

FunctionGenerator Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.GetFunctionGenerator ( )

inline

Get an instance of FunctionGenerator.

Returns: System.FunctionGenerator

◆ GetInformation()

SystemInformation Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.GetInformation ( )

inline

Get an instance of SystemInformation.

Returns: System.SystemInformation

◆ GetLicenseInformation()

LicenseInformation Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.GetLicenseInformation ( )

inline

Get an instance of LicenseInformation.

Returns: System.LicenseInformation

◆ GetLoadProtection()

LoadProtection Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.GetLoadProtection ( )

inline

Get an instance of LoadProtection.

Returns: System.LoadProtection

◆ GetOutputControl()

OutputControl Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.GetOutputControl ( )

inline

Get an instance of OutputControl.

Returns: System.OutputControl

◆ GetOutputMeasurement()

OutputMeasurement Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.GetOutputMeasurement ( )

inline

Get an instance of OutputMeasurement.

Returns: System.OutputMeasurement

◆ GetParameterSetConfiguration()

ParameterSetConfiguration Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.GetParameterSetConfiguration ( )

inline

Gets an instance of ParameterSetConfiguration.

Returns: Regatron.G5.Api.System.ParameterSetConfiguration

◆ GetReferenceValues()

ReferenceValues Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.GetReferenceValues ( )

inline

Get an instance of ReferenceValues.

Returns: System.ReferenceValues

◆ GetReferenceValueSource()

ReferenceValueSource Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.GetReferenceValueSource ( )

inline

Get an instance of ReferenceValueSource.

Returns: System.ReferenceValueSource

◆ GetSafety()

Safety Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.GetSafety ( )

inline

Get an instance of Safety.

Returns: System.Sensing

◆ GetSensing()

Sensing Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.GetSensing ( )

inline

Get an instance of Sensing.

Returns: System.Sensing

◆ GetSolarArraySimulation()

SolarArraySimulation Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.GetSolarArraySimulation ( )

inline

Get an instance of SolarArraySimulation.

Returns: System.SolarArraySimulation

◆ GetState()

SystemState Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.GetState ( )

inline

Get an instance of SystemState.

Returns: System.SystemState

◆ GetSystemReversePolarityProtection()

SystemReversePolarityProtection Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.GetSystemReversePolarityProtection ( )

inline

◆ IsConnected()

Boolean Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.IsConnected ( )

inline

Check if a device is connected.

Returns

True: A device is connected.

False: No Device is connected.

Exceptions

G5ApiException

Member Data Documentation

◆ InitializeLogging

bool Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.InitializeLogging = true

static

Use this to suppress "reinitialization" of the logging in case of the WebAPI or any other caller that also uses log4net logging.

Event Documentation

◆ ConnectionChanged

G5ConnectionChangedDelegate Regatron.G5.Api.System.G5SystemBase< TDevice, TControllerBoard, TConverterBoard >.ConnectionChanged

Informs whether or not there is a connection to the G5 device. In case of disconnection this can be: a) The user made the disconnection, b) Unexpected connection interruption.

Public Member Functions

Static Public Attributes

Events

Member Function Documentation

◆ Connect() [1/6]

◆ Connect() [2/6]

◆ Connect() [3/6]

◆ Connect() [4/6]

◆ Connect() [5/6]

◆ Connect() [6/6]

◆ Disconnect()

◆ GetActiveInterface()

◆ GetActualValues()

◆ GetBatteryControl()

◆ GetCharacteristics()

◆ GetCommands()

◆ GetConnectedDevice()

◆ GetDataExchange()

◆ GetDevice()

◆ GetDeviceList()

◆ GetEthernetConfiguration()

◆ GetFunctionGenerator()

◆ GetInformation()

◆ GetLicenseInformation()

◆ GetLoadProtection()

◆ GetOutputControl()

◆ GetOutputMeasurement()

◆ GetParameterSetConfiguration()

◆ GetReferenceValues()

◆ GetReferenceValueSource()

◆ GetSafety()

◆ GetSensing()

◆ GetSolarArraySimulation()

◆ GetState()

◆ GetSystemReversePolarityProtection()

◆ IsConnected()

Member Data Documentation

◆ InitializeLogging

Event Documentation

◆ ConnectionChanged