Zigen IP Essentials API RELEASE Ver1.0.9

General notes

API detail

Video Routing Commands Requests

Contains all video routing http requests for the Zigen IP Essentials API.

Leave HDMI Video and Audio Stream

Description

Leave a HDMI video and audio stream from a selected receiver device.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0"
}' "/LeaveHDMIVideoandAudioStream"
POST /LeaveHDMIVideoandAudioStream HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0"
}

Leave All HDMI Video Stream

Description

Leave all HDMI video streams from a selected receiver device.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0"
}
' "/LeaveHDMIVideoStream"
POST /LeaveHDMIVideoStream HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0"
}

Set HDMI Video to Genlock

Description

Set HDMI display mode of a selected receiver device to genlock mode.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0"
}' "/SetHDMIVideotoGenlock"
POST /SetHDMIVideotoGenlock HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0"
}

Set HDMI Video to Genlock Scaling

Description

Set a HDMI display mode of a selected receiver device to genlock scaling mode.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”,
    “video_options”: {
        “size”: {
            “width”: “1280”,
            “height”: “720”
        }
    }
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address
    “video_options” (required)
        “size”
            “width”
                Type: String or integer
                Parameter(String): Must be valid resolution screen width (e.g. “1920”)
                Parameter(integer): Must be valid resolution screen width (e.g. 1920)
            “height”
                Type: String or integer
                Parameter(String): Must be valid resolution screen height (e.g. “1080”)
                Parameter(integer): Must be valid resolution screen height (e.g. 1080)


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0",
	"video_options": {
		"size": {
			"width": "1280", 
			"height": "720"
		}
	}
}' "/SetHDMIVideotoGenlockScaling"
POST /SetHDMIVideotoGenlockScaling HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0",
	"video_options": {
		"size": {
			"width": "1280", 
			"height": "720"
		}
	}
}

Set HDMI Video to Fastswitch

Description

Set a HDMI display mode of a selected receiver device to fastswitch.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”,
    “video_options”: {
        “size”: {
            “width”: “1280”,
            “height”: “720”
        },
        “fps”: “30”
    }
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address
    “video_options” (if omitted, uses selected receiver device EDID defaults)
        “size” (required if video_options not omitted)
            “width”
                Type: String or integer
                Parameter(String): Must be valid resolution screen width (e.g. “1920”)
                Parameter(integer): Must be valid resolution screen width (e.g. 1920)
            “height”
                Type: String or integer
                Parameter(String): Must be valid resolution screen height (e.g. “1080”)
                Parameter(integer): Must be valid resolution screen height (e.g. 1080)
        “fps” (required if video_options not omitted)
            Type: String, integer, or float
            Parameter It can be either an integer (e.g. 50) or a float (50.000) or String (e.g. “60m” (59.94) or “30m” (29.97)) indicates frame rate must be divided by 1.001 (i.e. multiplied by 1000⁄1001).
        “stretch” (optional, false if omitted)
            Type: Boolean
            Parameter: true (ON) or false (OFF)
        “crop” (optional, false if omitted)
            Type: Boolean
            Parameter: true (ON) or false (OFF)


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0",
	"video_options": {
		"size": {
			"height": "720", 
			"width": "1280"
		},
		"fps": "30"
	}
}' "/SetHDMIVideotoFastswitch"
POST /SetHDMIVideotoFastswitch HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0",
	"video_options": {
		"size": {
			"height": "720", 
			"width": "1280"
		},
		"fps": "30"
	}
}

Stop and Free Scaled HDMI Stream

Description

Stop and free HDMI scaled stream from a selected transmitter device.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0"
}' "/StopandFreeScaledHDMIStream"
POST /StopandFreeScaledHDMIStream HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0"
}

Stop and Free All Streams

Description

Stop and free all HDMI video and audio streams from a selected transmitter device.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0"
}' "/StopandFreeHDMIVideoAudioStream"
POST /StopandFreeHDMIVideoAudioStream HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0"
}

Get Device Video Pairs

Description

Retrieve the video device receiver pairs of a selected transmitter device.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0"
}' "/GetDeviceVideoPairs"
POST /GetDeviceVideoPairs HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0"
}

Route HDMI

Description

Route HDMI video and audio stream from a selected source device to a selected destination device with optional options.

Command Usage

Request Format Example:
{
    “source”: “801f12413fa0”,
    “destination”: “801f124166b8”
    “mode”: “genlock scaling”,
    “route audio”: true,
    “video options”: {
        “size”: {
            “width”: 1920,
            “height”: 1080
        },
        “fps”: 30
    }
}
Arguments:
    “source” (required)
        Type: String
        Parameter: MAC address or name of the device.
    “destination” (required)
        Type: String
        Parameter: MAC address or name of the device. Name of group of type ‘video’ can also be specified to route to all eligible members of that group. “ALL_RX” to broadcast to all available receiver devices
    “mode” (optional)
        Type: String
        Parameter: Can be “Genlock”, “Genlock Scaling”, or  “Fastswitch”. (case-insensitive)
    “route audio” (optional)
        Note: If omitted, true by default.
        Type: String
        Parameter: “true” (Route with audio) or “false” (Do not route with audio)
        Type: Boolean
        Parameter: true (Route with audio) or false (Do not route with audio)
    “video options” (optional)
        Type: JSON
        Parameters: Set destination resolution and frames per second. If size is ommited, will scale according to EDID data of destination. If unavaliable, will scale to source parameters. If FPS is omitted, in “genlock scaling” will be set to source, in “fastswitch” will be set to EDID setting of destination.
        “size” (optional)
            “width”
                Type: String or integer
                Parameter(String): Must be valid resolution screen width (e.g. “1920”)
                Parameter(integer): Must be valid resolution screen width (e.g. 1920)
            “height”
                Type: String or integer
                Parameter(String): Must be valid resolution screen height (e.g. “1080”)
                Parameter(integer): Must be valid resolution screen height (e.g. 1080)
        “fps” (optional)
            Type: String, integer, or float
            Parameter It can be either an integer (e.g. 50) or a float (50.000) or String (e.g. “60m” (59.94) or “30m” (29.97)) indicates frame rate must be divided by 1.001 (i.e. multiplied by 1000⁄1001).


curl -X POST -H "Content-Type: application/json" -d '{
	"source": "801f12413fa0",
	"destination": "801f124166b8",
	"mode": "fastswitch",
	"route audio": true,
	"video_options": {
		"size": {
			"width": 1280,
			"height": 720
		},
		"fps" : 30
	}
}' "/RouteHDMI"
POST /RouteHDMI HTTP/1.1
Host: 
Content-Type: application/json

{
	"source": "801f12413fa0",
	"destination": "801f124166b8",
	"mode": "fastswitch",
	"route audio": true,
	"video_options": {
		"size": {
			"width": 1280,
			"height": 720
		},
		"fps" : 30
	}
}

Video Settings Commands Requests

Contains all video settings http requests for the Zigen IPLogic Control Server API.

Set HDCP 2.2 Support

Description

Enable or disable HDCP 2.2 support for a selected transmitter device.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”,
    “mode”: true
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address
    “mode” (required)
        Type: Boolean
        Parameter: true (Enable) or false (Disable)


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0",
	"mode": true
}' "/SetHDCP22Support"
POST /SetHDCP22Support HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0",
	"mode": true
}

Set Scaler Size

Description

Set the scaler size of HDMI scaled stream of a selected transmitter device.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”,
    “width”: 1280,
    “height”: 720
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address
    “width” (required)
        Type: String or integer
        Parameter(String): Must be valid resolution screen width (e.g. “1920”)
        Parameter(integer): Must be valid resolution screen width (e.g. 1920)
    “height” (required)
        Type: String or integer
        Parameter(String): Must be valid resolution screen height (e.g. “1080”)
        Parameter(integer): Must be valid resolution screen height (e.g. 1080)


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0",
	"width": 1280,
	"height": 720 
}' "/SetScalerSize"
POST /SetScalerSize HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0",
	"width": 1280,
	"height": 720 
}

Set Scaled Stream Frame Rate Conversion

Description

Enable or disable HDMI scaled stream frame rate divide by 2 option for a selected transmitter device.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”,
    “mode”: true
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address
    “mode” (required)
        Type: Boolean
        Parameter: true (Enable) or false (Disable)


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0",
	"mode": true
}' "/SetScaledStreamFrameRateConversion"
POST /SetScaledStreamFrameRateConversion HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0",
	"mode": true
}

Set Native Stream Frame Rate Conversion

Description

Enable or disable HDMI native stream frame rate divide by 2 option for a selected transmitter device.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”,
    “mode” true
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address
    “mode” (required)
        Type: Boolean
        Parameter: true (Enable) or false (Disable)


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0",
	"mode": true
}' "/SetNativeStreamFrameRateConversion"
POST /SetNativeStreamFrameRateConversion HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0",
	"mode": true
}

Set Auto Scale

Description

Enable or disable auto-scaling for a selected receiver device.

Command Usage

Request Format Example:
{
    “receiver_mac”: “801f12413fa0”,
    “autoscale”: true
}
Arguments:
    “receiver_mac” (required)
        Type: String
        Parameter: MAC address
    “autoscale” (required)
        Type: Boolean
        Parameter: true (Enable) or false (Disable)


curl -X POST -H "Content-Type: application/json" -d '{
	"receiver_mac": "801f12413fa0",
	"autoscale": true
}' "/SetAutoScale"
POST /SetAutoScale HTTP/1.1
Host: 
Content-Type: application/json

{
	"receiver_mac": "801f12413fa0",
	"autoscale": true
}

Get Auto Scale

Description

Retrieve the auto scale value for a selected receiver device.

Command Usage

Request Format Example:
{
    “receiver_mac”: “801f12413fa0”
}
Arguments:
    “receiver_mac” (required)
        Type: String
        Parameter: MAC address


curl -X POST -H "Content-Type: application/json" -d '{
	"receiver_mac": "801f12413fa0"
}' "/GetAutoScale"
POST /GetAutoScale HTTP/1.1
Host: 
Content-Type: application/json

