System and logs

The following resources and requests expose the rc_visard’s system-level API. They enable

  • access to log files (system-wide or module-specific)
  • access to information about the device and run-time statistics such as date, MAC address, clock-time synchronization status, and available resources;
  • management of installed software licenses; and
  • the rc_visard to be updated with a new firmware image.
GET /logs

Get list of available log files.

Template request

GET /api/v2/logs HTTP/1.1

Sample response

HTTP/1.1 200 OK
Content-Type: application/json

[
  {
    "date": 1503060035.0625782,
    "name": "rcsense-api.log",
    "size": 730
  },
  {
    "date": 1503060035.741574,
    "name": "stereo.log",
    "size": 39024
  },
  {
    "date": 1503060044.0475223,
    "name": "camera.log",
    "size": 1091
  },
  {
    "date": 1503060035.2115774,
    "name": "dynamics.log"
  }
]
Response Headers:
 
Status Codes:
  • 200 OK – successful operation (returns array of LogInfo)
Referenced Data Models:
 
GET /logs/{log}

Get a log file. Content type of response depends on parameter ‘format’.

Template request

GET /api/v2/logs/<log>?format=<format>&limit=<limit> HTTP/1.1

Sample response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "date": 1503060035.2115774,
  "log": [
    {
      "component": "rc_stereo_ins",
      "level": "INFO",
      "message": "Running rc_stereo_ins version 2.4.0",
      "timestamp": 1503060034.083
    },
    {
      "component": "rc_stereo_ins",
      "level": "INFO",
      "message": "Starting up communication interfaces",
      "timestamp": 1503060034.085
    },
    {
      "component": "rc_stereo_ins",
      "level": "INFO",
      "message": "Autostart disabled",
      "timestamp": 1503060034.098
    },
    {
      "component": "rc_stereo_ins",
      "level": "INFO",
      "message": "Initializing realtime communication",
      "timestamp": 1503060034.209
    },
    {
      "component": "rc_stereo_ins",
      "level": "INFO",
      "message": "Startet state machine in state IDLE",
      "timestamp": 1503060034.383
    },
    {
      "component": "rc_stereovisodo",
      "level": "INFO",
      "message": "Init stereovisodo ...",
      "timestamp": 1503060034.814
    },
    {
      "component": "rc_stereovisodo",
      "level": "INFO",
      "message": "rc_stereovisodo: Using standard VO",
      "timestamp": 1503060034.913
    },
    {
      "component": "rc_stereovisodo",
      "level": "INFO",
      "message": "rc_stereovisodo: Playback mode: false",
      "timestamp": 1503060035.132
    },
    {
      "component": "rc_stereovisodo",
      "level": "INFO",
      "message": "rc_stereovisodo: Ready",
      "timestamp": 1503060035.212
    }
  ],
  "name": "dynamics.log",
  "size": 695
}
Parameters:
  • log (string) – name of the log file (required)
Query Parameters:
 
  • format (string) – return log as JSON or raw (one of json, raw; default: json) (optional)
  • limit (integer) – limit to last x lines in JSON format (default: 100) (optional)
Response Headers:
 
Status Codes:
Referenced Data Models:
 
GET /system

Get system information on sensor.

Template request

GET /api/v2/system HTTP/1.1

Sample response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "dns": {
    "dns_servers": [
      "10.0.0.1",
      "1.1.1.1"
    ],
    "manual_dns_servers": [
      "1.1.1.1"
    ]
  },
  "firmware": {
    "active_image": {
      "image_version": "rc_visard_v1.1.0"
    },
    "fallback_booted": true,
    "inactive_image": {
      "image_version": "rc_visard_v1.0.0"
    },
    "next_boot_image": "active_image"
  },
  "hostname": "rc-visard-02873515",
  "link_speed": 1000,
  "mac": "00:14:2D:2B:D8:AB",
  "ntp_status": {
    "accuracy": "48 ms",
    "synchronized": true
  },
  "ptp_status": {
    "master_ip": "",
    "offset": 0,
    "offset_dev": 0,
    "offset_mean": 0,
    "state": "off"
  },
  "ready": true,
  "serial": "02873515",
  "time": 1504080462.641875,
  "uptime": 65457.42
}
Response Headers:
 
