Most AIOWDG functions take a signed 32-bit integer CardNum. Usually, CardNum = 0 because there's only one watchdog card in the system. You can simply use WDG_Pet(0); to pet the only watchdog card installed, and so forth. If, however, you have multiple watchdog cards in the system, see the Multi-Card Functions below.
Most functions return a UInt32 error code. On a success, this will be zero (= ERROR_SUCCESS). On a failure, it will be nonzero, and equal to some other Windows error code. See WinError.h for details; if your IDE doesn't provide Windows error codes, you can find WinError.h readily on the Web.
A few multi-card functions return an SInt32 number, which is a card number (or, technically, comparable to card numbers).
AIOWDG's functions are similar to — but not the same as — their equivalents in AIOWDM. All of these functions are exported three times:
cdecl calling convention. This is the easiest to use from languages like Delphi and C. In C++, you'll need to tell the compiler not to mangle the names, with extern "C".
cdecl calling convention. Visual Studio sometimes wants an underscore on extern "C" imports.
stdcall calling convention. This is the easiest to use from languages like Python and Visual Basic. It can also be useful while developing in other languages, since it checks the stack every call.
In general, you'll want to call WDGSetTimeout, then WDGStart at initialization, call WDGPet periodically during operation, then call WDGStop at deinitialization. During watchdog timing, you must "pet" often enough, or the watchdog will "growl", and then if it still isn't pet, "bark".
UInt32 WDG_SetTimeout(SInt32 CardNum, Double *pMilliseconds);Sets how often the watchdog must be pet. It's best to leave some margin for error; for example, if you plan to pet every 10 seconds, you could specify a timeout of 11,000 milliseconds.
The older name "WDGSetTimeout" is deprecated.
UInt32 WDG_Start(SInt32 CardNum);Starts the watchdog timing. After this, until WDG_Stop, the watchdog must be pet.
The older name "WDGStart" is deprecated.
UInt32 WDG_Stop(SInt32 CardNum);Stops the watchdog timing.
The older name "WDGStop" is deprecated.
UInt32 WDG_Pet(SInt32 CardNum);Pets the watchdog.
The older name "WDGPet" is deprecated.
UInt32 WDGInit(SInt32 CardNum);This function is entirely deprecated.
In previous versions, it initialized watchdog operation.
UInt32 WDG_SetResetDuration(SInt32 CardNum, Double *pMilliseconds);Sets how long the watchdog will hold the reset, once it barks. However, if the watchdog itself loses power when it barks, this duration is largely irrelevant.
The older name "WDGSetResetDuration" is deprecated.
UInt32 WDG_ReadTemp(SInt32 CardNum, Double *TempF);Reads the thermometer on the watchdog card, if installed.
The older name "WDGReadTemp" is deprecated.
UInt32 WDG_ReadStatus(SInt32 CardNum, UInt32 *StatusByte);Reads the watchdog's status, expressed in the form of a PCI-WDG-CSM status byte.
The older name "WDGReadStatus" is deprecated.
UInt32 WDG_WaitForEvent(SInt32 CardNum);Does not return until aborted, or the watchdog growls. If the process being monitored is not entirely locked up, this can be used to interrupt the process and return to normal petting operation. This is intended to be called from a high-priority worker thread; that way, the thread consumes no CPU while waiting, but once there's a growl, the thread comes out of the wait even if normal-priority threads are hogging the CPU. If aborted, returns ERROR_OPERATION_ABORTED instead of ERROR_SUCCESS.
The older name "WaitForWDG" is deprecated.
UInt32 WDG_AbortEventRequest(SInt32 CardNum);Aborts a waiting WDG_WaitForEvent call, including one from WDG_HandleEvent. Intended for use during deinitialization.
The older name "AbortWDGRequest" is deprecated.
UInt32 WDG_HandleEvent(SInt32 CardNum, UInt32 Action);Launches its own thread to call WDG_WaitForEvent, then responds with the indicated action. Action codes are the same as for AIOWDM.
The older name "WDGHandleIRQ" is deprecated. The event is not implemented as an IRQ.
UInt32 WDG_EmergencyReboot();Intended for use in WDG_WaitForEvent worker threads, to initiate a "hard" reboot command.
The older name "EmergencyReboot" is deprecated.
UInt32 Speaker_SetFreq(SInt32 CardNum, SInt32 Hz);Directly controls the speaker. Hz = 0 turns it off, any value from 1 to 65,279 inclusive turns it on at the specified frequency.
UInt32 DI_ReadAll(SInt32 CardNum, UInt8 *pDIData);Reads all the digital inputs into the provided buffer. Each bit corresponds to a single input; see the sample for details. This also resets the digital input latches.
UInt32 DI_Read1(SInt32 CardNum, UInt8 BitIndex, Bool32 *pBitValue);Reads the specified digital input into the provided variable. This also resets the digital input latches.
UInt32 DI_ReadLatched(SInt32 CardNum, UInt8 *pDIRisen, UInt8 *pDIFallen);Reads the digital input latches into the provided buffers, and resets the latches. *pDIRisen indicates which digital inputs have had a rising edge since last reset, while *pDIFallen does the same for falling edges.
UInt32 DI_PeekAll(SInt32 CardNum, UInt8 *pDIData);Like DI_ReadAll, except it doesn't reset the latches.
UInt32 DI_Peek1(SInt32 CardNum, UInt8 BitIndex, Bool32 *pBitValue);Like DI_Read1, except it doesn't reset the latches.
UInt32 DI_SetDebounceAll(SInt32 CardNum, UInt8 TimeMS);Sets a debouncing time constant for all the digital inputs. If the signals have high-frequency noise, this can be used to ignore it. This applies to all uses of the digital inputs, including reading, latching, and COS events.
UInt32 DI_SetDebounce1(SInt32 CardNum, UInt8 BitIndex, UInt8 TimeMS);Sets a debouncing time constant for the specified digital input.
UInt32 DI_SetDebounceSome(SInt32 CardNum, UInt8 BitMask, UInt8 TimeMS);Sets a debouncing time constant for the specified digital inputs. Each digital input whose bit is set in the bit mask will get the provided time constant.
UInt32 DI_WaitForCOS(SInt32 CardNum, UInt8 *pDIData);Does not return until aborted, or a change-of-state(COS) event occurs. This is intended to be called from a worker thread; that way, the thread consumes no CPU while waiting. If aborted, returns ERROR_OPERATION_ABORTED instead of ERROR_SUCCESS.
The older name "WaitForCOS" is deprecated.
UInt32 DI_WaitForCOSMulti(SInt32 CardNum, SInt32 *pTimestamp, SInt32 DISize, UInt8 *pDIData, Double *pAIData);Like DI_WaitForCOS, except it also provides a timestamp and the digital and analog readings at the time of the COS event.
The older name "WaitForCOSMulti" is deprecated.
UInt32 DI_AbortCOSRequest(SInt32 CardNum);Aborts a waiting DI_WaitForCOS call. Intended for use during deinitialization.
The older name "AbortCOSRequest" is deprecated.
UInt32 DI_ReadTimestamp(SInt32 CardNum, UInt16 *pTimestamp);Reads the current timestamp. Intended for use in interpreting the timestamps returned by DI_WaitForCOSMulti.
The older name "ReadTimestamp" is deprecated.
UInt32 DO_WriteAll(SInt32 CardNum, UInt8 DOData);Writes to all the digital outputs. Each bit corresponds to a single output; see the sample for details.
UInt32 DO_Write1(SInt32 CardNum, UInt8 BitIndex, Bool32 BitValue);Writes to the specified digital output.
UInt32 DO_ReadbackAll(SInt32 CardNum, UInt8 *pDIData);Reads back all the digital outputs into the provided buffer. The bit layout matches the DO_WriteAll bit layout.
UInt32 DO_SetPWM(SInt32 CardNum, UInt32 BitIndex, UInt8 DutyCycle, SInt32 RepCount);Controls PWM on the indexed digital output bit. DutyCycle is out of 256, and generally varies from 1(.4%) to 255(99.6%). DutyCycle = 0 is valid, but not particularly useful.
If RepCount = 0, then this turns off PWM on that bit.
If RepCount = -1, then this turns on PWM on that bit and sets it to run until turned off.
If RepCount > 0, then this turns on PWM on that bit and sets it to run that many times, then turn off. The maximum RepCount is 65,534.
UInt32 AI_Enable(SInt32 CardNum);Enables the analog inputs. The card powers up with the analog inputs disabled.
UInt32 AI_Disable(SInt32 CardNum);Disables the analog inputs. Intended for use during deinitialization.
UInt32 AI_ReadAll(SInt32 CardNum, Double *pAIData);Reads all the analog inputs into the provided buffer. The pointer should point to the first of an array of IEEE double-precision floating-point entries.
UInt32 AI_Read1(SInt32 CardNum, UInt8 ChannelIndex, Double *pAIData);Reads the specified analog input into the provided variable.
These functions are not recommended for new development, but they support easy conversion from AIOWDM. For non-Rel addressing, the "base address" is 16×CardNum, except any address of 200h or more is treated as CardNum = 0. This "base address" is returned by QueryCardInfo, as normal for AIOWDM.
UInt16 InPortB(UInt32 Addr);UInt16 OutPortB(UInt32 Addr, UInt8 Value);UInt16 RelInPortB(CardNum, UInt32 Offset);UInt16 RelOutPortB(CardNum, UInt32 Offset, UInt8 Value);If you have multiple AIOWDG cards in the system, you can use these functions to identify them. This example recognizes multiple cards by their serial numbers:
NumCards = GetNumCards();
for ( ThisCard = 0; ThisCard < NumCards; ++ThisCard )
{
Err = QueryCardSerialNumber(ThisCard, @ThisSN);
if ( Err == ERROR_SUCCESS )
for ( I = 0; I < WDGOb.Length(); ++I )
if ( ThisSN == WDGOb[I].SN )
{
WDGOb[I].CardNum = ThisCard;
break;
}
}
SInt32 GetNumCards();Returns how many cards are installed. The cards will be numbered from 0 to GetNumCards()-1. For example, if GetNumCards returns 4, then those four cards are numbered 0, 1, 2, and 3. You can then query them, notably their digital inputs and serial numbers, to determine which is which.
UInt32 QueryCardID(SInt32 CardNum, UInt32 *pDeviceID);Reads the card's ID into the provided variable. This can be used to tell a PCIe-WDG-CSMA from a PCIe-WDG-CSM.
UInt32 QueryCardName(SInt32 CardNum, UInt32 *pNameSize, Char8 *pName);Reads the card's "friendly name" string into the provided buffer. *pNameSize should contain the length of the buffer when called, and upon return will contain the length of the string read into the buffer.
UInt32 QueryCardSerialNumber(SInt32 CardNum, SInt64 *pSerialNumber);Reads the card's internal software serial number into the provided variable. This can be used to tell each individual card apart, but may be too specific — it doesn't support drop-in replacement with another card of the exact same model.
The older name "QuerySerialNumber" is deprecated.
UInt32 QueryCardInfo(SInt32 CardNum, UInt32 *pDeviceID, UInt32 *pBase, UInt32 *pNameSize, Char8 *pName);Like QueryCardID and QueryCardName, in a single call. The "base address" provided is useful for the non-"Rel" PCI-WDG-CSM emulation functions. Intended for easy conversion from AIOWDM.
UInt32 AIOWDG_CloseCard(SInt32 CardNum);Closes the internal handles to the card. AIOWDG.dll will close all handles upon exit, so this is strictly optional in modern driver versions.
The older name "AIOWDG_CloseDevice" is deprecated.
UInt32 AIOWDG_CloseAll();Closes the internal handles to all cards. AIOWDG.dll will close all handles upon exit, so this is strictly optional in modern driver versions.
SInt32 GetCardBySerialNumber(SInt64 *pSerialNumber);Returns the CardNum of the card with the specified serial number, or -1 if there is no such card.
The older name "GetDeviceBySerialNumber" is deprecated.