{
	"receiver_mac": "801f12413fa0"
}

Set Route with Audio

Description

Enable or disable route with audio value for a selected receiver device.

Command Usage

Request Format Example:
{
    “receiver_mac”: “801f12413fa0”,
    “route audio”: true
}
Arguments:
    “receiver_mac” (required)
        Type: String
        Parameter: MAC address
    “route audio” (required)
        Type: Boolean
        Parameter: true (Enable) or false (Disable)


curl -X POST -H "Content-Type: application/json" -d '{
	"receiver_mac": "801f12413fa0",
	"route audio": true
}' "/SetRouteWithAudio"
POST /SetRouteWithAudio HTTP/1.1
Host: 
Content-Type: application/json

{
	"receiver_mac": "801f12413fa0",
	"route audio": true
}

Get Route with Audio

Description

Retrieve the route with audio value for a selected receiver device.

Command Usage

Request Format Example:
{
    “receiver_mac”: “801f12413fa0”
}
Arguments:
    “receiver_mac” (required)
        Type: String
        Parameter: MAC address


curl -X POST -H "Content-Type: application/json" -d '{
	"receiver_mac": "801f12413fa0"
}' "/GetRouteWithAudio"
POST /GetRouteWithAudio HTTP/1.1
Host: 
Content-Type: application/json

{
	"receiver_mac": "801f12413fa0"
}

Get Last Video Mode

Description

Retrieve the last video mode, resolution, and frame rate for a selected receiver device.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address


curl -X POST -H "Content-Type: application/json" -d '{
	"mac":"801f12413fa0"
}' "/GetLastVidMode"
POST /GetLastVidMode HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac":"801f12413fa0"
}

Edid Management Commands Requests

Contains all EDID management http requests for the Zigen IP Essentials API.

Set Manual EDID

Description

Set to configure the EDID manually for a selected transmitter device, where selection contains 5 default presets, receiver’s MAC address, and any custom EDID selection created by user.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”,
    “selection”: “1080p60 SDR”,
    “modifyAudio”: “No”,
    “allowDTS”: “No”,
    “allowDolby”: “No”
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address (Transmitters Only) or “ALL_TX”
    “selection” (required)
        Type: String
        Parameter: “1080p60 SDR”, “2160p30 HDR”, “2160p30 SDR”, “2160p60 HDR”, “2160p60 SDR”, Receivers MAC address, or User-defined EDID name
    “modifyAudio” (required)
        Type: String
        Parameter: “Yes” or “No”
    “allowDTS” (required)
        Type: String
        Parameter: “Yes” or “No”
    “allowDolby” (required)
        Type: String
        Parameter: “Yes” or “No”


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0",
	"selection": "1080p60 SDR",
	"modifyAudio": "Yes",
	"allowDTS": "No",
	"allowDolby": "No"
}' "/SetManualEDID"
POST /SetManualEDID HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0",
	"selection": "1080p60 SDR",
	"modifyAudio": "Yes",
	"allowDTS": "No",
	"allowDolby": "No"
}

Set Auto EDID

Description

Set the auto-edid and auto-scale setting.

Command Usage

Request Format Example:
{
    “mode”: “Native”,
    “modifyAudio”: “Yes”,
    “allowDTS”: “No”,
    “allowDolby”: “No”
}
Arguments:
    “mode” (required)
        Type: String
        Parameter: “Native” or “Compatibilty”
    “modifyAudio” (required)
        Type: String
        Parameter: “Yes” or “No”
    “allowDTS” (required)
        Type: String
        Parameter: “Yes” or “No”
    “allowDolby” (required)
        Type: String
        Parameter: “Yes” or “No”


curl -X POST -H "Content-Type: application/json" -d '{
	"mode": "Compatibility",
	"modifyAudio": "Yes",
	"allowDTS": "No",
	"allowDolby": "No"
}' "/SetAutoEDID"
POST /SetAutoEDID HTTP/1.1
Host: 
Content-Type: application/json

{
	"mode": "Compatibility",
	"modifyAudio": "Yes",
	"allowDTS": "No",
	"allowDolby": "No"
}

Upload EDID

Description

Upload custom EDID binary file.

Command Usage

Request Format Example:
    Select File
Arguments:
    Select File (required)
        Type: File
        Parameter: Binary file must be 128 or 256 bytes


curl -X POST "/UploadEDID"
POST /UploadEDID HTTP/1.1
Host:

Get Custom EDID

Description

Retrieves all the custom EDID names and custom EDID json-format data from the IP Essentials.

Command Usage

Request Format Example:
{



}
Arguments:
    None


curl -X POST -H "Content-Type: application/json" -d '{
	
}' "/GetCustomEDID"
POST /GetCustomEDID HTTP/1.1
Host: 
Content-Type: application/json

{
	
}

Get EDID Settings

Description

Retrieves current EDID settings which includes Mode, modifyAudio, allowDolby, and allowDTS.

Command Usage

Request Format Example:
{



}
Arguments:
    None


curl -X POST -H "Content-Type: application/json" -d '{
	
}' "/GetEDIDSettings"
POST /GetEDIDSettings HTTP/1.1
Host: 
Content-Type: application/json

{
	
}

Audio Routing Commands Requests

Contains all audio routing http requests for the Zigen IP Essentials API.

Set AES67 Network

Description

Setup the AES67 network by setting the mode and ip for a selected transmitter device.

Command Usage

Request Format:
{
    “mac”: “801f12413fa0”,
    “mode”: “static”,
    “ip_address”: “192.168.0.10”,
    “subnet_mask”: “255.255.255.0”,
    “default_gateway”: “192.168.0.1”
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address
    “mode” (required)
        Type: String
        Parameter: “static” or “dhcp”
    “ip_address” (required if “mode” is static)
        Type: String
        Parameter: A valid IP address
    “subnet_mask” (required if “mode” is static)
        Type: String
        Parameter: A valid subnet mask
    “default_gateway” (required if “mode” is static)
        Type: String
        Parameter: A valid default gateway


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0",
	"mode": "static",
	"ip_address": "192.168.0.10",
	"subnet_mask": "255.255.255.0",
	"default_gateway": "192.168.0.1"
}' "/SetAES67Network"
POST /SetAES67Network HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0",
	"mode": "static",
	"ip_address": "192.168.0.10",
	"subnet_mask": "255.255.255.0",
	"default_gateway": "192.168.0.1"
}

Leave AES67 Stream

Description

Leaves the AES67 stream from a selected transmitter device, used for AES67 audio routing.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0"
}' "/LeaveAES67Stream"
POST /LeaveAES67Stream HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0"
}

Get AES67 Network

Description

Retrieves the AES67 network IP address from a selected transmitter device.

Command Usage

Request Format:
{
    “mac”: “801f12413fa0”
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0"
}' "/GetAES67Network"
POST /GetAES67Network HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0"
}

Leave I2S Audio Stream

Description

Leave I2S audio stream from a selected device, used for Audio Return Channel (ARC), Toslink, or Analog audio routing.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0"
}' "/LeaveI2SAudioStream"
POST /LeaveI2SAudioStream HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0"
}

Leave HDMI Audio Stream

Description

Leave a HDMI audio stream from a selected receiver device, used for HDMI IN to HDMI OUT audio routing.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0"
}' "/LeaveHDMIAudioStream"
POST /LeaveHDMIAudioStream HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0"
}

Route Audio Stream

Description

Route audio stream of a selected source device to a selected destination device, audio device group, or broadcast to a specific type of devices where the audio is automatically routed through either HDMI IN to HDMI OUT, HDMI Local, AES67, Audio Return Channel (ARC), Toslink, or Analog. The “args” only needed when choosing to route audio to either ARC, Toslink, or Analog.

Command Usage

Request Format Example:
{
    “source”: “801f12413fa0”,
    “destination”: “801f12413fa0”,
    “args”: {
        “receiver_source”: “TOSLINK”
    }
}
Arguments:
    “source” (required)
        Type: String
        Parameter: MAC address or name of the device.
    “destination”: (required)
        Type: String
        Parameter: MAC address or name of the device. Name of group of type ‘audio’ can also be specified to route to all eligible members of that group. “ALL_RX” to broadcast to all available receiver devices.
        “ALL_TX” to broadcast to all available transmitter devices.
        “ALL” to broadcast to all available devices.
    “args” (required if source is a receiver device)
        “receiver_source”
            Type: String
            Parameter: “TOSLINK” (Toslink), “ARC” (ARC), or “ANALOG” (Analog)


curl -X POST -H "Content-Type: application/json" -d '{
	"source": "801f12413fa0",
	"destination": "801f12413fa0",
	"args": {
		"receiver_source": "TOSLINK"
	}
}' "/RouteAudioStream"
POST /RouteAudioStream HTTP/1.1
Host: 
Content-Type: application/json

{
	"source": "801f12413fa0",
	"destination": "801f12413fa0",
	"args": {
		"receiver_source": "TOSLINK"
	}
}

Get Device Audio Source

Description

Retrieve audio source for either a receiver or transmitter device.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0"
}' "/GetDeviceAudio"
POST /GetDeviceAudio HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0"
}

Audio Settings Commands Requests

Contains all audio http requests for the Zigen IP Essentials API.

Get Audio Info

Description

Retrieve audio information for a selected transmitter device.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0"
}' "/GetAudioInfo"
POST /GetAudioInfo HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0"
}

Set Audio Volume Level

Description

Set the audio volume level of a selected transmitter device.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”,
    “group”: null,
    “volume”: 50
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address or null (When “mac” is a given MAC address, “group” is ignored.)
    “group” (optional)
        Type: String
        Parameter: “transmitter”, “receiver”, “all”, or null
    “volume” (required)
        Type: integer
        Parameter: 0 to 100 (0% to 100%)


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0",
	"volume": 50
}' "/SetAudioVolLvl"
POST /SetAudioVolLvl HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0",
	"volume": 50
}

Set Audio Mute

Description

