You are here: Technical Reference > User Set Control
FLIR

Firefly®

FFY-U3-16S2C-DL

 

User Set Control

Features in the User Set Control category allow you to save camera settings to non-volatile memory so that they can be restored to a known state at any time (after the camera has been restarted).

Types of User Sets

You can select which user set to configure, save, or load with the UserSetSelector feature. There are two classes of user sets.

  • User-defined settings
  • Factory-defined settings. A factory-defined Default user set is always available. It represents a typical use case for the camera.

If the factory-defined settings must be changed for your application, they can be used as a starting point. From there, only a few features may need to be modified to achieve the desired configuration. The UserSetSave feature saves the current camera settings so that they can be recreated later. Once saved, these new custom settings can be loaded at any time.

The UserSetLoad feature loads the specified user set. Note that one can load a set without first saving. In this situation, the user set contents are the factory-defined default settings.

Start-up User Set

The UserSetDefault feature is used to configure a camera automatically at start-up. This loads the selected user set at start-up time. By default, it applies the factory-defined Default settings. However, you can change it to any user set so that the next time the camera restarts, it comes up with the selected user set.

User Set Managed Features

Due to limited on-board non-volatile memory, not all features are supported by user sets. See UserSetFeatureSelector for the list of all features that are supported. Features that are not listed are either of single session nature or are managed explicitly via other features, such as Defect Table Save.

User Set Conversion

The exact list of features managed by user sets may change between different versions of firmware. Consequently, there may not be a perfect match between the set of features saved to non-volatile memory and the set of features handled by the current version of firmware. In this situation, the camera performs any necessary conversions on all saved user sets. This happens automatically the first time the camera is restarted after a firmware update. The conversion performed depends on the nature of the feature discrepancy:

  • Obsolete features - Saved features that are no longer supported in the current firmware. These features are ignored and removed from all subsequently saved user sets.
  • Missing features - Saved user sets do not have features that are supported in the current firmware. These missing feature values are filled in using one of the factory-defined sets. If UserSetDefault points to a user-defined set, then the missing feature values are copied from the factory-defined Default set.

Summary Table

Name Interface Access Visibility Description
User Set Selector IEnumeration RW Beginner Selects the feature User Set to load, save or configure.
User Set Load [User Set Selector] ICommand RW Expert Loads the User Set specified by UserSetSelector to the device and makes it active.
User Set Save [User Set Selector] ICommand RW Beginner Saves the User Set specified by UserSetSelector to the non-volatile memory of the device.
User Set Default IEnumeration RW Beginner Selects the feature User Set to load and make active by default when the device is restarted.
User Set Feature Selector IEnumeration RW Expert List of features that are saved to user sets.
User Set Feature Enable IBoolean RO Expert Whether or not the selected feature is saved to user sets.

User Set Control Features


User Set Selector

Selects the feature User Set to load, save or configure.

Property Value
Name UserSetSelector
Interface IEnumeration
Access RW
Visibility Beginner

Enumeration Values
Default
UserSet0
UserSet1

User Set Load

Loads the User Set specified by UserSetSelector to the device and makes it active.

Property Value
Name UserSetLoad [User Set Selector]
Interface ICommand
Access RW
Visibility Expert

User Set Save

Saves the User Set specified by UserSetSelector to the non-volatile memory of the device.

Property Value
Name UserSetSave [User Set Selector]
Interface ICommand
Access RW
Visibility Beginner

User Set Default

Selects the feature User Set to load and make active by default when the device is restarted.

Property Value
Name UserSetDefault
Interface IEnumeration
Access RW
Visibility Beginner

Enumeration Values
Default
UserSet0
UserSet1

User Set Feature Selector

List of features that are saved to user sets.

Property Value
Name UserSetFeatureSelector
Interface IEnumeration
Access RW
Visibility Expert

Enumeration Values
AcquisitionFrameCount
AcquisitionFrameRate
AcquisitionFrameRateEnable
AcquisitionLineRate
AcquisitionMode
AcquisitionOnBoot
AdcBitDepth
AutoExposureControlPriority
AutoExposureExposureTimeLowerLimit
AutoExposureExposureTimeUpperLimit
AutoExposureGainLowerLimit
AutoExposureGainUpperLimit
AutoExposureGreyValueLowerLimit
AutoExposureGreyValueUpperLimit
AutoExposureLightingMode
AutoExposureTargetGreyValue
AutoExposureTargetGreyValueAuto
BalanceRatioBlue
BalanceRatioRed
BalanceWhiteAuto
BalanceWhiteAutoLowerLimit
BalanceWhiteAutoUpperLimit
BinningHorizontalAll
BinningVerticalAll
BlackLevelAll
ChunkEnableAll
ChunkModeActive
ColorTransformationEnable
DefectCorrectStaticEnable
DefectCorrectionMode
DeviceIndicatorMode
DeviceLinkBandwidthReserve
DeviceLinkThroughputLimit
EventNotificationError
EventNotificationExposureEnd
EventNotificationInference
EventNotificationSerialPortReceive
ExposureAuto
ExposureMode
ExposureTime
GainAll
GainAuto
GainRawAll
Gamma
GammaEnable
Height
InferenceEnable
InferenceNetworkTypeSelector
InferencePreprocessChannelMean
InferencePreprocessChannelMeanInternal
InferencePreprocessChannelScalar
InferencePreprocessChannelScalarInternal
IspEnable
LUTEnable
LineInferenceTargetLine0
LineInferenceTargetLine1
LineInferenceTargetLine2
LineInferenceTargetLine3
LineInferenceThresholdLine0
LineInferenceThresholdLine1
LineInferenceThresholdLine2
LineInferenceThresholdLine3
LineInverterLine0
LineInverterLine1
LineInverterLine2
LineInverterLine3
LineModeLine0
LineModeLine1
LineModeLine2
LineModeLine3
LineSourceLine0
LineSourceLine1
LineSourceLine2
LineSourceLine3
OffsetX
OffsetY
PixelFormat
ReverseX
ReverseY
RgbTransformLightSource
Saturation
SaturationEnable
SensorShutterMode
SerialPortBaudRateSerialPort0
SerialPortDataBitsSerialPort0
SerialPortParitySerialPort0
SerialPortSourceSerialPort0
SerialPortStopBitsSerialPort0
Sharpening
SharpeningEnable
TestPatternPipelineStart
TestPatternSensor
TransferBlockCount
TransferControlMode
TransferOperationMode
TriggerActivationAcquisitionStart
TriggerActivationFrameStart
TriggerModeAcquisitionStart
TriggerModeFrameStart
TriggerSourceAcquisitionStart
TriggerSourceFrameStart
UserOutputValue
UserOutputValueAll
V3_3Enable
Width

User Set Feature Enable

Whether or not the selected feature is saved to user sets.

Property Value
Name UserSetFeatureEnable
Interface IBoolean
Access RO
Visibility Expert

 

5/8/2020
© 2015-2020 FLIR® Integrated Imaging Solutions Inc.
All rights reserved.
Legal
| Contact Support

Firefly® FFY-U3-16S2C-DL
Camera Reference