FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kIoTest.h
Go to the documentation of this file.
1 
8 #ifndef K_FIRESYNC_IO_TEST_H
9 #define K_FIRESYNC_IO_TEST_H
10 
11 #include <kFireSync/kNodeDef.h>
12 
19 //typedef kObject kIoTest; --forward-declared in kFsDef.x.h
20 
28 kFsFx(kSize) kIoTest_Id(kIoTest test);
29 
37 kFsFx(kStatus) kIoTest_Clear(kIoTest test);
38 
46 kFsFx(kStatus) kIoTest_Reset(kIoTest test);
47 
57 
66 
76 
85 kFsFx(kStatus) kIoTest_SetBitRate(kIoTest test, k32u rate);
86 
94 kFsFx(k32u) kIoTest_BitRate(kIoTest test);
95 
104 kFsFx(kStatus) kIoTest_BitRateInfo(kIoTest test, kInfo32u* info);
105 
114 kFsFx(kStatus) kIoTest_SetG20x0MasterMode(kIoTest test, kBool masterMode);
115 
124 
134 
143 kFsFx(kStatus) kIoTest_SetSafety(kIoTest test, kBool safety);
144 
152 kFsFx(kBool) kIoTest_Safety(kIoTest test);
153 
162 kFsFx(kStatus) kIoTest_SafetyInfo(kIoTest test, kInfoBool* info);
163 
173 kFsFx(kStatus) kIoTest_SetDigitalOut(kIoTest test, kSize index, kBool state);
174 
183 kFsFx(kBool) kIoTest_DigitalOut(kIoTest test, kSize index);
184 
194 kFsFx(kStatus) kIoTest_DigitalOutInfo(kIoTest test, kSize index, kInfoBool* info);
195 
204 kFsFx(kStatus) kIoTest_SetSyncIo(kIoTest test, k32u syncIo);
205 
213 kFsFx(k32u) kIoTest_SyncIo(kIoTest test);
214 
223 kFsFx(kStatus) kIoTest_SyncIoInfo(kIoTest test, kInfo32u* info);
224 
233 kFsFx(kStatus) kIoTest_SetMovingAvgWindow(kIoTest test, kSize window);
234 
243 
253 
262 kFsFx(kStatus) kIoTest_Stats(kIoTest test, kIoTestStats* stats);
263 
274 kFsFx(kStatus) kIoTest_ReadSerial(kIoTest test, void* buffer, kSize capacity, kSize* bytesRead);
275 
283 kFsFx(kStatus) kIoTest_ReadAd7415(kNode node, k32u deviceId, k32s* temp);
284 
285 #include <kFireSync/Client/kIoTest.x.h>
286 
287 #endif
kStatus kIoTest_SetSafety(kIoTest test, kBool safety)
Sets safety output state.
kStatus kIoTest_ReadAd7415(kNode node, k32u deviceId, k32s *temp)
External temperature probe AD7415 is not supported in FireSync 6+.
kIoTestSerialMode kIoTest_SerialMode(kIoTest test)
Gets serial receiver mode.
kStatus kIoTest_SafetyInfo(kIoTest test, kInfoBool *info)
Reports constraint and validity information for the Safety setting.
kStatus kIoTest_DigitalOutInfo(kIoTest test, kSize index, kInfoBool *info)
Reports constraint and validity information for the DigitalOut setting.
kStatus kIoTest_SetDigitalOut(kIoTest test, kSize index, kBool state)
Sets digital output state.
Represents constraint and validity information for a bit flag setting.
Definition: kInfo.h:544
kBool kIoTest_DigitalOut(kIoTest test, kSize index)
Gets digital output state.
kStatus kIoTest_ReadSerial(kIoTest test, void *buffer, kSize capacity, kSize *bytesRead)
Read serial data.
kStatus kIoTest_G20x0MasterModeInfo(kIoTest test, kInfoBool *info)
Reports constraint and validity information for the G20x0MasterMode setting.
kStatus kIoTest_SerialModeInfo(kIoTest test, kInfoBits *info)
Reports constraint and validity information for the SerialMode setting.
kStatus kIoTest_Clear(kIoTest test)
Resets test output device settings to defaults.
kBool kIoTest_G20x0MasterMode(kIoTest test)
Gets Gocator 20x0 master mode.
Represents I/O test jig run-time statistics.
Definition: kNodeDef.h:1488
k32u kIoTest_BitRate(kIoTest test)
Gets the bit rate for UART.
Essential declarations related to FireSync nodes.
Represents a FireSync node (sensor).
kStatus kIoTest_SetG20x0MasterMode(kIoTest test, kBool masterMode)
Sets Gocator 20x0 master mode.
kStatus kIoTest_SetMovingAvgWindow(kIoTest test, kSize window)
Sets ADC moving average window size.
kStatus kIoTest_MovingAvgWindowInfo(kIoTest test, kInfoSize *info)
Reports constraint and validity information for the ADC moving average window size.
kSize kIoTest_Id(kIoTest test)
Gets the id of the output.
kStatus kIoTest_SyncIoInfo(kIoTest test, kInfo32u *info)
Reports constraint and validity information for the SyncIo setting.
kStatus kIoTest_SetSyncIo(kIoTest test, k32u syncIo)
Sets Sync I/O value.
kStatus kIoTest_SetSerialMode(kIoTest test, kIoTestSerialMode mode)
Sets serial receiver mode.
kStatus kIoTest_SetBitRate(kIoTest test, k32u rate)
Sets the bit rate for UART.
kStatus kIoTest_BitRateInfo(kIoTest test, kInfo32u *info)
Reports constraint and validity information for the bit rate setting.
kStatus kIoTest_Stats(kIoTest test, kIoTestStats *stats)
Retrieve statistics.
kSize kIoTest_MovingAvgWindow(kIoTest test)
Gets ADC moving average window size.
k32u kIoTest_SyncIo(kIoTest test)
Gets Sync I/O value.
Represents constraint and validity information for a 32-bit unsigned integer setting.
Definition: kInfo.h:98
Represents constraint and validity information for a kSize setting.
Definition: kInfo.h:370
Represents I/O test jig serial output modes.
kBool kIoTest_Safety(kIoTest test)
Gets safety output state.
kStatus kIoTest_Reset(kIoTest test)
Reset the I/O test module.
Represents I/O test configuration.
Represents constraint and validity information for a boolean setting.
Definition: kInfo.h:493