Set the audio mute of a selected transmitter device to either ON (mute) or OFF (unmute).

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”,
    “group”: null,
    “mute”: true
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address or null (When “mac” is a given MAC address, “group” is ignored.)
    “group” (optional)
        Type: String
        Parameter: “transmitter”, “receiver”, “all”, or null
    “volume” (required)
        Type: Boolean
        Parameter: true (for mute) or false (for unmute)


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0",
	"mute": true
}' "/SetAudioMute"
POST /SetAudioMute HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0",
	"mute": true
}

Set Audio Tune Control

Description

Set the Audio tune control of a selected transmitter device to either Disabled, Presets, Graphic EQ, or Tone Control.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”,
    “mode”: “disabled”
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address or null (When “mac” is a given MAC address, “group” is ignored.)
    “mode” (required)
        Type: String
        Parameter: “disabled” (Disabled), “presets” (Presets), “equalizer” (Graphic EQ), or “tonecontrol” (Tone Control)


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0",
	"mode": "disabled"
}' "/SetAudioTuneCtrl"
POST /SetAudioTuneCtrl HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0",
	"mode": "disabled"
}

Set Audio Preset

Description

Set audio preset of a selected transmitter device to either Flat, Rock, Classical, Dance, or Acoustic.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”,
    “group”: null,
    “preset”: “flat”
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address or null (When “mac” is a given MAC address, “group” is ignored.)
    “group” (optional)
        Type: String
        Parameter: “transmitter”, “receiver”, “all”, or null
    “preset” (required)
        Type: String
        Parameter: “flat” (Flat), “rock” (Rock), “classical” (Classical), “dance” (Dance), or “acoustic” (Acoustic)


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0",
	"preset": "flat"
}' "/SetAudioPreset"
POST /SetAudioPreset HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0",
	"preset": "flat"
}

Set Audio Equalizer Bands

Description

Set audio equalizer bands of a selected transmitter device where the frequency bands (top to bottom) are 115Hz, 330Hz, 990Hz, 3000Hz, 9900Hz where the “bands” values are in dB.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”,
    “group”: null,
    “bands”: [
        0,
        2.5,
        -5,
        7.5,
        10
    ]
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address or null (When “mac” is a given MAC address, “group” is ignored.)
    “group” (optional)
        Type: String
        Parameter: “transmitter”, “receiver”, “all”, or null
    “bands” (required)
        Type: integer
        Parameter: -11.75 to 12 (step size of 0.25 and must contain an array size of 5)


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0",
	"bands": [
		0,
		2.5,
		-5,
		7.5,
		10
	]
}' "/SetAudioEqBands"
POST /SetAudioEqBands HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0",
	"bands": [
		0,
		2.5,
		-5,
		7.5,
		10
	]
}

Set Audio Tone Control

Description

Set audio tone control of the bass and treble of a selected transmitter device where the “bass” and “treble” value is in dB.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”,
    “group”: null,
    “tone”: {
        “bass”: 0,
        “treble”: 12
    }
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address or null (When “mac” is a given MAC address, “group” is ignored.)
    “group” (optional)
        Type: String
        Parameter: “transmitter”, “receiver”, “all”, or null
    “tone” (required)
        Type: integer
        Parameter: -11.75 to 12 (step size of 0.25 for “bass” and “treble” in “tone”)


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0",
	"tone": {
		"bass": 0,
		"treble": 12
	}
}' "/SetAudioToneCtrl"
POST /SetAudioToneCtrl HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0",
	"tone": {
		"bass": 0,
		"treble": 12
	}
}

Set Audio Surround Control

Description

Set audio surround control toggle ON or OFF of a selected transmitter device.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”,
    “group”: null,
    “surround”: true
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address or null (When “mac” is a given MAC address, “group” is ignored.)
    “group” (optional)
        Type: String
        Parameter: “transmitter”, “receiver”, “all”, or null
    “surround” (required)
        Type: Boolean
        Parameter: true (ON) or false (OFF)


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0",
	"surround": true
}' "/SetAudioSurroundCtrl"
POST /SetAudioSurroundCtrl HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0",
	"surround": true
}

Set Audio Surround Level

Description

Set audio surround level between a range of narrow to wide for a selected transmitter device.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”,
    “group”: null,
    “surrlevel”: 0
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address or null (When “mac” is a given MAC address, “group” is ignored.)
    “group” (optional)
        Type: String
        Parameter: “transmitter”, “receiver”, “all”, or null
    “surrlevel” (required)
        Type: integer
        Parameter: 0 to 7 (Narrow to Wide)


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0",
	"surrlevel": 0
}' "/SetAudioSurroundLvl"
POST /SetAudioSurroundLvl HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0",
	"surrlevel": 0
}

Set Audio Bass Control

Description

Set audio bass enhancement control either ON or OFF for a selected transmitter device.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”,
    “group”: null,
    “bass”: true
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address or null (When “mac” is a given MAC address, “group” is ignored.)
    “group” (optional)
        Type: String
        Parameter: “transmitter”, “receiver”, “all”, or null
    “bass” (required)
        Type: Boolean
        Parameter: true (ON) or false (OFF)


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0",
	"bass": true
}' "/SetAudioBassCtrl"
POST /SetAudioBassCtrl HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0",
	"bass": true
}

Set Audio Bass Cutoff Frequency

Description

Set audio bass cutoff frequency (in Hz) of a selected transmitter device.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”,
    “group”: null,
    “freq”: 200
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address or null (When “mac” is a given MAC address, “group” is ignored.)
    “group” (optional)
        Type: String
        Parameter: “transmitter”, “receiver”, “all”, or null
    “freq” (required)
        Type: integer
        Parameter: 75 to 225 (step size of 25)


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0",
	"freq": 200
}' "/SetAudioBassCutoffFreq"
POST /SetAudioBassCutoffFreq HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0",
	"freq": 200
}

Set Audio Bass HighPass Control

Description

Set audio bass high pass control to either enable (set same as cut-off frequency) or disable (to bypass high-pass frequency) the high-pass cut-off frequency for a selected transmitter device.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”,
    “group”: null,
    “highpass”: true
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address or null (When “mac” is a given MAC address, “group” is ignored.)
    “group” (optional)
        Type: String
        Parameter: “transmitter”, “receiver”, “all”, or null
    “highpass” (required)
        Type: Boolean
        Parameter: true (same as cut-off frequency) or false (bypass high-pass frequency)


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0",
	"highpass": true
}' "/SetAudioBassHighPassCtrl"
POST /SetAudioBassHighPassCtrl HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0",
	"highpass": true
}

Set Audio Bass Level

Description

Set audio bass effect level of a selected transmitter device.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”,
    “group”: null,
    “basslevel”: 0
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address or null (When “mac” is a given MAC address, “group” is ignored.)
    “group” (optional)
        Type: String
        Parameter: “transmitter”, “receiver”, “all”, or null
    “basslevel” (required)
        Type: integer
        Parameter: 0 to 127 (Less bass to More bass)


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0",
	"basslevel": 7
}' "/SetAudioBassLvl"
POST /SetAudioBassLvl HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0",
	"basslevel": 7
}

Set Audio Delay Control

Description

Enable or disable the ability for audio delay for a selected transmitter device.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”,
    “group”: null,
    “delay”: true
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address or null (When “mac” is a given MAC address, “group” is ignored.)
    “group” (optional)
        Type: String
        Parameter: “transmitter”, “receiver”, “all”, or null
    “delay” (required)
        Type: Boolean
        Parameter: true (ON) or false (OFF)


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0",
	"delay": true
}' "/SetAudioDelayCtrl"
POST /SetAudioDelayCtrl HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0",
	"delay": true
}

Set Audio Delay Value

Description

Set audio delay time value of a selected transmitter device.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”,
    “group”: null,
    “milisec”: 0
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address or null (When “mac” is a given MAC address, “group” is ignored.)
    “group” (optional)
        Type: String
        Parameter: “transmitter”, “receiver”, “all”, or null
    “milisec” (required)
        Type: integer
        Parameter: 0 to 680 (time in milliseconds)


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0",
	"milisec": 500
}' "/SetAudioDelayVal"
POST /SetAudioDelayVal HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0",
	"milisec": 500
}

Set Audio Analog Mode

Description

Set analog audio mode to balanced, unbalanced, or mic IN (works for receiver devices ONLY) for a selected transmitter device or selected receiver device.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”,
    “analog_mode”: “balanced”
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address
    “analog_mode” (required)
        Type: String
        Parameter: “balanced” (Balanced mode), “unbalanced” (Unbalanced mode), or “mic_in” (Mic IN, works for receiver devices ONLY)


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0",
	"analog_mode": "balanced"
}' "/SetAudioAnalogMode"
POST /SetAudioAnalogMode HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0",
	"analog_mode": "balanced"
}

Multiview Commands Requests

Contains all multiview http requests for the Zigen IP Essentials API.

Leave Multiview Streams

Description

Leave all multiview streams on a selected receiver device.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0"
}' "/LeaveMultiviewStreams"
POST /LeaveMultiviewStreams HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0"
}

Enable Scaled Stream

Description

Enable and set the scaler of a selected transmitter device for the scaled stream for multiview.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”,
    “width”: 1920,
    “height”: 1080
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address
    “width” (required)
        Type: String or integer
        Parameter(String): Must be valid resolution screen width (e.g. “1920”)
        Parameter(integer): Must be valid resolution screen width (e.g. 1920)
    “height” (required)
        Type: String or integer
        Parameter(String): Must be valid resolution screen height (e.g. “1080”)
        Parameter(integer): Must be valid resolution screen height (e.g. 1080)


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0",
	"width": 1920,
	"height": 1080
}' "/EnableScaledStream"
POST /EnableScaledStream HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0",
	"width": 1920,
	"height": 1080
}

Modify Layout Window

Description

