Setting description of serial ports

Request to get the settings:

https://[address_server]:[port]/settings/serialports/?sid=[id_session]

Response:

{
    "name" : "serialports",
    "type" : "SerialFolder",
    "subdirs" : [
        "Y4fZMht3",
        "jlqB4fO0"
    ],
    "values" : [
        "dumps",
        "port_create_now",
        "port_erase",
        "port_new_guid",
        "supported_ptz_protocols",
        "moxa_ports_connected",
        "moxa_ports_total"
    ]
}

Table 143. 

subdirs Description TRASSIR
[GUID_port] GUID of serial port. ≥3.1

Retrieve a value (R):

https://[address_server]:[port]/settings/serialports/[setting]?sid=[id_session]

Write a value (W):

https://[address_server]:[port]/settings/serialports/[setting]=[value]?sid=[id_session]

Table 144. 

values Description Type   TRASSIR
dumps   integer RW ≥3.1
port_create_now New port creation request string RW ≥3.1
port_create_now Port removal request string W ≥3.1
port_new_guid Last connected port GUID string R ≥3.1
supported_ptz_protocols Supported PTZ protocols string R ≥3.1
moxa_ports_connected Connected MOXA ports integer R ≥3.2
moxa_ports_total Available MOXA ports integer R ≥3.2

Request to get a port settings:

https://[address_server]:[port]/settings/serialports/[GUID_port]/?sid=[id_session]

Response:

{
    "name" : "Y4fZMht3",
    "type" : "SerialPort",
    "subdirs" : [
        "X3B8ZCgn"
    ],
    "values" : [
        "baud_rate",
        "create_now_fac",
        "create_now_ptz",
        "data_bits",
        "erase_now",
        "flow_control",
        "new_guid",
        "parity",
        "port_name",
        "stop_bits"
    ]
}

Table 145. 

subdirs Description TRASSIR
[GUID_channel] GUID of associated channel. ≥3.1

Retrieve a value (R):

https://[address_server]:[port]/settings/serialports/[GUID_port]/[setting]?sid=[id_session]

Write a value (W):

https://[address_server]:[port]/settings/serialports/[GUID_port]/[setting]=[value]?sid=[id_session]

Table 146. 

values Description Type   TRASSIR
baud_rate Speed integer RW ≥3.1
create_now_fac Manual panel adding request integer RW ≥3.1
create_now_ptz PTZ device adding request integer RW ≥3.1
data_bits Data bits integer RW ≥3.1
erase_now   string W ≥3.1
flow_control

Stream control enabled:

0 - no, 1 - yes

integer RW ≥3.1
new_guid New GUID string R ≥3.1
parity

Parity:

0 - even, 1 - uneven

integer RW ≥3.1
port_name Port name string RW ≥3.1
stop_bits Stop bits integer RW ≥3.1

Access control panel adding request:

https://[server_address]:[port]/settings/serialports/[port_GUID]/create_now_fac=1?sid=[session_id]

Response:

{
    "success": "1"
}

PTZ device adding request:

https://[server_address]:[port]/settings/serialports/[port_GUID]/create_now_ptz=1?sid=[session_ID]

Response:

{
    "success": "1"
}

Request to get a settings of associated channel:

https://[address_server]:[port]/settings/serialports/[GUID_port]/[GUID_channel]/?sid=[id_session]

Response:

{
    "name" : "X3B8ZCgn",
    "type" : "SerialPtzRecord",
    "subdirs" : [

    ],
    "values" : [
        "ctime",
        "device_id",
        "ptz_associated_channel",
        "ptz_protocol"
    ]
}

Retrieve a value (R):

https://[address_server]:[port]/settings/serialports/[GUID_port]/[setting]?sid=[id_session]

Write a value (W):

https://[address_server]:[port]/settings/serialports/[GUID_port]/[setting]=[value]?sid=[id_session]

Table 147. 

values Description Type   TRASSIR
ctime   real RW ≥3.1
device_id Device ID integer RW ≥3.1
ptz_associated_channel Associated channel string RW ≥3.1
ptz_associated_channel PTZ protocol string RW ≥3.1

See also