Commands | C-cloud User Manual

# Commands

Wakeup Command
Sleep Command
Upgrade Command
Brightness Command
Reboot Command
Volume Command
Color Temperature Command
Onboard Relay Command
Clear Cache Command
Relay Command
Switch Signal Source Command
Set Language and Region Command
Set Time Zone Command
Screenshot Command
GPS Reporting Command
Adjust Monitoring Reporting Interval Command
Enable or Disable Content Reporting Command
Report Terminal Runtime Log Command
Enable/Disable Terminal Log Reporting Command
Network Interface Configuration Reporting Command
Enable/Disable Reporting of Carousel Schedule Program Name Command
Update Program Command
Switch Program Command
Clear Program Command
Delete Terminal Program Command

"post": Terminal ID, not processed by the device. Optional.

# Brightness Command

Example:

Parameter: Brightness.

The range of brightness values: 0-255.

Command command = CommandGenerator.createBrightnessCommand(88);

Response:

{
	"id": 1,
	"post": 1,
	"author_url": "api/brightness",
	"content": {
		"raw": "{\"brightness\":88}"
	},
	"karma": 2
}

# Upgrade Command

Example:

Parameter: Upgrade package URL

Command command = CommandGenerator.createUpgradeCommand("http://ip/wp-content/upload/2020/12/update_c1_v1.67.1.1329_b7c809cdb9bd4a78500d3bd8c27f0de9_480774370.zip");

Response:

{
	"id": 1,
	"post": 1,
	"author_url": "api/update",
	"content": {
		"raw": "http://ip/wp-content/upload/2020/12/update_c1_v1.67.1.1329_b7c809cdb9bd4a78500d3bd8c27f0de9_480774370.zip"
	},
	"karma": 0
}

# Reboot Command

Example:

Command command = CommandGenerator.createRebootCommand();

Response:

{
	"id": 1,
	"post": 1,
	"author_url": "api/action",
	"content": {
		"raw": "{\"command\":\"reboot\"}"
	},
	"karma": 1
}

# Screenshot Command

Example:

Command command = CommandGenerator.createScreenshotCommand();

Response:

{
	"id": 1,
	"post": 1,
	"author_url": "transmission/ftp/config",
	"content": {
		"raw": "{}"
	},
	"karma": 0
}

# Sleep Command

Example:

Command command = CommandGenerator.createSleepCommand();

Response:

{
    "id": 1,
    "post": 1,
    "author_url": "api/action",
    "content": {
        "raw": "{\"command\":\"sleep\"}" 
    },
    "karma": 1
}

# Update Program Command

Example:

Command command = CommandGenerator.createUpdateProgramCommand();

Response:

{
	"id": 1,
	"post": 1,
	"author_url": "",
	"content": {
		"raw": "{\"program\":\"dirty\"}"
	},
	"karma": 0
}

# Wakeup Command

Example:

Command command = CommandGenerator.createWakeupCommand();

Response:

{
    "id": 1,
    "post": 1,
    "author_url": "api/action",
    "content": {
        "raw": "{\"command\":\"wakeup\"}" 
    },
    "karma": 1
}

# Schedule Command

Example:

Command command = CommandGenerator.createScheduleCommand();

Response:

{
    "id":1,
    "post":1,
    "author_url":"",
    "content":{
        "raw":"{\"program\":\"schedule\"}"
    },
    "karma":0
}

# Onboard Relay Command

Example:

Parameter: Board relay status value (0: Close; 1: Open)

Command command = CommandGenerator.createBoardRelayCommand(1);

Response:

{
    "id":1,
    "post":1,
    "author_url":"api/board_relay",
    "content":{
        "raw":"[{\"relay\":1,\"delay\":0,\"status\":1}]"
    },
    "karma":2
}

# Relay Command

Example:

Parameter: Relays 1, 2, and 3 status values, such as "[1, 1, 0]", where 0: Close, 1: Open

Command command = CommandGenerator.createRelayCommand(1,1,1);

Response:

{
    "id":1,
    "post":1,
    "author_url":"api/relay",
    "content":{
"raw":"[{\"relay\":1,\"delay\":0,\"status\":1},{\"relay\":2,\"delay\":0,\"status\":1},{\"relay\":3,\"delay\":0,\"status\":1}]"
    },
    "karma":2
}

# Clear Cache Command

Example:

Command command = CommandGenerator.createClearCacheCommand();

