API docs by Redocly

ColorNavigator API (1.0.0)

Download OpenAPI specification:Download

Accesses ColorNavigator's features and data via HTTP API.

NOTE

  • Following monitors are supported.
    • CG3145
    • CG319X
    • CG279X
    • CG3146
    • CG2700S
    • CG2700X
  • We highly recommend updating to the latest firmware.
  • Do NOT call POST/PUT/PATCH API periodically and too frequently. Several API processes are very complex. Frequent API calls will increase the load on the monitor. But The load of almost GET API is small. You can monitor the state of the monitor periodically.
  • Be sure to wait for the API response. Several APIs are very complex. Shutting down the PC or accessing the monitor with OSD during the API processing may cause problems.

Getting Started

Enable ColorNavigator API and ColorNavigator Agent

HTTP API is disabled by default. First, you should enable it. And HTTP API can only be used in the resident state. So, you should enable ColorNavigator Agent, too. Please follow the steps below to enable ColorNavigator API and ColorNavigator Agent.

  1. Open the preferences window.
  2. Select the "ColorNavigator API" toolbar and check "Enable ColorNavigator API." If necessary, configure the port number.
  3. Select the "General" toolbar and check "Use ColorNavigator Agent."

Run ColorNavigator 7 with the resident state

Run ColorNavigator 7 with the resident state. If the main window or preferences window is open, HTTP API cannot be used.

Call HTTP API

For example, you can call HTTP API with curl from a terminal app.

> curl http://127.0.0.1:50005/monitors
{"monitors":[{"id":"cg279x_12345678","modelName":"CG279X","serialNumber":"12345678"}]}

Miscellaneous

EIZOSDK

We also have EIZOSDK (the library of C lang) if you want to control ColorEdge more directly. Please contact your nearest office from here. However, this is limited to corporate customers, and this is not designed for simultaneous use with ColorNavigator 7 or ColorNavigator Network.

Changelog

0.10.1-beta (ColorNavigator 7.1.13)

  • Supports SpyderX2

0.10.0-beta (ColorNavigator 7.1.12)

0.9.1-beta (ColorNavigator 7.1.11 API-beta)

  • ColorNavigator v7.1.11 base
  • Fix the "colormodes" property of the response data of GET /monitors/{monitorId}/color-modes to "colorModes"
  • Fix the "parameter" property of ColorMode to "parameters"

0.9.0-beta (ColorNavigator 7.1.10 API-beta)

  • ColorNavigator v7.1.10 base
  • First Edition

Gets connected monitors.

Responses

Response samples

Content type
application/json
{
  • "monitors": [
    ]
}

Gets all color modes information.

path Parameters
monitorId
required
string
Example: cg279x_12345678

An identifier of the control target monitor.

Responses

Response samples

Content type
application/json
{
  • "colorModes": [
    ]
}

Changes the current color mode.

path Parameters
monitorId
required
string
Example: cg279x_12345678

An identifier of the control target monitor.

Request Body schema: application/json
index
required
integer

An index of the color mode. It is zero-based indexing.

The color mode "number" on OSD begins at 1. The index of color mode No.1 is 0.

Responses

Request samples

