FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kControl6Client.h
Go to the documentation of this file.
1 
8 #ifndef K_FIRESYNC_CONTROL_6_CLIENT_H
9 #define K_FIRESYNC_CONTROL_6_CLIENT_H
10 
11 #include <kFireSync/kNodeDef.h>
12 
20 //typedef kObject kControl6Client; --forward-declared in kFsDef.x.h
21 
28 kFsFx(kStatus) kControl6Client_Construct(kControl6Client* client, kAlloc allocator);
29 
30 kFsFx(kStatus) kControl6Client_SetErrorHandler(kControl6Client client, kCallbackFx function, kPointer receiver);
31 kFsFx(kStatus) kControl6Client_SetCancelHandler(kControl6Client client, kCallbackFx function, kPointer receiver);
32 kFsFx(kStatus) kControl6Client_BeginOpen(kControl6Client client, kIpAddress address, k32u port);
33 kFsFx(kStatus) kControl6Client_EndOpen(kControl6Client client);
34 kFsFx(kStatus) kControl6Client_Close(kControl6Client client);
35 
36 kFsFx(kStatus) kControl6Client_SetProtocolVersion(kControl6Client client, kVersion protocol, kVersion platform);
37 
38 kFsFx(kStatus) kControl6Client_ClearFirmware(kControl6Client client, kNodeFirmwareType type);
39 kFsFx(kStatus) kControl6Client_WriteFirmware(kControl6Client client, kNodeFirmwareType type, kStream stream, kSize size, kCallbackFx progress, kPointer context);
40 kFsFx(kStatus) kControl6Client_ReloadFirmware(kControl6Client client, kNodeFirmwareType type, kStream stream, kSize size);
41 kFsFx(kStatus) kControl6Client_Reset(kControl6Client client, kBool restartApp);
42 
43 kFsFx(kStatus) kControl6Client_WriteFile(kControl6Client client, const kChar* path, kStream stream, kSize size, kCallbackFx progress, kPointer context);
44 kFsFx(kStatus) kControl6Client_CopyFile(kControl6Client client, const kChar* sourcePath, const kChar* destPath, kCallbackFx progress, kPointer context);
45 kFsFx(kStatus) kControl6Client_ReadFile(kControl6Client client, const kChar* path, kStream stream, kCallbackFx progress, kPointer context);
46 kFsFx(kStatus) kControl6Client_DeleteFile(kControl6Client client, const kChar* path);
47 kFsFx(kStatus) kControl6Client_GetFileInfo(kControl6Client client, const kChar* path, kStorageItem* item);
48 kFsFx(kStatus) kControl6Client_CreateDirectory(kControl6Client client, const kChar* path);
49 kFsFx(kStatus) kControl6Client_DeleteDirectory(kControl6Client client, const kChar* path);
50 kFsFx(kStatus) kControl6Client_ListDirectoryEntries(kControl6Client client, const kChar* path, kBool includeFiles, kBool includeDirectories, kArrayList entries);
51 kFsFx(kStatus) kControl6Client_ListDirectoryEntriesEx(kControl6Client client, const kChar* path, kArrayList entries);
52 
53 kFsFx(kStatus) kControl6Client_GetDeviceConfig(kControl6Client client, kXml xml, k64u* revisionId);
54 kFsFx(kStatus) kControl6Client_SetDeviceConfig(kControl6Client client, kXml xml, k64u revisionId);
55 kFsFx(kStatus) kControl6Client_CommitDeviceConfig(kControl6Client client);
56 kFsFx(kStatus) kControl6Client_GetModeConfig(kControl6Client client, kXml xml, k64u* revisionId);
57 kFsFx(kStatus) kControl6Client_SetModeConfig(kControl6Client client, kXml xml, k64u revisionId);
58 kFsFx(kStatus) kControl6Client_SaveModeConfig(kControl6Client client, const kChar* path);
59 kFsFx(kStatus) kControl6Client_LoadModeConfig(kControl6Client client, const kChar* path);
60 kFsFx(kStatus) kControl6Client_CommitModeConfig(kControl6Client client);
61 kFsFx(kStatus) kControl6Client_ValidateBlockConfig(kControl6Client client, kXml xml);
62 
63 kFsFx(kStatus) kControl6Client_SetDateTime(kControl6Client client, kDateTime dateTime, kBool isAuthoritative);
64 kFsFx(kStatus) kControl6Client_IncrementInputCounter(kControl6Client client);
65 
66 kFsFx(kStatus) kControl6Client_CameraOverride(kControl6Client client, kSize index, const kCameraOverrideItem* overrides, kSize count);
67 kFsFx(kStatus) kControl6Client_LightOverride(kControl6Client client, kSize index, const kLightOverrideItem* overrides, kSize count);
68 
69 kFsFx(kStatus) kControl6Client_ListProcedures(kControl6Client client, kArrayList procedures);
70 kFsFx(kStatus) kControl6Client_InvokeProcedure(kControl6Client client, const kChar* name, kObject input, kObject* output, kAlloc alloc);
71 
72 kFsFx(kStatus) kControl6Client_SetVariable(kControl6Client client, const kChar* name, kObject variable);
73 kFsFx(kStatus) kControl6Client_GetVariable(kControl6Client client, const kChar* name, kObject* variable, kAlloc alloc);
74 kFsFx(kStatus) kControl6Client_GetVariableInfo(kControl6Client client, const kChar* name, kNodeVariableInfo* info);
75 kFsFx(kStatus) kControl6Client_DeleteVariable(kControl6Client client, const kChar* name);
76 kFsFx(kStatus) kControl6Client_ListVariables(kControl6Client client, kArrayList variables);
77 
78 kFsFx(kStatus) kControl6Client_ValidateActionConfig(kControl6Client client, kXml xml);
79 kFsFx(kStatus) kControl6Client_InvokeAction(kControl6Client client, const kChar* typeName, kXml xml, kObject input, kObject* output, kAlloc alloc);
80 kFsFx(kStatus) kControl6Client_InvokeNamedAction(kControl6Client client, const kChar* name, kObject input, kObject* output, kAlloc alloc);
81 
82 kFsFx(kStatus) kControl6Client_ReadMemory(kControl6Client client, kNodeMemorySpace space, k64u offset, kSize length, void* data);
83 kFsFx(kStatus) kControl6Client_WriteMemory(kControl6Client client, kNodeMemorySpace space, k64u offset, kSize length, const void* data);
84 
85 kFsFx(kStatus) kControl6Client_ReadRegisters(kControl6Client client, kRegisterModule moduleType, kSize moduleIndex, kArrayList registers);
86 kFsFx(kStatus) kControl6Client_ReadRegisterOverrides(kControl6Client client, kRegisterModule moduleType, kArrayList registers);
87 kFsFx(kStatus) kControl6Client_WriteRegisterOverrides(kControl6Client client, kRegisterModule moduleType, kArrayList registers);
88 
89 kFsFx(kStatus) kControl6Client_I2cRead(kControl6Client client, k32u deviceId, k32u address, kByte* data, kSize size);
90 kFsFx(kStatus) kControl6Client_I2cWrite(kControl6Client client, k32u deviceId, k32u address, const kByte* data, kSize size);
91 
92 kFsFx(kStatus) kControl6Client_BeginSpi(kControl6Client client, kSpiDeviceType type);
93 kFsFx(kStatus) kControl6Client_EndSpi(kControl6Client client);
94 kFsFx(kStatus) kControl6Client_SpiRead(kControl6Client client, kByte* opCode, kSize opSize, kByte* data, kSize dataSize);
95 kFsFx(kStatus) kControl6Client_SpiWrite(kControl6Client client, kByte* opCode, kSize opSize, kByte* data, kSize dataSize);
96 
97 kFsFx(kStatus) kControl6Client_ReadLogHistory(kControl6Client client, kArrayList logItems);
98 kFsFx(kStatus) kControl6Client_ReadCrashLog(kControl6Client client, kString* crashLog, kAlloc allocator);
99 kFsFx(kStatus) kControl6Client_ClearCrashLog(kControl6Client client);
100 
101 kFsFx(kStatus) kControl6Client_BeginStart(kControl6Client client);
102 kFsFx(kStatus) kControl6Client_EndStart(kControl6Client client);
103 kFsFx(kStatus) kControl6Client_BeginStop(kControl6Client client, kBool synchronizeData);
104 kFsFx(kStatus) kControl6Client_EndStop(kControl6Client client);
105 kFsFx(kStatus) kControl6Client_BeginEngage(kControl6Client client, k64u startTime, k64s startEncoder);
106 kFsFx(kStatus) kControl6Client_EndEngage(kControl6Client client);
107 
108 kFsFx(kStatus) kControl6Client_BeginStartReplay(kControl6Client client);
109 kFsFx(kStatus) kControl6Client_EndStartReplay(kControl6Client client);
110 kFsFx(kStatus) kControl6Client_Replay(kControl6Client client, kObject input, kArrayList output);
111 
112 kFsFx(kStatus) kControl6Client_ScheduleEvent(kControl6Client client, k32u eventManagerId, k64s target);
113 kFsFx(kStatus) kControl6Client_TriggerEvent(kControl6Client client, k32u eventManagerId);
114 kFsFx(kStatus) kControl6Client_TriggerCamera(kControl6Client client, kSize index);
115 kFsFx(kStatus) kControl6Client_SetLightState(kControl6Client client, kSize index, kBool enabled);
116 kFsFx(kStatus) kControl6Client_TriggerLight(kControl6Client client, kSize index);
117 kFsFx(kStatus) kControl6Client_SetDigitalOutState(kControl6Client client, kSize index, kBool state);
118 kFsFx(kStatus) kControl6Client_TriggerDigitalOut(kControl6Client client, kSize index);
119 kFsFx(kStatus) kControl6Client_EnqueueAnalogOut(kControl6Client client, kSize index, k32u value);
120 kFsFx(kStatus) kControl6Client_EnqueueAnalogOutCurrent(kControl6Client client, kSize index, k64f current);
121 kFsFx(kStatus) kControl6Client_WriteAnalogOutCalibration(kControl6Client client, kSize index, kArray2 calibration, k64u revisionId);
122 kFsFx(kStatus) kControl6Client_WriteSerialOut(kControl6Client client, kSize index, const void* buffer, kSize size);
123 
124 kFsFx(kStatus) kControl6Client_WriteRamImage(kControl6Client client, kSize index, kSize stateIndex, kSize imageIndex, kImage image);
125 kFsFx(kStatus) kControl6Client_WritePrnu(kControl6Client client, kSize index, kImage white, kImage black);
126 kFsFx(kStatus) kControl6Client_WriteFpn(kControl6Client client, kSize index, kImage offsets);
127 kFsFx(kStatus) kControl6Client_WriteRangeLut(kControl6Client client, kSize index,
128  const kRangeLutParams* params, const kRangeLutArray* xArray,
129  const kRangeLutArray* zArray, const kRangeLutArray* validArray);
130 kFsFx(kStatus) kControl6Client_WritePhaseDecoderLut(kControl6Client client, kSize index, kCameraPhaseDecoderLutType type, kArray1 lut);
131 kFsFx(kStatus) kControl6Client_SetCameraLvdsPower(kControl6Client client, kSize index, k32u power);
132 kFsFx(kStatus) kControl6Client_GetCameraLvdsPower(kControl6Client client, kSize index, k32u* power);
133 kFsFx(kStatus) kControl6Client_WriteAccelerationTestData(kControl6Client client, kSize index, kObject data);
134 kFsFx(kStatus) kControl6Client_ReadAccelerationTestResult(kControl6Client client, kSize index, kObject* data, kAlloc allocator);
135 
136 kFsFx(kStatus) kControl6Client_LoadPatterns(kControl6Client client, kSize index, kArray2 patterns);
137 kFsFx(kStatus) kControl6Client_LoadProjectorRowGains(kControl6Client client, kSize index, kArray1 gains);
138 kFsFx(kStatus) kControl6Client_LoadProjectorColGains(kControl6Client client, kSize index, kArray1 gains);
139 kFsFx(kStatus) kControl6Client_ResetEncoder(kControl6Client client);
140 kFsFx(kStatus) kControl6Client_EnableLed(kControl6Client client, kLed instance, kBool enabled);
141 kFsFx(kStatus) kControl6Client_SetLedMode(kControl6Client client, kLed instance, kLedMode mode);
142 kFsFx(kStatus) kControl6Client_SetGpioState(kControl6Client client, kSize bankIndex, k64u mask, k64u state);
143 kFsFx(kStatus) kControl6Client_GetGpioState(kControl6Client client, kSize bankIndex, k64u* state);
144 
145 kFsFx(kStatus) kControl6Client_GetInfo(kControl6Client client, kNodeInfo* info);
146 kFsFx(kStatus) kControl6Client_GetState(kControl6Client client, kNodeStateInfo* info);
147 kFsFx(kStatus) kControl6Client_GetHealth(kControl6Client client, kArrayList stats);
148 kFsFx(kStatus) kControl6Client_ReadHealthLog(kControl6Client client, kHealthSummary* summary, kAlloc alloc);
149 kFsFx(kStatus) kControl6Client_ClearHealthLog(kControl6Client client);
150 kFsFx(kStatus) kControl6Client_GetNodeStats(kControl6Client client, kNodeStats* stats);
151 kFsFx(kStatus) kControl6Client_GetEventStats(kControl6Client client, k32u eventManagerId, kEventStats* stats);
152 kFsFx(kStatus) kControl6Client_GetCameraStats(kControl6Client client, kSize index, kCameraStats* stats);
153 kFsFx(kStatus) kControl6Client_GetLightStats(kControl6Client client, kSize index, kLightStats* stats);
154 kFsFx(kStatus) kControl6Client_GetProjectorStats(kControl6Client client, kSize index, kProjectorStats* stats);
155 kFsFx(kStatus) kControl6Client_GetAnalogOutStats(kControl6Client client, kSize index, kAnalogOutStats* stats);
156 kFsFx(kStatus) kControl6Client_GetDigitalOutStats(kControl6Client client, kSize index, kDigitalOutStats* stats);
157 kFsFx(kStatus) kControl6Client_GetSerialOutStats(kControl6Client client, kSize index, kSerialOutStats* stats);
158 
159 kFsFx(kStatus) kControl6Client_ResetIoTest(kControl6Client client, kSize index);
160 kFsFx(kStatus) kControl6Client_GetIoTestStats(kControl6Client client, kSize index, kIoTestStats* stats);
161 kFsFx(kStatus) kControl6Client_ReadIoTestSerialData(kControl6Client client, kSize index, void* buffer, kSize capacity, kSize* bytesRead);
162 
163 kFsFx(kStatus) kControl6Client_TestJigCommand(kControl6Client client, kTestJigCommand command, k64u data);
164 kFsFx(kStatus) kControl6Client_GetTestJigStats(kControl6Client client, kTestJigStats* stats);
165 
166 kFsFx(kStatus) kControl6Client_LockOutLight(kControl6Client client, kSize index, kBool shouldLock);
167 kFsFx(kStatus) kControl6Client_SetLightDriverControl(kControl6Client client, kSize index, k64u key, kBool enabled);
168 kFsFx(kStatus) kControl6Client_GetLightDriverControl(kControl6Client client, kSize index, k64u key, kBool* enabled);
169 kFsFx(kStatus) kControl6Client_SetLightDriverPower(kControl6Client client, kSize index, k64u key, k32u power, kBool commit);
170 kFsFx(kStatus) kControl6Client_GetLightDriverPower(kControl6Client client, kSize index, k64u key, k32u* power);
171 kFsFx(kStatus) kControl6Client_SetLightDriverCurrentLimit(kControl6Client client, kSize index, k64u key, k32u currentLimit, kBool commit);
172 kFsFx(kStatus) kControl6Client_GetLightDriverCurrentLimit(kControl6Client client, kSize index, k64u key, k32u* currentLimit);
173 kFsFx(kStatus) kControl6Client_GetLightDriverRemainingSlotCount(kControl6Client client, kSize index, k64u key, kSize* remainingCount);
174 kFsFx(kStatus) kControl6Client_SetLightDriverInfo(kControl6Client client, kSize index, k64u key, kLightModel model, kVersion revision, k32u deviceId);
175 kFsFx(kStatus) kControl6Client_GetLightDriverInfo(kControl6Client client, kSize index, k64u key, kLightModel* model, kVersion* revision, k32u* deviceId);
176 kFsFx(kStatus) kControl6Client_SetLightDriverCalibration(kControl6Client client, kSize index, k64u key, kDataTree ldCal, kBool commit);
177 kFsFx(kStatus) kControl6Client_GetLightDriverCalibration(kControl6Client client, kSize index, k64u key, kDataTree* ldCal, kAlloc alloc);
178 kFsFx(kStatus) kControl6Client_ReadLightDriverTemperature(kControl6Client client, kSize index, k64u key, k32s* temperature);
179 
180 kFsFx(kStatus) kControl6Client_StartOrientationCalibration(kControl6Client client);
181 kFsFx(kStatus) kControl6Client_GetOrientationStats(kControl6Client client, kOrientationStats* stats);
182 
183 #include <kFireSync/Client/Network/kControl6Client.x.h>
184 
185 #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