Response:

{
    "id":1,
    "post":1,
    "author_url":"api/clrresunused",
    "content":{
        "raw":"{}"
    },
    "karma":3
}

# Color Temperature Command

Example:

Parameter: Color temperature, with a range between 2000 and 10000

Command command = CommandGenerator.createColortempCommand(2222);

Response:

{
    "id":1,
    "post":1,
    "author_url":"api/colortemp",
    "content":{
        "raw":"{\"colortemp\":2222}"
    },
    "karma":2
}

# Switch Signal Source Command

Example:

Parameter: Signal type, where 0: Sync signal (HDMI), 1: Async signal (DVI)

Command command = CommandGenerator.createSwitchSignalSourceCommand(0);

Response:

{
    "id":1,
    "post":1,
    "author_url":"api/inputmode",
    "content":{
        "raw":"{\"inputmode\":\"hdmi\"}"
    },
    "karma":2
}

# Volume Command

Parameter: Volume.

The output volume is divided into 16levels (0-15), with 15 representing 100% volume.

Example:

Command command = CommandGenerator.createVolumeCommand(10);

Response:

{
    "id":1,
    "post":1,
    "author_url":"api/volume",
    "content":{
        "raw":"{\"musicvolume\":10}"
    },
    "karma":2
}

# GPS Reporting Command

Parameter：

"gpsReportInterval": GPS reporting interval in seconds; when set to 0, GPS reporting is disabled.

Example:

Command command = CommandGenerator.createGpsReportCommand(30);

Response:

{
    "id": 1,
    "post": 1,
    "author_url":"api/setreporttime",
    "content":{
        "raw": "{\"gps.report.interval\":30}"
    },
    "karma": 1
}

# Switch Program Command

Parameter："type": Program sources；"name": Program name.

You can view the program list in the status information reported by the device.

Example of vsns content is as follows：

{
  "contents": [
    {
      "unused": 0,
      "ressize": 0,
      "type": "lan",
      "content": [
        {
          "size": 5075,
          "name": "Playlist8770_319e0214d9f829fa1a461106c9665504_5075.vsn",
          "publishedmd5": "",
          "md5": ""
        }
      ]
    },
    {
      "unused": 3735273,
      "ressize": 4065575,
      "type": "internet",
      "content": [
        {
          "size": 331634,
          "name": "Playlist9017_783596d9ee396d7a604dac56a6979546_1332.vsn",
          "publishedmd5": "",
          "md5": ""
        }
      ]
    }
  ],
  "playing": {
    "name": "Playlist8770_319e0214d9f829fa1a461106c9665504_5075.vsn",
    "type": "internet"
  }
}

Example：

Command command = CommandGenerator.createSwitchProgramCommand("internet", "Playlist9017_783596d9ee396d7a604dac56a6979546_1332.vsn");

Response:

{
  "post": 1,
  "id": 1,
  "author_url": "api/vsns/sources/internet/vsns/Playlist9017_783596d9ee396d7a604dac56a6979546_1332.vsn/activated",
  "content": {
    "raw": "{\"command\":\"\"}"
  },
  "karma": 2
}

# Adjust Monitoring Reporting Interval Command

Parameter：

"sensor.report.interval": is the sensor reporting interval, in seconds

"ber.report.interval": is the bit error rate reporting interval, in seconds

When set to 0, the terminal will not report.

Example：

Command command = CommandGenerator.createSensorReportCommand(180, 180);

Response:

{
  "post": 1,
  "id": 1,
  "author_url": "api/setreporttime",
  "content": {
    "raw": "{\"sensor.report.interval\":\"180\",\"ber.report.interval\":\"180\"}"
  },
  "karma": 1
}

# Enable or Disable Content Reporting Command

(Switch of playing statistics)

Parameter：

"status": "status": 1: Enable, 0: Disable.

Example：

Command command = CommandGenerator.createContentReportCommand(1);

Response:

{
  "post": 1,
  "id": 1,
  "author_url": "api/contentreport",
  "content": {
    "raw": "{\"status\":1}"
  },
  "karma": 2
}

# Clear Program Command

This command is used to clear all programs of the player.

Example：

Command command = CommandGenerator.createClearProgramsCommand();

Response:

{
  "id":1,
  "post":1,
  "author_url":"api/clrprgms",
  "content":{
    "raw":"{}"
  },
  "karma":3
}

