Skip to content
STAGING SERVER
DEVELOPMENT SERVER

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:

JSON Payload#

Field Optional Type Description
TransactionID Yes String Transaction identification
Action No String Method called. Fixed value: GetParameters
DeviceID No String Device identification
ParameterList No Array of string The list of parameters to be read 
{
    "TransactionID": "2345645",
    "Action": "GetParameters",
    "DeviceID": "548451887",
    "ParameterList": [
        "Width",
        "@CameraDevice/Height"
    ]
}

Response Object#

Field Optional Type Description
TransactionID Yes String Transaction identification
ReturnCode No Integer (32-bit unsigned) Message code following Message Codes
Message No String Response message
ParameterList No Parameter Object Array Parameter object array containing the parameter details

Parameter Object#

Field Optional Type Description
Name No String Unique parameter name
DisplayName Yes String Display name of the parameter for the user interface
Type No String Parameter value type. Possible values: String, Integer, Float, Enumeration, Boolean, Command
Value Yes String/ Integer (64-bit signed)/ Float/ Bool Currently defined value. For enumerations, the type of value must be a string. This parameter object isn't available if Type is Command or Readable is False.
IntValue Yes Integer (64-bit signed) On enumerations, it's the integer defined.
Readable No Boolean Flag indicating whether the parameter can be read. The readable flag depends on the current camera state.
Writable No Boolean Flag indicating whether the parameter can be written. The writable flag depends on the current camera state.
Minimum Yes Integer (64-bit signed)/ Float For Integer and Float parameters: Minimum allowed value for numeric type parameters.
For String parameters: The minimum number of allowed bytesa in the string (provided as an Integer). Usually, this value is 0.
For all other parameter types: No minimum is provided.
Maximum Yes Integer (64-bit signed)/ Float For Integer and Float parameters: Maximum allowed value for numeric type parameters.
For String parameters: The maximum number of allowed bytesa in the string (provided as an Integer).
For all other parameter types: No maximum is provided.
Increment Yes Integer (64-bit signed)/ Float Allowed increment for the parameter
Representation Yes String Information about how this parameter should be represented in a user interface. This is only available for integer and float parameters.
Possible values: Linear, Logarithmic, PureNumber, Boolean, HexNumber, IPV4Address, MACAddress
Alias Yes String Name of an alias parameter. An alias parameter represents the same functionality, but in a different form. For example, a float parameter could have an integer parameter as an alias.
EnumEntries Yes Enum Entries Array Array containing the entries available for the parameter

  1. The number of bytes in the string is the number of UTF-8 encoded bytes, not the number of characters. This means that a string with 3 characters, where one character is a 4-byte UTF-8 character, has a length of 6 bytes.

Enum Entries#

Field Optional Type Description
DisplayName Yes String Display name of the enum entry for the user interface
Value No String Parameter value that needs to be set
IntValue No Integer (64-bit signed) Integer value of the enum entry
Description Yes String Enum entry description 
{
  "TransactionID": "2345645",
  "ReturnCode": 0,
  "Message": "Parameters read successfully",
  "ParameterList": [
    {
      "Name": "Width",
      "DisplayName": "Width",
      "Type": "Integer",
      "Value": 1024,
      "Readable": true,
      "Writable": true,
      "Minimum": 1,
      "Maximum": 4096,
      "Increment": 1,
      "Representation": "Linear",
      "Alias": "ImageWidth"
    },
    {
      "Name": "PixelFormat",
      "DisplayName": "Pixel Format",
      "Type": "Enumeration",
      "Value": "Mono8",
      "IntValue": 17301505,
      "Readable": true,
      "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."
        }
      ]
    }
  ]
}