IDS peak 2.10.0 / uEye+ firmware 3.34

IDS Peak comfortSDK, genericSDK, IPL, and AFL developer manuals are external documents. Please contact us if you need them.

Activates or deactivates the heartbeat of the link.

Values description

•Off: Disables the heartbeat of the link. If no heartbeat is received, the connection is not closed by the camera. When you are debugging on the host side, it could make sense to disable the heartbeat mechanism.

•On: Enables the heartbeat of the link. If no heartbeat is received on the command channel within the time limit specified by DeviceLinkHeartbeatTimeout, the camera disconnects the link.

Code example

C++

// Determine the current entry of DeviceLinkHeartbeatMode
std::string value = nodeMapRemoteDevice->FindNode<peak::core::nodes::EnumerationNode>("DeviceLinkHeartbeatMode")->CurrentEntry()->SymbolicValue();
// Get a list of all available entries of DeviceLinkHeartbeatMode
auto allEntries = nodeMapRemoteDevice->FindNode<peak::core::nodes::EnumerationNode>("DeviceLinkHeartbeatMode")->Entries();
std::vector<std::shared_ptr<peak::core::nodes::EnumerationEntryNode>> availableEntries;
for(const auto & entry : allEntries)
{
  if ((entry->AccessStatus()!=peak::core::nodes::NodeAccessStatus::NotAvailable)
          && (entry->AccessStatus()!=peak::core::nodes::NodeAccessStatus::NotImplemented))
  {
      availableEntries.emplace_back(entry);
  }
}
// Set DeviceLinkHeartbeatMode to "On"
nodeMapRemoteDevice->FindNode<peak::core::nodes::EnumerationNode>("DeviceLinkHeartbeatMode")->SetCurrentEntry("On");

C#

// Determine the current entry of DeviceLinkHeartbeatMode
string value = nodeMapRemoteDevice.FindNode<peak.core.nodes.EnumerationNode>("DeviceLinkHeartbeatMode").CurrentEntry().SymbolicValue();
// Get a list of all available entries of DeviceLinkHeartbeatMode
allEntries = nodeMapRemoteDevice.FindNode<peak.core.nodes.EnumerationNode>("DeviceLinkHeartbeatMode").Entries();
List<string> availableEntries = new List<string>();
for(int i = 0; i < allEntries.Count(); ++i)
{
  if ((allEntries[i].AccessStatus() != peak.core.nodes.NodeAccessStatus.NotAvailable)
          && (allEntries[i].AccessStatus() != peak.core.nodes.NodeAccessStatus.NotImplemented))
  {
      availableEntries.Add(allEntries[i].SymbolicValue());
  }
}
// Set DeviceLinkHeartbeatMode to "On"
nodeMapRemoteDevice.FindNode<peak.core.nodes.EnumerationNode>("DeviceLinkHeartbeatMode").SetCurrentEntry("On");

Python

# Determine the current entry of DeviceLinkHeartbeatMode (str)
value = nodeMapRemoteDevice.FindNode("DeviceLinkHeartbeatMode").CurrentEntry().SymbolicValue()
# Get a list of all available entries of DeviceLinkHeartbeatMode
allEntries = nodeMapRemoteDevice.FindNode("DeviceLinkHeartbeatMode").Entries()
availableEntries = []
for entry in allEntries:
  if (entry.AccessStatus() != ids_peak.NodeAccessStatus_NotAvailable
          and entry.AccessStatus() != ids_peak.NodeAccessStatus_NotImplemented):
      availableEntries.append(entry.SymbolicValue())
 
# Set DeviceLinkHeartbeatMode to "On" (str)
nodeMapRemoteDevice.FindNode("DeviceLinkHeartbeatMode").SetCurrentEntry("On")