|
FireSync API
|
Declares the kHxNode class.
Go to the source code of this file.
Typedefs | |
| typedef kStatus(kCall * | kHxNodeMainFx )() |
| Dynamic entry point to user application. More... | |
Functions | |
| kStatus | kHxNode_AddEnvironUpdateHandler (kHxNode node, kCallbackFx function, kPointer receiver) |
| Registers a callback function for periodic environment updates. More... | |
| kStatus | kHxNode_AddHealthUpdateHandler (kHxNode node, kCallbackFx function, kPointer receiver) |
| Registers a callback function for periodic health updates. More... | |
| void | kHxNode_AddLeakedMemory (kHxNode node, kSize amount) |
| Adds to the total reported amount of memory leaked by this node. | |
| kStatus | kHxNode_BootConfig (kHxNode node, kBootConfig *config) |
| Gets the node's boot configuration parameters. | |
| kStatus | kHxNode_Clear (kHxNode node) |
| Resets most mode configuration to defaults. More... | |
| kStatus | kHxNode_ClearCrashLog (kHxNode node) |
| Clears the crash log history records. | |
| kStatus | kHxNode_ClearFirmware (kHxNode node, kNodeFirmwareType type) |
| Clear the firmware region specified. | |
| kStatus | kHxNode_ClearStats (kHxNode node) |
| Clears cumulative run-time counters. More... | |
| kStatus | kHxNode_CommitConfig (kHxNode node) |
| Commits changes to device configuration. More... | |
| kDateTime | kHxNode_DateTime (kHxNode node) |
| Gets the current calendar date/time for the node. More... | |
| kDaughterboardModel | kHxNode_DaughterboardModel (kHxNode node) |
| Reports the node's daughterboard model. More... | |
| kNetworkSpeed | kHxNode_DefaultNetworkSpeed (kHxNode node, kSize index) |
| Gets the default network speed settings for this device. | |
| kStatus | kHxNode_Disengage (kHxNode node) |
| Begins termination of node acquisition and output activities. More... | |
| kStatus | kHxNode_DynamicIpConfig (kHxNode node, kSize index, kIpConfig *config) |
| Retrieve IP configuration by querying the stack. More... | |
| kStatus | kHxNode_EnableLightDriverHighPower (kHxNode node, kBool enabled) |
| Enables use of higher-powered light-driver set points. | |
| kStatus | kHxNode_EnableWatchdog (kHxNode node, kBool enable, k64u timeoutPeriod) |
| Enables or disables the watchdog timer. More... | |
| kStatus | kHxNode_Engage (kHxNode node, k64u startTime, k64s startEncoder, kBool maintainPhase) |
| Begin node acquisition and output activities. | |
| kStatus | kHxNode_GetCrashLog (kHxNode node, kString *crashLog, kAlloc allocator) |
| Gets all log messages in the log history records. | |
| kStatus | kHxNode_GetLogItems (kHxNode node, kArrayList logItems) |
| Gets all log messages in the log history queue. | |
| kBool | kHxNode_GetRestartRequest (kHxNode node) |
| Gets the current state of the application restart flag. More... | |
| kBool | kHxNode_HasStorage (kHxNode node) |
| Reports whether this node provides storage support. | |
| kBool | kHxNode_HasWatchdog (kHxNode node) |
| Reports whether watchdog services are available on this platform. | |
| kHealth | kHxNode_Health (kHxNode node) |
| Returns health service associated with this node. | |
| kStatus | kHxNode_HealthLogPriority (kHxNode node, kThreadPriorityClass *priorityClass, k32s *priorityOffset) |
| Returns the recommended thread priority for health logging. More... | |
| k32u | kHxNode_Id (kHxNode node) |
| Gets the node's device identifier (serial number). | |
| kStatus | kHxNode_IncrementInputCounter (kHxNode node) |
| Increments the node input counter. More... | |
| kStatus | kHxNode_Info (kHxNode node, kNodeInfo *info) |
| Fills in the given node info structure with any known information about this node. | |
| kStatus | kHxNode_InputCounter (kHxNode node) |
| Reports the current input counter value. More... | |
| kStatus | kHxNode_IpConfig (kHxNode node, kSize index, kIpConfig *config) |
| Gets the IP configuration with which the device booted. More... | |
| kBool | kHxNode_IsVirtual (kHxNode node) |
| Reports whether this node is a virtual (simulated) node. | |
| kSize | kHxNode_LeakedMemory (kHxNode node) |
| Reports the total amount of leaked memory. | |
| kBool | kHxNode_LightDriverHighPowerEnabled (kHxNode node) |
| Reports whether use of higher-powered light-driver set points is enabled. | |
| kStatus | kHxNode_LoadApp (kHxNode node, kDynamicLib *library) |
| Uses platform-specific methodology to load the library containing the application. | |
| kStatus | kHxNode_Log (kHxNode node, const kChar *message) |
| Adds an item to the log. | |
| kStatus | kHxNode_LogEx (kHxNode node, kLogOption options, const kChar *source, const kChar *message) |
| Adds an item to the log. | |
| kStatus | kHxNode_MacAddress (kHxNode node, kSize index, kMacAddress *address) |
| Gets the node's Ethernet MAC address. More... | |
| kTempProbeId | kHxNode_MainTempProbe (kHxNode node) |
| Gets a value indicating the stamp temperature source. | |
| k64u | kHxNode_MinHealthLogPeriod (kHxNode node) |
| Returns the recommended minimum health logging period. More... | |
| kSize | kHxNode_NetInterfaceCount (kHxNode node) |
| Reports the number of network interfaces. | |
| kNetworkSpeed | kHxNode_NetworkSpeed (kHxNode node, kSize index) |
| Gets current network speed. | |
| kNetworkSpeed | kHxNode_NetworkSpeedCapabilities (kHxNode node, kSize index) |
| Gets the network speed settings supported by this device. | |
| k32u | kHxNode_NetworkTransmitRate (kHxNode node, kSize index) |
| Reports the maximum Ethernet transmission rate. | |
| kBool | kHxNode_NetworkTransmitRateSupported (kHxNode node, kSize index) |
| Reports whether the TransmitRate setting is supported by this device. | |
| k32u | kHxNode_NextId (kHxNode node) |
| Gets the node's future device identifier (after reboot). | |
| kStatus | kHxNode_NextIpConfig (kHxNode node, kSize index, kIpConfig *config) |
| Gets the node's future IP configuration (after reboot). | |
| kNetworkSpeed | kHxNode_NextNetworkSpeed (kHxNode node, kSize index) |
| Gets network speed that should take effect on next reboot. | |
| kNodeType | kHxNode_NodeType (kHxNode node) |
| Gets the type of node. | |
| k32u | kHxNode_Pl2Config (kHxNode node) |
| Reports the node's secondary PL configuration id. More... | |
| kBool | kHxNode_Pl2Loaded (kHxNode node) |
| Reports whether the node's secondary PL has been successfully programmed. More... | |
| kVersion | kHxNode_Pl2Version (kHxNode node) |
| Reports the node's secondary PL firmware version. More... | |
| k32u | kHxNode_PlConfig (kHxNode node) |
| Reports the node's primary PL configuration id. More... | |
| kBool | kHxNode_PlLoaded (kHxNode node) |
| Reports whether the node's primary PL has been successfully programmed. More... | |
| kVersion | kHxNode_PlVersion (kHxNode node) |
| Reports the node's primary PL firmware version. More... | |
| k64u | kHxNode_PowerSaverThreshold (kHxNode node) |
| Gets the node's power saver threshold. | |
| k64u | kHxNode_PowerSaverTimeout (kHxNode node) |
| Gets the node's power saver timeout. | |
| kSize | kHxNode_ProcessorCount (kHxNode node) |
| Reports the number of available processor cores. | |
| kStatus | kHxNode_ReadLogItems (kHxNode node, kArrayList logItems) |
| Destructively reads log messages from the log history queue. | |
| kStatus | kHxNode_ReloadFirmware (kHxNode node, kNodeFirmwareType type, kStream stream, kSize size) |
| Reloads firmware without affecting non-volatile records or rebooting. More... | |
| kStatus | kHxNode_RemoveEnvironUpdateHandler (kHxNode node, kCallbackFx function, kPointer receiver) |
| Unregisters a callback function that was previously registered using kHxNode_AddEnvironUpdateHandler. | |
| kStatus | kHxNode_RemoveHealthUpdateHandler (kHxNode node, kCallbackFx function, kPointer receiver) |
| Unregisters a callback function that was previously registered using kHxNode_AddHealthUpdateHandler. | |
| void | kHxNode_RequestAppRestart (kHxNode node) |
| Requests that the application should be restarted after exiting. More... | |
| kStatus | kHxNode_SetBootConfig (kHxNode node, const kBootConfig *config) |
| Sets boot configuration parameters. More... | |
| kStatus | kHxNode_SetCrashLogAppInfo (kHxNode node, kVersion version, k32u nodeId) |
| Sets the appropriate fields in the crash log object. | |
| kStatus | kHxNode_SetDataHandler (kHxNode node, kCallbackFx function, kPointer receiver) |
| Sets the callback for camera data messages. | |
| kStatus | kHxNode_SetDateTime (kHxNode node, kDateTime dateTime) |
| Set the current calendar date/time for the node. More... | |
| void | kHxNode_SetLeakedMemory (kHxNode node, kSize amount) |
| Sets the reported amount of memory that has been leaked on this node. More... | |
| kStatus | kHxNode_SetLedMode (kHxNode node, kLed instance, kLedMode mode) |
| Sets the given LED to the given operational state. | |
| kStatus | kHxNode_SetMainTempProbe (kHxNode node, kTempProbeId probeId) |
| Specifies whether the internal temperature is selected to present in message stamp. | |
| kStatus | kHxNode_SetMessageAlloc (kHxNode node, kAlloc allocator) |
| Sets the memory allocator used to generate camera messages. | |
| kStatus | kHxNode_SetNetworkTransmitRate (kHxNode node, kSize index, k32u rate) |
| Sets the maximum Ethernet transmission rate. | |
| kStatus | kHxNode_SetNextId (kHxNode node, k32u id) |
| Sets the node's future device identifier (after reboot). More... | |
| kStatus | kHxNode_SetNextIpConfig (kHxNode node, kSize index, const kIpConfig *config) |
| Sets the node's future IP configuration (after reboot). More... | |
| kStatus | kHxNode_SetNextNetworkSpeed (kHxNode node, kSize index, kNetworkSpeed speed) |
| Sets network speed that should take effect on next reboot. More... | |
| kStatus | kHxNode_SetPowerSaverThreshold (kHxNode node, k64u threshold) |
| Sets the node's power saver threshold. | |
| kStatus | kHxNode_SetPowerSaverTimeout (kHxNode node, k64u timeout) |
| Sets the node's power saver timeout. | |
| kStatus | kHxNode_SetSyncSource (kHxNode node, kSyncSource source) |
| Sets the node's preferred synchronization source. | |
| kStatus | kHxNode_Start (kHxNode node) |
| Prepare for node acquisition and output activities. | |
| kStatus | kHxNode_StartHealth (kHxNode node, kHealth health, kAlloc alloc) |
| Starts health services related to the base node object. More... | |
| kStatus | kHxNode_Stats (kHxNode node, kNodeStats *stats) |
| Fills in the node statistics items that are known by the kHardware library. More... | |
| kStatus | kHxNode_Stop (kHxNode node) |
| Ends node acquisition and output activities. | |
| kStatus | kHxNode_StopHealth (kHxNode node) |
| Destroys health services related to the base node object. More... | |
| const kChar * | kHxNode_StoragePath (kHxNode node) |
| Provides the root storage path for this node (if storage is supported). | |
| kSyncSource | kHxNode_SyncSource (kHxNode node) |
| Gets the node's preferred synchronization source. | |
| kStatus | kHxNode_UpdateWatchdog (kHxNode node, kRestartReason reason) |
| Updates the watchdog status, optionally resetting the watchdog countdown timer. More... | |
| kStatus | kHxNode_WaitForNetworkOnline (kHxNode node) |
| Waits for network startup complation. More... | |
| kStatus | kHxNode_WaitForRecoveryEvent (kHxNode node, k64u timeout) |
| Reports whether the node has an error condition requiring it to be stopped and started again. More... | |
| kStatus | kHxNode_WriteFirmware (kHxNode node, kNodeFirmwareType type, kStream stream, kSize size, kCallbackFx progress, kPointer context) |
| Writes the firmware region specified. More... | |
