Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
http://merlin.local:55552/v0/frenzel_state

Body for PUT

Code Block
{
    "side": "right",
    "state": "run",
    "duration_set": 20000,
    "duration_done": 0,
    "fps": 100
}

Body for GET

Code Block
{
    "side": "right"
}

Response for GET

Advanced code syntax highlighter
version2
{"code":"{\n  \"side\": \"right\",\n  \"state\": \"reset\",\n  \"duration_set\": 600000,\n  \"duration_done\": 0,\n  \"fps\": 500,\n  \"roi\": {\n    \"x\": 207,\n    \"y\": 319,\n    \"width\": 350,\n    \"height\": 190,\n    \"hflip\": true,\n    \"vflip\": true\n  }\n}","theme":"coy","language":"json","showLineNumbers":true}

The body for a GET request can be reduced to just indicate the camera side for which the state shall be send.

However, the full body as for PUT can be Send as well. All other information beside side is ignored.

MQTT response

none

Notes

This endpoint controls and reports the state of recording in Frenzel mode.

side

The camera side requested to be returned or modified.

...

state

The state returned by a GET request represents the current state of the Frenzel mode. The state which is sent in PUT request triggers a state transition.

  • “run” - start the recording

    • valid in “reset”

    • transits to “run”

  • “stop” - stop the recording

    • valid in “run”

    • transits to “stop”

  • “reset” - reset stored file and set Duration_done to 0

    • valid in “run” and “stop”

    • transits to “reset”

See Frenzel Mode /wiki/spaces/DPET/pages/2311028985 for possible state transitions.

...

This integer value represents the requested duration in ms for the recording.

duration_done

This integer value represents the currently recorded duration of recording.

Note

The value is ignored in PUT requests but musst be contained in the struct.

Examples

Expand
titleGET frenzel_state

image-20240822-100243.pngImage Added

Expand
titlePUT frenzel_state in reset state to change Duration_set

image-20240822-100154.pngImage Added

Expand
titlePUT frenzel_state into run state incl. setting Duration_set
image-20240822-100347.pngImage Added