FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kNodeProvider.h
Go to the documentation of this file.
1 
8 #ifndef K_FIRESYNC_NODE_PROVIDER_H
9 #define K_FIRESYNC_NODE_PROVIDER_H
10 
11 #include <kFireSync/kNodeDef.h>
12 #include <kApi/Io/kStream.h>
13 
20 //typedef kObject kNodeProvider; --forward-declared in kFsDef.x.h
21 
22 //thread-safe
23 
24 kFsFx(kBool) kNodeProvider_IsRemote(kNodeProvider provider);
25 
26 kFsFx(kStatus) kNodeProvider_SetErrorHandler(kNodeProvider provider, kCallbackFx function, kPointer receiver);
27 kFsFx(kStatus) kNodeProvider_SetCancelHandler(kNodeProvider provider, kCallbackFx function, kPointer receiver);
28 kFsFx(kStatus) kNodeProvider_SetProtocolVersion(kNodeProvider provider, kVersion protocol, kVersion platform);
29 kFsFx(kStatus) kNodeProvider_BeginOpenControl(kNodeProvider provider);
30 kFsFx(kStatus) kNodeProvider_EndOpenControl(kNodeProvider provider);
31 kFsFx(kStatus) kNodeProvider_CloseControl(kNodeProvider provider);
32 kFsFx(kStatus) kNodeProvider_SetHealthHandler(kNodeProvider provider, kCallbackFx function, kPointer receiver);
33 kFsFx(kStatus) kNodeProvider_BeginOpenHealth(kNodeProvider provider);
34 kFsFx(kStatus) kNodeProvider_EndOpenHealth(kNodeProvider provider);
35 kFsFx(kStatus) kNodeProvider_CloseHealth(kNodeProvider provider);
36 kFsFx(kStatus) kNodeProvider_SetDataBufferSize(kNodeProvider provider, kSize size);
37 kFsFx(kStatus) kNodeProvider_SetDataHandler(kNodeProvider provider, kCallbackFx function, kPointer receiver);
38 kFsFx(kStatus) kNodeProvider_BeginOpenData(kNodeProvider provider, const k16u* ports, kSize portCount);
39 kFsFx(kStatus) kNodeProvider_EndOpenData(kNodeProvider provider);
40 kFsFx(kStatus) kNodeProvider_EndDataSession(kNodeProvider provider);
41 kFsFx(kStatus) kNodeProvider_CloseData(kNodeProvider provider);
42 kFsFx(kStatus) kNodeProvider_InvalidateDataSession(kNodeProvider provider);
43 
44 kFsFx(kStatus) kNodeProvider_ClearFirmware(kNodeProvider provider, kNodeFirmwareType type);
45 kFsFx(kStatus) kNodeProvider_WriteFirmware(kNodeProvider provider, kNodeFirmwareType type, kStream stream, kSize size, kCallbackFx progress, kPointer context);
46 kFsFx(kStatus) kNodeProvider_ReloadFirmware(kNodeProvider provider, kNodeFirmwareType type, kStream stream, kSize size);
47 kFsFx(kStatus) kNodeProvider_Reset(kNodeProvider provider, kBool restartApp);
48 
49 kFsFx(kStatus) kNodeProvider_ChangeAddressAndReset(kNodeProvider provider, kSize nodeInterfaceIndex, const kIpConfig* config);
50 
51 kFsFx(kStatus) kNodeProvider_WriteFile(kNodeProvider provider, const kChar* path, kStream stream, kSize size, kCallbackFx progress, kPointer context);
52 kFsFx(kStatus) kNodeProvider_CopyFile(kNodeProvider provider, const kChar* sourcePath, const kChar* destPath, kCallbackFx progress, kPointer context);
53 kFsFx(kStatus) kNodeProvider_ReadFile(kNodeProvider provider, const kChar* path, kStream stream, kCallbackFx progress, kPointer context);
54 kFsFx(kStatus) kNodeProvider_DeleteFile(kNodeProvider provider, const kChar* path);
55 kFsFx(kStatus) kNodeProvider_GetFileInfo(kNodeProvider provider, const kChar* path, kStorageItem* item);
56 kFsFx(kStatus) kNodeProvider_CreateDirectory(kNodeProvider provider, const kChar* path);
57 kFsFx(kStatus) kNodeProvider_DeleteDirectory(kNodeProvider provider, const kChar* path);
58 kFsFx(kStatus) kNodeProvider_ListDirectoryEntries(kNodeProvider provider, const kChar* path, kBool includeFiles, kBool includeDirectories, kArrayList entries);
59 kFsFx(kStatus) kNodeProvider_ListDirectoryEntriesEx(kNodeProvider provider, const kChar* path, kArrayList entries);
60 
61 kFsFx(kStatus) kNodeProvider_SetDeviceConfig(kNodeProvider provider, kXml xml, k64u revisionId);
62 kFsFx(kStatus) kNodeProvider_GetDeviceConfig(kNodeProvider provider, kXml xml, k64u* revisionId);
63 kFsFx(kStatus) kNodeProvider_CommitDeviceConfig(kNodeProvider provider);
64 kFsFx(kStatus) kNodeProvider_SetModeConfig(kNodeProvider provider, kXml xml, k64u revisionId);
65 kFsFx(kStatus) kNodeProvider_GetModeConfig(kNodeProvider provider, kXml xml, k64u* revisionId);
66 kFsFx(kStatus) kNodeProvider_SaveModeConfig(kNodeProvider provider, const kChar* path);
67 kFsFx(kStatus) kNodeProvider_LoadModeConfig(kNodeProvider provider, const kChar* path);
68 kFsFx(kStatus) kNodeProvider_CommitModeConfig(kNodeProvider provider);
69 kFsFx(kStatus) kNodeProvider_ValidateBlockConfig(kNodeProvider provider, kXml xml);
70 kFsFx(kStatus) kNodeProvider_SetDateTime(kNodeProvider provider, kDateTime dateTime, kBool isAuthoritative);
71 kFsFx(kStatus) kNodeProvider_IncrementInputCounter(kNodeProvider provider);
72 
73 kFsFx(kStatus) kNodeProvider_ListProcedures(kNodeProvider provider, kArrayList procedures);
74 kFsFx(kStatus) kNodeProvider_InvokeProcedure(kNodeProvider provider, const kChar* name, kObject input, kObject* output, kAlloc alloc);
75 
76 kFsFx(kStatus) kNodeProvider_SetVariable(kNodeProvider provider, const kChar* name, kObject variable);
77 kFsFx(kStatus) kNodeProvider_GetVariable(kNodeProvider provider, const kChar* name, kObject* variable, kAlloc alloc);
78 kFsFx(kStatus) kNodeProvider_GetVariableInfo(kNodeProvider provider, const kChar* name, kNodeVariableInfo* info);
79 kFsFx(kStatus) kNodeProvider_DeleteVariable(kNodeProvider provider, const kChar* name);
80 kFsFx(kStatus) kNodeProvider_ListVariables(kNodeProvider provider, kArrayList variables);
81 
82 kFsFx(kStatus) kNodeProvider_ValidateActionConfig(kNodeProvider provider, kXml config);
83 kFsFx(kStatus) kNodeProvider_InvokeAction(kNodeProvider provider, const kChar* typeName, kXml config, kObject input, kObject* output, kAlloc alloc);
84 kFsFx(kStatus) kNodeProvider_InvokeNamedAction(kNodeProvider provider, const kChar* name, kObject input, kObject* output, kAlloc alloc);
85 
86 kFsFx(kStatus) kNodeProvider_ReadMemory(kNodeProvider provider, kNodeMemorySpace space, k64u offset, kSize length, void* data);
87 kFsFx(kStatus) kNodeProvider_WriteMemory(kNodeProvider provider, kNodeMemorySpace space, k64u offset, kSize length, const void* data);
88 
89 kFsFx(kStatus) kNodeProvider_ReadRegisters(kNodeProvider provider, kRegisterModule moduleType, kSize moduleIndex, kArrayList registers);
90 kFsFx(kStatus) kNodeProvider_ReadRegisterOverrides(kNodeProvider provider, kRegisterModule moduleType, kArrayList registers);
91 kFsFx(kStatus) kNodeProvider_WriteRegisterOverrides(kNodeProvider provider, kRegisterModule moduleType, kArrayList registers);
92 
93 kFsFx(kStatus) kNodeProvider_I2cRead(kNodeProvider provider, k32u deviceId, k32u address, kByte* data, kSize size);
94 kFsFx(kStatus) kNodeProvider_I2cWrite(kNodeProvider provider, k32u deviceId, k32u address, const kByte* data, kSize size);
95 
96 kFsFx(kStatus) kNodeProvider_BeginSpi(kNodeProvider provider, kSpiDeviceType type);
97 kFsFx(kStatus) kNodeProvider_EndSpi(kNodeProvider provider);
98 kFsFx(kStatus) kNodeProvider_SpiRead(kNodeProvider provider, kByte* opCode, kSize opSize, kByte* data, kSize dataSize);
99 kFsFx(kStatus) kNodeProvider_SpiWrite(kNodeProvider provider, kByte* opCode, kSize opSize, kByte* data, kSize dataSize);
100 
101 kFsFx(kStatus) kNodeProvider_ReadLogHistory(kNodeProvider provider, kArrayList logItems);
102 kFsFx(kStatus) kNodeProvider_ReadCrashLog(kNodeProvider provider, kString* crashLog, kAlloc allocator);
103 kFsFx(kStatus) kNodeProvider_ClearCrashLog(kNodeProvider provider);
104 
105 kFsFx(kStatus) kNodeProvider_BeginStart(kNodeProvider provider);
106 kFsFx(kStatus) kNodeProvider_EndStart(kNodeProvider provider);
107 kFsFx(kStatus) kNodeProvider_BeginStop(kNodeProvider provider, kBool synchronizeData);
108 kFsFx(kStatus) kNodeProvider_EndStop(kNodeProvider provider);
109 kFsFx(kStatus) kNodeProvider_BeginEngage(kNodeProvider provider, k64u startTime, k64s startEncoder);
110 kFsFx(kStatus) kNodeProvider_EndEngage(kNodeProvider provider);
111 
112 kFsFx(kStatus) kNodeProvider_BeginStartReplay(kNodeProvider provider);
113 kFsFx(kStatus) kNodeProvider_EndStartReplay(kNodeProvider provider);
114 kFsFx(kStatus) kNodeProvider_Replay(kNodeProvider provider, kObject input, kArrayList output);
115 
116 kFsFx(kStatus) kNodeProvider_CameraOverride(kNodeProvider provider, kSize index, const kCameraOverrideItem* overrides, kSize count);
117 kFsFx(kStatus) kNodeProvider_LightOverride(kNodeProvider provider, kSize index, const kLightOverrideItem* overrides, kSize count);
118 
119 kFsFx(kStatus) kNodeProvider_ScheduleEvent(kNodeProvider provider, k32u eventManagerId, k64s target);
120 kFsFx(kStatus) kNodeProvider_TriggerEvent(kNodeProvider provider, k32u eventManagerId);
121 kFsFx(kStatus) kNodeProvider_WriteRamImage(kNodeProvider provider, kSize index, kSize stateIndex, kSize imageIndex, kImage image);
122 kFsFx(kStatus) kNodeProvider_WritePrnu(kNodeProvider provider, kSize index, kImage white, kImage black);
123 kFsFx(kStatus) kNodeProvider_WriteFpn(kNodeProvider provider, kSize index, kImage offsets);
124 kFsFx(kStatus) kNodeProvider_WriteRangeLut(kNodeProvider provider, kSize index, const kRangeLutParams* params, const kRangeLutArray* xArray,
125  const kRangeLutArray* zArray, const kRangeLutArray* validArray);
126 kFsFx(kStatus) kNodeProvider_WritePhaseDecoderLut(kNodeProvider provider, kSize index, kCameraPhaseDecoderLutType type, kArray1 lut);
127 kFsFx(kStatus) kNodeProvider_SetCameraLvdsPower(kNodeProvider provider, kSize index, k32u power);
128 kFsFx(kStatus) kNodeProvider_GetCameraLvdsPower(kNodeProvider provider, kSize index, k32u* power);
129 kFsFx(kStatus) kNodeProvider_WriteAccelerationTestData(kNodeProvider provider, kSize index, kObject data);
130 kFsFx(kStatus) kNodeProvider_ReadAccelerationTestResult(kNodeProvider provider, kSize index, kObject* data, kAlloc allocator);
131 kFsFx(kStatus) kNodeProvider_TriggerCamera(kNodeProvider provider, kSize index);
132 kFsFx(kStatus) kNodeProvider_TriggerLight(kNodeProvider provider, kSize index);
133 kFsFx(kStatus) kNodeProvider_SetLightState(kNodeProvider provider, kSize index, kBool enabled);
134 kFsFx(kStatus) kNodeProvider_LoadPatterns(kNodeProvider provider, kSize index, kArray2 patterns);
135 kFsFx(kStatus) kNodeProvider_LoadProjectorRowGains(kNodeProvider provider, kSize index, kArray1 gains);
136 kFsFx(kStatus) kNodeProvider_LoadProjectorColGains(kNodeProvider provider, kSize index, kArray1 gains);
137 kFsFx(kStatus) kNodeProvider_SetDigitalOutState(kNodeProvider provider, kSize index, kBool state);
138 kFsFx(kStatus) kNodeProvider_TriggerDigitalOut(kNodeProvider provider, kSize index);
139 kFsFx(kStatus) kNodeProvider_EnqueueAnalogOut(kNodeProvider provider, kSize index, k32u value);
140 kFsFx(kStatus) kNodeProvider_EnqueueAnalogOutCurrent(kNodeProvider provider, kSize index, k64f current);
141 kFsFx(kStatus) kNodeProvider_WriteAnalogOutCalibration(kNodeProvider provider, kSize index, kArray2 calibration, k64u revisionId);
142 kFsFx(kStatus) kNodeProvider_WriteSerialOut(kNodeProvider provider, kSize index, const void* buffer, kSize size);
143 kFsFx(kStatus) kNodeProvider_ResetEncoder(kNodeProvider provider);
144 kFsFx(kStatus) kNodeProvider_EnableLed(kNodeProvider provider, kLed instance, kBool enabled);
145 kFsFx(kStatus) kNodeProvider_SetLedMode(kNodeProvider provider, kLed instance, kLedMode mode);
146 kFsFx(kStatus) kNodeProvider_SetGpioState(kNodeProvider provider, kSize bankIndex, k64u mask, k64u state);
147 kFsFx(kStatus) kNodeProvider_GetGpioState(kNodeProvider provider, kSize bankIndex, k64u* state);
148 
149 kFsFx(kStatus) kNodeProvider_GetInfo(kNodeProvider provider, kNodeInfo* info);
150 kFsFx(kStatus) kNodeProvider_GetState(kNodeProvider provider, kNodeStateInfo* info);
151 kFsFx(kStatus) kNodeProvider_GetHealth(kNodeProvider provider, kArrayList stats);
152 kFsFx(kStatus) kNodeProvider_ReadHealthLog(kNodeProvider provider, kHealthSummary* summary, kAlloc alloc);
153 kFsFx(kStatus) kNodeProvider_ClearHealthLog(kNodeProvider provider);
154 kFsFx(kStatus) kNodeProvider_GetNodeStats(kNodeProvider provider, kNodeStats* stats);
155 kFsFx(kStatus) kNodeProvider_GetEventStats(kNodeProvider provider, k32u eventManagerId, kEventStats* stats);
156 kFsFx(kStatus) kNodeProvider_GetCameraStats(kNodeProvider provider, kSize index, kCameraStats* stats);
157 kFsFx(kStatus) kNodeProvider_GetLightStats(kNodeProvider provider, kSize index, kLightStats* stats);
158 kFsFx(kStatus) kNodeProvider_GetProjectorStats(kNodeProvider provider, kSize index, kProjectorStats* stats);
159 kFsFx(kStatus) kNodeProvider_GetAnalogOutStats(kNodeProvider provider, kSize index, kAnalogOutStats* stats);
160 kFsFx(kStatus) kNodeProvider_GetDigitalOutStats(kNodeProvider provider, kSize index, kDigitalOutStats* stats);
161 kFsFx(kStatus) kNodeProvider_GetSerialOutStats(kNodeProvider provider, kSize index, kSerialOutStats* stats);
162 
163 kFsFx(kStatus) kNodeProvider_ResetIoTest(kNodeProvider provider, kSize index);
164 kFsFx(kStatus) kNodeProvider_GetIoTestStats(kNodeProvider provider, kSize index, kIoTestStats* stats);
165 kFsFx(kStatus) kNodeProvider_ReadIoTestSerialData(kNodeProvider provider, kSize index, void* buffer, kSize capacity, kSize* bytesRead);
166 
167 kFsFx(kStatus) kNodeProvider_TestJigCommand(kNodeProvider provider, kTestJigCommand command, k64u data);
168 kFsFx(kStatus) kNodeProvider_GetTestJigStats(kNodeProvider provider, kTestJigStats* stats);
169 
170 kFsFx(kStatus) kNodeProvider_LockOutLight(kNodeProvider provider, kSize index, kBool shouldLock);
171 kFsFx(kStatus) kNodeProvider_SetLightDriverControl(kNodeProvider provider, kSize index, k64u key, kBool enabled);
172 kFsFx(kStatus) kNodeProvider_GetLightDriverControl(kNodeProvider provider, kSize index, k64u key, kBool* enabled);
173 kFsFx(kStatus) kNodeProvider_SetLightDriverPower(kNodeProvider provider, kSize index, k64u key, k32u power, kBool commit);
174 kFsFx(kStatus) kNodeProvider_GetLightDriverPower(kNodeProvider provider, kSize index, k64u key, k32u* power);
175 kFsFx(kStatus) kNodeProvider_SetLightDriverCurrentLimit(kNodeProvider provider, kSize index, k64u key, k32u currentLimit, kBool commit);
176 kFsFx(kStatus) kNodeProvider_GetLightDriverCurrentLimit(kNodeProvider provider, kSize index, k64u key, k32u* currentLimit);
177 kFsFx(kStatus) kNodeProvider_GetLightDriverRemainingSlotCount(kNodeProvider provider, kSize index, k64u key, kSize* remainingCount);
178 kFsFx(kStatus) kNodeProvider_SetLightDriverInfo(kNodeProvider provider, kSize index, k64u key, kLightModel model, kVersion revision, k32u deviceId);
179 kFsFx(kStatus) kNodeProvider_GetLightDriverInfo(kNodeProvider provider, kSize index, k64u key, kLightModel* model, kVersion* revision, k32u* deviceId);
180 kFsFx(kStatus) kNodeProvider_SetLightDriverCalibration(kNodeProvider provider, kSize index, k64u key, kDataTree ldCal, kBool commit);
181 kFsFx(kStatus) kNodeProvider_GetLightDriverCalibration(kNodeProvider provider, kSize index, k64u key, kDataTree* ldCal, kAlloc alloc);
182 kFsFx(kStatus) kNodeProvider_ReadLightDriverTemperature(kNodeProvider provider, kSize index, k64u key, k32s* temperature);
183 
184 kFsFx(kStatus) kNodeProvider_StartOrientationCalibration(kNodeProvider provider);
185 kFsFx(kStatus) kNodeProvider_GetOrientationStats(kNodeProvider provider, kOrientationStats* stats);
186 
187 #include <kFireSync/Client/Network/kNodeProvider.x.h>
188 
189 #endif
kLedMode
Represents indicator LED operational modes.
kLightOverrideItem
Represents light override item.
Definition: kNodeDef.h:979
kOrientationStats
Represents orientation device run-time statistics.
Definition: kNodeDef.h:1595
kNodeFirmwareType
Represents types of node firmware.
kRegisterModule
Represents an enumeration of register modules.
kTestJigStats
Represents controller test jig run-time statistics.
Definition: kNodeDef.h:1679
kCameraStats
Represents camera run-time statistics.
Definition: kNodeDef.h:695
kDataTree
Represents a tree of data objects.
kCameraPhaseDecoderLutType
Represents camera phase decoder LUT type.
kNodeInfo
Represents detailed information about node hardware/firmware.
Definition: kNodeDef.h:2219
kIoTestStats
Represents I/O test jig run-time statistics.
Definition: kNodeDef.h:1488
kIpConfig
Represents address configuration for an Internet Protocol adapter.
Definition: kFsDef.h:157
kNodeMemorySpace
Represents an addressable memory space within a node.
kHealthSummary
Represents a summary of health log data.
kNodeVariableInfo
Represents information about a remote variable.
Definition: kNodeDef.h:2283
kLightStats
Represents light run-time statistics.
Definition: kNodeDef.h:1052
kNodeDef.h
Essential declarations related to FireSync nodes.
kCameraOverrideItem
Represents camera override item.
Definition: kNodeDef.h:351
kSerialOutStats
Represents serial output run-time statistics.
Definition: kNodeDef.h:1423
kStorageItem
Represents a storage item.
kProjectorStats
Represents projector run-time statistics.
Definition: kNodeDef.h:1211
kEventStats
Represents event manager run-time statistics.
Definition: kNodeDef.h:152
kAnalogOutStats
Represents analog output run-time statistics.
Definition: kNodeDef.h:1356
kTestJigCommand
Represents test jig command types.
kLightModel
Represents supported light device types.
kNodeStats
Represents node run-time statistics.
Definition: kNodeDef.h:2256
kLed
Represents indicator LED types.
kDigitalOutStats
Represents digital output run-time statistics.
Definition: kNodeDef.h:1304