This page contain reference for the JSON-RPC interface.

The program accept JSON-RPC 2.0 request on the port 3277 using both direct socket or HTTP POST.

For HTTP POST set your JSON-RPC procedure to use the following URL:

http://localhost:3277/jsonrpc

This JSON-RPC method are the basis for the Python scripts, both internal (launched from CCDciel) or external (launched from a terminal or another application).
A Python function is provided to simplify the use. The host,port parameters can be use to send the command to another instance of CCDciel.
The syntax is:

jsonresult = ccdciel(method)
jsonresult = ccdciel(method,parameter)
jsonresult = ccdciel(method,parameter,host,port)

For example:

from ccdciel import ccdciel
ra = ccdciel('TelescopeRA')['result']

To make Python to find this function in external script you must specify the environment variable PYTHONPATH, this is not necessary when running the script from CCDciel:

set PYTHONPATH=C:\Program Files\CCDciel\scripts
export PYTHONPATH=/usr/share/ccdciel/scripts

Use the standard Python functions ( argv, getopt, argparse) to retrieve the script parameters. For example:

print ('Argument List:', str(sys.argv))

The invocation format for this methods is: {“jsonrpc”: “2.0”, “method”: “method_name”, “id”:1}
The responses for this methods are in the form: {“jsonrpc”: “2.0”, “result”: result_value, “id”: 1}
Method name is not case sensitive.

The invocation format for this methods is: {“jsonrpc”: “2.0”, “method”: “method_name”, “id”:1}
The responses for this methods are in the form: {“jsonrpc”: “2.0”, “result”:{“status”: “OK!”}, “id”: 1}
Status can be “OK!” if the command is successful, or “Failed!” if not. In this later case it can contain information about why it fail.
Method name is not case sensitive.

The invocation format for this methods is: {“jsonrpc”: “2.0”, “method”: “method_name”, “params”: [params], “id”:1}
The responses for this methods are in the form: {“jsonrpc”: “2.0”, “result”:{“status”: “OK!”}, “id”: 1}
Status can be “OK!” if the command is successful, or “Failed!” if not. In this later case it can contain information about why it fail.
Method name is not case sensitive.

This method return a global program status with the same information as the Status web page.

The params field allow to filter the information send by the program.
When the params field is not specified the response include all the information.

Example:

$ telnet localhost 3277
Connected to localhost.
{"jsonrpc": "2.0", "method": "status", "params": ["camera","focuser"], "id": 2}

{"jsonrpc": "2.0", "result":{"camera": {"connected": true, "binning": "1x1", 
"frame": "0/0/1280/1024", "cooler": false, "temperature": 0.0}, 
"focuser": {"connected": true, "position": 37200, "temperature": 0.0, 
"focusermessage": "AutoFocus successful; 15:03:52 HFD=4.2"}}, "id": 2}

There is three way to get the status information:

• The status web page.
• The Simple socket command.
• This JSON-RPC status method.