Status Codes:
  • 200 OK – successful operation (returns SysInfo)
Referenced Data Models:
 
GET /system/backup

Get backup.

Template request

GET /api/v2/system/backup?pipelines=<pipelines>&load_carriers=<load_carriers>&regions_of_interest=<regions_of_interest>&grippers=<grippers> HTTP/1.1
Query Parameters:
 
  • pipelines (boolean) – backup pipelines with node settings, i.e. parameters and preferred_orientation (default: True) (optional)
  • load_carriers (boolean) – backup load_carriers (default: True) (optional)
  • regions_of_interest (boolean) – backup regions_of_interest (default: True) (optional)
  • grippers (boolean) – backup grippers (default: True) (optional)
Response Headers:
 
Status Codes:
  • 200 OK – successful operation
POST /system/backup

Restore backup.

Template request

POST /api/v2/system/backup HTTP/1.1
Accept: application/json

{}

Sample response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "return_code": {
    "message": "backup restored",
    "value": 0
  },
  "warnings": []
}
Request JSON Object:
 
  • backup (object) – backup data as json object (required)
Request Headers:
 
Response Headers:
 
Status Codes:
  • 200 OK – successful operation
GET /system/dns

Get DNS settings.

Template request

GET /api/v2/system/dns HTTP/1.1

Sample response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "dns": {
    "dns_servers": [
      "10.0.0.1",
      "1.1.1.1"
    ],
    "manual_dns_servers": [
      "1.1.1.1"
    ]
  }
}
Response Headers:
 
Status Codes:
  • 200 OK – successful operation (returns DNS)
Referenced Data Models:
 
PUT /system/dns

Set manual DNS servers.

Template request

PUT /api/v2/system/dns HTTP/1.1
Accept: application/json

{}

Sample response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "dns": {
    "dns_servers": [
      "10.0.0.1",
      "1.1.1.1"
    ],
    "manual_dns_servers": [
      "1.1.1.1"
    ]
  }
}
Request JSON Object:
 
  • manual_dns_servers (ManualDNSServers) – Manual DNS servers (required)
Request Headers:
 
Response Headers:
 
Status Codes:
Referenced Data Models:
 
GET /system/license

Get information about licenses installed on sensor.

Template request

GET /api/v2/system/license HTTP/1.1

Sample response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "components": {
    "calibration": true,
    "fusion": true,
    "hand_eye_calibration": true,
    "rectification": true,
    "self_calibration": true,
    "slam": false,
    "stereo": true,
    "svo": true
  },
  "valid": true
}
Response Headers:
 
Status Codes:
  • 200 OK – successful operation (returns LicenseInfo)
Referenced Data Models:
 
POST /system/license

Update license on sensor with a license file.

Template request

POST /api/v2/system/license HTTP/1.1
Accept: multipart/form-data
Form Parameters:
 
  • file – license file (required)
Request Headers:
 
  • Accept – multipart/form-data
Status Codes:
GET /system/network

Get current network configuration.

Template request

GET /api/v2/system/network HTTP/1.1

Sample response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "current_method": "DHCP",
  "default_gateway": "10.0.3.254",
  "ip_address": "10.0.1.41",
  "settings": {
    "dhcp_enabled": true,
    "persistent_default_gateway": "",
    "persistent_ip_address": "192.168.0.10",
    "persistent_ip_enabled": false,
    "persistent_subnet_mask": "255.255.255.0"
  },
  "subnet_mask": "255.255.252.0"
}
Response Headers:
 
Status Codes:
  • 200 OK – successful operation (returns NetworkInfo)
Referenced Data Models:
 
GET /system/network/settings

Get current network settings.

Template request

GET /api/v2/system/network/settings HTTP/1.1

Sample response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "dhcp_enabled": true,
  "persistent_default_gateway": "",
  "persistent_ip_address": "192.168.0.10",
  "persistent_ip_enabled": false,
  "persistent_subnet_mask": "255.255.255.0"
}
Response Headers:
 
Status Codes:
  • 200 OK – successful operation (returns NetworkSettings)
Referenced Data Models:
 
PUT /system/network/settings

