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 
13 kBeginHeader()
14 
15 
22 //typedef kObject kControl6Client; --forward-declared in kFsDef.x.h
23 
24 
30 kFsFx(kStatus) kControl6Client_Construct(kControl6Client* client, kAlloc allocator);
31 
32 kFsFx(kStatus) kControl6Client_SetErrorHandler(kControl6Client client, kCallbackFx function, kPointer receiver);
33 kFsFx(kStatus) kControl6Client_SetCancelHandler(kControl6Client client, kCallbackFx function, kPointer receiver);
34 kFsFx(kStatus) kControl6Client_BeginOpen(kControl6Client client, kIpAddress address, k32u port);
35 kFsFx(kStatus) kControl6Client_EndOpen(kControl6Client client);
36 kFsFx(kStatus) kControl6Client_Close(kControl6Client client);
37 
38 kFsFx(kStatus) kControl6Client_SetProtocolVersion(kControl6Client client, kVersion version);
39 
40 kFsFx(kStatus) kControl6Client_WriteFirmware(kControl6Client client, kNodeFirmwareType type, kStream stream, kSize size, kCallbackFx progress, kPointer context);
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, kNodeFileInfo* info);
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 
52 kFsFx(kStatus) kControl6Client_GetDeviceConfig(kControl6Client client, kXml xml, k64u* revisionId);
53 kFsFx(kStatus) kControl6Client_SetDeviceConfig(kControl6Client client, kXml xml, k64u revisionId);
54 kFsFx(kStatus) kControl6Client_CommitDeviceConfig(kControl6Client client);
55 kFsFx(kStatus) kControl6Client_GetModeConfig(kControl6Client client, kXml xml, k64u* revisionId);
56 kFsFx(kStatus) kControl6Client_SetModeConfig(kControl6Client client, kXml xml, k64u revisionId);
57 kFsFx(kStatus) kControl6Client_SaveModeConfig(kControl6Client client, const kChar* path);
58 kFsFx(kStatus) kControl6Client_LoadModeConfig(kControl6Client client, const kChar* path);
59 kFsFx(kStatus) kControl6Client_CommitModeConfig(kControl6Client client);
60 kFsFx(kStatus) kControl6Client_ValidateBlockConfig(kControl6Client client, kXml xml);
61 kFsFx(kStatus) kControl6Client_CameraOverride(kControl6Client client, kSize index, const kCameraOverrideItem* overrides, kSize count);
62 kFsFx(kStatus) kControl6Client_LightOverride(kControl6Client client, kSize index, const kLightOverrideItem* overrides, kSize count);
63 
64 kFsFx(kStatus) kControl6Client_ListProcedures(kControl6Client client, kArrayList procedures);
65 kFsFx(kStatus) kControl6Client_InvokeProcedure(kControl6Client client, const kChar* name, kObject input, kObject* output, kAlloc alloc);
66 
67 kFsFx(kStatus) kControl6Client_SetVariable(kControl6Client client, const kChar* name, kObject variable);
68 kFsFx(kStatus) kControl6Client_GetVariable(kControl6Client client, const kChar* name, kObject* variable, kAlloc alloc);
69 kFsFx(kStatus) kControl6Client_GetVariableInfo(kControl6Client client, const kChar* name, kNodeVariableInfo* info);
70 kFsFx(kStatus) kControl6Client_DeleteVariable(kControl6Client client, const kChar* name);
71 kFsFx(kStatus) kControl6Client_ListVariables(kControl6Client client, kArrayList variables);
72 
73 kFsFx(kStatus) kControl6Client_ValidateActionConfig(kControl6Client client, kXml xml);
74 kFsFx(kStatus) kControl6Client_InvokeAction(kControl6Client client, const kChar* typeName, kXml xml, kObject input, kObject* output, kAlloc alloc);
75 kFsFx(kStatus) kControl6Client_InvokeNamedAction(kControl6Client client, const kChar* name, kObject input, kObject* output, kAlloc alloc);
76 
77 kFsFx(kStatus) kControl6Client_ReadRegisters(kControl6Client client, kRegisterModule moduleType, kSize moduleIndex, kArrayList registers);
78 kFsFx(kStatus) kControl6Client_ReadRegisterOverrides(kControl6Client client, kRegisterModule moduleType, kArrayList registers);
79 kFsFx(kStatus) kControl6Client_WriteRegisterOverrides(kControl6Client client, kRegisterModule moduleType, kArrayList registers);
80 
81 kFsFx(kStatus) kControl6Client_I2cRead(kControl6Client client, k32u deviceId, k32u address, kByte* data, kSize size);
82 kFsFx(kStatus) kControl6Client_I2cWrite(kControl6Client client, k32u deviceId, k32u address, const kByte* data, kSize size);
83 
84 kFsFx(kStatus) kControl6Client_ReadLogHistory(kControl6Client client, kArrayList logItems);
85 
86 kFsFx(kStatus) kControl6Client_BeginStart(kControl6Client client);
87 kFsFx(kStatus) kControl6Client_EndStart(kControl6Client client);
88 kFsFx(kStatus) kControl6Client_BeginStop(kControl6Client client);
89 kFsFx(kStatus) kControl6Client_EndStop(kControl6Client client);
90 kFsFx(kStatus) kControl6Client_BeginPause(kControl6Client client);
91 kFsFx(kStatus) kControl6Client_EndPause(kControl6Client client);
92 kFsFx(kStatus) kControl6Client_BeginResume(kControl6Client client);
93 kFsFx(kStatus) kControl6Client_EndResume(kControl6Client client);
94 kFsFx(kStatus) kControl6Client_BeginEngage(kControl6Client client, k64u startTime, k64s startEncoder);
95 kFsFx(kStatus) kControl6Client_EndEngage(kControl6Client client);
96 
97 kFsFx(kStatus) kControl6Client_BeginStartReplay(kControl6Client client);
98 kFsFx(kStatus) kControl6Client_EndStartReplay(kControl6Client client);
99 kFsFx(kStatus) kControl6Client_Replay(kControl6Client client, kObject input, kArrayList output);
100 
101 kFsFx(kStatus) kControl6Client_ScheduleEvent(kControl6Client client, k32u eventManagerId, k64s target);
102 kFsFx(kStatus) kControl6Client_TriggerEvent(kControl6Client client, k32u eventManagerId);
103 kFsFx(kStatus) kControl6Client_TriggerCamera(kControl6Client client, kSize index);
104 kFsFx(kStatus) kControl6Client_SetLightState(kControl6Client client, kSize index, kBool enabled);
105 kFsFx(kStatus) kControl6Client_TriggerLight(kControl6Client client, kSize index);
106 kFsFx(kStatus) kControl6Client_SetDigitalOutState(kControl6Client client, kSize index, kBool state);
107 kFsFx(kStatus) kControl6Client_TriggerDigitalOut(kControl6Client client, kSize index);
108 kFsFx(kStatus) kControl6Client_EnqueueAnalogOut(kControl6Client client, kSize index, k32u value);
109 kFsFx(kStatus) kControl6Client_WriteSerialOut(kControl6Client client, kSize index, const void* buffer, kSize size);
110 
111 kFsFx(kStatus) kControl6Client_WriteRamImage(kControl6Client client, kSize index, kSize stateIndex, kSize imageIndex, kImage image);
112 kFsFx(kStatus) kControl6Client_WritePrnu(kControl6Client client, kSize index, kImage white, kImage black);
113 kFsFx(kStatus) kControl6Client_WriteFpn(kControl6Client client, kSize index, kImage offsets);
114 kFsFx(kStatus) kControl6Client_WriteRangeLut(kControl6Client client, kSize index,
115  const kRangeLutParams* params, const kRangeLutArray* xArray,
116  const kRangeLutArray* zArray, const kRangeLutArray* validArray);
117 kFsFx(kStatus) kControl6Client_LoadPatterns(kControl6Client client, kSize index, kArray2 patterns);
118 kFsFx(kStatus) kControl6Client_ResetEncoder(kControl6Client client);
119 kFsFx(kStatus) kControl6Client_EnableLed(kControl6Client client, kLed instance, kBool enabled);
120 kFsFx(kStatus) kControl6Client_SetGpioState(kControl6Client client, kSize bankIndex, k64u mask, k64u state);
121 kFsFx(kStatus) kControl6Client_GetGpioState(kControl6Client client, kSize bankIndex, k64u* state);
122 
123 kFsFx(kStatus) kControl6Client_GetInfo(kControl6Client client, kNodeInfo* info);
124 kFsFx(kStatus) kControl6Client_GetState(kControl6Client client, kNodeStateInfo* info);
125 kFsFx(kStatus) kControl6Client_GetNodeStats(kControl6Client client, kNodeStats* stats);
126 kFsFx(kStatus) kControl6Client_GetEventStats(kControl6Client client, k32u eventManagerId, kEventStats* stats);
127 kFsFx(kStatus) kControl6Client_GetCameraStats(kControl6Client client, kSize index, kCameraStats* stats);
128 kFsFx(kStatus) kControl6Client_GetLightStats(kControl6Client client, kSize index, kLightStats* stats);
129 kFsFx(kStatus) kControl6Client_GetProjectorStats(kControl6Client client, kSize index, kProjectorStats* stats);
130 kFsFx(kStatus) kControl6Client_GetAnalogOutStats(kControl6Client client, kSize index, kAnalogOutStats* stats);
131 kFsFx(kStatus) kControl6Client_GetDigitalOutStats(kControl6Client client, kSize index, kDigitalOutStats* stats);
132 kFsFx(kStatus) kControl6Client_GetSerialOutStats(kControl6Client client, kSize index, kSerialOutStats* stats);
133 
134 kFsFx(kStatus) kControl6Client_ResetIoTest(kControl6Client client, kSize index);
135 kFsFx(kStatus) kControl6Client_GetIoTestStats(kControl6Client client, kSize index, kIoTestStats* stats);
136 kFsFx(kStatus) kControl6Client_ReadIoTestSerialData(kControl6Client client, kSize index, void* buffer, kSize capacity, kSize* bytesRead);
137 
138 kFsFx(kStatus) kControl6Client_TestJigCommand(kControl6Client client, kTestJigCommand command, k64u data);
139 kFsFx(kStatus) kControl6Client_GetTestJigStats(kControl6Client client, kTestJigStats* stats);
140 
141 kFsFx(kStatus) kControl6Client_LockOutLight(kControl6Client client, kSize index, kBool shouldLock);
142 kFsFx(kStatus) kControl6Client_SetLightModel(kControl6Client client, kSize index, k64u key, kLightModel model);
143 kFsFx(kStatus) kControl6Client_GetLightModel(kControl6Client client, kSize index, k64u key, kLightModel* model);
144 kFsFx(kStatus) kControl6Client_SetLightPower(kControl6Client client, kSize index, k64u key, k32u power, kBool commit);
145 kFsFx(kStatus) kControl6Client_GetLightPower(kControl6Client client, kSize index, k64u key, k32u* power);
146 
147 kFsFx(kStatus) kControl6Client_StartOrientationCalibration(kControl6Client client);
148 kFsFx(kStatus) kControl6Client_GetOrientationStats(kControl6Client client, kOrientationStats* stats);
149 
150 kEndHeader()
151 
152 #include <kFireSync/Client/Network/kControl6Client.x.h>
153 
154 #endif
kLightOverrideItem
Represents light override item.
Definition: kNodeDef.h:786
kOrientationStats
Represents orientation device run-time statistics.
Definition: kNodeDef.h:1369
kNodeFirmwareType
Represents types of node firmware.
kRegisterModule
Represents an enumeration of register modules.
kTestJigStats
Represents M2 test jig run-time statistics.
Definition: kNodeDef.h:1452
kCameraStats
Represents camera run-time statistics.
Definition: kNodeDef.h:585
kNodeInfo
Represents detailed information about node hardware/firmware.
Definition: kNodeDef.h:1929
kIoTestStats
Represents I/O test jig run-time statistics.
Definition: kNodeDef.h:1262
kNodeVariableInfo
Represents information about a remote variable.
Definition: kNodeDef.h:1986
kLightStats
Represents light run-time statistics.
Definition: kNodeDef.h:827
kNodeDef.h
Essential declarations related to FireSync nodes.
kCameraOverrideItem
Represents camera override item.
Definition: kNodeDef.h:331
kSerialOutStats
Represents serial output run-time statistics.
Definition: kNodeDef.h:1197
kProjectorStats
Represents projector run-time statistics.
Definition: kNodeDef.h:981
kEventStats
Represents event manager run-time statistics.
Definition: kNodeDef.h:152
kAnalogOutStats
Represents analog output run-time statistics.
Definition: kNodeDef.h:1130
kTestJigCommand
Represents test jig command types.
kLightModel
Represents supported light device types.
kNodeStats
Represents node run-time statistics.
Definition: kNodeDef.h:1960
kLed
Represents indicator LED types.
kDigitalOutStats
Represents digital output run-time statistics.
Definition: kNodeDef.h:1078