Modify a layout window for a specific layout to be able to change its current size and position and update the layout for a selected receiver device.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”,
    “size”: {
        “width”: 1920,
        “height”: 1080
    },
    “position”: {
        “horizontal”: 64,
        “vertical”: 64
    },
    “layout_number”: 0,
    “window_priority”: 0,
    “receiver_index”: 0,
    “fps”: 30
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address
    “size” (required)
        Type: integer
        Parameter:
            “width”: Must be valid resolution screen width (e.g. 1920)
            “height”: Must be valid resolution screen height (e.g. 1080)
    “position” (required)
        Type: integer
        Parameter:
            “horizontal”: value >= 0 && value < size’s width
            “vertical”: value >= 0 && value < size’s height
    “layout_number”: (optional)
        Type: String or Integer
        Parameter: >= 0
        Note: Default is 0. For future implementation, No other current layout number is affected with “layout_number” besides 0.
    “window_priority”: (optional)
        Type: String or Integer
        Parameter: A value from 0 to 31 (where the lowest number is display in the foreground of all other video sources)
        Note: Default is 0. For future implementation, No other window_priority value is affected with “window_priority” besides 0.
    “receiver_index”: (optional)
        Type: String or Integer
        Parameter: A value from 0 to 31 (which signifies where to place the source video in the receiver subscription list) Note: Using the same value for “receiver_index” for same multiview layout means to clone same source video to multiple positions in the multiview layout.
        Note: Default is 0. For future implementation, No other receiver_index value is affected with “receiver_index” besides 0.
    “fps” (optional)
        Type: String, integer, or float
        Parameter It can be either an integer (e.g. 50) or a float (50.000) or String (e.g. “60m” (59.94) or “30m” (29.97)) indicates frame rate must be divided by 1.001 (i.e. multiplied by 1000⁄1001).


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0",
	"size": {
		"width": 1920,
		"height": 1080
	},
	"position": {
		"horizontal": 64,
		"vertical": 64
	},
	"layout_number": 0,
	"window_priority": 0,
	"receiver_index": 0,
	"fps": 30
}' "/ModifyWindowLayout"
POST /ModifyWindowLayout HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0",
	"size": {
		"width": 1920,
		"height": 1080
	},
	"position": {
		"horizontal": 64,
		"vertical": 64
	},
	"layout_number": 0,
	"window_priority": 0,
	"receiver_index": 0,
	"fps": 30
}

Set Receiver to Multiview

Description

Set selected receiever device to selected multiview layout.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”,
    “layout_number”: 0,
    “fps”: “30”
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address
    “layout_number” (required)
        Type: integer
        Parameter: value >= 0
    “fps” (optional)
        Type: String, integer, or float
        Parameter It can be either an integer (e.g. 50) or a float (50.000) or String (e.g. “60m” (59.94) or “30m” (29.97)) indicates frame rate must be divided by 1.001 (i.e. multiplied by 1000⁄1001). (if omitted, default is 30)


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0",
	"layout_number": 0,
	"fps": 30
}' "/SetReceivertoMultiview"
POST /SetReceivertoMultiview HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0",
	"layout_number": 0,
	"fps": 30
}

Join Scaled Video to Multiview

Description

Join scaled stream video of a selected transmitter device to a selected position on the multiview layout of the receiver device.

Command Usage

Request Format Example:
{
    “transmitter_mac”: “801f12413fa0”,
    “receiver_mac”: “801f124166b8”,
    “layout_number”: 0,
    “receiver_index”: 0
}
Arguments:
    “transmitter_mac” (required)
        Type: String
        Parameter: MAC address
    “receiver_mac” (required)
        Type: String
        Parameter: MAC address
    “layout_number” (required)
        Type: integer
        Parameter: value >= 0
    “receiver_index” (required)
        Type: integer
        Parameter: value >= 0
    “force” (optional)
        Type: Boolean
        Parameter: true (To remove transmitter from one or more different layouts with different size.) or false (To leave transmitter from one or more different layouts with different size.)


curl -X POST -H "Content-Type: application/json" -d '{
	"transmitter_mac": "801f12413fa0",
	"receiver_mac": "801f124166b8",
	"layout_number": 0,
	"receiver_index": 0
}' "/JoinScaledVideotoMultiview"
POST /JoinScaledVideotoMultiview HTTP/1.1
Host: 
Content-Type: application/json

{
	"transmitter_mac": "801f12413fa0",
	"receiver_mac": "801f124166b8",
	"layout_number": 0,
	"receiver_index": 0
}

Leave HDMI Video Stream By Mac

Description

Leave HDMI video stream 1 of a selected receiver device (source) from a selected transmitter device (destination).

Command Usage

Request Format Example:
{
    “source”: “801f12413fa0”,
    “destination”: “801f124166b8”
}
Arguments:
    “source” (required)
        Type: String
        Parameter: MAC address
    “destination” (required)
        Type: String
        Parameter: MAC address


curl -X POST -H "Content-Type: application/json" -d '{
	"source": "801f12413fa0",
	"destination": "801f124166b8"
}' "/LeaveHDMIVideoStreamByMac"
POST /LeaveHDMIVideoStreamByMac HTTP/1.1
Host: 
Content-Type: application/json

{
	"source": "801f12413fa0",
	"destination": "801f124166b8"
}

Get Receiver Multiview

Description

Get the multiview layout index, layout name, and current video subscriptions of a selected receiver device.

Command Usage

Request Format Example:
{
    “receiver_mac”: “801f12413fa0”
}
Arguments:
    “receiver_mac” (required)
        Type: String
        Parameter: MAC address


curl -X POST -H "Content-Type: application/json" -d '{
	"receiver_mac": "801f12413fa0"
}' "/GetReceiverMultiview"
POST /GetReceiverMultiview HTTP/1.1
Host: 
Content-Type: application/json

{
	"receiver_mac": "801f12413fa0"
}

Wall Routing Commands Requests

Contains all wall routing http requests for the Zigen IP Essentials API.

Get Bezel State

Description

Retrieve bezel information of a selected receiver device.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0"
}' "/GetBezelState"
POST /GetBezelState HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0"
}

Save Bezel State

Description

Save bezel information for a selected receiver device.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”,
    “bezel_correction”: {
        “left”: 0,
        “right”: 0,
        “top”: 0,
        “bottom”: 0
    },
    “bezel_format”: “percentage”
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address
    “bezel_correction” (required)
        Type: String or integer
        Parameter(String):
            “left”
                From “0” to “480” in Pixel Format
                From “0” to “25” in Percentage Format
            “right”
                From “0” to “480” in Pixel Format
                From “0” to “25” in Percentage Format
            “top”
                From “0” to “270” in Pixel Format
                From “0” to “25” in Percentage Format
            “bottom”
                From “0” to “270” in Pixel Format
                From “0” to “25” in Percentage Format
        Parameter(integer):
            “left”
                From 0 to 480 in Pixel Format
                From 0 to 25 in Percentage Format
            “right”
                From 0 to 480 in Pixel Format
                From 0 to 25 in Percentage Format
            “top”
                From 0 to 270 in Pixel Format
                From 0 to 25 in Percentage Format
            “bottom”
                From 0 to 270 in Pixel Format
                From 0 to 25 in Percentage Format
    “bezel_format” (required)
        Type: String
        Parameter(String): “percentage” or “pixel” (case-insensitive)


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0",
	"bezel_correction": {
		"left": 0,
		"right": 0,
		"top": 0,
		"bottom": 0
	},
	"bezel_format": "percentage"
}' "/SaveBezelState"
POST /SaveBezelState HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0",
	"bezel_correction": {
		"left": 0,
		"right": 0,
		"top": 0,
		"bottom": 0
	},
	"bezel_format": "percentage"
}

Apply Video Wall

Description

Apply either genlock wall mode or fastswitch wall mode to all receivers on the video wall of a selected transmitter device.

Command Usage

Request Format Example:
{
    “transmitter_mac”: “801f12413fa0”,
    “wall_size”: [2, 2],
    “mode”: “fastswitch”,
    “aspect_ratio”: “stretch”,
    “receiver_list”: [
        null,
        {
            “mac”: “801f124166b8”
        },
        {
            “mac”: “801f12419471”,
            “video options”: {
                “fps”: 30
            }
        },
        null
    ]
}
Arguments:
    “transmitter_mac” (required)
        Type: String
        Parameter: MAC address
    “wall_size” (required)
        Type: Array of Integer (Array length of 2)
        Parameter(integer): [wall_width, wall_height]
    “mode” (required)
        Type: String
        Parameter: “fastswitch” (Fastswitch Wall mode) or “genlock” (Genlock Wall mode)
    “aspect_ratio” (required)
        Type: String
        Parameter: “keep” (Keep aspect ratio by adding black bars to wall) or “stretch” (Stretch to cover entire wall with no black bars added)
    “receiver_list” (required)
        Type: Array (Array size based on area of “wall_width” x “wall_height”)
        Note: Index 0 of the array refer to the top-left monitor while the last index would refer to the bottom right monitor. The progression is left to right, top to bottom. Add null to array list to leave that position on the wall empty.
        Parameter:
            “mac” (required)
                Type: String
                Parameter: MAC address of a receiver device
            “video options” (optional)
                Type: JSON String
                Parameter:
                “size” (optional)
                    “width” (required if “size” is not omitted)
                        Type: Integer
                        Parameter(Integer): Must be valid resolution screen width (e.g. 1920)
                    “height” (required if “size” is not omitted)
                        Type: Integer
                        Parameter(Integer): Must be valid resolution screen height (e.g. 1080)
                “fps” (optional)
                    Type: String, integer, or float
                    Parameter It can be either an integer (e.g. 50) or a float (50.000) or String (e.g. “60m” (59.94) or “30m” (29.97)) indicates frame rate must be divided by 1.001 (i.e. multiplied by 1000⁄1001).


curl -X POST -H "Content-Type: application/json" -d '{
	"transmitter_mac": "801f12413fa0",
	"wall_size": [2, 2],
	"mode": "fastswitch",
	"receiver_list": [
        null,
        {
            "mac": "801f124166b8"
        },
        {
        	"mac": "801f12419471",
        	"video options": {
        		"fps": 30
        	}
        },
        null
    ]
}' "/ApplyVideoWall"
POST /ApplyVideoWall HTTP/1.1
Host: 
Content-Type: application/json

