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 
14 kBeginHeader()
15 
16 
22 //typedef kObject kNodeProvider; --forward-declared in kFsDef.x.h
23 
24 //thread-safe
25 
26 kFsFx(kBool) kNodeProvider_IsRemote(kNodeProvider provider);
27 
28 kFsFx(kStatus) kNodeProvider_SetErrorHandler(kNodeProvider provider, kCallbackFx function, kPointer receiver);
29 kFsFx(kStatus) kNodeProvider_SetCancelHandler(kNodeProvider provider, kCallbackFx function, kPointer receiver);
30 kFsFx(kStatus) kNodeProvider_SetProtocolVersion(kNodeProvider provider, kVersion version);
31 kFsFx(kStatus) kNodeProvider_BeginOpenControl(kNodeProvider provider);
32 kFsFx(kStatus) kNodeProvider_EndOpenControl(kNodeProvider provider);
33 kFsFx(kStatus) kNodeProvider_CloseControl(kNodeProvider provider);
34 kFsFx(kStatus) kNodeProvider_SetHealthHandler(kNodeProvider provider, kCallbackFx function, kPointer receiver);
35 kFsFx(kStatus) kNodeProvider_BeginOpenHealth(kNodeProvider provider);
36 kFsFx(kStatus) kNodeProvider_EndOpenHealth(kNodeProvider provider);
37 kFsFx(kStatus) kNodeProvider_CloseHealth(kNodeProvider provider);
38 kFsFx(kStatus) kNodeProvider_SetDataBufferSize(kNodeProvider provider, kSize size);
39 kFsFx(kStatus) kNodeProvider_SetDataHandler(kNodeProvider provider, kCallbackFx function, kPointer receiver);
40 kFsFx(kStatus) kNodeProvider_BeginOpenData(kNodeProvider provider, const k16u* ports, kSize portCount);
41 kFsFx(kStatus) kNodeProvider_EndOpenData(kNodeProvider provider);
42 kFsFx(kStatus) kNodeProvider_EndDataSession(kNodeProvider provider);
43 kFsFx(kStatus) kNodeProvider_CloseData(kNodeProvider provider);
44 
45 kFsFx(kStatus) kNodeProvider_WriteFirmware(kNodeProvider provider, kNodeFirmwareType type, kStream stream, kSize size, kCallbackFx progress, kPointer context);
46 kFsFx(kStatus) kNodeProvider_Reset(kNodeProvider provider, kBool restartApp);
47 
48 kFsFx(kStatus) kNodeProvider_WriteFile(kNodeProvider provider, const kChar* path, kStream stream, kSize size, kCallbackFx progress, kPointer context);
49 kFsFx(kStatus) kNodeProvider_CopyFile(kNodeProvider provider, const kChar* sourcePath, const kChar* destPath, kCallbackFx progress, kPointer context);
50 kFsFx(kStatus) kNodeProvider_ReadFile(kNodeProvider provider, const kChar* path, kStream stream, kCallbackFx progress, kPointer context);
51 kFsFx(kStatus) kNodeProvider_DeleteFile(kNodeProvider provider, const kChar* path);
52 kFsFx(kStatus) kNodeProvider_GetFileInfo(kNodeProvider provider, const kChar* path, kNodeFileInfo* info);
53 kFsFx(kStatus) kNodeProvider_CreateDirectory(kNodeProvider provider, const kChar* path);
54 kFsFx(kStatus) kNodeProvider_DeleteDirectory(kNodeProvider provider, const kChar* path);
55 kFsFx(kStatus) kNodeProvider_ListDirectoryEntries(kNodeProvider provider, const kChar* path, kBool includeFiles, kBool includeDirectories, kArrayList entries);
56 
57 kFsFx(kStatus) kNodeProvider_SetDeviceConfig(kNodeProvider provider, kXml xml, k64u revisionId);
58 kFsFx(kStatus) kNodeProvider_GetDeviceConfig(kNodeProvider provider, kXml xml, k64u* revisionId);
59 kFsFx(kStatus) kNodeProvider_CommitDeviceConfig(kNodeProvider provider);
60 kFsFx(kStatus) kNodeProvider_SetModeConfig(kNodeProvider provider, kXml xml, k64u revisionId);
61 kFsFx(kStatus) kNodeProvider_GetModeConfig(kNodeProvider provider, kXml xml, k64u* revisionId);
62 kFsFx(kStatus) kNodeProvider_SaveModeConfig(kNodeProvider provider, const kChar* path);
63 kFsFx(kStatus) kNodeProvider_LoadModeConfig(kNodeProvider provider, const kChar* path);
64 kFsFx(kStatus) kNodeProvider_CommitModeConfig(kNodeProvider provider);
65 kFsFx(kStatus) kNodeProvider_ValidateBlockConfig(kNodeProvider provider, kXml xml);
66 
67 kFsFx(kStatus) kNodeProvider_ListProcedures(kNodeProvider provider, kArrayList procedures);
68 kFsFx(kStatus) kNodeProvider_InvokeProcedure(kNodeProvider provider, const kChar* name, kObject input, kObject* output, kAlloc alloc);
69 
70 kFsFx(kStatus) kNodeProvider_SetVariable(kNodeProvider provider, const kChar* name, kObject variable);
71 kFsFx(kStatus) kNodeProvider_GetVariable(kNodeProvider provider, const kChar* name, kObject* variable, kAlloc alloc);
72 kFsFx(kStatus) kNodeProvider_GetVariableInfo(kNodeProvider provider, const kChar* name, kNodeVariableInfo* info);
73 kFsFx(kStatus) kNodeProvider_DeleteVariable(kNodeProvider provider, const kChar* name);
74 kFsFx(kStatus) kNodeProvider_ListVariables(kNodeProvider provider, kArrayList variables);
75 
76 kFsFx(kStatus) kNodeProvider_ValidateActionConfig(kNodeProvider provider, kXml config);
77 kFsFx(kStatus) kNodeProvider_InvokeAction(kNodeProvider provider, const kChar* typeName, kXml config, kObject input, kObject* output, kAlloc alloc);
78 kFsFx(kStatus) kNodeProvider_InvokeNamedAction(kNodeProvider provider, const kChar* name, kObject input, kObject* output, kAlloc alloc);
79 
80 kFsFx(kStatus) kNodeProvider_ReadRegisters(kNodeProvider provider, kRegisterModule moduleType, kSize moduleIndex, kArrayList registers);
81 kFsFx(kStatus) kNodeProvider_ReadRegisterOverrides(kNodeProvider provider, kRegisterModule moduleType, kArrayList registers);
82 kFsFx(kStatus) kNodeProvider_WriteRegisterOverrides(kNodeProvider provider, kRegisterModule moduleType, kArrayList registers);
83 
84 kFsFx(kStatus) kNodeProvider_I2cRead(kNodeProvider provider, k32u deviceId, k32u address, kByte* data, kSize size);
85 kFsFx(kStatus) kNodeProvider_I2cWrite(kNodeProvider provider, k32u deviceId, k32u address, const kByte* data, kSize size);
86 
87 kFsFx(kStatus) kNodeProvider_ReadLogHistory(kNodeProvider provider, kArrayList logItems);
88 
89 kFsFx(kStatus) kNodeProvider_BeginStart(kNodeProvider provider);
90 kFsFx(kStatus) kNodeProvider_EndStart(kNodeProvider provider);
91 kFsFx(kStatus) kNodeProvider_BeginStop(kNodeProvider provider);
92 kFsFx(kStatus) kNodeProvider_EndStop(kNodeProvider provider);
93 kFsFx(kStatus) kNodeProvider_BeginPause(kNodeProvider provider);
94 kFsFx(kStatus) kNodeProvider_EndPause(kNodeProvider provider);
95 kFsFx(kStatus) kNodeProvider_BeginResume(kNodeProvider provider);
96 kFsFx(kStatus) kNodeProvider_EndResume(kNodeProvider provider);
97 kFsFx(kStatus) kNodeProvider_BeginEngage(kNodeProvider provider, k64u startTime, k64s startEncoder);
98 kFsFx(kStatus) kNodeProvider_EndEngage(kNodeProvider provider);
99 
100 kFsFx(kStatus) kNodeProvider_BeginStartReplay(kNodeProvider provider);
101 kFsFx(kStatus) kNodeProvider_EndStartReplay(kNodeProvider provider);
102 kFsFx(kStatus) kNodeProvider_Replay(kNodeProvider provider, kObject input, kArrayList output);
103 
104 kFsFx(kStatus) kNodeProvider_CameraOverride(kNodeProvider provider, kSize index, const kCameraOverrideItem* overrides, kSize count);
105 kFsFx(kStatus) kNodeProvider_LightOverride(kNodeProvider provider, kSize index, const kLightOverrideItem* overrides, kSize count);
106 
107 kFsFx(kStatus) kNodeProvider_ScheduleEvent(kNodeProvider provider, k32u eventManagerId, k64s target);
108 kFsFx(kStatus) kNodeProvider_TriggerEvent(kNodeProvider provider, k32u eventManagerId);
109 kFsFx(kStatus) kNodeProvider_WriteRamImage(kNodeProvider provider, kSize index, kSize stateIndex, kSize imageIndex, kImage image);
110 kFsFx(kStatus) kNodeProvider_WritePrnu(kNodeProvider provider, kSize index, kImage white, kImage black);
111 kFsFx(kStatus) kNodeProvider_WriteFpn(kNodeProvider provider, kSize index, kImage offsets);
112 kFsFx(kStatus) kNodeProvider_WriteRangeLut(kNodeProvider provider, kSize index, const kRangeLutParams* params, const kRangeLutArray* xArray,
113  const kRangeLutArray* zArray, const kRangeLutArray* validArray);
114 kFsFx(kStatus) kNodeProvider_TriggerCamera(kNodeProvider provider, kSize index);
115 kFsFx(kStatus) kNodeProvider_TriggerLight(kNodeProvider provider, kSize index);
116 kFsFx(kStatus) kNodeProvider_SetLightState(kNodeProvider provider, kSize index, kBool enabled);
117 kFsFx(kStatus) kNodeProvider_LoadPatterns(kNodeProvider provider, kSize index, kArray2 patterns);
118 kFsFx(kStatus) kNodeProvider_SetDigitalOutState(kNodeProvider provider, kSize index, kBool state);
119 kFsFx(kStatus) kNodeProvider_TriggerDigitalOut(kNodeProvider provider, kSize index);
120 kFsFx(kStatus) kNodeProvider_EnqueueAnalogOut(kNodeProvider provider, kSize index, k32u value);
121 kFsFx(kStatus) kNodeProvider_WriteSerialOut(kNodeProvider provider, kSize index, const void* buffer, kSize size);
122 kFsFx(kStatus) kNodeProvider_ResetEncoder(kNodeProvider provider);
123 kFsFx(kStatus) kNodeProvider_EnableLed(kNodeProvider provider, kLed instance, kBool enabled);
124 kFsFx(kStatus) kNodeProvider_SetGpioState(kNodeProvider provider, kSize bankIndex, k64u mask, k64u state);
125 kFsFx(kStatus) kNodeProvider_GetGpioState(kNodeProvider provider, kSize bankIndex, k64u* state);
126 
127 kFsFx(kStatus) kNodeProvider_GetInfo(kNodeProvider provider, kNodeInfo* info);
128 kFsFx(kStatus) kNodeProvider_GetState(kNodeProvider provider, kNodeStateInfo* info);
129 kFsFx(kStatus) kNodeProvider_GetNodeStats(kNodeProvider provider, kNodeStats* stats);
130 kFsFx(kStatus) kNodeProvider_GetEventStats(kNodeProvider provider, k32u eventManagerId, kEventStats* stats);
131 kFsFx(kStatus) kNodeProvider_GetCameraStats(kNodeProvider provider, kSize index, kCameraStats* stats);
132 kFsFx(kStatus) kNodeProvider_GetLightStats(kNodeProvider provider, kSize index, kLightStats* stats);
133 kFsFx(kStatus) kNodeProvider_GetProjectorStats(kNodeProvider provider, kSize index, kProjectorStats* stats);
134 kFsFx(kStatus) kNodeProvider_GetAnalogOutStats(kNodeProvider provider, kSize index, kAnalogOutStats* stats);
135 kFsFx(kStatus) kNodeProvider_GetDigitalOutStats(kNodeProvider provider, kSize index, kDigitalOutStats* stats);
136 kFsFx(kStatus) kNodeProvider_GetSerialOutStats(kNodeProvider provider, kSize index, kSerialOutStats* stats);
137 
138 kFsFx(kStatus) kNodeProvider_ResetIoTest(kNodeProvider provider, kSize index);
139 kFsFx(kStatus) kNodeProvider_GetIoTestStats(kNodeProvider provider, kSize index, kIoTestStats* stats);
140 kFsFx(kStatus) kNodeProvider_ReadIoTestSerialData(kNodeProvider provider, kSize index, void* buffer, kSize capacity, kSize* bytesRead);
141 
142 kFsFx(kStatus) kNodeProvider_TestJigCommand(kNodeProvider provider, kTestJigCommand command, k64u data);
143 kFsFx(kStatus) kNodeProvider_GetTestJigStats(kNodeProvider provider, kTestJigStats* stats);
144 
145 kFsFx(kStatus) kNodeProvider_LockOutLight(kNodeProvider provider, kSize index, kBool shouldLock);
146 kFsFx(kStatus) kNodeProvider_SetLightModel(kNodeProvider provider, kSize index, k64u key, kLightModel model);
147 kFsFx(kStatus) kNodeProvider_GetLightModel(kNodeProvider provider, kSize index, k64u key, kLightModel* model);
148 kFsFx(kStatus) kNodeProvider_SetLightPower(kNodeProvider provider, kSize index, k64u key, k32u power, kBool commit);
149 kFsFx(kStatus) kNodeProvider_GetLightPower(kNodeProvider provider, kSize index, k64u key, k32u* power);
150 
151 kFsFx(kStatus) kNodeProvider_StartOrientationCalibration(kNodeProvider provider);
152 kFsFx(kStatus) kNodeProvider_GetOrientationStats(kNodeProvider provider, kOrientationStats* stats);
153 
154 kEndHeader()
155 
156 #include <kFireSync/Client/Network/kNodeProvider.x.h>
157 
158 #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