Inheritance diagram for VIB::Service:

Detailed Description

This class contains functions associated with the hardware component (serial number, system temperature, watchdog, firmware updates).

The behavior of this class is different in comparison to other device classes, because it can be opened more than once the same time. Note that the library functions are thread safe but not process safe.

The following table lists the supported features for different hardware components:

Platform	Hardware component (see eHardwareType)	Generic system type eSystemType	Supported features
Platform	Hardware component (see eHardwareType)	Generic system type eSystemType	Serial Number^[1]	Temperature Status	Fan Status and Control	Watchdog	Firmware Update
VisionBox AGE-X1	Mainboard	SYST_BASEBOARD	AGEXyymm0xxxxx	yes	yes (control)	yes	yes
VisionBox AGE-X2	Mainboard	SYST_BASEBOARD	AGEXyymm1xxxxx	yes	no	yes	yes
	Smart NIC	SYST_NETWORK	NIC0yymmxxxxxx	no	no	no	yes
	Camera Link	SYST_CL	CL00yymmxxxxxx	no	no	no	yes
VisionBox AGE-X3	I/O board	SYST_BASEBOARD	AGEXyymm2xxxxx	no	no	yes	yes
VisionBox AGE-X4^[2]	Mainboard	SYST_BASEBOARD	AGEXyymm3xxxxx	yes	yes (status)	yes	no
VisionBox AGE-X5	Mainboard	SYST_BASEBOARD	AGEXyymm4xxxxx	no	no	yes	yes
	Smart NIC	SYST_NETWORK	no	no	no	no	yes
	Camera Link	SYST_CL	no	no	no	no	yes
VisionBox LE MANS^[2]	Mainboard	SYST_BASEBOARD	LMNSyymmxxxxxx	yes	no	yes	yes
VisionBox DAYTONA	Mainboard	SYST_BASEBOARD	DTNAyymmxxxxxx	yes	no	yes	yes
VisionBox AI	Mainboard	SYST_BASEBOARD	VBAIyymmxxxxxx	yes	no	yes	yes
VisionBoards	Machine Vision Controller	SYST_INTERNAL_PCI	MVC0yymmxxxxxx	no	no	no	yes
	PCIe Smart NIC board	SYST_NETWORK	NIC1yymmxxxxxx	no	no	no	yes
	PCIe Camera Link board	SYST_CL	CL01yymmxxxxxx	no	no	no	yes
VisionCam XM	Mainboard	SYST_BASEBOARD	VCXMyymm0xxxxx	yes	no	yes	no
VisionCam XM2	Mainboard	SYST_BASEBOARD	VCXMyymm1xxxxx	yes	no	yes	no
VisionSensor PV / PV2	Mainboard	SYST_BASEBOARD	VSPVyymm0xxxxx	yes	no	no	no
VisionSensor PV3	Mainboard	SYST_BASEBOARD	VSPVyymm1xxxxx	yes	no	yes^[3]	no
Machine Vision Manager	USB device	SYST_EXTERNAL_USB	MVM0yymmxxxxxx	no	no	yes^[4]	yes
Machine Vision Manager 2	USB device	SYST_EXTERNAL_USB	MVM2yymmxxxxxx	no	no	yes^[4]	yes

Serial number format:
yymm: place holder for production year and month
xxx...: place holder for a serial number
The VisionBox AGE-X4 and the VisionBox LE MANS can also use the VisionBoards.
VisionSensor PV3: requires I/O Expansion and only SERVICE_WDT_RESET_TYPE_MULTIPLEXER is supported.
Machine Vision Manager: requires firmware ≥ 1.0.0.69 and only SERVICE_WDT_RESET_TYPE_MULTIPLEXER is supported.

Serial Number

The function GetSerialNumber() returns the serial number for the associated hardware component.

The serial number consists of a null-terminated string. The string format is listed in the table above for the different hardware entities.

Example code

VIB::VIBSystem      *pVIBSystem     = NULL;
VIB::Service        *pService       = NULL;
 
// create a factory instance for the mainboard
VIB::VIBSystem::CreateInstance(&pVIBSystem, SYST_BASEBOARD, 0)
 
pVIBSystem->OpenDevice(VIB::DT_SERVICE, 0, (VIB::iDevice**)(&pService));
 
// read the serial number
char serialnumber[32];
pService->GetSerialNumber(serialnumber);
 
printf("Serial number: '%s'\n", serialnumber);
 
// Close the device and the factory
pVIBSystem->CloseDevice(pService);
VIB::VIBSystem::DeleteInstance(pVIBSystem);

