Basler Vision Connector Messaging: Retrieving Camera Parameter List#

With the following message, you can request a list of available parameters.

The GetParameters command is allocated to one of the following node maps:

@CameraDevice -> CInstantCamera::GetNodeMap

@CameraInstance -> CInstantCamera::GetInstantCameraNodeMap

@DeviceTransportLayer -> CInstantCamera::GetTLNodeMap

@StreamGrabber0 -> CInstantCamera::GetStreamGrabberNodeMap

@EventGrabber -> CInstantCamera::GetEventGrabberNodeMap

If no node map is defined, the @CameraDevice default node map is used. This node map represents the camera parameters. All other commands only operate on the @CameraDevice default node map.

The syntax for using the node map is as follows:

    "ParameterList": [
        "Width",
        "@CameraDevice/Height"
    ]

For an explanation of node maps, see the pylon API documentation.

You can find documentation about the available node maps at:

@CameraDevice or in your camera documentation
@CameraInstance
@DeviceTransportLayer
@StreamGrabber0
@EventGrabber

JSON Payload#

Field	Optional	タイプ	説明
TransactionID	はい	String	Transaction identification
アクション	いいえ	String	Method called. Fixed value: `GetParameters`
DeviceID	いいえ	String	Device identification
ParameterList	いいえ	Array of string	The list of parameters to be read

{
    "TransactionID": "2345645",
    "Action": "GetParameters",
    "DeviceID": "548451887",
    "ParameterList": [
        "Width",
        "@CameraDevice/Height"
    ]
}

Response Object#

Field	Optional	タイプ	説明
TransactionID	はい	String	Transaction identification
ReturnCode	いいえ	Integer (32-bit unsigned)	Message code following Message Codes
メッセージ	はい	String	Response message
ParameterList	いいえ	Parameter Object Array	Parameter object array containing the parameter details

Parameter Object#

Field	Optional	タイプ	説明
名前	いいえ	String	Unique parameter name
DisplayName	はい	String	Display name of the parameter for the user interface
タイプ	いいえ	String	Parameter value type. Possible values: `String`, `Integer`, `Float`, `Enumeration`, `Boolean`
値	はい	String/ Integer (64-bit signed)/ Float/ Bool	Currently defined value. For enumerations, the type of `value` must be a string.
IntValue	はい	Int	On enumerations, it's the integer defined.
Readable	いいえ	Boolean	Flag indicating whether the parameter can be read. The readable flag depends on the current camera state.
Writable	いいえ	Boolean	Flag indicating whether the parameter can be written. The writable flag depends on the current camera state.
最小	はい	Integer (64-bit signed)/ Float	Minimum allowed value for numeric type parameters
最大	はい	Integer (64-bit signed)/ Float	Maximum allowed value for numeric type parameters
Increment	はい	Integer (64-bit signed)/ Float	Allowed increment for the parameter
EnumEntries	はい	Enum Entries Array	Array containing the entries available for the parameter

Enum Entries#

Field	Optional	タイプ	説明
DisplayName	はい	String	Display name of the enum entry for the user interface
値	いいえ	String	Parameter value that needs to be set
IntValue	いいえ	Integer (64-bit signed)	Integer value of the enum entry
説明	はい	String	Enum entry description

{
  "TransactionID": "2345645",
  "ReturnCode": 0,
  "Message": "Parameters read successfully",
  "ParameterList": [
    {
      "Name": "@CameraDevice/Width",
      "DisplayName": "Width",
      "Type": "Integer",
      "Value": 1024,
      "Writable": true,
      "Minimum": 1,
      "Maximum": 4096,
      "Increment": 1
    },
    {
      "Name": "PixelFormat",
      "DisplayName": "Pixel Format",
      "Type": "Enumeration",
      "Value": "Mono8",
      "IntValue": 17301505,
      "Writable": true,
      "EnumEntries": [
        {
          "DisplayName": "Mono 8",
          "Value": "Mono8",
          "IntValue": 17301505,
          "Description": "This enumeration value sets the pixel format to Mono 8."
        },
        {
          "DisplayName": "Mono 10",
          "Value": "Mono10",
          "IntValue": 17825795,
          "Description": "This enumeration value sets the pixel format to Mono 10."
        },
        {
          "DisplayName": "Mono 12",
          "Value": "Mono12",
          "IntValue": 17825797,
          "Description": "This enumeration value sets the pixel format to Mono 12."
        },
        {
          "DisplayName": "Mono 16",
          "Value": "Mono16",
          "IntValue": 17825799,
          "Description": "This enumeration value sets the pixel format to Mono 16."
        }
      ]
    }
  ]
}