{
	"transmitter_mac": "801f12413fa0",
	"wall_size": [2, 2],
	"mode": "fastswitch",
	"receiver_list": [
        null,
        {
            "mac": "801f124166b8"
        },
        {
        	"mac": "801f12419471",
        	"video options": {
        		"fps": 30
        	}
        },
        null
    ]
}

Infrared Routing Commands Request

Contains all infrared http requests for the Zigen IP Essentials API.

Save Infrared Command

Description

Saves the infrared command to the IP Essentials.

Command Usage

Request Format Example:
{
    “name”: “Command 1”,
    “code”: “0000 006d 0026 0000 0155 00aa 0016 0015 0016 0015 0016 0040 0016 0015 0016 0015 0016 0015 0016 0014 0016 0015 0016 0040 0016 0040 0016 0015 0016 0040 0016 0040 0016 0040 0016 0040 0016 0040 0016 0015 0016 0015 0016 0040 0016 0015 0016 0015 0016 0015 0016 0040 0016 0040 0016 0040 0016 0040 0016 0015 0016 0040 0016 0040 0016 0040 0016 0014 0016 0015 0016 060b 0155 0055 0016 0e58 0155 0055 0016 00aa”
}
Arguments:
    “name” (required)
        Type: String
        Parameter: User-defined name (Must be unique)
    “code” (required)
        Type: String
        Parameter: ASCII-based (No more than 1000 characters)


curl -X POST -H "Content-Type: application/json" -d '{
	"name": "HELLO",
	"code": "0000 006d 0026 0000 0155 00aa 0016 0015 0016 0015 0016 0040 0016 0015 0016 0015 0016 0015 0016 0014 0016 0015 0016 0040 0016 0040 0016 0015 0016 0040 0016 0040 0016 0040 0016 0040 0016 0040 0016 0015 0016 0015 0016 0040 0016 0015 0016 0015 0016 0015 0016 0040 0016 0040 0016 0040 0016 0040 0016 0015 0016 0040 0016 0040 0016 0040 0016 0014 0016 0015 0016 060b 0155 0055 0016 0e58 0155 0055 0016 00aa"
}' "/SaveInfraredCommand"
POST /SaveInfraredCommand HTTP/1.1
Host: 
Content-Type: application/json

{
	"name": "HELLO",
	"code": "0000 006d 0026 0000 0155 00aa 0016 0015 0016 0015 0016 0040 0016 0015 0016 0015 0016 0015 0016 0014 0016 0015 0016 0040 0016 0040 0016 0015 0016 0040 0016 0040 0016 0040 0016 0040 0016 0040 0016 0015 0016 0015 0016 0040 0016 0015 0016 0015 0016 0015 0016 0040 0016 0040 0016 0040 0016 0040 0016 0015 0016 0040 0016 0040 0016 0040 0016 0014 0016 0015 0016 060b 0155 0055 0016 0e58 0155 0055 0016 00aa"
}

Send Infrared Command

Description

Send a infrared command from the IP Essentials to a selected device.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”,
    “code”: “0000 006d 0026 0000 0155 00aa 0016 0015 0016 0015 0016 0040 0016 0015 0016 0015 0016 0015 0016 0014 0016 0015 0016 0040 0016 0040 0016 0015 0016 0040 0016 0040 0016 0040 0016 0040 0016 0040 0016 0015 0016 0015 0016 0040 0016 0015 0016 0015 0016 0015 0016 0040 0016 0040 0016 0040 0016 0040 0016 0015 0016 0040 0016 0040 0016 0040 0016 0014 0016 0015 0016 060b 0155 0055 0016 0e58 0155 0055 0016 00aa”
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address
    “code” (required)
        Type: String
        Parameter: HEX code (Works with spaces and w/o spaces)


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0",
	"code": "0000 006d 0026 0000 0155 00aa 0016 0015 0016 0015 0016 0040 0016 0015 0016 0015 0016 0015 0016 0014 0016 0015 0016 0040 0016 0040 0016 0015 0016 0040 0016 0040 0016 0040 0016 0040 0016 0040 0016 0015 0016 0015 0016 0040 0016 0015 0016 0015 0016 0015 0016 0040 0016 0040 0016 0040 0016 0040 0016 0015 0016 0040 0016 0040 0016 0040 0016 0014 0016 0015 0016 060b 0155 0055 0016 0e58 0155 0055 0016 00aa"
}' "/SendInfraredCommand"
POST /SendInfraredCommand HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0",
	"code": "0000 006d 0026 0000 0155 00aa 0016 0015 0016 0015 0016 0040 0016 0015 0016 0015 0016 0015 0016 0014 0016 0015 0016 0040 0016 0040 0016 0015 0016 0040 0016 0040 0016 0040 0016 0040 0016 0040 0016 0015 0016 0015 0016 0040 0016 0015 0016 0015 0016 0015 0016 0040 0016 0040 0016 0040 0016 0040 0016 0015 0016 0040 0016 0040 0016 0040 0016 0014 0016 0015 0016 060b 0155 0055 0016 0e58 0155 0055 0016 00aa"
}

Get Infrared Commands

Description

Retrieve all infrared commands from the IP Essentials.

Command Usage

Request Format Example:
{



}
Arguments:
    None


curl -X GET -H "Content-Type: application/json" "/GetInfraredCommands"
GET /GetInfraredCommands HTTP/1.1
Host: 
Content-Type: application/json

Get Device Infrared Pairs

Description

Retrieve the infrared device destination pairs where the selected device is the source location.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0"
}' "/GetDeviceInfraredPairs"
POST /GetDeviceInfraredPairs HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0"
}

USB Commands Requests

Contains all usb settings http requests for the Zigen IP Essentials API.

Set USB Static Mode

Description

Set a selected device to static mode for USB for network settings.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”,
    “ip_address”: “192.168.0.10”,
    “subnet_mask”: “255.255.255.0”,
    “default_gateway”: “192.168.0.1”
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address
    “ip_address” (required)
        Type: String
        Parameter: A valid IP address
    “subnet_mask” (required)
        Type: String
        Parameter: A valid subnet mask
    “default_gateway” (required)
        Type: String
        Parameter: A valid default gateway


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0",
	"ip_address": "192.168.0.10",
	"subnet_mask": "255.255.255.0",
	"default_gateway": "192.168.0.1"
}' "/SetUSBStaticMode"
POST /SetUSBStaticMode HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0",
	"ip_address": "192.168.0.10",
	"subnet_mask": "255.255.255.0",
	"default_gateway": "192.168.0.1"
}

Set USB DHCP

Description

Set a selected device to DHCP mode for USB for network settings.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0"
}' "/SetUSBDHCP"
POST /SetUSBDHCP HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0"
}

Description

Retrieve the USB link status of a selected device.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address

Get USB Config Data

Description

Retrieve the USB configuration information of a selected device.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0"
}' "/GetUSBConfigData"
POST /GetUSBConfigData HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0"
}

Get USB Device Information

Description

Retrieve the USB device information of a selected device.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0"
}' "/GetUSBDeviceInfo"
POST /GetUSBDeviceInfo HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0"
}

Disconnect USB Pair

Description

Disconnect usb pairing of two selected devices where the source is a transmitter device and the destination is a receiver device.

Command Usage

Request Format Example:
{
    “source_mac”: “801f12413fa0”,
    “destination_mac”: “801f124166b8”
}
Arguments:
    “source_mac” (required)
        Type: String
        Parameter: MAC address
    “destination_mac” (required)
        Type: String
        Parameter: MAC address


curl -X POST -H "Content-Type: application/json" -d '{
	"source_mac": "801f12413fa0",
	"destination_mac": "801f124166b8"
}' "/DisconnectUSBPair"
POST /DisconnectUSBPair HTTP/1.1
Host: 
Content-Type: application/json

{
	"source_mac": "801f12413fa0",
	"destination_mac": "801f124166b8"
}

Add USB Force Pair Communication

Description

Force usb pairing of two selected devices by unpairing from all connected devices then pairing the two selected devices where the source is a transmitter device and the destination is a receiver device.

Command Usage

Request Format Example:
{
    “source_mac”: “801f12413fa0”,
    “destination_mac”: “801f124166b8”
}
Arguments:
    “source_mac” (required)
        Type: String
        Parameter: MAC address
    “destination_mac” (required)
        Type: String
        Parameter: MAC address


curl -X POST -H "Content-Type: application/json" -d '{
	"source_mac": "801f12413fa0",
	"destination_mac": "801f124166b8"
}' "/AddUSBForcePairComm"
POST /AddUSBForcePairComm HTTP/1.1
Host: 
Content-Type: application/json

{
	"source_mac": "801f12413fa0",
	"destination_mac": "801f124166b8"
}

Add USB Pair Communication

Description

Apply usb pairing of two selected devices where the source is a transmitter device and the destination is a receiver device.

Command Usage

Request Format Example:
{
    “source_mac”: “801f12413fa0”,
    “destination_mac”: “801f124166b8”
}
Arguments:
    “source_mac” (required)
        Type: String
        Parameter: MAC address
    “destination_mac” (required)
        Type: String
        Parameter: MAC address


curl -X POST -H "Content-Type: application/json" -d '{
	"source_mac": "801f12413fa0",
	"destination_mac": "801f124166b8"
}' "/AddUSBPairComm"
POST /AddUSBPairComm HTTP/1.1
Host: 
Content-Type: application/json

{
	"source_mac": "801f12413fa0",
	"destination_mac": "801f124166b8"
}

Disconnect All USB Pairings

Description

Disconnect all USB pairing devices from a selected device.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0"
}' "/DisconnectAllUSBPairings"
POST /DisconnectAllUSBPairings HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0"
}

Get USB Pairs

Description

Retrieves all USB pairing information from a selected device.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0"
}' "/GetUSBPairs"
POST /GetUSBPairs HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0"
}

RS232 Routing Commands Requests

Contains all rs232 http requests for the Zigen IP Essentials API.

Save RS232 Command

Description

Saves the RS232 command to the IP Essentials.

Command Usage

