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 
13 kBeginHeader()
14 
15 
23 //typedef kObject kNode6Client; --forward-declared in kFsDef.x.h
24 
25 
31 kFsFx(kStatus) kNode6Client_Construct(kNode6Client* client, kIpAddress address, kAlloc allocator);
32 
33 kFsFx(kStatus) kNode6Client_SetControlPort(kNode6Client client, k32u port);
34 kFsFx(kStatus) kNode6Client_SetHealthPort(kNode6Client client, k32u port);
35 kFsFx(kStatus) kNode6Client_SetDataPort(kNode6Client client, k32u port);
36 kFsFx(kStatus) kNode6Client_SetMessageAlloc(kNode6Client client, kAlloc alloc);
37 
38 kFsFx(kStatus) kNode6Client_SetErrorHandler(kNode6Client client, kCallbackFx function, kPointer receiver);
39 kFsFx(kStatus) kNode6Client_SetCancelHandler(kNode6Client client, kCallbackFx function, kPointer receiver);
40 kFsFx(kStatus) kNode6Client_SetProtocolVersion(kNode6Client client, kVersion version);
41 kFsFx(kStatus) kNode6Client_BeginOpenControl(kNode6Client client);
42 kFsFx(kStatus) kNode6Client_EndOpenControl(kNode6Client client);
43 kFsFx(kStatus) kNode6Client_CloseControl(kNode6Client client);
44 kFsFx(kStatus) kNode6Client_SetHealthHandler(kNode6Client client, kCallbackFx function, kPointer receiver);
45 kFsFx(kStatus) kNode6Client_BeginOpenHealth(kNode6Client client);
46 kFsFx(kStatus) kNode6Client_EndOpenHealth(kNode6Client client);
47 kFsFx(kStatus) kNode6Client_CloseHealth(kNode6Client client);
48 kFsFx(kStatus) kNode6Client_SetDataBufferSize(kNode6Client client, kSize size);
49 kFsFx(kStatus) kNode6Client_SetDataHandler(kNode6Client client, kCallbackFx function, kPointer receiver);
50 kFsFx(kStatus) kNode6Client_BeginOpenData(kNode6Client client, const k16u* ports, kSize portCount);
51 kFsFx(kStatus) kNode6Client_EndOpenData(kNode6Client client);
52 kFsFx(kStatus) kNode6Client_EndDataSession(kNode6Client client);
53 kFsFx(kStatus) kNode6Client_CloseData(kNode6Client client);
54 
55 kFsFx(kStatus) kNode6Client_WriteFirmware(kNode6Client client, kNodeFirmwareType type, kStream stream, kSize size, kCallbackFx progress, kPointer context);
56 kFsFx(kStatus) kNode6Client_Reset(kNode6Client client, kBool restartApp);
57 
58 kFsFx(kStatus) kNode6Client_WriteFile(kNode6Client client, const kChar* path, kStream stream, kSize size, kCallbackFx progress, kPointer context);
59 kFsFx(kStatus) kNode6Client_CopyFile(kNode6Client client, const kChar* sourcePath, const kChar* destPath, kCallbackFx progress, kPointer context);
60 kFsFx(kStatus) kNode6Client_ReadFile(kNode6Client client, const kChar* path, kStream stream, kCallbackFx progress, kPointer context);
61 kFsFx(kStatus) kNode6Client_DeleteFile(kNode6Client client, const kChar* path);
62 kFsFx(kStatus) kNode6Client_GetFileInfo(kNode6Client client, const kChar* path, kNodeFileInfo* info);
63 kFsFx(kStatus) kNode6Client_CreateDirectory(kNode6Client client, const kChar* path);
64 kFsFx(kStatus) kNode6Client_DeleteDirectory(kNode6Client client, const kChar* path);
65 kFsFx(kStatus) kNode6Client_ListDirectoryEntries(kNode6Client client, const kChar* path, kBool includeFiles, kBool includeDirectories, kArrayList entries);
66 
67 kFsFx(kStatus) kNode6Client_SetDeviceConfig(kNode6Client client, kXml xml, k64u revisionId);
68 kFsFx(kStatus) kNode6Client_GetDeviceConfig(kNode6Client client, kXml xml, k64u* revisionId);
69 kFsFx(kStatus) kNode6Client_CommitDeviceConfig(kNode6Client client);
70 kFsFx(kStatus) kNode6Client_SetModeConfig(kNode6Client client, kXml xml, k64u revisionId);
71 kFsFx(kStatus) kNode6Client_GetModeConfig(kNode6Client client, kXml xml, k64u* revisionId);
72 kFsFx(kStatus) kNode6Client_SaveModeConfig(kNode6Client client, const kChar* path);
73 kFsFx(kStatus) kNode6Client_LoadModeConfig(kNode6Client client, const kChar* path);
74 kFsFx(kStatus) kNode6Client_CommitModeConfig(kNode6Client client);
75 kFsFx(kStatus) kNode6Client_ValidateBlockConfig(kNode6Client client, kXml config);
76 kFsFx(kStatus) kNode6Client_CameraOverride(kNode6Client client, kSize index, const kCameraOverrideItem* overrides, kSize count);
77 kFsFx(kStatus) kNode6Client_LightOverride(kNode6Client client, kSize index, const kLightOverrideItem* overrides, kSize count);
78 
79 kFsFx(kStatus) kNode6Client_ListProcedures(kNode6Client client, kArrayList procedures);
80 kFsFx(kStatus) kNode6Client_InvokeProcedure(kNode6Client client, const kChar* name, kObject input, kObject* output, kAlloc alloc);
81 
82 kFsFx(kStatus) kNode6Client_SetVariable(kNode6Client client, const kChar* name, kObject variable);
83 kFsFx(kStatus) kNode6Client_GetVariable(kNode6Client client, const kChar* name, kObject* variable, kAlloc alloc);
84 kFsFx(kStatus) kNode6Client_GetVariableInfo(kNode6Client client, const kChar* name, kNodeVariableInfo* info);
85 kFsFx(kStatus) kNode6Client_DeleteVariable(kNode6Client client, const kChar* name);
86 kFsFx(kStatus) kNode6Client_ListVariables(kNode6Client client, kArrayList variables);
87 
88 kFsFx(kStatus) kNode6Client_ValidateActionConfig(kNode6Client client, kXml config);
89 kFsFx(kStatus) kNode6Client_InvokeAction(kNode6Client client, const kChar* typeName, kXml config, kObject input, kObject* output, kAlloc alloc);
90 kFsFx(kStatus) kNode6Client_InvokeNamedAction(kNode6Client client, const kChar* name, kObject input, kObject* output, kAlloc alloc);
91 
92 kFsFx(kStatus) kNode6Client_ReadRegisters(kNode6Client client, kRegisterModule moduleType, kSize moduleIndex, kArrayList registers);
93 kFsFx(kStatus) kNode6Client_ReadRegisterOverrides(kNode6Client client, kRegisterModule moduleType, kArrayList registers);
94 kFsFx(kStatus) kNode6Client_WriteRegisterOverrides(kNode6Client client, kRegisterModule moduleType, kArrayList registers);
95 
96 kFsFx(kStatus) kNode6Client_I2cRead(kNode6Client client, k32u deviceId, k32u address, kByte* data, kSize size);
97 kFsFx(kStatus) kNode6Client_I2cWrite(kNode6Client client, k32u deviceId, k32u address, const kByte* data, kSize size);
98 
99 kFsFx(kStatus) kNode6Client_ReadLogHistory(kNode6Client client, kArrayList logItems);
100 
101 kFsFx(kStatus) kNode6Client_BeginStart(kNode6Client client);
102 kFsFx(kStatus) kNode6Client_EndStart(kNode6Client client);
103 kFsFx(kStatus) kNode6Client_BeginStop(kNode6Client client);
104 kFsFx(kStatus) kNode6Client_EndStop(kNode6Client client);
105 kFsFx(kStatus) kNode6Client_BeginPause(kNode6Client client);
106 kFsFx(kStatus) kNode6Client_EndPause(kNode6Client client);
107 kFsFx(kStatus) kNode6Client_BeginResume(kNode6Client client);
108 kFsFx(kStatus) kNode6Client_EndResume(kNode6Client client);
109 kFsFx(kStatus) kNode6Client_BeginEngage(kNode6Client client, k64u startTime, k64s startEncoder);
110 kFsFx(kStatus) kNode6Client_EndEngage(kNode6Client client);
111 
112 kFsFx(kStatus) kNode6Client_BeginStartReplay(kNode6Client client);
113 kFsFx(kStatus) kNode6Client_EndStartReplay(kNode6Client client);
114 kFsFx(kStatus) kNode6Client_Replay(kNode6Client client, kObject input, kArrayList output);
115 
116 kFsFx(kStatus) kNode6Client_ScheduleEvent(kNode6Client client, k32u eventManagerId, k64s target);
117 kFsFx(kStatus) kNode6Client_TriggerEvent(kNode6Client client, k32u eventManagerId);
118 kFsFx(kStatus) kNode6Client_TriggerCamera(kNode6Client client, kSize index);
119 kFsFx(kStatus) kNode6Client_TriggerLight(kNode6Client client, kSize index);
120 kFsFx(kStatus) kNode6Client_SetLightState(kNode6Client client, kSize index, kBool enabled);
121 kFsFx(kStatus) kNode6Client_SetDigitalOutState(kNode6Client client, kSize index, kBool state);
122 kFsFx(kStatus) kNode6Client_TriggerDigitalOut(kNode6Client client, kSize index);
123 kFsFx(kStatus) kNode6Client_EnqueueAnalogOut(kNode6Client client, kSize index, k32u value);
124 kFsFx(kStatus) kNode6Client_WriteSerialOut(kNode6Client client, kSize index, const void* buffer, kSize size);
125 kFsFx(kStatus) kNode6Client_WriteRamImage(kNode6Client client, kSize index, kSize stateIndex, kSize imageIndex, kImage image);
126 kFsFx(kStatus) kNode6Client_WritePrnu(kNode6Client client, kSize index, kImage white, kImage black);
127 kFsFx(kStatus) kNode6Client_WriteFpn(kNode6Client client, kSize index, kImage offsets);
128 kFsFx(kStatus) kNode6Client_WriteRangeLut(kNode6Client client, kSize index,
129  const kRangeLutParams* params, const kRangeLutArray* xArray,
130  const kRangeLutArray* zArray, const kRangeLutArray* validArray);
131 kFsFx(kStatus) kNode6Client_LoadPatterns(kNode6Client client, kSize index, kArray2 patterns);
132 kFsFx(kStatus) kNode6Client_ResetEncoder(kNode6Client client);
133 kFsFx(kStatus) kNode6Client_EnableLed(kNode6Client client, kLed instance, kBool enabled);
134 kFsFx(kStatus) kNode6Client_SetGpioState(kNode6Client client, kSize bankIndex, k64u mask, k64u state);
135 kFsFx(kStatus) kNode6Client_GetGpioState(kNode6Client client, kSize bankIndex, k64u* state);
136 
137 kFsFx(kStatus) kNode6Client_GetInfo(kNode6Client client, kNodeInfo* info);
138 kFsFx(kStatus) kNode6Client_GetState(kNode6Client client, kNodeStateInfo* info);
139 kFsFx(kStatus) kNode6Client_GetNodeStats(kNode6Client client, kNodeStats* stats);
140 kFsFx(kStatus) kNode6Client_GetEventStats(kNode6Client client, k32u eventManagerId, kEventStats* stats);
141 kFsFx(kStatus) kNode6Client_GetCameraStats(kNode6Client client, kSize index, kCameraStats* stats);
142 kFsFx(kStatus) kNode6Client_GetLightStats(kNode6Client client, kSize index, kLightStats* stats);
143 kFsFx(kStatus) kNode6Client_GetProjectorStats(kNode6Client client, kSize index, kProjectorStats* stats);
144 kFsFx(kStatus) kNode6Client_GetAnalogOutStats(kNode6Client client, kSize index, kAnalogOutStats* stats);
145 kFsFx(kStatus) kNode6Client_GetDigitalOutStats(kNode6Client client, kSize index, kDigitalOutStats* stats);
146 kFsFx(kStatus) kNode6Client_GetSerialOutStats(kNode6Client client, kSize index, kSerialOutStats* stats);
147 
148 kFsFx(kStatus) kNode6Client_ResetIoTest(kNode6Client client, kSize index);
149 kFsFx(kStatus) kNode6Client_GetIoTestStats(kNode6Client client, kSize index, kIoTestStats* stats);
150 kFsFx(kStatus) kNode6Client_ReadIoTestSerialData(kNode6Client client, kSize index, void* buffer, kSize capacity, kSize* bytesRead);
151 
152 kFsFx(kStatus) kNode6Client_TestJigCommand(kNode6Client client, kTestJigCommand command, k64u data);
153 kFsFx(kStatus) kNode6Client_GetTestJigStats(kNode6Client client, kTestJigStats* stats);
154 
155 kFsFx(kStatus) kNode6Client_LockOutLight(kNode6Client client, kSize index, kBool shouldLock);
156 kFsFx(kStatus) kNode6Client_SetLightModel(kNode6Client client, kSize index, k64u key, kLightModel model);
157 kFsFx(kStatus) kNode6Client_GetLightModel(kNode6Client client, kSize index, k64u key, kLightModel* model);
158 kFsFx(kStatus) kNode6Client_SetLightPower(kNode6Client client, kSize index, k64u key, k32u power, kBool commit);
159 kFsFx(kStatus) kNode6Client_GetLightPower(kNode6Client client, kSize index, k64u key, k32u* power);
160 
161 kFsFx(kStatus) kNode6Client_StartOrientationCalibration(kNode6Client client);
162 kFsFx(kStatus) kNode6Client_GetOrientationStats(kNode6Client client, kOrientationStats* stats);
163 
164 kEndHeader()
165 
166 #include <kFireSync/Client/Network/kNode6Client.x.h>
167 
168 #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