Please note that error checking was removed to keep the code simple.

Temperature Status

The temperature of the mainboard can be read with GetSystemTemperature().

Example code

VIB::Service service;
float temperature;
 
service.Open();
service.GetSystemTemperature(temperature);
printf("Temperature: %.1f °C\n", temperature);

Please note that error checking was removed to keep the code simple.

Fan Status and Control

Depending on the hardware configuration, the VisionBox AGE-X1 and AGE-X4 can have one or more fans installed.

The VisionBox AGE-X4 supports reading the number of fan channels with GetFanNumberOfChannels() and reading the fan speed with GetFanSpeed().

The VisionBox AGE-X1 supports adjustment of the target temperature for the fan regulation circuit by SetFanTargetTemperature().

Watchdog

The Watchdog can be used to reset the system if the function WatchdogService() is not called within a time period specified by WatchdogSetup().

Example code

VIB::Service service;
 
// create a factory instance for the mainboard
service.Open(0);
 
// enable Watchdog with a timeout of 3 seconds
service.WatchdogSetup(true, 3000);
 
// reset Watchdog timer in the main loop
while (progIsRunning)
{
    service.WatchdogService();
 
    // do something else
}
 
// disable the Watchdog
service.WatchdogSetup(false, 3000); 

Please note that error checking was removed to keep the code simple.

Starting with firmware version ≥ 1.0.0.37, the Watchdog can alternatively be used to reset only the Multiplexer to the default state (all output lines off), see SERVICE_WDT_RESET_TYPE. The function WatchdogHasFired() can then be used to check the state of the watchdog.

Firmware Update

Firmware updates are normally provided by IMAGO as separate packages which can be executed on the system. The function FirmwareUpdate() can alternatively be used to update the firmware within the user application.

This function is not supported by the following platforms. The firmware is provided as Debian packages instead:

VisionCam XM
VisionSensor PV (1/2/3)
VisionBox DAYTONA

Note

A system may contain multiple hardware components which have to be updated separately.
Using the incorrect firmware file can lead to inoperative hardware. Contact IMAGO for choosing the right files.
The update process can take up to one minute. Don't interrupt the process.
After success, the power supply for most systems must be reapplied before the new firmware is used.

Public Types
enum	SERVICE_WDT_RESET_TYPE
	Configures the reset behavior of the watchdog, used by WatchdogSetup() More...

Public Member Functions
bool	FirmwareUpdate (const unsigned char *pFirmwareData, const size_t FileSize)
	Executes an update of the firmware for the hardware entity. More...

bool	GetFanNumberOfChannels (unsigned int &NumberOfChannels)
	Returns the number of possible fan channels. More...

bool	GetFanSpeed (const unsigned int ChannelIndex, unsigned int &RPM)
	Return the current fan speed for the given index. More...

bool	GetSerialNumber (char pSerialnumber[32])
	Returns the serial number for the hardware component. More...

bool	GetSystemTemperature (float &fTemperature)
	Returns system temperature. More...

bool	Reset ()
	Resets the device to default settings. More...

	Service ()
	Default constructor for the device object More...

bool	SetFanTargetTemperature (unsigned int Temperature)
	Sets the target temperature of the fan regulation. More...

bool	WatchdogHasFired (bool &HasFired)
	Returns the state of the Watchdog. More...

bool	WatchdogService ()
	Sends a signal to the FPGA which resets the watchdog timer. More...

bool	WatchdogSetup (bool boEnable, unsigned int msTimeout)
	Configures the FPGA watchdog. More...

bool	WatchdogSetup (bool boEnable, unsigned int msTimeout, SERVICE_WDT_RESET_TYPE ResetType)
	Configures the watchdog and the reset behavior. More...

Public Member Functions inherited from VIB::iDevice
bool	Close ()
	Closes a device More...

	iDevice (const iDevice &device)
	The copy constructor makes a copy of the existing device object More...

bool	isOpen (bool &state)
	Returns the open state of a device object More...

bool	Open (unsigned int Index=0)
	Opens a device More...

iDevice &	operator= (const iDevice &device)
	The assignment operator makes a copy of the existing device object More...

virtual	~iDevice ()
	Deletes the device object More...

Member Enumeration Documentation

◆ SERVICE_WDT_RESET_TYPE

enum VIB::Service::SERVICE_WDT_RESET_TYPE

Configures the reset behavior of the watchdog, used by WatchdogSetup()

Enumerator
SERVICE_WDT_RESET_TYPE_REBOOT	Cold reset of the system using a hardware reset signal.
SERVICE_WDT_RESET_TYPE_MULTIPLEXER	The output signals of the Multiplexer are reset to the default state.