Request Format Example:
{
    “name”: “Command 1”,
    “option”: “ASCII”,
    “code”: “HELLO WORLD”
}
Arguments:
    “name” (required)
        Type: String
        Parameter: User-defined name (Must be unique)
    “option” (required)
        Type: String
        Parameter: “ASCII” or “HEX”
    “code” (required)
        Type: String
        Parameter: ASCII-based (No more than 1000 characters)


curl -X POST -H "Content-Type: application/json" -d '{
	"name": "Command 1",
	"option": "ASCII",
	"code": "HELLO WORLD"
}' "/SaveRS232Command"
POST /SaveRS232Command HTTP/1.1
Host: 
Content-Type: application/json

{
	"name": "Command 1",
	"option": "ASCII",
	"code": "HELLO WORLD"
}

Send RS232 Command

Description

Send a RS232 command from the IP Essentials to a selected device.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”,
    “code”: “TESTING”
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address
    “code” (required)
        Type: String
        Parameter: ASCII (No more than 1000 characters long)


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0",
	"code": "TESTING"
}' "/SendRS232Command"
POST /SendRS232Command HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0",
	"code": "TESTING"
}

Get RS232 Commands

Description

Retrieve all RS232 commands from the IP Essentials.

Command Usage

Request Format Example:
{



}
Arguments:
    None


curl -X GET -H "Content-Type: application/json" "/GetRS232Commands"
GET /GetRS232Commands HTTP/1.1
Host: 
Content-Type: application/json

Get Device RS232 Pairs

Description

Retrieve the RS232 device destination pairs where the selected device is the source location.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0"
}
' "/GetDeviceRS232Pairs"
POST /GetDeviceRS232Pairs HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0"
}

Get RS232 Configuration

Description

Retrieves the RS232 configurations of a selected device.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0"
}' "/GetRS232Configuration"
POST /GetRS232Configuration HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0"
}

Save RS232 Configuration

Description

Change the RS232 configurations of a selected device.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”,
    “baud_rate”: 9600,
    “data_bits”: 8,
    “stop_bits”: 1,
    “parity”: “NONE”
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address
    “baud_rate” (required)
        Type: Integer
        Parameter: 2400, 4800, 9600, 19200, 38400, 57600, or 115200
    “data_bits” (required)
        Type: Integer
        Parameter: 6, 7, or 8
    “stop_bits” (required)
        Type: Integer
        Parameter: 1 or 2
    “parity” (required)
        Type: String
        Parameter: “NONE”, “ODD”, or “EVEN”


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0",
	"baud_rate": 9600,
	"data_bits": 8,
	"stop_bits": 1,
	"parity": "NONE"
}' "/SaveRS232Configuration"
POST /SaveRS232Configuration HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0",
	"baud_rate": 9600,
	"data_bits": 8,
	"stop_bits": 1,
	"parity": "NONE"
}

Communication Commands Requests

Contains all communication http requests for the Zigen IP Essentials API.

Delete Communication Command

Description

Delete a stored communication command name and its content from the IP Essentials.

Command Usage

Request Format Example:
{
    “name”: “Command 1”,
    “type”: “rs232”
}
Arguments:
    “name” (required)
        Type: String
        Parameter: Previous User-defined name or default name
    “type” (required)
        Type: String
        Parameter: “rs232”, “infrared”, or “cec”


curl -X POST -H "Content-Type: application/json" -d '{
	"name": "Command 1",
	"type": "rs232"
}' "/DeleteCommCommand"
POST /DeleteCommCommand HTTP/1.1
Host: 
Content-Type: application/json

{
	"name": "Command 1",
	"type": "rs232"
}

Rename Communication Command

Description

Rename the previous communication command name to the new communication command name to the IP Essentials.

Command Usage

Request Format Example:
{
    “oldname”: “Old Command Name”,
    “name”: “New Command Name”,
    “type”: “rs232”
}
Arguments:
    “oldname” (required)
        Type: String
        Parameter: Previous User-defined name or default name
    “name” (required)
        Type: String
        Parameter: User-defined name (Must be unique)
    “type” (required)
        Type: String
        Parameter: “rs232”, “infrared”, or “cec”


curl -X POST -H "Content-Type: application/json" -d '{
	"oldname": "Old Command Name",
	"name": "New Command Name",
	"type": "rs232"
}' "/RenameCommCommand"
POST /RenameCommCommand HTTP/1.1
Host: 
Content-Type: application/json

{
	"oldname": "Old Command Name",
	"name": "New Command Name",
	"type": "rs232"
}

Update Communication Command

Description

Update a stored communication command code to a new communication command code to the IP Essentials.

Command Usage

Request Format Example:
{
    “name”: “Command 1”,
    “type”: “rs232”,
    “code”: “HELLO WORLD”,
    “option”: “ASCII”
}
Arguments:
    “name” (required)
        Type: String
        Parameter: Previous User-defined name or default name
    “type” (required)
        Type: String
        Parameter: “rs232”, “infrared”, or “cec”
    “code” (required)
        Type: String
        Parameter: ASCII (No more than 1000 characters long)
    “option” (required)
        Type: String
        Parameter: “ASCII” or “HEX”


curl -X POST -H "Content-Type: application/json" -d '{
	"name": "Command 1",
	"type": "rs232",
	"code": "HELLO WORLD",
	"option": "ASCII"
}' "/UpdateCommCommand"
POST /UpdateCommCommand HTTP/1.1
Host: 
Content-Type: application/json

{
	"name": "Command 1",
	"type": "rs232",
	"code": "HELLO WORLD",
	"option": "ASCII"
}

Broadcast Communication

Description

Broadcast on a selected device, a certain type of communication to all devices.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”,
    “type”: “infrared”
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address
    “type” (required)
        Type: String
        Parameter: “infrared”, “rs232”, or “cec”


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0",
	"type": "infrared"
}' "/BroadcastComm"
POST /BroadcastComm HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0",
	"type": "infrared"
}

Disconnect One Way Communication

Description

Disconnect a one way pairing communication connection from one selected device(e.g. transmitter) to another selected device(e.g. receiver).

Command Usage

Request Format Example:
{
    “source_mac”: “801f12413fa0”,
    “destination_mac”: “801f124166b8”,
    “type”: “infrared”
}
Arguments:
    “source_mac” (required)
        Type: String
        Parameter: MAC address
    “destination_mac” (required)
        Type: String
        Parameter: MAC address
    “type” (required)
        Type: String
        Parameter: “infrared”, “rs232”, or “cec”


curl -X POST -H "Content-Type: application/json" -d '{
	"source_mac": "801f12413fa0",
	"destination_mac": "801f124166b8",
	"type": "infrared"
}' "/DisconnectOneWayComm"
POST /DisconnectOneWayComm HTTP/1.1
Host: 
Content-Type: application/json

{
	"source_mac": "801f12413fa0",
	"destination_mac": "801f124166b8",
	"type": "infrared"
}

Disconnect Source All One Way Communication

Description

Disconnect a selected device from all communication pairings.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”,
    “type”: “infrared”
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address
    “type” (required)
        Type: String
        Parameter: “infrared”, “rs232”, or “cec”


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0",
	"type": "infrared"
}' "/DisconnectSourceAllOneWayComm"
POST /DisconnectSourceAllOneWayComm HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0",
	"type": "infrared"
}

Add One Way Pair Communication

Description

Add a one way pairing communication connection from one selected device(e.g. transmitter) to another selected device(e.g. receiver).

Command Usage

Request Format Example:
{
    “source_mac”: “801f12413fa0”,
    “destination_mac”: “801f124166b8”,
    “type”: “infrared”
}
Arguments:
    “source_mac” (required)
        Type: String
        Parameter: MAC address
    “destination_mac” (required)
        Type: String
        Parameter: MAC address
    “type” (required)
        Type: String
        Parameter: “infrared”, “rs232”, or “cec”


curl -X POST -H "Content-Type: application/json" -d '{
	"source_mac": "801f12413fa0",
	"destination_mac": "801f124166b8",
	"type": "infrared"
}' "/AddOneWayPairComm"
POST /AddOneWayPairComm HTTP/1.1
Host: 
Content-Type: application/json

{
	"source_mac": "801f12413fa0",
	"destination_mac": "801f124166b8",
	"type": "infrared"
}

Pair Device Communication to Control Server

Description

Pair selected device to IP Essentials to send communication commands (e.g. RS232 or infrared) remotely.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”,
    “type”: “infrared”
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address
    “type” (required)
        Type: String
        Parameter: “infrared”, “rs232”, or “cec”


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0",
	"type": "infrared"
}' "/PairDeviceCommunicationtoControlServer"
POST /PairDeviceCommunicationtoControlServer HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0",
	"type": "infrared"
}

Contains all diagnostic http requests for the Zigen IP Essentials API.

Description

Retrieve the Logic Core network settings information of a selected device.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address

Description

Retrieve the Video Core network settings information of a selected device.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address

Description

Retrieve the edid binary array information as a string from a selected receiver device.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address

Description

Retrieve the edid settings from a selected device.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address

Description

Retrieve the Video Core scaled stream information from a selected transmitter device.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address

Description

Retrieve the Video Core streams information from a selected device.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address

Description

Retrieve the Video Core temperature information from a selected device.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address

Description

Retrieve all Video Core settings information from a selected device.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address

Settings Commands Requests

Contains all general settings http requests for the Zigen IP Essentials API.

Factory Reset

Description

Factory reset a selected device or a group of selected devices of a certain type to default settings.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”,
    “group”: null
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address or null (When “mac” is a given MAC address, “group” is ignored.)
    “group” (optional)
        Type: String
        Parameter: “all”, “receiver”, “transmitter”, or null


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0",
	"group": null
}' "/FactoryReset"
POST /FactoryReset HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0",
	"group": null
}

Reboot Device

Description

Reboot a selected device or a group of selected devices of a certain type.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”,
    “group”: null
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address or null (When “mac” is a given MAC address, “group” is ignored.)
    “group” (optional)
        Type: String
        Parameter: “all”, “receiver”, “transmitter”, or null


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0",
	"group": null
}' "/RebootDevice"
POST /RebootDevice HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0",
	"group": null
}