# Delete Terminal Program Command

Parameter：

You can view the device's program list and switch between programs in the status data reported by the device.

"author_url": api/vsns/sources/ + program source (type) + /vsns/ + program name (name)

Example：

Command command = CommandGenerator.createDeleteProgramCommand("internet", "Playlist9017_783596d9ee396d7a604dac56a6979546_1332.vsn");

Response:

{
  "id":1,
  "post":1,
  "author_url":"api/vsns/sources/internet/vsns/Playlist9017_783596d9ee396d7a604dac56a6979546_1332.vsn",
  "content":{
    "raw":"{\"command\":\"\"}"
  },
  "karma":3
}

# Report Terminal Runtime Log Command

Currently, log reporting is supported only on terminals with version 1.70.5 or higher, as well as certain customized versions.

Example：

Command command = CommandGenerator.createHistoryLogReportCommand();

Response:

{
  "id":1,
  "post":1,
  "author_url":"api/current_log",
  "content":{
    "raw":"{}"
  },
  "karma":0
}

# Set Language and Region Command

Parameters in "{"language":"zh","country":"HK"}":

Language: Refer to: https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes (opens new window)

Region: Refer to: https://en.wikipedia.org/wiki/ISO_3166-2 (opens new window)

You can also refer to: https://doc.weixin.qq.com/doc/w3_AbIAhwbDAOwV1GV28m2Rgu1MPj9bh?scode=ABoA9QdVAGEFbOVZu7AbIAhwbDAOw (opens new window)

Chinese (China): zh-CN

English (Canada): en, CA

Example：

Command command = CommandGenerator.createLanguageAndCountryCommand("zh", "CN");

Response:

{
  "id":1,
  "post":1,
  "author_url":"api/locale",
  "content":{
    "raw":"{\"language\":\"zh\",\"country\":\"CN\"}"
  },
  "karma":2
}

# Terminal Log Reporting Command

Enable/Disable Terminal Log Reporting Command

"{"log_report":"on"}": "on" means enabled; "off" means disabled.

Example：

Command command = CommandGenerator.createLogReportCommand(1);

Response:

{
  "id":1,
  "post":1,
  "author_url":"api/reportswitch",
  "content":{
    "raw":"{\"log_report\":\"on\"}"
  },
  "karma":2
}

# Network Interface Configuration Reporting Command

The reported content is from the ifstatus interface in the terminal status.

Example：

Command command = CommandGenerator.createNetworkStatusReportCommand();

Response:

{
  "id":1,
  "post":1,
  "author_url":"api/ifstatus",
  "content":{
    "raw":"{}"
  },
  "karma":0
}

# Reporting of Carousel Schedule Program Name Command

Enable/Disable Reporting of Carousel Schedule Program Name Command

You can enable or disable the reporting of carousel program names by modifying the "reportswitch.rotate_program_vsns_report" field in the terminal status.

"{"rotate_program_vsns_report":"on"}": "on" means enabled; "off" means disabled.

Parameter：

status：1: on；0: off

Example：

Command command = CommandGenerator.createRotateProgramVsnsReportCommand(1);

Response:

{
  "id":1,
  "post":1,
  "author_url":"api/reportswitch",
  "content":{
    "raw":"{\"rotate_program_vsns_report\":\"on\"}"
  },
  "karma":2
}

# Set Time Zone Command

timezoneId: Time zone ID

timezone: The offset of this time zone from UTC

isautotime: Whether to automatically synchronize time (1: Yes, 0: No)

For details, refer to: https://www.zeitverschiebung.net/cn/all-time-zones.html (opens new window)

You can also refer to: https://doc.weixin.qq.com/doc/w3_AbIAhwbDAOwV1GV28m2Rgu1MPj9bh?scode=ABoA9QdVAGEFbOVZu7AbIAhwbDAOw (opens new window)

（UTC+08:00）Asia/Shanghai: timezoneId: Asia/Shanghai, timezone: 8

（UTC-07:00）America/Creston: timezoneId: America/Creston, timezone: -7

Example：

Command command = CommandGenerator.createTimeZoneCommand("Asia/Taipei", 8, 1);

Response:

{
  "id": 1,
  "post": 1,
  "author_url": "api/newrtc",
  "content": {
    "raw": "{\"timezoneId\":\"Asia/Taipei\",\"timezone\":8,\"isautotime\":1}"
  },
  "karma": 2
}