8 #ifndef K_FIRESYNC_NODE_H
9 #define K_FIRESYNC_NODE_H
2120 #include <kFireSync/Client/kNode.x.h>
kOrientation kNode_Orientation(kNode node)
Gets the orientation configuration module, if present.
Numeric identifier for a health statistic.
kSize kNode_StatCount(kNode node)
Gets the number of available health statistics.
kStatus kNode_FirmwareInfo(kNode node, kInfoBits *info)
Determines the types of firmware that can be loaded to the device.
kStatus kNode_WatchdogAllowedInfo(kNode node, kInfoBool *info)
Reports constraint and validity information for the AllowWatchdog setting.
kNodeState kNode_State(kNode node)
Reports the current state of the node.
kBool kNode_RescueWaitEnabled(kNode node)
Reports whether the feature to wait for a rescue message at boot time is enabled. ...
kProjector kNode_ProjectorAt(kNode node, kSize index)
Gets the projector module at the specified index.
kStatus kNode_RefreshStats(kNode node)
Retrieves latest health statistics from the node.
kIpAddress kNode_NetBootServer(kNode node)
Reports the IP address of the FTP server that will provide firmware during a network-based boot...
kStatus kNode_Stats(kNode node, kNodeStats *stats)
Reports a selection of top-level run-time statistics for the node.
kStatus kNode_EnableLightDriverHighPower(kNode node, kBool enable)
Enables light driver high power setting.
Numeric identifier for kStamp temperature source.
kStatus kNode_DiscoveryIpConfig(kNode node, kIpConfig *ipConfig)
Gets the current IP configuration, as received via sensor discovery.
kStatus kNode_Enable(kNode node, kBool enable)
Enables or disables the node.
kStatus kNode_EnableSshd(kNode node, kBool enable)
Enables Secure Shell Daemon (SSHD).
Represents indicator LED operational modes.
const kChar * kNode_NetBootPath(kNode node)
Reports the FTP resource path used to fetch firmware during a network-based boot. ...
kStatus kNode_CommitDeviceConfig(kNode node)
Commits current device settings to non-volatile storage, to be used as defaults after boot...
kStatus kNode_SetLedMode(kNode node, kLed instance, kLedMode mode)
Sets the given LED to the desired operational mode.
kCamera kNode_CameraAt(kNode node, kSize index)
Gets the camera module at the specified index.
kStatus kNode_BeginStart(kNode node)
Begins preparing node for acquisition and data processing activities.
Represents types of node firmware.
kStatus kNode_FindStat(kNode node, kHealthId id, k32u instance, k64s *value)
Gets the health statistic with the specified id and instance.
kStatus kNode_Commit(kNode node)
Commits current settings to non-volatile storage, to be used as defaults after boot.
kNodeType kNode_Type(kNode node)
Gets the type of this node.
Represents pipe configuration.
Represents the state of a health probe.
Definition: kNodeDef.h:3005
kIoTest kNode_IoTestAt(kNode node, kSize index)
Gets the I/O test at the specified index.
kStatus kNode_LoadFirmware(kNode node, kNodeFirmwareType type, const kChar *path, kCallbackFx progress, kPointer context)
Loads firmware from a local file to non-volatile storage.
Represents digital configuration.
k64u kNode_RescueWaitTimeout(kNode node)
Reports the current value for the RescueWait timeout setting.
kDigitalOut kNode_DigitalOutAt(kNode node, kSize index)
Gets the digital output at the specified index.
Represents an enumeration of register modules.
kStatus kNode_EnableAutoExecute(kNode node, kBool enable)
Enables automatic execution of firmware at boot time.
kEncoder kNode_Encoder(kNode node)
Gets the encoder configuration module, if present.
kStatus kNode_ReadCrashLog(kNode node, kString *crashLog, kAlloc allocator)
Retrieves a crash log summary from the node.
kStatus kNode_BeginEngage(kNode node, k64u startTime, k64s startEncoder)
Initiates acquisition after BeginStart/EndStart.
kSize kNode_ErrorCount(kNode node)
Returns the number of errors that were detected when the node was last verified.
kStatus kNode_EndEngage(kNode node)
Completes an asynchronous engage operation that was initiated using the kNode_BeginEngage method...
kStatus kNode_EndDataSession(kNode node)
Ends data collection until the next time that this node is started/resumed.
kStatus kNode_ClearEx(kNode node, kNodeClearOption options)
Restores the specified aspects of node state to default values.
kBool kNode_LightDriverHighPowerEnabled(kNode node)
Reports whether light driver high power is enabled.
kStatus kNode_CommitModeConfig(kNode node)
Commits current mode settings to non-volatile storage, to be used as defaults after boot...
kStorage kNode_Storage(kNode node)
Gets the storage module.
Represents constraint and validity information for a bit flag setting.
Definition: kInfo.h:544
kVersion kNode_PlatformVersion(kNode node)
Gets the platform version running on this node.
kVersion kNode_OsVersion(kNode node)
Gets the operating system version running on this node.
kStatus kNode_ExportModeConfig(kNode node, const kChar *filePath)
Saves current mode configuration to the specified local file.
kVersion kNode_AppVersion(kNode node)
Gets the application version running on this node.
kStatus kNode_Resume(kNode node)
(Deprecated) Function currently calls kNode_Start.
kStatus kNode_ReadRegisterOverrides(kNode node, kRegisterModule moduleType, kArrayList registers)
Reads a list of register overrides for a given module type.
kStatus kNode_ReloadFirmware(kNode node, kNodeFirmwareType type, const kChar *path)
Replaces currently running firmware without affecting non-volatile storage.
kStatus kNode_ReadMemory(kNode node, kNodeMemorySpace space, k64u offset, kSize length, void *data)
Reads from the specified memory space.
kSerialOut kNode_SerialOutAt(kNode node, kSize index)
Gets the serial output at the specified index.
kSize kNode_LightCount(kNode node)
Reports the number of light modules supported by this node.
kStatus kNode_Refresh(kNode node)
Refreshes node state.
kStatus kNode_RescueWaitEnabledInfo(kNode node, kInfoBool *info)
Reports constraint and validity information for the RescueWait setting.
kActions kNode_Actions(kNode node)
Gets the actions configuration module.
Represents configuration for a node's local encoder.
k64u kNode_TimeCounter(kNode node)
Gets the current synchronization time value from the node.
kStatus kNode_I2cWrite(kNode node, k32u deviceId, k32u address, const kByte *data, kSize size)
Writes to I2C register.
kStatus kNode_WriteMemory(kNode node, kNodeMemorySpace space, k64u offset, kSize length, const void *data)
Writes to the specified memory space.
Represents camera configuration.
Represents types of nodes.
kStatus kNode_NextIdInfo(kNode node, kInfo32u *info)
Reports constraint and validity information for the NextId setting.
kStatus kNode_CrashLogEnabledInfo(kNode node, kInfoBool *info)
Reports constraint and validity information for the EnableCrashLog setting.
kSize kNode_AnalogOutCount(kNode node)
Reports the number of analog outputs supported by this node.
kStatus kNode_DeleteVariable(kNode node, const kChar *name)
Disposes a remote variable with the specified name.
kStatus kNode_SetNetBootServer(kNode node, kIpAddress address)
Sets the IP address of the FTP server that will provide firmware during a network-based boot...
kStatus kNode_EnableRescueWait(kNode node, kBool enable)
Enables the feature to wait for a rescue message at boot time.
Represents projector configuration.
Represents detailed information about node hardware/firmware.
Definition: kNodeDef.h:2219
kStatus kNode_SetNetBootPath(kNode node, const kChar *path)
Sets the FTP resource path used to fetch firmware during a network-based boot.
kStatus kNode_Clear(kNode node)
Restores mode settings to default values.
kEventManager kNode_EventManagerAt(kNode node, kSize index)
Gets the event manager at the specified index.
kStatus kNode_ReloadFirmwareFromStream(kNode node, kNodeFirmwareType type, kStream stream, kSize size)
Replaces currently running firmware without affecting non-volatile storage.
kStatus kNode_SaveReport(kNode node, const kChar *filePath)
Saves a report containing a description of current node state to the specified file.
Represents address configuration for an Internet Protocol adapter.
Definition: kFsDef.h:157
kStatus kNode_HealthLogPeriodInfo(kNode node, kInfo64u *info)
Reports constraint and validity information for the health logging period setting.
Represents an addressable memory space within a node.
kSize kNode_DigitalOutCount(kNode node)
Reports the number of digital outputs supported by this node.
Represents a summary of health log data.
kStatus kNode_Variable(kNode node, const kChar *name, kObject *variable, kAlloc alloc)
Gets the value of the specified remote variable.
kStatus kNode_ClearCrashLog(kNode node)
Clears the crash log data stored on the device.
Represents information about a remote variable.
Definition: kNodeDef.h:2283
kStatus kNode_BeginStop(kNode node, kBool synchronizeData)
Begins stopping node acquisition and data processing activities.
Essential declarations related to FireSync nodes.
kStatus kNode_ListVariables(kNode node, kArrayList variableNames)
Gets the list of custom variables available from this node.
kVersion kNode_ProtocolVersion(kNode node)
Gets the protocol version support by this node.
kStatus kNode_CloseData(kNode node)
Closes the data connection to the remote node.
kStatus kNode_LoadModeConfig(kNode node, const kChar *filePath)
Loads mode configuration from a file in node storage.
kSize kNode_GpioBankCount(kNode node)
Reports the number of GPIO banks supported by this node.
kNet kNode_Net(kNode node)
Gets the network configuration module.
Represents a FireSync node clear option.
kTempProbeId kNode_MainTempProbe(kNode node)
Gets the primary source for temperature information used by this node.
kStatus kNode_Reset(kNode node, kBool defer=kFALSE)
Begins rebooting the node.
kStatus kNode_SetDateTime(kNode node, kDateTime dateTime)
Adjusts the date-time value that will be reported by the node.
kStatus kNode_Disconnect(kNode node)
Disconnects the node's control connection.
kStatus kNode_SetPowerSaverThreshold(kNode node, k64u threshold)
Sets the power saver threshold for all lights.
kBool kNode_IsEnabled(kNode node)
Reports whether the node is currently enabled.
Represents M2 test jig configuration.
kBool kNode_IsServer(kNode node)
Reports whether the node handle is associated with a local server node.
Definition: kNode.h:176
kStatus kNode_EnableCrashLog(kNode node, kBool enable)
Enables crash log facility.
kStatus kNode_OpenData(kNode node)
Opens a data connection to the remote node.
kStatus kNode_SshdEnabledInfo(kNode node, kInfoBool *info)
Reports constraint and validity information for the EnableSshd setting.
Represents a FireSync node (sensor).
k32u kNode_NextId(kNode node)
Gets the device identifier that will take effect after reset.
kStatus kNode_ErrorAt(kNode node, kSize index, kChar *error, kSize capacity)
Gets the verification error string at the specified index.
kBootMode kNode_BootMode(kNode node)
Gets the method that will be used to boot this device.
const kChar * kNode_AppName(kNode node)
Gets the name of the application running on this node.
kStatus kNode_StartReplay(kNode node)
Prepares node to begin receiving and processing replay data.
kStatus kNode_AutoExecuteEnabledInfo(kNode node, kInfoBool *info)
Reports constraint and validity information for the AutoExcecute setting.
Represents the mode by which a node's program was loaded.
k64u kNode_PowerSaverTimeout(kNode node)
Gets the power saver timeout for all lights.
kStatus kNode_BootModeInfo(kNode node, kInfoBits *info)
Reports constraint and validity information for the BootMode setting.
kStatus kNode_SetMainTempProbe(kNode node, kTempProbeId probeId)
Specifies the primary source for temperature information used by this node.
kStatus kNode_ClearHealthLog(kNode node)
Clears the node health log.
kSize kNode_SerialOutCount(kNode node)
Reports the number of serial outputs supported by this node.
kTestJig kNode_TestJig(kNode node)
Gets the test jig configuration module, if present.
kStatus kNode_AllowWatchdog(kNode node, kBool allow)
Specifies whether the watchdog can be enabled/disabled.
kStatus kNode_FindStatByName(kNode node, const kChar *name, k64s *value)
Gets the health statistic with the specified name.
kStatus kNode_ReadLogHistory(kNode node, kArrayList logItems)
Gets a list of log messages.
kBool kNode_AutoExecuteEnabled(kNode node)
Reports whether firmware will execute automatically at boot time.
Represents light configuration.
kStatus kNode_OpenHealth(kNode node)
Opens a health connection to the remote node.
kStatus kNode_SetPowerSaverTimeout(kNode node, k64u timeout)
Sets the power saver timeout for all lights.
kStatus kNode_ImportModeConfig(kNode node, const kChar *filePath)
Loads mode configuration from a local file.
kStatus kNode_EnableErrorRecovery(kNode node, kBool enable)
Enables automatic recovery from hardware/software errors (e.g.
kSize kNode_CameraCount(kNode node)
Reports the number of camera modules supported by this node.
Represents analog configuration.
kStatus kNode_LoadFirmwareFromStream(kNode node, kNodeFirmwareType type, kStream stream, kSize size, kCallbackFx progress, kPointer context)
Loads firmware from a local stream to non-volatile storage.
Represents serial configuration.
kStatus kNode_SetNextId(kNode node, k32u id)
Sets the device identifier for this node, which typically corresponds to a manufacturing serial numbe...
kStatus kNode_Start(kNode node)
Starts node acquisition and data processing activities.
kSvNode kNode_Server(kNode node)
Gets the local server node handle associated with the specified client node handle.
kStatus kNode_WriteRegisterOverrides(kNode node, kRegisterModule moduleType, kArrayList registers)
Writes a list of registers overrides for a given module type.
Represents configuration for a node's local orientation.
kDaughterboardModel kNode_DaughterboardModel(kNode node)
Gets the model of the daughterboard.
Represents node file services.
kStatus kNode_SetVariable(kNode node, const kChar *name, kObject variable)
Sets the value of a remote variable.
Represents constraint and validity information for a 64-bit unsigned integer setting.
Definition: kInfo.h:234
kStatus kNode_SetRescueWaitTimeout(kNode node, k64u waitTimeout)
Sets the RescueWait timeout (us).
kStatus kNode_Connect(kNode node)
Creates a control connection to the node.
kStatus kNode_VariableInfo(kNode node, const kChar *name, kNodeVariableInfo *info)
Gets information about a custom variable.
kLight kNode_LightAt(kNode node, kSize index)
Gets the light module at the specified index.
k64u kNode_PowerSaverThreshold(kNode node)
Gets the power saver threshold for all lights.
Represents model of daughterboard.
kStatus kNode_ErrorRecoveryEnabledInfo(kNode node, kInfoBool *info)
Reports constraint and validity information for the ErrorRecovery setting.
kSize kNode_EventManagerCount(kNode node)
Reports the number of event managers supported by this node.
kSize kNode_IoTestCount(kNode node)
Reports the number of I/O tests supported by this node.
kStatus kNode_Verify(kNode node)
Checks the validity of all node settings.
kStatus kNode_Info(kNode node, kNodeInfo *info)
Gets general information about this node.
Represents a local node's GPIO bank.
kStatus kNode_Stop(kNode node)
Stops node acquisition and data processing activities.
Represents configuration for various node network services (e.g. control, data).
kBool kNode_ErrorRecoveryEnabled(kNode node)
Reports whether automatic error recovery is enabled.
kPipe kNode_Pipe(kNode node)
Gets the pipe configuration module.
kStatus kNode_IncrementInputCounter(kNode node)
Increments the node software input counter.
kStatus kNode_VerifyAndApply(kNode node)
Checks for errors and applies settings if no errors are detected.
kStatus kNode_PowerSaverTimeoutInfo(kNode node, kInfo64u *info)
Reports constraint and validity information for the power saver timeout setting.
const kHealthStat * kNode_StatAt(kNode node, kSize index)
Gets the health statistic at the specified index.
kStatus kNode_MainTempProbeInfo(kNode node, kInfoBits *info)
Reports constraint and validity information for the MainTempProbe setting.
kStatus kNode_RescueWaitTimeoutInfo(kNode node, kInfo64u *info)
Reports constraint and validity information for the RescueWait timeout setting.
kStatus kNode_ReadRegisters(kNode node, kRegisterModule moduleType, kSize moduleIndex, kArrayList registers)
Gets a list of registers for a given module type and module index.
kStatus kNode_EndStop(kNode node)
Completes an asynchronous stop operation that was initiated using the kNode_BeginStop method...
Represents event manager configuration.
Represents configuration for a collection of actions.
Represents constraint and validity information for a 32-bit unsigned integer setting.
Definition: kInfo.h:98
kStatus kNode_EndStart(kNode node)
Completes an asynchronous start operation that was initiated using the kNode_BeginStart method...
kAnalogOut kNode_AnalogOutAt(kNode node, kSize index)
Gets the analog output at the specified index.
kGpioBank kNode_GpioBankAt(kNode node, kSize index)
Gets the GPIO bank at the specified index.
kStatus kNode_Restart(kNode node, kBool defer=kFALSE)
Begins restarting node application software.
kStatus kNode_I2cRead(kNode node, k32u deviceId, k32u address, kByte *data, kSize size)
Reads I2C register value.
kStatus kNode_SaveModeConfig(kNode node, const kChar *filePath)
Saves current mode configuration to the specified file.
Represents configuration for (PID) temperature regulation.
k64u kNode_HealthLogPeriod(kNode node)
Reports the current health logging period.
kStatus kNode_Report(kNode node, kObject *report, kAlloc allocator)
Creates a report containing a description of current node state.
kBool kNode_SshdEnabled(kNode node)
Reports whether firmware will enable SSHD.
kStatus kNode_WarningAt(kNode node, kSize index, kChar *warning, kSize capacity)
Gets the verification warning string at the specified index.
k32u kNode_Id(kNode node)
Gets the current device identifier for this node, which typically corresponds to a manufacturing seri...
kTempControl kNode_TempControl(kNode node)
Gets the temperature control configuration module, if present.
kStatus kNode_SubscribeData(kNode node, const k16u *ports, kSize portCount)
Sets the network data output ports to which this client should connect.
k64s kNode_EncoderCounter(kNode node)
Gets the current encoder value from the node.
kStatus kNode_ReadHealthLog(kNode node, kHealthSummary *summary, kAlloc alloc)
Reads and summarizes the node health log.
Represents node run-time statistics.
Definition: kNodeDef.h:2256
kStatus kNode_Pause(kNode node)
(Deprecated) Function currently calls kNode_Stop.
kSize kNode_WarningCount(kNode node)
Returns the number of warnings that were detected when the node was last verified.
kSize kNode_ProjectorCount(kNode node)
Reports the number of projector modules supported by this node.
Represents the current state of a node object.
kStatus kNode_CloseHealth(kNode node)
Closes the health connection to the remote node.
kBool kNode_WatchdogAllowed(kNode node)
Reports whether watchdog feature is allowed to be enabled/disabled.
kStatus kNode_SetHealthLogPeriod(kNode node, k64u period)
Sets the health logging period.
Represents message source information and an attached message.
kBool kNode_CrashLogEnabled(kNode node)
Reports whether firmware will enable crash logging facility.
Represents I/O test configuration.
Provides FireSync node network services and mediates access to node hardware.
kStatus kNode_SetBootMode(kNode node, kBootMode mode)
Sets the method that should be used to boot this device.
kStatus kNode_SetDiscoveryIpConfig(kNode node, const kIpConfig *ipConfig)
Sets the current IP configuration via a sensor discovery broadcast.
Represents constraint and validity information for a boolean setting.
Definition: kInfo.h:493
kStatus kNode_Apply(kNode node)
Sends current settings to this node.
kStatus kNode_ClearFirmware(kNode node, kNodeFirmwareType type)
Clears a firmware program from non-volatile storage.
Represents indicator LED types.
kStatus kNode_LightDriverHighPowerInfo(kNode node, kInfoBool *info)
Reports constraint and validity information for the light driver high power setting.
kStatus kNode_PowerSaverThresholdInfo(kNode node, kInfo64u *info)
Reports constraint and validity information for the power saver threshold setting.
kStatus kNode_DeleteVariables(kNode node)
Disposes all remote variables.
kStatus kNode_Replay(kNode node, kMsgInfo input, kArrayList output)
Replays an input message and waits to receive output.
kStatus kNode_SaveAsVirtual(kNode node, const kChar *path)
Creates the necessary content in the local file system to support simulating this node...
kStatus kNode_Wipe(kNode node)
Resets device settings and storage contents to defaults.
