Thermal visual fusion configuration

This API is based on the Device Configuration API framework. For guidance on how to use these APIs, please refer to the Device Configuration APIs section in the VAPIX Library.

warning

This API is in BETA stage. The API is provided for testing purposes and is subject to backward-incompatible changes, including modifications to functionality, behavior, and availability. Please don't use in production environment.

The VAPIX® Thermal visual fusion configuration API allows the user to control the thermal visual fusion view. The view is a combination of two streams: one is the base stream and the other is the overlaid stream. The camera has a set of resolutions for the view, fixed scale that is unique to each camera variant, and a default factory alignment setting.

The user can control which source to use for the base stream out of two options of sources this API provides, how transparent the overlaid stream is, and the xy alignment between the two streams. The user can also reset the alignment to its default value. The view is available on channel 3 and is not user customizable.

In the context of this API, there are three properties that the user can control:

• Fusion Mode (GET, SET): control which source that should be used for the base stream.
• Alignment (update, reset): control the xy alignment between two streams.
• Transparency (GET, SET): control the transparency of the overlaid stream.

Use cases

Read fusion mode

Use the thermal visual fusion to get the current mode.

GET /config/rest/thermal-visual-fusion/v1beta/fusionMode HTTP/1.1
HOST: my-device
Content-Type: application/json

HTTP/1.1 200 OK
Content-Type: application/json

{
    "status": "success",
    "data": "VISUAL"
}

Change fusion mode

Switch the fusion mode from visual mode (thermal on top of visual stream, 16:9 aspect ratio) to thermal mode (visual on top of thermal, 4:3 aspect ratio).

PATCH /config/rest/thermal-visual-fusion/v1beta/fusionMode HTTP/1.1
HOST: my-device
Content-Type: application/json

{
    "data": "VISUAL"
}

HTTP/1.1 200 OK
Content-Type: application/json

{
    "status": "success"
}

Update alignment setting

Update the alignment of the thermal stream against the visual stream by passing one of: MOVE_LEFT, MOVE_RIGHT, MOVE_UP, MOVE_DOWN.

Reset alignment setting

Reset the alignment of the thermal stream against the visual stream back to its factory default value.

Read transparency setting

Request the current transparency value of the overlaid stream. The transparency value can be set between 0.0 to 1.0, with 0.0 being fully transparent and 1.0 being fully opaque.

GET /config/rest/thermal-visual-fusion/v1beta/transparency HTTP/1.1
HOST: my-device
Content-Type: application/json

HTTP/1.1 200 OK
Content-Type: application/json

{
    "status": "success",
    "data": 0.5
}

Change transparency setting

Change the transparency of an overlaid stream.

PATCH /config/rest/thermal-visual-fusion/v1beta/transparency HTTP/1.1
HOST: my-device
Content-Type: application/json

{
    "data": 0.5
}

HTTP/1.1 200 OK
Content-Type: application/json

{
    "status": "success"
}

API Definition

Structure

thermal-visual-fusion.v1 (Root Entity)
    ├── alignment (Property)
    ├── fusionMode (Property)
    ├── transparency (Property)
    ├── resetAlignment (Action)
    ├── updateAlignment (Action)

Entities

thermal-visual-fusion.v1

• Description: Thermal Visual Fusion Root Entity
• Type: Singleton
• Operations
  • GET
• Attributes
  • Dynamic Support: No

Properties

alignment

• Description: Alignment of the overlaid stream.
• Datatype: Alignment
• Operations
  • GET (Permissions: admin, viewer, operator)
  • SET (Permissions: admin)
• Attributes
  • Nullable: No
  • Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No

fusionMode

• Description: The mode of the thermal visual fusion.
• Datatype: FusionModeEnum
• Operations
  • GET (Permissions: admin, viewer, operator)
  • SET (Permissions: admin)
• Attributes
  • Nullable: No
  • Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No

transparency

• Description: Transparency of the overlaid stream.
• Datatype: Transparency
• Operations
  • GET (Permissions: admin, viewer, operator)
  • SET (Permissions: admin)
• Attributes
  • Nullable: No
  • Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No

Actions

resetAlignment

• Description: Reset the alignment to factory settings.
• Request Datatype: ResetAlignmentReq
• Response Datatype: ResetAlignmentResp
• Trigger Permissions: admin
• Attributes
  • Dynamic Support: No

updateAlignment

• Description: Update alignment of the fusion stream.
• Request Datatype: UpdateAlignmentReq
• Response Datatype: UpdateAlignmentResp
• Trigger Permissions: admin
• Attributes
  • Dynamic Support: No

Data types

AbsCoordinate

• Description: The coordinate used in absolute coordinates system. (-1.0, -1.0) is bottom left corner and (1.0, 1.0) is top right corner of the stream. (0.0, 0.0) is center of the stream.
• Type: number
• Minimum Value: -1
• Maximum Value: 1

Alignment

• Description: Distance between the center of the thermal stream and the center of visual stream. Any part of the overlaid stream that is outside the base stream will be cropped out. Use the [-1..1] coordinate system.
• Type: complex
• Fields
  • x
    • Description: x-axis part of the alignment.
    • Type: AbsCoordinate
    • Nullable: No / Gettable: Yes
  • y
    • Description: y-axis part of the alignment.
    • Type: AbsCoordinate
    • Nullable: No / Gettable: Yes

FusionModeEnum

• Description: The base source for the fusion stream. Visual means that the fusion stream will use a visual stream as the base and overlay thermal stream on top. For Thermal mode, it is the other way around.
• Type: string
• Enum Values: "VISUAL", "THERMAL"

FusionMoveEnum

• Description: What movement to apply to the alignment in fusion.
• Type: string
• Enum Values: MOVE_LEFT, MOVE_RIGHT, MOVE_UP, MOVE_DOWN

ResetAlignmentReq

• Description: Extensible type for the reset alignment request.
• Type: complex
• Fields

ResetAlignmentResp

• Description: Extensible type for the reset alignment response.
• Type: complex
• Fields

Transparency

• Description: Transparency value of the overlaid stream. 0.0 means that the stream is fully transparent and 1.0 means fully opaque.
• Type: number
• Minimum Value: 0
• Maximum Value: 1

UpdateAlignmentReq

• Description: Extensible type for the update alignment request.
• Type: complex
• Fields
  • fusionMoveAlignment
    • Description: What movement to apply to alignment in fusion.
    • Type: FusionMoveEnum
    • Nullable: No / Gettable: Yes

UpdateAlignmentResp

• Description: Extensible type for the update alignment response.
• Type: complex
• Fields