FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kNode6Client.h
Go to the documentation of this file.
1 
8 #ifndef K_FIRESYNC_NODE_6_CLIENT_H
9 #define K_FIRESYNC_NODE_6_CLIENT_H
10 
11 #include <kFireSync/kNodeDef.h>
12 
21 //typedef kObject kNode6Client; --forward-declared in kFsDef.x.h
22 
29 kFsFx(kStatus) kNode6Client_Construct(kNode6Client* client, kIpAddress address, kAlloc allocator);
30 
31 kFsFx(kStatus) kNode6Client_SetControlPort(kNode6Client client, k32u port);
32 kFsFx(kStatus) kNode6Client_SetHealthPort(kNode6Client client, k32u port);
33 kFsFx(kStatus) kNode6Client_SetDataPort(kNode6Client client, k32u port);
34 kFsFx(kStatus) kNode6Client_SetMessageAlloc(kNode6Client client, kAlloc alloc);
35 
36 kFsFx(kStatus) kNode6Client_SetErrorHandler(kNode6Client client, kCallbackFx function, kPointer receiver);
37 kFsFx(kStatus) kNode6Client_SetCancelHandler(kNode6Client client, kCallbackFx function, kPointer receiver);
38 kFsFx(kStatus) kNode6Client_SetProtocolVersion(kNode6Client client, kVersion protocol, kVersion platform);
39 kFsFx(kStatus) kNode6Client_BeginOpenControl(kNode6Client client);
40 kFsFx(kStatus) kNode6Client_EndOpenControl(kNode6Client client);
41 kFsFx(kStatus) kNode6Client_CloseControl(kNode6Client client);
42 kFsFx(kStatus) kNode6Client_SetHealthHandler(kNode6Client client, kCallbackFx function, kPointer receiver);
43 kFsFx(kStatus) kNode6Client_BeginOpenHealth(kNode6Client client);
44 kFsFx(kStatus) kNode6Client_EndOpenHealth(kNode6Client client);
45 kFsFx(kStatus) kNode6Client_CloseHealth(kNode6Client client);
46 kFsFx(kStatus) kNode6Client_SetDataBufferSize(kNode6Client client, kSize size);
47 kFsFx(kStatus) kNode6Client_SetDataHandler(kNode6Client client, kCallbackFx function, kPointer receiver);
48 kFsFx(kStatus) kNode6Client_BeginOpenData(kNode6Client client, const k16u* ports, kSize portCount);
49 kFsFx(kStatus) kNode6Client_EndOpenData(kNode6Client client);
50 kFsFx(kStatus) kNode6Client_EndDataSession(kNode6Client client);
51 kFsFx(kStatus) kNode6Client_CloseData(kNode6Client client);
52 kFsFx(kStatus) kNode6Client_InvalidateDataSession(kNode6Client client);
53 
54 kFsFx(kStatus) kNode6Client_ClearFirmware(kNode6Client client, kNodeFirmwareType type);
55 kFsFx(kStatus) kNode6Client_WriteFirmware(kNode6Client client, kNodeFirmwareType type, kStream stream, kSize size, kCallbackFx progress, kPointer context);
56 kFsFx(kStatus) kNode6Client_ReloadFirmware(kNode6Client client, kNodeFirmwareType type, kStream stream, kSize size);
57 kFsFx(kStatus) kNode6Client_Reset(kNode6Client client, kBool restartApp);
58 
59 kFsFx(kStatus) kNode6Client_WriteFile(kNode6Client client, const kChar* path, kStream stream, kSize size, kCallbackFx progress, kPointer context);
60 kFsFx(kStatus) kNode6Client_CopyFile(kNode6Client client, const kChar* sourcePath, const kChar* destPath, kCallbackFx progress, kPointer context);
61 kFsFx(kStatus) kNode6Client_ReadFile(kNode6Client client, const kChar* path, kStream stream, kCallbackFx progress, kPointer context);
62 kFsFx(kStatus) kNode6Client_DeleteFile(kNode6Client client, const kChar* path);
63 kFsFx(kStatus) kNode6Client_GetFileInfo(kNode6Client client, const kChar* path, kStorageItem* item);
64 kFsFx(kStatus) kNode6Client_CreateDirectory(kNode6Client client, const kChar* path);
65 kFsFx(kStatus) kNode6Client_DeleteDirectory(kNode6Client client, const kChar* path);
66 kFsFx(kStatus) kNode6Client_ListDirectoryEntries(kNode6Client client, const kChar* path, kBool includeFiles, kBool includeDirectories, kArrayList entries);
67 kFsFx(kStatus) kNode6Client_ListDirectoryEntriesEx(kNode6Client client, const kChar* path, kArrayList entries);
68 
69 kFsFx(kStatus) kNode6Client_SetDeviceConfig(kNode6Client client, kXml xml, k64u revisionId);
70 kFsFx(kStatus) kNode6Client_GetDeviceConfig(kNode6Client client, kXml xml, k64u* revisionId);
71 kFsFx(kStatus) kNode6Client_CommitDeviceConfig(kNode6Client client);
72 kFsFx(kStatus) kNode6Client_SetModeConfig(kNode6Client client, kXml xml, k64u revisionId);
73 kFsFx(kStatus) kNode6Client_GetModeConfig(kNode6Client client, kXml xml, k64u* revisionId);
74 kFsFx(kStatus) kNode6Client_SaveModeConfig(kNode6Client client, const kChar* path);
75 kFsFx(kStatus) kNode6Client_LoadModeConfig(kNode6Client client, const kChar* path);
76 kFsFx(kStatus) kNode6Client_CommitModeConfig(kNode6Client client);
77 kFsFx(kStatus) kNode6Client_ValidateBlockConfig(kNode6Client client, kXml config);
78 
79 kFsFx(kStatus) kNode6Client_SetDateTime(kNode6Client client, kDateTime dateTime, kBool isAuthoritative);
80 kFsFx(kStatus) kNode6Client_IncrementInputCounter(kNode6Client client);
81 
82 kFsFx(kStatus) kNode6Client_CameraOverride(kNode6Client client, kSize index, const kCameraOverrideItem* overrides, kSize count);
83 kFsFx(kStatus) kNode6Client_LightOverride(kNode6Client client, kSize index, const kLightOverrideItem* overrides, kSize count);
84 
85 kFsFx(kStatus) kNode6Client_ListProcedures(kNode6Client client, kArrayList procedures);
86 kFsFx(kStatus) kNode6Client_InvokeProcedure(kNode6Client client, const kChar* name, kObject input, kObject* output, kAlloc alloc);
87 
88 kFsFx(kStatus) kNode6Client_SetVariable(kNode6Client client, const kChar* name, kObject variable);
89 kFsFx(kStatus) kNode6Client_GetVariable(kNode6Client client, const kChar* name, kObject* variable, kAlloc alloc);
90 kFsFx(kStatus) kNode6Client_GetVariableInfo(kNode6Client client, const kChar* name, kNodeVariableInfo* info);
91 kFsFx(kStatus) kNode6Client_DeleteVariable(kNode6Client client, const kChar* name);
92 kFsFx(kStatus) kNode6Client_ListVariables(kNode6Client client, kArrayList variables);
93 
94 kFsFx(kStatus) kNode6Client_ValidateActionConfig(kNode6Client client, kXml config);
95 kFsFx(kStatus) kNode6Client_InvokeAction(kNode6Client client, const kChar* typeName, kXml config, kObject input, kObject* output, kAlloc alloc);
96 kFsFx(kStatus) kNode6Client_InvokeNamedAction(kNode6Client client, const kChar* name, kObject input, kObject* output, kAlloc alloc);
97 
98 kFsFx(kStatus) kNode6Client_ReadMemory(kNode6Client client, kNodeMemorySpace space, k64u offset, kSize length, void* data);
99 kFsFx(kStatus) kNode6Client_WriteMemory(kNode6Client client, kNodeMemorySpace space, k64u offset, kSize length, const void* data);
100 
101 kFsFx(kStatus) kNode6Client_ReadRegisters(kNode6Client client, kRegisterModule moduleType, kSize moduleIndex, kArrayList registers);
102 kFsFx(kStatus) kNode6Client_ReadRegisterOverrides(kNode6Client client, kRegisterModule moduleType, kArrayList registers);
103 kFsFx(kStatus) kNode6Client_WriteRegisterOverrides(kNode6Client client, kRegisterModule moduleType, kArrayList registers);
104 
105 kFsFx(kStatus) kNode6Client_I2cRead(kNode6Client client, k32u deviceId, k32u address, kByte* data, kSize size);
106 kFsFx(kStatus) kNode6Client_I2cWrite(kNode6Client client, k32u deviceId, k32u address, const kByte* data, kSize size);
107 
108 kFsFx(kStatus) kNode6Client_BeginSpi(kNode6Client client, kSpiDeviceType type);
109 kFsFx(kStatus) kNode6Client_EndSpi(kNode6Client client);
110 kFsFx(kStatus) kNode6Client_SpiRead(kNode6Client client, kByte* opCode, kSize opSize, kByte* data, kSize dataSize);
111 kFsFx(kStatus) kNode6Client_SpiWrite(kNode6Client client, kByte* opCode, kSize opSize, kByte* data, kSize dataSize);
112 
113 kFsFx(kStatus) kNode6Client_ReadLogHistory(kNode6Client client, kArrayList logItems);
114 kFsFx(kStatus) kNode6Client_ReadCrashLog(kNode6Client client, kString* crashLog, kAlloc allocator);
115 kFsFx(kStatus) kNode6Client_ClearCrashLog(kNode6Client client);
116 
117 kFsFx(kStatus) kNode6Client_BeginStart(kNode6Client client);
118 kFsFx(kStatus) kNode6Client_EndStart(kNode6Client client);
119 kFsFx(kStatus) kNode6Client_BeginStop(kNode6Client client, kBool synchronizeData);
120 kFsFx(kStatus) kNode6Client_EndStop(kNode6Client client);
121 kFsFx(kStatus) kNode6Client_BeginEngage(kNode6Client client, k64u startTime, k64s startEncoder);
122 kFsFx(kStatus) kNode6Client_EndEngage(kNode6Client client);
123 
124 kFsFx(kStatus) kNode6Client_BeginStartReplay(kNode6Client client);
125 kFsFx(kStatus) kNode6Client_EndStartReplay(kNode6Client client);
126 kFsFx(kStatus) kNode6Client_Replay(kNode6Client client, kObject input, kArrayList output);
127 
128 kFsFx(kStatus) kNode6Client_ScheduleEvent(kNode6Client client, k32u eventManagerId, k64s target);
129 kFsFx(kStatus) kNode6Client_TriggerEvent(kNode6Client client, k32u eventManagerId);
130 kFsFx(kStatus) kNode6Client_TriggerCamera(kNode6Client client, kSize index);
131 kFsFx(kStatus) kNode6Client_TriggerLight(kNode6Client client, kSize index);
132 kFsFx(kStatus) kNode6Client_SetLightState(kNode6Client client, kSize index, kBool enabled);
133 kFsFx(kStatus) kNode6Client_SetDigitalOutState(kNode6Client client, kSize index, kBool state);
134 kFsFx(kStatus) kNode6Client_TriggerDigitalOut(kNode6Client client, kSize index);
135 kFsFx(kStatus) kNode6Client_EnqueueAnalogOut(kNode6Client client, kSize index, k32u value);
136 kFsFx(kStatus) kNode6Client_EnqueueAnalogOutCurrent(kNode6Client client, kSize index, k64f current);
137 kFsFx(kStatus) kNode6Client_WriteAnalogOutCalibration(kNode6Client client, kSize index, kArray2 calibration, k64u revisionId);
138 
139 kFsFx(kStatus) kNode6Client_WriteSerialOut(kNode6Client client, kSize index, const void* buffer, kSize size);
140 kFsFx(kStatus) kNode6Client_WriteRamImage(kNode6Client client, kSize index, kSize stateIndex, kSize imageIndex, kImage image);
141 kFsFx(kStatus) kNode6Client_WritePrnu(kNode6Client client, kSize index, kImage white, kImage black);
142 kFsFx(kStatus) kNode6Client_WriteFpn(kNode6Client client, kSize index, kImage offsets);
143 kFsFx(kStatus) kNode6Client_WriteRangeLut(kNode6Client client, kSize index,
144  const kRangeLutParams* params, const kRangeLutArray* xArray,
145  const kRangeLutArray* zArray, const kRangeLutArray* validArray);
146 kFsFx(kStatus) kNode6Client_WritePhaseDecoderLut(kNode6Client client, kSize index, kCameraPhaseDecoderLutType type, kArray1 lut);
147 kFsFx(kStatus) kNode6Client_SetCameraLvdsPower(kNode6Client client, kSize index, k32u power);
148 kFsFx(kStatus) kNode6Client_GetCameraLvdsPower(kNode6Client client, kSize index, k32u* power);
149 kFsFx(kStatus) kNode6Client_WriteAccelerationTestData(kNode6Client client, kSize index, kObject data);
150 kFsFx(kStatus) kNode6Client_ReadAccelerationTestResult(kNode6Client client, kSize index, kObject* data, kAlloc allocator);
151 
152 kFsFx(kStatus) kNode6Client_LoadPatterns(kNode6Client client, kSize index, kArray2 patterns);
153 kFsFx(kStatus) kNode6Client_LoadProjectorRowGains(kNode6Client client, kSize index, kArray1 gains);
154 kFsFx(kStatus) kNode6Client_LoadProjectorColGains(kNode6Client client, kSize index, kArray1 gains);
155 kFsFx(kStatus) kNode6Client_ResetEncoder(kNode6Client client);
156 kFsFx(kStatus) kNode6Client_EnableLed(kNode6Client client, kLed instance, kBool enabled);
157 kFsFx(kStatus) kNode6Client_SetLedMode(kNode6Client client, kLed instance, kLedMode mode);
158 kFsFx(kStatus) kNode6Client_SetGpioState(kNode6Client client, kSize bankIndex, k64u mask, k64u state);
159 kFsFx(kStatus) kNode6Client_GetGpioState(kNode6Client client, kSize bankIndex, k64u* state);
160 
161 kFsFx(kStatus) kNode6Client_GetInfo(kNode6Client client, kNodeInfo* info);
162 kFsFx(kStatus) kNode6Client_GetState(kNode6Client client, kNodeStateInfo* info);
163 kFsFx(kStatus) kNode6Client_GetHealth(kNode6Client client, kArrayList stats);
164 kFsFx(kStatus) kNode6Client_ReadHealthLog(kNode6Client client, kHealthSummary* summary, kAlloc alloc);
165 kFsFx(kStatus) kNode6Client_ClearHealthLog(kNode6Client client);
166 kFsFx(kStatus) kNode6Client_GetNodeStats(kNode6Client client, kNodeStats* stats);
167 kFsFx(kStatus) kNode6Client_GetEventStats(kNode6Client client, k32u eventManagerId, kEventStats* stats);
168 kFsFx(kStatus) kNode6Client_GetCameraStats(kNode6Client client, kSize index, kCameraStats* stats);
169 kFsFx(kStatus) kNode6Client_GetLightStats(kNode6Client client, kSize index, kLightStats* stats);
170 kFsFx(kStatus) kNode6Client_GetProjectorStats(kNode6Client client, kSize index, kProjectorStats* stats);
171 kFsFx(kStatus) kNode6Client_GetAnalogOutStats(kNode6Client client, kSize index, kAnalogOutStats* stats);
172 kFsFx(kStatus) kNode6Client_GetDigitalOutStats(kNode6Client client, kSize index, kDigitalOutStats* stats);
173 kFsFx(kStatus) kNode6Client_GetSerialOutStats(kNode6Client client, kSize index, kSerialOutStats* stats);
174 
175 kFsFx(kStatus) kNode6Client_ResetIoTest(kNode6Client client, kSize index);
176 kFsFx(kStatus) kNode6Client_GetIoTestStats(kNode6Client client, kSize index, kIoTestStats* stats);
177 kFsFx(kStatus) kNode6Client_ReadIoTestSerialData(kNode6Client client, kSize index, void* buffer, kSize capacity, kSize* bytesRead);
178 
179 kFsFx(kStatus) kNode6Client_TestJigCommand(kNode6Client client, kTestJigCommand command, k64u data);
180 kFsFx(kStatus) kNode6Client_GetTestJigStats(kNode6Client client, kTestJigStats* stats);
181 
182 kFsFx(kStatus) kNode6Client_LockOutLight(kNode6Client client, kSize index, kBool shouldLock);
183 kFsFx(kStatus) kNode6Client_SetLightDriverControl(kNode6Client client, kSize index, k64u key, kBool enabled);
184 kFsFx(kStatus) kNode6Client_GetLightDriverControl(kNode6Client client, kSize index, k64u key, kBool* enabled);
185 kFsFx(kStatus) kNode6Client_SetLightDriverPower(kNode6Client client, kSize index, k64u key, k32u power, kBool commit);
186 kFsFx(kStatus) kNode6Client_GetLightDriverPower(kNode6Client client, kSize index, k64u key, k32u* power);
187 kFsFx(kStatus) kNode6Client_SetLightDriverCurrentLimit(kNode6Client client, kSize index, k64u key, k32u currentLimit, kBool commit);
188 kFsFx(kStatus) kNode6Client_GetLightDriverCurrentLimit(kNode6Client client, kSize index, k64u key, k32u* currentLimit);
189 kFsFx(kStatus) kNode6Client_GetLightDriverRemainingSlotCount(kNode6Client client, kSize index, k64u key, kSize* remainingCount);
190 kFsFx(kStatus) kNode6Client_SetLightDriverInfo(kNode6Client client, kSize index, k64u key, kLightModel model, kVersion revision, k32u deviceId);
191 kFsFx(kStatus) kNode6Client_GetLightDriverInfo(kNode6Client client, kSize index, k64u key, kLightModel* model, kVersion* revision, k32u* deviceId);
192 kFsFx(kStatus) kNode6Client_SetLightDriverCalibration(kNode6Client provider, kSize index, k64u key, kDataTree ldCal, kBool commit);
193 kFsFx(kStatus) kNode6Client_GetLightDriverCalibration(kNode6Client provider, kSize index, k64u key, kDataTree* ldCal, kAlloc alloc);
194 kFsFx(kStatus) kNode6Client_ReadLightDriverTemperature(kNode6Client provider, kSize index, k64u key, k32s* temperature);
195 
196 kFsFx(kStatus) kNode6Client_StartOrientationCalibration(kNode6Client client);
197 kFsFx(kStatus) kNode6Client_GetOrientationStats(kNode6Client client, kOrientationStats* stats);
198 
199 #include <kFireSync/Client/Network/kNode6Client.x.h>
200 
201 #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
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