VIB_NET::Service Class Reference

Inheritance diagram for VIB_NET::Service:

Detailed Description

This class contains functions associated with the hardware component or the whole system

See class VIB::Service in the VisionBox Interface Library for a detailed description.

Examples

• C#: Service_Example.cs
• Visual Basic: Service_Example.vb

Public Types
enum	eSERVICE_RESET_TYPE
	Configures the reset behaviour of the watchdog More...

Public Member Functions
UInt32	FanSpeed (UInt32 ChannelIndex)
	Returns the current fan speed for the given index More...
void	FirmwareUpdate (System::String^ stFileName)
	Executes an update of the firmware for this hardware More...
void	Reset ()
	Resets the device to default settings. More...
void	WatchdogService ()
	Sends a signal to the FPGA which resets the watchdog timer More...
void	WatchdogSetup (Boolean boEnable, UInt32 msTimeout)
	Configures the FPGA watchdog More...
void	WatchdogSetup (Boolean boEnable, UInt32 msTimeout, eSERVICE_RESET_TYPE ResetType)
	Configures the watchdog and the reset behaviour More...
Public Member Functions inherited from VIB_NET::iDevice
void	Close ()
	Closes a device More...
bool	isOpen ()
	Returns the open state of a device object More...
void	Open ()
	Opens a device More...
void	Open (unsigned int Index)
	Opens a device More...

Properties
UInt32	FanNumberOfChannels [get]
	Contains the number of possible fan channels More...
UInt32	FanTargetTemperature [get, set]
	Sets the target temperature of the fan regulation More...
String^	SerialNumber [get]
	Returns the serial number for the hardware entity More...
Single	SystemTemperature [get]
	Reads and returns the current system temperature in °C More...
virtual VIB_NET::eDEVICE_TYPE	Type [get]
	Returns the device type for the current instance, see eDEVICE_TYPE More...
Boolean	WatchdogHasFired [get]
	Returns the state of the Watchdog More...
Properties inherited from VIB_NET::iDevice
virtual VIB_NET::eDEVICE_TYPE	Type [get]
	Returns the device type for the current instance, see eDEVICE_TYPE More...

Member Enumeration Documentation

eSERVICE_RESET_TYPE

enum VIB_NET::Service::eSERVICE_RESET_TYPE

strong

Configures the reset behaviour of the watchdog

Enumerator
REBOOT	Cold restart of the hole system, effect is similar to an event on the external reset input.
MULTIPLEXER	Only all signals of the VIB_NET::Multiplexer are set back to their default configuration.

Member Function Documentation

FanSpeed()

UInt32 VIB_NET::Service::FanSpeed

(

UInt32

ChannelIndex

)

Returns the current fan speed for the given index

Parameters

ChannelIndex

Fan index, 0 ... (FanNumberOfChannels - 1)

Returns

Current speed in RPM

FirmwareUpdate()

void VIB_NET::Service::FirmwareUpdate

(

System::String^

stFileName

)

Executes an update of the firmware for this hardware

This function can be used to update the firmware whithin the user application.

Parameters

stFileName

Name of firmware file, an absolute path is preferred.

Example:

C#: Service_Example.cs
Visual Basic: Service_Example.vb

Reset()

void VIB_NET::Service::Reset

(

)

Resets the device to default settings.

See also VIB::Service::Reset().

WatchdogService()

void VIB_NET::Service::WatchdogService

(

)

Sends a signal to the FPGA which resets the watchdog timer

Example:

C#: Service_Example.cs
Visual Basic: Service_Example.vb

WatchdogSetup() [1/2]

void VIB_NET::Service::WatchdogSetup	(	Boolean	boEnable,
		UInt32	msTimeout
	)

Configures the FPGA watchdog

If the watchdog is enabled the program has to call WatchdogService() within the specified timeout period. If the timeout expires, a hardware system reset is triggered.

This function call is identical to WatchdogSetup(boEnable, msTimeout, eSERVICE_RESET_TYPE::REBOOT).

The class will never disable the watchdog automatically, for example by closing the instance.

Parameters

boEnable	true -> turn the WDT on
msTimeout	Watchdog timeout in milliseconds (max. 40000)

Example:

C#: Service_Example.cs
Visual Basic: Service_Example.vb

WatchdogSetup() [2/2]

void VIB_NET::Service::WatchdogSetup	(	Boolean	boEnable,
		UInt32	msTimeout,
		eSERVICE_RESET_TYPE	ResetType
	)

Configures the watchdog and the reset behaviour

This function is identical to the WatchdogSetup() except, that the reset type can be specified after the timeout expires.

Parameters

boEnable	Enables or disables the watchdog timer
msTimeout	Watchdog timeout in milliseconds (max. 40000)
ResetType	Reset behavior

Property Documentation

FanNumberOfChannels

VIB_NET::Service::FanNumberOfChannels

get

Contains the number of possible fan channels

The number of installed fans can be lower.

FanTargetTemperature

VIB_NET::Service::FanTargetTemperature

getset

Sets the target temperature of the fan regulation

Remember, a higher system temperature will reduce the noise but also reduces the life-time and decreases the ability to for the CPU to use clock speeds above the base frequency.

Parameters

FanTargetTemperature

Target temperature in °C, 0 ... 50

Example:

C#: Service_Example.cs
Visual Basic: Service_Example.vb

SerialNumber

VIB_NET::Service::SerialNumber

get

Returns the serial number for the hardware entity

The function will return a null-terminated string like "AGEX1109000012"

Example:

C#: Service_Example.cs
Visual Basic: Service_Example.vb

SystemTemperature

VIB_NET::Service::SystemTemperature

get

Reads and returns the current system temperature in °C

Example:

C#: Service_Example.cs
Visual Basic: Service_Example.vb

Type

VIB_NET::Service::Type

get

Returns the device type for the current instance, see eDEVICE_TYPE

WatchdogHasFired

VIB_NET::Service::WatchdogHasFired

get

Returns the state of the Watchdog

The function returns true if the watchdog timeout has expired. A reboot or any call to WatchdogSetup() resets the state.