Update Device Firmware to Device

Description

Update firmware of the Logic Core of a selected device or update firmware of the Cage system of a selected device. The “force update” argument will update the selected device regardless if the firmware is the same, older, or newest firmware.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address
    “force update” (if omitted, Disable by default)
        Type: String
        Parameter: “true” (Enable) or “false” (Disable)
        Type: Boolean
        Parameter: true (Enable) or false (Disable)


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0",
	"force update": "true"
}' "/UpdateDeviceFirmwaretoDevice"
POST /UpdateDeviceFirmwaretoDevice HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0",
	"force update": "true"
}

Check Device Firmware Update

Description

Check for available firmware or if firmware is up to date for the Logic Core of a selected device or of the Cage system of a selected device.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0"
}' "/CheckDeviceFirmwareUpdate"
POST /CheckDeviceFirmwareUpdate HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0"
}

Get Device Firmware Progress

Description

Check the firmware progess of the Logic Core of a selected device or check the firmware progress of the Cage system of a selected device when being updated.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0"
}' "/GetDeviceFirmwareProgress"
POST /GetDeviceFirmwareProgress HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0"
}

Locate Mode

Description

Place a selected device in locate mode making the LEDs flash repeatedly to locate that certain device.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”,
    “mode”: 0
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address
    “mode” (required)
        Type: String or integer
        Parameter(String): “off” (OFF) or “on” (ON)
        Parameter(integer): 0 (OFF) or 1 (ON)


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0",
	"mode": 0
}' "/LocateMode"
POST /LocateMode HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0",
	"mode": 0
}

Set Video Core Static Mode

Description

Set a selected device to static mode for Logic Core for network settings.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”,
    “ip_address”: “192.168.0.10”,
    “subnet_mask”: “255.255.255.0”,
    “default_gateway”: “192.168.0.1”
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address
    “ip_address” (required)
        Type: String
        Parameter: A valid IP address
    “subnet_mask” (required)
        Type: String
        Parameter: A valid subnet mask
    “default_gateway” (required)
        Type: String
        Parameter: A valid default gateway


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0",
	"ip_address": "192.168.0.10",
	"subnet_mask": "255.255.255.0",
	"default_gateway": "192.168.0.1"
}' "/SetVideoCoreStaticMode"
POST /SetVideoCoreStaticMode HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0",
	"ip_address": "192.168.0.10",
	"subnet_mask": "255.255.255.0",
	"default_gateway": "192.168.0.1"
}

Set Video Core DHCP

Description

Set a selected device to DHCP mode for Video Core for network settings.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0"
}' "/SetVideoCoreDHCP"
POST /SetVideoCoreDHCP HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0"
}

Get Ip Logic Settings

Description

Retrieve the Logic Core information of a selected device.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0"
}' "/GetIpLogicSettings"
POST /GetIpLogicSettings HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0"
}

Get Video Core Response

Description

Retrieve the Video Core response of a previous sent Video Core API command.

Command Usage

Request Format Example:
{
    “reqId”: 0
}
Arguments:
    “reqId” (required)
        Type: integer
        Parameter: value >= 0


curl -X POST -H "Content-Type: application/json" -d '{
	"reqId":1
}' "/GetVideoCoreResp"
POST /GetVideoCoreResp HTTP/1.1
Host: 
Content-Type: application/json

{
	"reqId":1
}

Set Device Static Mode

Description

Set a selected device to static mode for Logic Core for network settings.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”,
    “ip_address”: “192.168.0.10”,
    “subnet_mask”: “255.255.255.0”,
    “default_gateway”: “192.168.0.1”
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address
    “ip_address” (required)
        Type: String
        Parameter: A valid IP address
    “subnet_mask” (required)
        Type: String
        Parameter: A valid subnet mask
    “default_gateway” (required)
        Type: String
        Parameter: A valid default gateway


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0",
	"ip_address": "192.168.0.10",
	"subnet_mask": "255.255.255.0",
	"default_gateway": "192.168.0.1"
}' "/SetDeviceStaticMode"
POST /SetDeviceStaticMode HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0",
	"ip_address": "192.168.0.10",
	"subnet_mask": "255.255.255.0",
	"default_gateway": "192.168.0.1"
}

Set Device DHCP

Description

Set a selected device to DHCP mode for Logic Core for network settings.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0"
}' "/SetDeviceDHCP"
POST /SetDeviceDHCP HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0"
}

Save Device Name

Description

Change the name of a selected device.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”,
    “name”: “TEST”
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address
    “name” (required)
        Type: String
        Parameter: Must be no longer than 18 characters


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0",
	"name": "TEST"
}' "/SaveDeviceName"
POST /SaveDeviceName HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0",
	"name": "TEST"
}

Save Device Notes

Description

Save notes information from a selected device to the IP Essentials.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”,
    “notes”: “This device works great!”
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address
    “notes” (required)
        Type: String
        Parameter: ASCII (No more than 1000 characters long) or null


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0",
	"notes": "This device works great!"
}' "/SaveDeviceNotes"
POST /SaveDeviceNotes HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0",
	"notes": "This device works great!"
}

Get Device Notes

Description

Retrieve notes information from a selected device stored from the IP Essentials.

Command Usage

Request Format Example:
{
    “mac”: “801f41123fa0”
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0"
}' "/GetDeviceNotes"
POST /GetDeviceNotes HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0"
}

Discover Device

Description

Put a selected device in discovery mode in which the leds blink for a specified duration of time.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”,
    “blinkTime”: 0
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address
    “blinkTime” (required)
        Type: integer
        Parameter: 0 to 950


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0",
	"blinkTime": 0
}' "0.0.0.0:5000/DiscoverDevice"
failed to parse url
parse 0.0.0.0:5000/DiscoverDevice: first path segment in URL cannot contain colon

Add Devices to Cage

Description

Add devices to a selected cage device system to be monitored and placed into the cage.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”,
    “deviceList”: [“801f124166b8”,“801f12416fb3”]
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address
    “deviceList” (required)
        Type: String
        Parameter: An array of MAC addresses (Up to 10 MAC addresses) or empty array []


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0",
	"deviceList": ["801f124166b8","801f12416fb3"]
}' "/AddDevicestoCage"
POST /AddDevicestoCage HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0",
	"deviceList": ["801f124166b8","801f12416fb3"]
}

Set AES67 PTP Master

Description

Set the PTP master of a selected transmitter device. Note: There can only be one PTP master selected on a given network.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”,
    “force”: true
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address
    “force” (required)
        Type: Boolean
        Parameter: true (force device to become PTP master) or false (set device to become a slave)


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0",
	"force": true
}' "/SetAES67PTPMaster"
POST /SetAES67PTPMaster HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0",
	"force": true
}

Get AES67 PTP Master

Description

Get the PTP master from a list of available transmitter devices. Note: There can only be one PTP master selected on a given network.

Command Usage

Request Format Example:
{



}
Arguments:
    None


curl -X GET "/GetAES67PTPMaster"
GET /GetAES67PTPMaster HTTP/1.1
Host:

Bridge Network Switch Port

Description

Split or bridge the network switch port between the 10G and 1G port of a selected transmitter device.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”,
    “mode”: true
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address
    “mode” (required)
        Type: Boolean
        Parameter: true (for bridge the network switch) or false (for split the network switch)


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0",
	"mode": true
}' "/BridgeNetworkSwitchPort"
POST /BridgeNetworkSwitchPort HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0",
	"mode": true
}

Admin Settings Commands Requests

Contains all admin settings http requests for the Zigen IP Essentials API.

Factory Reset Server

Description

Factory reset for the IP Essentials.

Command Usage

Request Format Example:
{



}
Arguments:
    None


curl -X POST -H "Content-Type: application/json" -d '{
	
}' "/FactoryResetServer"
POST /FactoryResetServer HTTP/1.1
Host: 
Content-Type: application/json

{
	
}

Reboot Server

Description

Reboot the IP Essentials.

Command Usage

Request Format Example:
{



}
Arguments:
    None


curl -X POST -H "Content-Type: application/json" -d '{
	
}' "/RebootServer"
POST /RebootServer HTTP/1.1
Host: 
Content-Type: application/json

{
	
}

Get Server Admin Details

Description

Retrieve admin information from the IP Essentials.

Command Usage

Request Format Example:
{



}
Arguments:
    None


curl -X POST -H "Content-Type: application/json" -d '{
	
}' "/GetServerAdminDetails"
POST /GetServerAdminDetails HTTP/1.1
Host: 
Content-Type: application/json

{
	
}

Get Server Temperature

Description

Retrieve temperature information in Celsius from the IP Essentials.

Command Usage

Request Format Example:
{



}
Arguments:
    None


curl -X POST -H "Content-Type: application/json" -d '{
	
}' "/GetServerTemperature"
POST /GetServerTemperature HTTP/1.1
Host: 
Content-Type: application/json

{
	
}

Get Server MAC Addresses

Description

Retrieve MAC addresses from the IP Essentials.

Command Usage

Request Format Example:
{



}
Arguments:
    None


curl -X POST -H "Content-Type: application/json" -d '{
	
}' "/GetServerMACAddresses"
POST /GetServerMACAddresses HTTP/1.1
Host: 
Content-Type: application/json

{
	
}

Get Server IP

Description

Retrieve IP address information from the IP Essentials.

Command Usage

Request Format Example:
{



}
Arguments:
    None


curl -X POST -H "Content-Type: application/json" -d '{
	
}' "/GetServerIP"
POST /GetServerIP HTTP/1.1
Host: 
Content-Type: application/json

{
	
}

Save Admin Notes

Description

Save admin notes information to the IP Essentials.

Command Usage

Request Format Example:
{
    “notes”: “This device works great!”
}
Arguments:
    “notes” (required)
        Type: String
        Parameter: ASCII (No more than 1000 characters long)


curl -X POST -H "Content-Type: application/json" -d '{
	"notes": "This device works great!"
}' "/SaveAdminNotes"
POST /SaveAdminNotes HTTP/1.1
Host: 
Content-Type: application/json