Set current network settings.

Template request

PUT /api/v2/system/network/settings HTTP/1.1
Accept: application/json

{}

Sample response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "dhcp_enabled": true,
  "persistent_default_gateway": "",
  "persistent_ip_address": "192.168.0.10",
  "persistent_ip_enabled": false,
  "persistent_subnet_mask": "255.255.255.0"
}
Request JSON Object:
 
  • settings (NetworkSettings) – network settings to apply (required)
Request Headers:
 
Response Headers:
 
Status Codes:
  • 200 OK – successful operation (returns NetworkSettings)
  • 400 Bad Request – invalid/missing arguments
  • 403 Forbidden – Changing network settings forbidden because this is locked by a running GigE Vision application.
Referenced Data Models:
 
PUT /system/reboot

Reboot the sensor.

Template request

PUT /api/v2/system/reboot HTTP/1.1
Status Codes:
  • 200 OK – successful operation
GET /system/rollback

Get information about currently active and inactive firmware/system images on sensor.

Template request

GET /api/v2/system/rollback HTTP/1.1

Sample response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "active_image": {
    "image_version": "rc_visard_v1.1.0"
  },
  "fallback_booted": false,
  "inactive_image": {
    "image_version": "rc_visard_v1.0.0"
  },
  "next_boot_image": "active_image"
}
Response Headers:
 
Status Codes:
  • 200 OK – successful operation (returns FirmwareInfo)
Referenced Data Models:
 
PUT /system/rollback

Rollback to previous firmware version (inactive system image).

Template request

PUT /api/v2/system/rollback HTTP/1.1
Status Codes:
GET /system/time

Get system time in UTC as string with format “YYYY-MM-DD hh:mm:ss”

Template request

GET /api/v2/system/time HTTP/1.1

Sample response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "utc": "2023-10-05 08:35:26"
}
Response Headers:
 
Status Codes:
  • 200 OK – successful operation
PUT /system/time

Set system time in UTC as string with format “YYYY-MM-DD hh:mm:ss”

Template request

PUT /api/v2/system/time?utc=<utc> HTTP/1.1

Sample response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "utc": "2023-10-05 08:35:26"
}
Query Parameters:
 
  • utc (string) – Time in UTC as string with format “YYYY-MM-DD hh:mm:ss” (required)
Response Headers:
 
Status Codes:
GET /system/ui_lock

Get UI lock status.

Template request

GET /api/v2/system/ui_lock HTTP/1.1

Sample response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "enabled": false
}
Response Headers:
 
Status Codes:
  • 200 OK – successful operation (returns UILock)
Referenced Data Models:
 
DELETE /system/ui_lock

Remove UI lock.

Template request

DELETE /api/v2/system/ui_lock HTTP/1.1

Sample response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "enabled": false,
  "valid": false
}
Response Headers:
 
Status Codes:
  • 200 OK – successful operation
POST /system/ui_lock

Verify or set UI lock.

Template request

POST /api/v2/system/ui_lock?hash=<hash>&set=<set> HTTP/1.1

Sample response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "enabled": true,
  "valid": true
}
Query Parameters:
 
  • hash (string) – hash of the UI lock password (required)
  • set (boolean) – set new hash instead of veryfing (optional)
Response Headers:
 
Status Codes:
  • 200 OK – successful operation
GET /system/update

Get information about currently active and inactive firmware/system images on sensor.

Template request

GET /api/v2/system/update HTTP/1.1

Sample response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "active_image": {
    "image_version": "rc_visard_v1.1.0"
  },
  "fallback_booted": false,
  "inactive_image": {
    "image_version": "rc_visard_v1.0.0"
  },
  "next_boot_image": "active_image"
}
Response Headers:
 
Status Codes:
  • 200 OK – successful operation (returns FirmwareInfo)
Referenced Data Models:
 
POST /system/update

Update firmware/system image with a mender artifact. Reboot is required afterwards in order to activate updated firmware version.

Template request

POST /api/v2/system/update HTTP/1.1
Accept: multipart/form-data
Form Parameters:
 
  • file – mender artifact file (required)
Request Headers:
 
  • Accept – multipart/form-data
Status Codes: