IPEVO iZiggi API

Overview

About iZiggi-HD iZiggi-HD – the document camera designed for iPad – is the next evolution in affordable doc cam technology from IPEVO. Traditional doc cams often need to be connected to a computer via USB. But with the exciting rise of tablet computing in more and more classrooms, it's time to harness the full educational potential of iPad with wireless streaming of documents, artwork, objects, device screens and more.

About the iZiggi-HD Developer Document This Developer Document contains everything you need to know when working with the iZiggi-HD API. You can control camera parameters such as image resolution, exposure and more. The API uses standard URL query strings to send requests to iZiggi-HD, returning results in JSON format.

Prerequisites

All API requests are handled by ipevoapi.cgi except for obtaining the firmware version. If iZiggi-HD does not contain “ipevoapi.cgi,” it means the iZiggi-HD is using outdated firmware. In this case, you should display a message informing users to upgrade iZiggi-HD’s firmware. You can also obtain the firmware version using the API to check if iZiggi-HD’s firmware is too old (See 9. iZiggi-HD’s API version).

Video Stream

All applications should start with getting the video stream.

Getting Video Stream

  1. Connect to iZiggi-HD’s Wi-Fi network.
  2. Use Bonjour (https://developer.apple.com/bonjour/) to discover iZiggi-HD*.
  3. In the Service Name field, use “_mjpegStreamer._tcp” to get information from iZiggi-HD. This information contains iZiggi-HD's Host Name and Port.
  4. Use iZiggi-HD's Host Name and Port to get the M-JPEG video stream.

    *Note: for computers without Bonjour service installed, you can use the wireless gateway IP instead to get M-JPEG video stream, e.g.: 10.10.10.1/?action=stream

Using ipevoapi.cgi

  1. Resolution
  2. Initiate a focus action
  3. Auto exposure on/off control
  4. Exposure value
  5. Auto focus mode status
  6. Current focus status
  7. Power frequency (flicker mode)
  8. Multiple camera control status (API list #3-7) in one command
  9. iZiggi-HD’s API version

Using api.cgi

Use api.cgi to obtain iZiggi-HD’s current firmware version only.

Using ipevoapi.cgi

Resolution

Change the streaming resolution of iZiggi-HD.
Input
Parameter Value
id account ID (Admin)
pwd account password
command 0x29
value Choose from a range of available resolutions: 640x480, 800x600, 1024x768, 1280x720, 1600x1200
Return result
Success
{
  "Status": 0
}
Fail
{
  "Status": 1
}
No "Id" or "pwd" parameter, or either one of them does not match
{
  "Status": 2
}
Failed to execute command
{
  "Status": 3
}
No “command” parameter, or command is incorrect
{
  "Status": 4
}
No “value” parameter, or value is incorrect
{
  "Status": 5
}
Other error
Request sample
http://10.10.10.1/ipevoapi.cgi?id=Admin&pwd=admin&command=0x29&value=1024x768
Get the current streaming resolution of iZiggi-HD.
Input
Parameter Value
id account ID (Admin)
pwd account password
command 0x2A
Return result
Success
{
  "Status": 0,
  "Resolution": "1024x768"
}
Fail
{
 "Status": 1
}
No “Id” or “pwd” parameter, or either one of them does not match
{
 "Status": 2
}
Failed to execute command
{
 "Status": 3
}
No “command” parameter, or command is incorrect
{
 "Status": 5
}
Other error
Request sample
http://10.10.10.1/ipevoapi.cgi?id=Admin&pwd=admin&command=0x2A
List all resolutions supported by iZiggi-HD.

List supported resolutions of the camera

Input
Parameter Value
id account ID (Admin)
pwd account password
command 0x2B
Return result
Success
{
 "Status": 0,
 "resolutions": [
   {
     "resolution": "1024x768 ",
     "fps": "15.0"
   },
   {
     "resolution": "640x480 ",
     "fps": "30.0"
   },
   {
     "resolution": "800x600 ",
     "fps": "15.0"
   },
   {
     "resolution": "1280x720 ",
     "fps": "30.0"
   },
   {
     "resolution": "1600x1200 ",
     "fps": "15.0"
   }
 ]
}
Fail
{
  "Status": 1
}
No “Id” or “pwd” parameter, or either one of them does not match
{
  "Status": 2
}
Failed to execute command
{
  "Status": 3
}
No “command” parameter, or command is incorrect
{
  "Status": 5
}
Other error
Request sample
http://10.10.10.1/ipevoapi.cgi?id=Admin&pwd=admin&command=0x2B

Initiate focus action

Initiate a focus action of iZiggi-HD’s camera. That is, focus the camera.

Input
Parameter Value
id account ID (Admin)
pwd account password
command 0x04
Return result
Success
{
"Status": 0
}
Fail
{
  "Status": 1
}
No “Id” or “pwd” parameter, or either one of them does not match
{
  "Status": 2
}
Failed to execute command
{
  "Status": 3
}
No “command” parameter, or command is incorrect
{
  "Status": 5
}
Other error
Request sample
http://10.10.10.1/ipevoapi.cgi?id=Admin&pwd=admin&command=0x04

Auto exposure on/off control

Configure auto exposure setting of iZiggi-HD’s camera. Value “0” turns on auto exposure function, and value “1” turns off auto exposure function.

Set auto exposure
Input
Parameter Value
id account ID (Admin)
pwd account password
command 0x02
value 0 → Auto
1 → Not auto
Return result
Success
{
  "Status": 0
}
Fail
{
  "Status": 1
}
No “Id” or “pwd” parameter, or either one of them does not match
{
  "Status": 2
}
Failed to execute command
{
  "Status": 3
}
No “command” parameter, or command is incorrect
{
  "Status": 4
}
No “value” parameter, or value is incorrect
{
  "Status": 5
}
Other error
Request sample
http://10.10.10.1/ipevoapi.cgi?id=Admin&pwd=admin&command=0x02&value=0
Get auto exposure setting of iZiggi-HD’s camera.

Get auto exposure status

Input
Parameter Value
id account ID (Admin)
pwd account password
command 0x0B
Return result
Success
{
  "Status": 0,
  "Auto Exposure": 0
}
Auto Exposure: 0 -> Auto
Auto Exposure: 1 -> Not Auto
Fail
{
  "Status": 1
}
No “Id” or “pwd” parameter, or either one of them does not match
{
  "Status": 2
}
Failed to execute command
{
  "Status": 3
}
No “command” parameter, or command is incorrect
{
  "Status": 5
}
Other error
Request sample
http://10.10.10.1/ipevoapi.cgi?id=Admin&pwd=admin&command=0x0B

Exposure value

Configure exposure value of iZiggi-HD’s camera. A smaller value darkens the image while a larger value makes the image brighter. Default value is set to “8.”

Set exposure value
Input
Parameter Value
id account ID (Admin)
pwd account password
command 0x03
value 1~15
Return result
Success
{
  "Status": 0
}
Fail
{
  "Status": 1
}
No “Id” or “pwd” parameter, or either one of them does not match
{
  "Status": 2
}
Failed to execute command
{
  "Status": 3
}
No “command” parameter, or command is incorrect
{
  "Status": 4
}
No “value” parameter, or value is incorrect
{
  "Status": 5
}
Other error
Request sample
http://10.10.10.1/ipevoapi.cgi?id=Admin&pwd=admin&command=0x03&value=9
Get current exposure value of iZiggi-HD’s camera.

Get exposure value

Input
Parameter Value
id account ID (Admin)
pwd account password
command 0x06
Return result
Success
{
  "Status": 0,
  "Exposure": 9
}
Fail
{
  "Status": 1
}
No “Id” or “pwd” parameter, or either one of them does not match
{
  "Status": 2
}
Failed to execute command
{
  "Status": 3
}
No “command” parameter, or command is incorrect
{
  "Status": 5
}
Other error
Request sample
http://10.10.10.1/ipevoapi.cgi?id=Admin&pwd=admin&command=0x06

Auto focus mode status

Get auto focus mode setting of iZiggi-HD’s camera. On single focus mode (AF-S), iZiggi-HD will focus once and stay at that focus. On continuous focus mode (AF-C), iZiggi-HD will constantly try to get the best focus.

Get focus mode setting
Input
Parameter Value
id account ID (Admin)
pwd account password
command 0x05
Return result
Success
{
  "Status": 0,
  "Focus Mode": 0
}
Focus Mode: 0 → AF-S
Focus Mode: 1 → AF-C
Fail
{
  "Status": 1
}
No “Id” or “pwd” parameter, or either one of them does not match
{
  "Status": 2
}
Failed to execute command
{
  "Status": 3
}
No “command” parameter, or command is incorrect
{
  "Status": 5
}
Other error
Request sample
http://10.10.10.1/ipevoapi.cgi?id=Admin&pwd=admin&command=0x05

Current focus status

Get the current focus status of iZiggi-HD’s camera

Input
Parameter Value
id account ID (Admin)
pwd account password
command 0x09
Return result
Success
{
  "Status": 0,
  "Focus Status": 0
}
Focus Status: 0 -> normal, camera is not focusing, or focus is finished
Focus Status: 1 -> focus start, camera is focusing
Fail
{
  "Status": 1
}
No “Id” or “pwd” parameter, or either one of them does not match
{
  "Status": 2
}
Failed to execute command
{
  "Status": 3
}
No “command” parameter, or command is incorrect
{
  "Status": 5
}
Other error
Request sample
http://10.10.10.1/ipevoapi.cgi?id=Admin&pwd=admin&command=0x09

Power frequency (flicker mode)

Configure the power frequency value (Flicker mode) of iZiggi-HD’s camera. Value 0 means 60Hz while value 1 means 50Hz.

Set power frequency (flicker mode)
Input
Parameter Value
id account ID (Admin)
pwd account password
command 0x01
value 0 → 60Hz
1 → 50Hz
Return result
Success
{
  "Status": 0
}
Fail
{
  "Status": 1
}
No “Id” or “pwd” parameter, or either one of them does not match
{
  "Status": 2
}
Failed to execute command
{
  "Status": 3
}
No “command” parameter, or command is incorrect
{
  "Status": 4
}
No “value” parameter, or value is incorrect
{
  "Status": 5
}
Other error
Request sample
http://10.10.10.1/ipevoapi.cgi?id=Admin&pwd=admin&command=0x01&value=0
Get current power frequency (flicker mode) of iZiggi-HD’s camera.
Input
Parameter Value
id account ID (Admin)
pwd account password
command 0x07
Return result
Success
{
  “Status”: 0,
  “Power Frequency”: 0
}
0 → 60Hz
1 → 50Hz
Fail
{
  "Status": 1
}
No “Id” or “pwd” parameter, or either one of them does not match
{
  "Status": 2
}
Failed to execute command
{
  "Status": 3
}
No “command” parameter, or command is incorrect
{
  "Status": 5
}
Other error
Request sample
http://10.10.10.1/ipevoapi.cgi?id=Admin&pwd=admin&command=0x07

Multiple camera control status (API list #3-7) in one command

Get the exposure value, auto focus mode, focus status, power frequency and auto exposure value in one command.

Input
Parameter Value
id account ID (Admin)
pwd account password
command 0x0A
Return result
Success
{
  "Status": 0,
  "Exposure": 9,
  "Focus Mode": 1,
  "Focus Status": 0,
  "Power Frequency": 1,
  "Auto Exposure": 0
}
Exposure: 1~15

Focus Mode: 0 → AF-S / 1 → AF-C

Focus Status: 0 → normal, camera is not focusing, or focus is finished
Focus Status: 1 → focus start, camera is focusing

Power Frequency: 0 → 60Hz / 1 → 50Hz
Auto Exposure: 0 → Auto / 1 → Not auto
Fail
{
  "Status": 1
}
No “Id” or “pwd” parameter, or either one of them does not match
{
  "Status": 2
}
Failed to execute command
{
  "Status": 3
}
No “command” parameter, or command is incorrect
{
  "Status": 5
}
Other error
Request sample
http://10.10.10.1/ipevoapi.cgi?id=Admin&pwd=admin&command=0x0A

iZiggi-HD’s API version

If you are not getting a response from this API, iZiggi-HD’s firmware could be outdated and in need of an update. You should display a message informing user to upgrade iZiggi-HD’s firmware. You can also use “api.cgi” to get the firmware version of your iZiggi-HD to determine if it is too old.

Get API version string
Input
id account ID (Admin)
pwd account password
command 0x0C
Return result
Success
{
  "Status": 0,
  "API Version": "1.0"
}
Fail
{
  "Status": 2
}
Failed to execute command
{
  "Status": 3
}
No “command” parameter, or command is incorrect
{
  "Status": 5
}
Other error
Request sample
http://10.10.10.1/ipevoapi.cgi?command=0x0C

Using api.cgi

Get iZiggi-HD’s firmware version. If the firmware version is “1.0.0.3” or before, the firmware is too old to support the APIs above.

Get firmware version
Input
Parameter Value
id account ID (Admin)
pwd account password
version 1
Return result
Success
{
  "login": 0,
  "FIRMWARE": [
    {
      "version": "iZiggi_1.0.0.3"
    }
  ]
}
Fail
{
  "login": -1
}
No "Id" or "pwd" parameter, or either one of them does not match
Request sample
http://10.10.10.1/api.cgi?id=Admin&pwd=admin&version=1