{
	"notes": "This device works great!"
}

Get Admin Notes

Description

Retrieve notes information stored from the IP Essentials.

Command Usage

Request Format Example:
{



}
Arguments:
    None


curl -X GET -H "Content-Type: application/json" "/GetAdminNotes"
GET /GetAdminNotes HTTP/1.1
Host: 
Content-Type: application/json

Get Server Version

Description

Retrieve the current version number of the IP Essentials.

Command Usage

Request Format Example:
{



}
Arguments:
    None


curl -X GET -H "Content-Type: application/json" "/GetServerVersion"
GET /GetServerVersion HTTP/1.1
Host: 
Content-Type: application/json

Device Info Retrieval Commands Requests

Contains all device information retrieval http requests for the Zigen IP Essentials API.

Get Single Device Info

Description

Retrieves selected device information based off their MAC address.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0"
}' "/GetSingleDeviceInfo"
POST /GetSingleDeviceInfo HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0"
}

Get All Device List

Description

Retrieves all devices from the IP Essentials regardless if whether the devices are connected or disconnected.

Command Usage

Request Format Example:
{



}
Arguments:
    None


curl -X GET -H "Content-Type: application/json" "/GetAllDeviceList"
GET /GetAllDeviceList HTTP/1.1
Host: 
Content-Type: application/json

Get All Online Device List

Description

Retrieves all connected devices from the IP Essentials.

Command Usage

Request Format Example:
{



}
Arguments:
    None


curl -X GET -H "Content-Type: application/json" "/GetAllOnlineDeviceList"
GET /GetAllOnlineDeviceList HTTP/1.1
Host: 
Content-Type: application/json

Get Transmitter List

Description

Retrieves all transmitter devices from the IP Essentials if the device is connected.

Command Usage

Request Format Example:
{



}
Arguments:
    None


curl -X GET -H "Content-Type: application/json" "/GetTransmitterList"
GET /GetTransmitterList HTTP/1.1
Host: 
Content-Type: application/json

Get Receiver List

Description

Retrieves all receiver devices from the IP Essentials if the device is connected.

Command Usage

Request Format Example:
{



}
Arguments:
    None


curl -X GET -H "Content-Type: application/json" "/GetReceiverList"
GET /GetReceiverList HTTP/1.1
Host: 
Content-Type: application/json

Number of Groups and Devices

Description

Retrieves the number of devices stored in the IP Essentials.

Command Usage

Request Format Example:
{



}
Arguments:
    None


curl -X GET -H "Content-Type: application/json" "/NumberOfGroupsandDevices"
GET /NumberOfGroupsandDevices HTTP/1.1
Host: 
Content-Type: application/json

Grouping Commands Requests

Contains all grouping http requests for the Zigen IP Essentials API.

Create Device Group

Description

Create a custom group of selected devices, must specify a custom group name and group type, to be used to control all devices in that certain group.

Command Usage

Request Format Example:
{
    “name”: “ZigenGroup”,
    “deviceList”: [
        {
            “mac”: “801f12413fa0”
        },
        {
            “mac”: “801f124166b8”
        },
        {
            “mac”: “801f12415454”
        }
    ],
    “type”: “video”
}
Arguments:
    “name” (if omitted, a default name will be given)
        Type: String
        Parameter: Custom group name
    “deviceList” (required)
        Type: String
        Parameter: An array of MAC addresses
    “type” (required)
        Type: String
        Parameter: “video”, “audio”, “infrared”, “rs232”, “usb”, or “cec”


curl -X POST -H "Content-Type: application/json" -d '{
	"name": "ZigenGroup",
	"deviceList": [
		{
			"mac": "801f12413fa0"
		},
		{
			"mac": "801f124166b8"
		},
		{
			"mac": "801f12415454"
		}
	],
	"type": "video"
}' "/CreateDeviceGroup"
POST /CreateDeviceGroup HTTP/1.1
Host: 
Content-Type: application/json

{
	"name": "ZigenGroup",
	"deviceList": [
		{
			"mac": "801f12413fa0"
		},
		{
			"mac": "801f124166b8"
		},
		{
			"mac": "801f12415454"
		}
	],
	"type": "video"
}
Status200 OK
Content-Typeapplication/json
Content-Length33
ServerWerkzeug/0.14.1 Python/3.7.3
DateThu, 02 May 2019 21:26:35 GMT
{
    "status": "success",
    "errors": []
}
Status200 OK
Content-Typeapplication/json
Content-Length33
ServerWerkzeug/0.14.1 Python/3.7.3
DateThu, 02 May 2019 21:26:35 GMT
{
    "status": "success",
    "errors": []
}

Update Device Group

Description

Update a group with selected devices, must specify an existing group name to be updated.

Command Usage

Request Format Example:
{
    “name”: “ZigenGroup”,
    “deviceList”: [
        {
            “mac”: “801f12413fa0”
        },
        {
            “mac”: “801f124166b8”
        },
        {
            “mac”: “801f12415454”
        }
    ]
}
Arguments:
    “name” (required)
        Type: String
        Parameter: Name of group to be updated with new device list.
    “deviceList” (required)
        Type: String
        Parameter: An array of MAC addresses that will be the new set of members of the group specified.


curl -X POST -H "Content-Type: application/json" -d '{
	"name": "ZigenGroup",
	"deviceList": [
		{
			"mac": "801f12413fa0"
		},
		{
			"mac": "801f124166b8"
		},
		{
			"mac": "801f12415454"
		}
	]
}' "/UpdateDeviceGroup"
POST /UpdateDeviceGroup HTTP/1.1
Host: 
Content-Type: application/json

{
	"name": "ZigenGroup",
	"deviceList": [
		{
			"mac": "801f12413fa0"
		},
		{
			"mac": "801f124166b8"
		},
		{
			"mac": "801f12415454"
		}
	]
}
Status200 OK
Content-Typeapplication/json
Content-Length33
ServerWerkzeug/0.14.1 Python/3.7.3
DateThu, 02 May 2019 21:26:35 GMT
{
    "status": "success",
    "errors": []
}
Status200 OK
Content-Typeapplication/json
Content-Length33
ServerWerkzeug/0.14.1 Python/3.7.3
DateThu, 02 May 2019 21:26:35 GMT
{
    "status": "success",
    "errors": []
}

Get Device Group

Description

Retrieve all MAC addresses from a custom group, must specify the custom group name. If “type” is omitted, then all MAC addresses and its associated type with the specified group name will be retrieved.

Command Usage

Request Format Example:
{
    “name”: “ZigenGroup”,
    “type”: “video”
}
Arguments:
    “name” (optional if type is given)
        Note: Can be omitted if “type” is given, returns all groups of that certain type.
        Type: String
        Parameter: Custom group name
    “type” (optional if name is given)
        Note: Optional. Omit to get all types.
        Type: String
        Parameter: “video”, “audio”, “infrared”, “rs232”, “usb”, or “cec”


curl -X POST -H "Content-Type: application/json" -d '{
	"name": "ZigenGroup",
	"type": "video"
}' "/GetDeviceGroup"
POST /GetDeviceGroup HTTP/1.1
Host: 
Content-Type: application/json

{
	"name": "ZigenGroup",
	"type": "video"
}

Rename Device Group

Description

Rename an existing device group with a new given name.

Command Usage

Request Format Example:
{
    “name”: “ZigenGroup”,
    “new name”: “Best Group”
}
Arguments:
    “name” (required)
        Type: String
        Parameter: Name of group that needs its name changed.
    “new name” (required)
        Type: String
        Parameter: Set to desired new name.


curl -X POST -H "Content-Type: application/json" -d '{
	"name": "Group_1",
	"new name": "Zigen Group"
}' "/RenameDeviceGroup"
POST /RenameDeviceGroup HTTP/1.1
Host: 
Content-Type: application/json

{
	"name": "Group_1",
	"new name": "Zigen Group"
}
Status200 OK
Content-Typeapplication/json
Content-Length33
ServerWerkzeug/0.14.1 Python/3.7.3
DateThu, 02 May 2019 21:26:35 GMT
{
    "status": "success",
    "errors": []
}
Status200 OK
Content-Typeapplication/json
Content-Length33
ServerWerkzeug/0.14.1 Python/3.7.3
DateThu, 02 May 2019 21:26:35 GMT
{
    "status": "success",
    "errors": []
}

Delete Device Group

Description

Deletes an existing device group.

Command Usage

Request Format Example:
{
    “name”: “ZigenGroup”
}
Arguments:
    “name” (required)
        Type: String
        Parameter: Name of group to be deleted.


curl -X POST -H "Content-Type: application/json" -d '{
	"name": "ZigenGroup"
}' "/DeleteDeviceGroup"
POST /DeleteDeviceGroup HTTP/1.1
Host: 
Content-Type: application/json

{
	"name": "ZigenGroup"
}
Status200 OK
Content-Typeapplication/json
Content-Length33
ServerWerkzeug/0.14.1 Python/3.7.3
DateThu, 02 May 2019 21:26:35 GMT
{
    "status": "success",
    "errors": []
}
Status200 OK
Content-Typeapplication/json
Content-Length33
ServerWerkzeug/0.14.1 Python/3.7.3
DateThu, 02 May 2019 21:26:35 GMT
{
    "status": "success",
    "errors": []
}

Save Device Color Id

Description

Save a color ID for a selected device to the IP Essentials, which will be used for visual identification.

Command Usage

Request Format Example:
{
    “mac”: “801f12413fa0”
    “color”: “#FFFFFF”
}
Arguments:
    “mac” (required)
        Type: String
        Parameter: MAC address
    “color” (required)
        Type: String
        Parameter: “#000000” to “#FFFFFF”


curl -X POST -H "Content-Type: application/json" -d '{
	"mac": "801f12413fa0",
	"color": "#FFFFFF"
}' "/SaveDeviceColorId"
POST /SaveDeviceColorId HTTP/1.1
Host: 
Content-Type: application/json

{
	"mac": "801f12413fa0",
	"color": "#FFFFFF"
}