Skip to main content

USB Actions

Source
This content is based on Cyanview's official manuals. Always check the official page for the latest information and precise specifications.
https://support-next.cyanview.com/docs/reference/usb-actions/

You can perform advanced operations by placing a text file containing predefined commands on a USB drive.

Preparation steps​

  1. Format a USB drive as FAT (see the relevant OS vendor's guide for instructions on Windows/macOS)
  2. Create a text file named cmd.txt in the root directory
  3. Write one command per line (commands are executed in order, from top to bottom)

Available commands​

network_reset​

Resets "persistent" network settings. Note that volatile IPs in the configuration are left unchanged.

config_reset​

Resets the device's configuration (cameras, router pairing, tally settings, volatile IPs, etc.). Persistent IPs are preserved.

reset_all​

Resets both the network and the configuration (including both volatile and persistent IPs). The device returns to its factory-default state.

take_snapshot​

Takes a snapshot of the device configuration and saves it to the USB drive as snapshot.<device serial number>.txt.

restore_snapshot​

Requires a valid snapshot file named snapshot.txt in the root directory of the USB drive. Restores the device's configuration to the contents of that file.

doc​

Outputs a list of available commands to a file named cmd_logs.<device serial number>.txt.

Logs​

The commands in cmd.txt are executed one line at a time, from top to bottom. For example, a file containing:

take_snapshot
reset_all

will:

  1. Take a snapshot of the running configuration.
  2. Then reset everything (persistent network settings and configuration).

A complete log of the commands is stored on the USB drive as cmd_logs.<device serial number>.txt.

Example​

The official site provides a ready-made cmd.txt example for returning a device to factory settings. It contains the same two lines as the example above: take_snapshot and reset_all. Because the configuration is saved as a snapshot on the USB drive before the reset, you can restore it later with restore_snapshot if needed.