Content type
application/json
{
  • "index": 0
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Gets the color mode information.

path Parameters
monitorId
required
string
Example: cg279x_12345678

An identifier of the control target monitor.

colorModeIndex
required
integer

An index of the color mode. It is zero-based indexing.

The color mode "number" on OSD begins at 1. The index of color mode No.1 is 0.

Responses

Response samples

Content type
application/json
{
  • "selected": true,
  • "enabled": true,
  • "index": 0,
  • "name": "CAL1",
  • "type": "ADVANCED",
  • "target": {
    },
  • "parameters": {
    }
}

Changes the color mode settings.

This API changes color mode selection if the specified color mode index is not the current one.

path Parameters
monitorId
required
string
Example: cg279x_12345678

An identifier of the control target monitor.

colorModeIndex
required
integer

An index of the color mode. It is zero-based indexing.

The color mode "number" on OSD begins at 1. The index of color mode No.1 is 0.

Request Body schema: application/json
enabled
boolean

Indicates whether the color mode is selectable by OSD.

name
string

Color mode name.

Following characters are valid. The max length is 16.

  • Small or large alphabet [a-zA-Z]
  • Digits [0-9]
  • Space [ ]
  • Hyphen [-]
  • Underscore [_]
  • Period [.]
  • Parentheses [()]
type
string
Enum: "ADVANCED" "STANDARD" "SYNC_SIGNAL"

Color mode type.

  • If you specified ADVANCED, you can specify a calibration target with a target id
  • If you specified STANDARD or SYNC_SIGNAL, you can change a monitor's parameters
object
object or object

It is monitor's parameters of STANDARD or SYNC_SIGNAL type color mode. You can change monitor's parameters of the color mode.

The color mode type must be STANDARD or SYNC_SIGNAL type. You must specify the color mode type to STANDARD or SYNC_SIGNAL simultaneously if it is not.

Responses

Request samples

Content type
application/json
{
  • "enabled": true,
  • "name": "CAL1",
  • "type": "ADVANCED",
  • "target": {
    }
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Gets calibration results associated with the target.

path Parameters
monitorId
required
string
Example: cg279x_12345678

An identifier of the control target monitor.

colorModeIndex
required
integer

An index of the color mode. It is zero-based indexing.

The color mode "number" on OSD begins at 1. The index of color mode No.1 is 0.

Responses

Response samples

Content type
application/json
{
  • "calibrationResults": [
    ]
}

Gets validation results associated with the calibration result.

path Parameters
monitorId
required
string
Example: cg279x_12345678

An identifier of the control target monitor.

colorModeIndex
required
integer

An index of the color mode. It is zero-based indexing.

The color mode "number" on OSD begins at 1. The index of color mode No.1 is 0.

calibrationResultId
required
string

An identifier of the calibration result.

Responses

Response samples

Content type
application/json
{
  • "validationResults": [
    ]
}

Gets the key lock setting.

path Parameters
monitorId
required
string
Example: cg279x_12345678

An identifier of the control target monitor.

Responses

Response samples

Content type
application/json
{
  • "keyLock": "OFF"
}

Changes the key lock setting.

path Parameters
monitorId
required
string
Example: cg279x_12345678

An identifier of the control target monitor.

Request Body schema: application/json
keyLock
required
string
Enum: "OFF" "MENU" "ALL"

Key lock setting.

Responses

Request samples

Content type
application/json
{
  • "keyLock": "OFF"
}

Get pixel information of specified coordinate.

During executing this API, blanking occurs for about 3 to 5 seconds when getting the coordinate values. Pixel Inspection is only available on the following monitors.

  • CG2700X (Firmware Version: 10003-00108-10002 or later)
  • CG2700S (Firmware Version: 10007-10004 or later)

Note

  • Only the pixel values of even-numbered coordinates will be available When HDCP is enabled. If you specify an odd value as the coordinate, the coordinate is converted to the coordinate of an even value coordinate in the neighborhood.
  • YCbCr 4:2:0 is not supported. This API returns an error when the input signal format is YCbCr 4:2:0.
path Parameters
monitorId
required
string
Example: cg279x_12345678

An identifier of the control target monitor.

query Parameters
x
required
integer

X coordinate of the target pixel.

y
required
integer

Y coordinate of the target pixel.

show-marker
boolean
Default: true

Indicates whether the cross marker is displayed at the target pixel.

Responses

Response samples

Content type
application/json
{
  • "colorFormat": "RGB",
  • "hdcp": true,
  • "position": {
    },
  • "rawValue": {
    },
  • "convertedRgbFull": {
    }
}

Change the marker state of pixel inspection.

This API can quickly verify coordinates used in the Pixel Inspection feature.

Note

Obtaining coordinates can also be achieved with the GET API by setting the show-marker option to true. However, since the GET API takes time to execute, increasing the number of coordinates to be obtained will significantly increase the required time. By using this function, you can quickly check the coordinates.

path Parameters
monitorId
required
string
Example: cg279x_12345678

An identifier of the control target monitor.

Request Body schema: application/json
marker
required
string
Enum: "SHOW" "HIDE"

When specifying "SHOW" as the value of the marker, you need to include a position object in the request body.

object

Responses

Request samples

Content type
application/json
{
  • "marker": "SHOW",
  • "position": {
    }
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Changes the execution state of SelfCalibration.

path Parameters
monitorId
required
string
Example: cg279x_12345678

An identifier of the control target monitor.

Request Body schema: application/json
action
required
string
Enum: "RUN" "STOP"

Responses

Request samples

Content type
application/json
{
  • "action": "RUN"
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Gets calibration targets associated with the monitor.

path Parameters
monitorId
required
string
Example: cg279x_12345678

An identifier of the control target monitor.

Responses

Response samples

Content type
application/json
{
  • "targets": [
    ]
}

Creates a new calibration target.

path Parameters
monitorId
required
string
Example: cg279x_12345678

An identifier of the control target monitor.

Request Body schema: application/json
name
string

A name of the target.

colorModeName
string or null

A color mode name associated with the target.

required
object

Each parameter of the target.

profileUpdateRule
required
string
Default: "EVERYTIME"
Enum: "EVERYTIME" "CONCRETE"

A new ICC profile creation rule.

  • EVERYTIME: Creates a new ICC profile for every calibration.
  • CONCRETE: Always use the specified ICC profile.
object

A creation policy of the ICC profile.

useTargetNameAsProfileName
required
boolean
Default: false

Indicates whether the target name is used in the ICC profile name.

protection
required
boolean
Default: false

Indicates whether the target can be edited/deleted.

Responses

Request samples

Content type
application/json
{
  • "name": "sample_target",
  • "colorModeName": "CAL1",
  • "parameters": {
    },
  • "profileUpdateRule": "EVERYTIME",
  • "profilePolicy": {
    },
  • "useTargetNameAsProfileName": false,
  • "protection": false
}

Response samples

Content type
application/json
{
  • "id": "1732149a-7415-4882-97b8-8a241d29698e",
  • "name": "sample_target",
  • "colorModeName": "CAL1",
  • "parameters": {
    },
  • "profileUpdateRule": "EVERYTIME",
  • "profilePolicy": {
    },
  • "useTargetNameAsProfileName": false,
  • "protection": false
}