Constructor & Destructor Documentation

◆ Service()

VIB::Service::Service ( )

Default constructor for the device object

The device must be opened with Open() before it can be used.

Member Function Documentation

◆ FirmwareUpdate()

bool VIB::Service::FirmwareUpdate	(	const unsigned char *	pFirmwareData,
		const size_t	FileSize
	)

Executes an update of the firmware for the hardware entity.

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

Parameters

pFirmwareData	Pointer to buffer holding the firmware data
FileSize	Number of valid bytes in the buffer

Returns: true for success, use VIBSystem::GetLastErrorString() for an error description

◆ GetFanNumberOfChannels()

bool VIB::Service::GetFanNumberOfChannels ( unsigned int & NumberOfChannels )

Returns the number of possible fan channels.

The number of installed fans can be lower.

Returns: true for success, use VIBSystem::GetLastErrorString() for an error description

◆ GetFanSpeed()

bool VIB::Service::GetFanSpeed	(	const unsigned int	ChannelIndex,
		unsigned int &	RPM
	)

Return the current fan speed for the given index.

Parameters

ChannelIndex	Fan index, 0 ... (GetFanNumberOfChannels() - 1)
RPM	Current speed in RPM

Returns: true for success, use VIBSystem::GetLastErrorString() for an error description

◆ GetSerialNumber()

bool VIB::Service::GetSerialNumber ( char pSerialnumber[32] )

Returns the serial number for the hardware component.

The function will return a null-terminated string like "AGEX1109000012". See section Serial Number for a detailed description and example code.

Parameters

pSerialnumber Valid string pointer for storing the serial number

Returns: true for success, use VIBSystem::GetLastErrorString() for an error description

◆ GetSystemTemperature()

bool VIB::Service::GetSystemTemperature ( float & fTemperature )

Returns system temperature.

Parameters

fTemperature Temperature in °C

Returns: true for success, use VIBSystem::GetLastErrorString() for an error description

◆ Reset()

bool VIB::Service::Reset ( )

Resets the device to default settings.

The Watchdog is disabled
VisionBox AGE-X1: the fan target temperature is set to 45 °C

Returns: true for success, use VIBSystem::GetLastErrorString() for an error description

◆ SetFanTargetTemperature()

bool VIB::Service::SetFanTargetTemperature ( unsigned int Temperature )

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 for the CPU to use clock speeds above the base frequency.

Parameters

Temperature Target temperature in °C, 0 ... 50

Returns: true for success, use VIBSystem::GetLastErrorString() for an error description

◆ WatchdogHasFired()

bool VIB::Service::WatchdogHasFired ( bool & HasFired )

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.

Parameters

HasFired Watchdog state

Returns: true for success, use VIBSystem::GetLastErrorString() for an error description

◆ WatchdogService()

bool VIB::Service::WatchdogService ( )

Sends a signal to the FPGA which resets the watchdog timer.

Returns: true for success, use VIBSystem::GetLastErrorString() for an error description

◆ WatchdogSetup() [1/2]

bool VIB::Service::WatchdogSetup	(	bool	boEnable,
		unsigned int	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, SERVICE_WDT_RESET_TYPE_REBOOT).

The watchdog will not be disabled when the Service device is closed.

Parameters

boEnable	Enable or disables the watchdog timer
msTimeout	Watchdog timeout in milliseconds (max. 40000)

Returns: true for success, use VIBSystem::GetLastErrorString() for an error description

◆ WatchdogSetup() [2/2]

bool VIB::Service::WatchdogSetup	(	bool	boEnable,
		unsigned int	msTimeout,
		SERVICE_WDT_RESET_TYPE	ResetType
	)

Configures the watchdog and the reset behavior.

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

Parameters

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

Returns: true for success, use VIBSystem::GetLastErrorString() for an error description

Detailed Description

Serial Number

Temperature Status

Fan Status and Control

Watchdog

Firmware Update

Public Types

Public Member Functions

Member Enumeration Documentation

◆ SERVICE_WDT_RESET_TYPE

Constructor & Destructor Documentation

◆ Service()

Member Function Documentation

◆ FirmwareUpdate()

◆ GetFanNumberOfChannels()

◆ GetFanSpeed()

◆ GetSerialNumber()

◆ GetSystemTemperature()

◆ Reset()

◆ SetFanTargetTemperature()

◆ WatchdogHasFired()

◆ WatchdogService()

◆ WatchdogSetup() [1/2]

◆ WatchdogSetup() [2/2]