Please enable JavaScript to view this site.

IDS peak 2.17.1 / uEye+ firmware 3.70

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

Returns the current operational state of the sensor.

Name

SensorState

Category

AcquisitionControl

Interface

Enumeration

Access

Read

Unit

-

Visibility

Expert

Values

PowerOff

Ready

Running

Standby

WaitForReady

Standard

IDS

Availability uEye+

icon-gev icon-u3v

Availability uEye

-

Values description

PowerOff: The sensor is powered off and not operational.

Ready: The sensor is ready to start a new acquisition.

Running: The sensor is actively acquiring data.

Standby: The sensor is in low-power standby mode, awaiting activation.

WaitForReady: The sensor is preparing to enter the "Ready" state.

Code example

C++

// Determine the current entry of SensorState
std::string value = nodeMapRemoteDevice->FindNode<peak::core::nodes::EnumerationNode>("SensorState")->CurrentEntry()->SymbolicValue();
// Get a list of all available entries of SensorState
auto allEntries = nodeMapRemoteDevice->FindNode<peak::core::nodes::EnumerationNode>("SensorState")->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);
  }
}

C#

// Determine the current entry of SensorState
string value = nodeMapRemoteDevice.FindNode<peak.core.nodes.EnumerationNode>("SensorState").CurrentEntry().SymbolicValue();
// Get a list of all available entries of SensorState
allEntries = nodeMapRemoteDevice.FindNode<peak.core.nodes.EnumerationNode>("SensorState").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());
  }
}

Python

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

© 2025 IDS Imaging Development Systems GmbH