HTTP Commands for Device Information

This is the list of commands or URLs used to get specific information about a device or interface with it.


  • These examples are from the commands used on a 1.2GHz AKD PDMM with firmware v4.00.0.89061, running KAS-IDE v4.00.0.89061.


  • The URL prefixes for the commands vary based on the controller model.
    Use http:// for AKD PDMM and PCMM models.
    Use https:// for PCMM2G.

Controller

Certificates


  • This feature is specific for PCMM2G only.

Information

Method

URL

Example Result

SSL Server Certificate Details

GET

https://(IP_Address)/controller/security/certificate_details

 
{
  "error": "", 
  "expiration_date": "11-13-2025 12:27:13 PM, PST", 
  "expired": false, 
  "status": "Installed", 
  "expiration_date_utc": 1763065633
}

Create SSL Server Certificate (Self-signed)

PUT

https://(IP_Address)/controller/security/ssl_certificate?orgName=<organization_name>&expPeriod=<expiration_period>

Possible responses:

  • Missing SSL Certificate information.
  • Failed to create SSL Certificate.
  • SSL certificate successfully created.
    Press OK to reboot.

List SSL Client Certificates

GET

https://(IP_Address)/certificates

 
{
  "Files" : [
  {
  "Name" : "t5opcua.der"
  },
  {
  "Name" : "uaexpert.der"
  }
  ]
}

Upload SSL Client Certificate

POST

https://(IP_Address)/controller/security/certificate_upload

 
{
  "message" : "Certificate upload was successful.",
  "status" : "success"
}

Delete SSL Client Certificate

DELETE

https://(IP_Address)/certificates/<certificate_file>

/certificates/uaexpert.der deleted.

CPU

Information

Method

URL

Example Result

CPU Cores, number of

GET

https://(IP_Address)/controller/cpu_cores

1

CPU Speed

GET

https://(IP_Address)/controller/cpu_speed

1.2GHz

Crash Dump

Information

Method

URL

Example Result

Crash Dump Files

GET

https://(IP_Address)/crashdumpfiles

Null

Date/Time and Time Synchronization


  • This feature is specific for PCMM2G only.

Information

Method

URL

Example Result

Date/Time and Time Zone information

GET

https://(IP_Address)/controller/date_time

 
{
  "dateTimeLocal" : {
   "day" : 20,
   "dst" : true,
   "hour" : 20,
   "minute" : 43,
   "month" : 10,
   "second" : 46,
   "year" : 2022
  },
   "dateTimeUTC" : 1666323826,
   "timeZoneName" : "America/Los_Angeles",
   "timeZoneOffsetSeconds"
 : -25200
}

List Available Time Zones

GET

https://(IP_Address)/controller/timezones_available

 
[
  {
    "display_name" : "Africa/Abidjan",
    "value" : "Africa/Abidjan"
  },
  {
    "display_name" : "Africa/Algiers",
    "value" : "Africa/Algiers"
  },
    …
]

NTP Server Name

GET

https://(IP_Address)/controller/ntp/server

time1.google.com

NTP Synchronization - Disable

PUT

https://(IP_Address)/controller/ntp/configured?use_ntp=false

NTP configuration updated to not synchronize Date/Time with external NTP server.

NTP Synchronization - Enable

PUT

https://(IP_Address)/controller/ntp/configured?use_ntp=true

NTP configuration updated to synchronize Date/Time with external NTP Server.

NTP Synchronization - Get Configured Status

GET

https://(IP_Address)/controller/ntp/configured

Possible responses:

  • Active
  • Disabled

NTP Synchronization - Status

GET

https://(IP_Address)/controller/ntp/synchronized

Possible responses:

  • Synchronized
  • Not Synchronized

Update Date/Time Setup

PUT

https://(IP_Address)/controller/date_time

HTTP Request Body:

  {
  “day” : 14
  “month” : 09
  “year” : 2022
  “hour” : 15
  “minute”: 07
  “second”: 47
  “dst”: true
  }

Possible responses:

  • Success: Date/Time settings updated.
  • Failure: Invalid Date/Time input.
  • Failure: Date/Time settings not updated.
    See the controller log for more information.

Update NTP Server Name

PUT

https://(IP_Address)/controller/ntp/server?newserver=<server_name>

Possible responses:

  • Success: NTP Server setting updated.
  • Failure: NTP Server setting not updated.

Update Time Zone

PUT

https://(IP_Address)/controller/timezone?newtimezone=”<timezone_name>”

Possible responses:

  • Success: Time Zone setting updated.
  • Failure: Invalid Time Zone input.
  • Failure: Time Zone setting not updated.
    See the controller log for more information.

Diagnostics

‡ - For dual-core systems, this value is the average between the two cores.

Information

Method

URL

Example Result

CPU Fan?

GET

https://(IP_Address)/controller/diagnostic/cpufanpresent

 
{
  "present" : "False"
}

CPU Temperature ‡

GET

https://(IP_Address)/controller/diagnostic/cputemp

 
{
  "currenttemp" : 54.750,

  "warninglevel" : "OK"
}

CPU Usage ‡

GET

https://(IP_Address)/controller/diagnostic/cpu

97

Subtract the value shown from 100 to get the current CPU use.

Device Drive Space

GET

https://(IP_Address)/controller/diagnostic/space

 
{
  "free" : "36017724",

  "total" : "38666240"
}

Device Memory

GET

https://(IP_Address)/controller/diagnostic/memory

 
{
  "available" : "170831872"
}

EEPROM

Information

Method

URL

Example Result

AKD Drive Hardware Revision

GET

https://(IP_Address)/controller/eeprom/optionboardhardwarerevision

P4C

This refers to the built-in AKD Drive in AKD PDMMs.

AKD Drive Serial Number

GET

https://(IP_Address)/controller/eeprom/optionboardserialnumber

B207000117

This refers to the built-in AKD Drive in AKD PDMMs.

Device Hardware Revision

GET

https://(IP_Address)/controller/eeprom/hardwarerevision

D1

Device Model Number

GET

https://(IP_Address)/controller/eeprom/modelnumber

AKD-M00306-M1EC-D000

Device Part Number

GET

https://(IP_Address)/controller/eeprom/partnumber

A195-0003

Device Serial Number

GET

https://(IP_Address)/controller/eeprom/serialnumber

R-1221-00203

EtherCAT MAC Address

GET

https://(IP_Address)/controller/eeprom/ethercatmacaddress

00:17:2f:b1:00:aa

TCP/IP MAC Address

GET

https://(IP_Address)/controller/eeprom/tcpipmacaddress

00:31:3d:f3:00:ec

Firmware

Information

Method

URL

Example Result

Firmware Version

GET

https://(IP_Address)/controller/firmware/version

2, 12, 0, 70432

Name of Firmware used by Controller

GET

https://(IP_Address)/controller/firmware/filename

KAS-PDMM-M-MCEC-{version}.img

Boot Loader Version

PCMM2G only.

GET

https://(IP_Address)/controller/firmware/uboot_version

2022.01.08

OS Version

PCMM2G only.

GET

https://(IP_Address)/controller/firmware/os_version

1.0.0.00373

Miscellaneous - Controller

Information

Method

URL

Example Result

Controller State

GET

https://(IP_Address)/controller/state

Stopped

Errors, current list of

GET

https://(IP_Address)/controller/errorjson

 
{
  "ListOfCurrentError" : null
}

Maintenance Mode Info

GET

https://(IP_Address)/controller/maintenanceinfo

Sample responses include:

  1. Backup the network.
  2. Retrieve the AKD firmware package.
  3. Entering pre-operational mode.
  4. Restoring firmware of AKD Drives.

Rotary Dial Position

GET

https://(IP_Address)/controller/rotary

1

Shared Directory Information

GET

https://(IP_Address)/controller/shareddir/SHARED_DIR_ALLINFO

 
{
  "directory" : {
     "value" : ""
   },
  "domain" : {
     "value" : ""
   },
  "ipAddress" : {
     "value" : ""
   },
  "mountStatus" : {
     "value" : "FALSE"
   },
  "netbiosName" : {
     "value" : ""
   },
  "spoofPosixAttributes" : {
     "value" : "FALSE"
   },
  "userName" : {
     "value" : ""
   },
  "userPassword" : {
     "value" : ""
   }
}

Network

Information

Method

URL

Example Result

Gateway Address

GET

https://(IP_Address)/controller/network/gateway

10.50.67.1

IP Address

GET

https://(IP_Address)/controller/network/ipaddress

10.50.67.133

Netmask Address

GET

https://(IP_Address)/controller/network/netmask

255.255.255.0

SD Card

Information

Method

URL

Example Result

Controller Backup - Export

GET

https://(IP_Address)/controller/sdcard/backup/export

 
{
  "message" : "Controller import was successful.",\n
  "status" : "success"\n
}

Controller Backup - Import

POST

https://(IP_Address)/controller/sdcard/backup/import

Sample responses include:

  1. The import was successful.
  2. The import failed.

Controller Backup - Status

GET

https://(IP_Address)/controller/sdcard/backup/status

 
{
  backupAvailable:"1"
}

SD Card Backup Status

GET

https://(IP_Address)/controller/sdcard/backup

SD card backup files are corrupt.

Security


  • This feature is specific for PCMM2G only.

Information

Method

URL

Example Result

SSH Connection Enable Status

GET

https://(IP_Address)/controller/security/ssh_connection

 
{
  "enabled": false,
  "error": null
}

Enable SSH

PUT

https://(IP_Address)/controller/security/ssh_connection?ssh_enabled=true

SSH connections have been enabled.

Disable SSH

PUT

https://(IP_Address)/controller/security/ssh_connection?ssh_enabled=false

SSH connections have been disabled; all active sessions have been terminated.

Non-Secure Connection Enable Status

GET

https://(IP_Address)/controller/security/http_connection

 
{
  "enabled": false,
  "error": null
}

Enable Non-Secure Connection (HTTP)

PUT

https://(IP_Address)/controller/security/http_connection?http_enabled=true

Non-secure connections have been enabled.

Disable Non-Secure Connection (HTTP)

PUT

https://(IP_Address)/controller/security/http_connection?http_enabled=false

Non-secure connections have been disabled.

EtherCAT

Information

Method

URL

Example Result

EtherCAT Backup - Date

GET

https://(IP_Address)/ethercat/backup/date

1480534150021

EtherCAT Backup - Firmware Package Status

GET

https://(IP_Address)/ethercat/backup/firmwarePackage

Sample Response 1: 

{
   "FWRequired" : false,
   "status" : "success"
}

Sample Response 2: 

{
   "FWPackageName" : "AKD-Firmware-for-KAS-V01-24-00-001.tgz",
   "FWPackageName2" : "AKD2G-Firmware-for-KAS-V02-14-00-000.tgz",
   "FWPackageName3" : "KED-Firmware-for-KAS-V02-14-01-000.tgz",
   "FWRequired" : true,
   "status" : "success"
}

EtherCAT Backup - Status

GET

https://(IP_Address)/ethercat/backup/devices/status

 
{
  "status" : "success"
}

EtherCAT Backup - Topology

GET

https://(IP_Address)/ethercat/backup/topology

 
{
   "CanPerformRestore" : true,
   "backupTime_h" : 405,
   "backupTime_l" : 2337279143,
   "crc16" : 54512,
   "topologyBackup" : {
      "DevList" : [
         {
            "modeInfo" : "KED-SPM-6V12S-A100-A000",
            "productId" : 353435904,
            "supportFwDownload" : true,
            "vendorId" : 106
         },
         {
            "modeInfo" : "AKD2G-SPE-7V03D-A1DX-0000",
            "productId" : 287375616,
            "supportFwDownload" : true,
            "vendorId" : 106
         },
      ],
      "Status" : "Ok"
   },
   "topologyCurrent" : {
      "DevList" : [
         {
            "hasChanged" : "no",
            "modeInfo" : "KED-SPM-6V12S-A100-A000",
            "previousRestoreFailed" : false,
            "productId" : 353435904,
            "serialNumber" : "\r-1702-04377",
            "supportFwDownload" : true,
            "vendorId" : 106
         },
         {
            "hasChanged" : "no",
            "modeInfo" : "AKD2G-SPE-7V03D-A1DX-0000",
            "previousRestoreFailed" : false,
            "productId" : 287375616,
            "serialNumber" : "\r-1711-12699",
            "supportFwDownload" : true,
            "vendorId" : 106
         },
      ],
      "Status" : "Ok"
   }
}

KAS Application

Information

Method

URL

Example Result

Autostart (true | false)

GET

https://(IP_Address)/kas/option/autostart

False

Axis Info of Running Application

GET

https://(IP_Address)/kas/monitoring/axis

 
[
  {
    "CurrentFBPosition" : 46693211.0,
      "CurrentPosition" : 46695964.0,
      "FBUnitsPerTurn" : 1048576,
      "Status" : 4159,
      "bPresent" : true,
      "driveID" : 1002,
      "szName" : "DrivePLCOpenAxis1",
  },
  {
      "CurrentFBPosition" : 113774031.0,
      "CurrentPosition" : 113779583.0,
      "FBUnitsPerTurn" : 1048576,
      "Status" : 4159,
      "bPresent" : true,
      "driveID" : 1003,
      "szName" : "DrivePLCOpenAxis1",
  }
]

Start Application

PUT

https://(IP_Address)/kas/state?newstate=started

Started

Stop Application

PUT

https://(IP_Address)/kas/state?newstate=stopped

Stopped

Log File

Information

Method

URL

Example Result

Log File Level Configuration

GET

https://(IP_Address)/logsconfig

 
{
   "LogSource" : {
      "Controller" : "WARNING",
      "Drive" : "WARNING",
      "EtherCAT" : "WARNING",
      "IDE" : "WARNING",
      "Motion" : "WARNING",
      "PLC" : "WARNING",
      "System" : "WARNING"
      "Unknown" : "WARNING"
    }
}

Log File Names

GET

https://(IP_Address)/logfiles

 
{
    "Files" : [
        {
            "Name" : "pdmm_log"
        },
        {
            "Name" : "pdmm_log_0000000000"
        },
        {
            "Name" : "pdmm_log_0000000001"
        }
    ]
}

Miscellaneous

Information

Method

URL

Example Result

Application Version Information

GET

https://(IP_Address)/appfiles/VersInfo.xml

 
<?xml version="1.0"?>
<
 deviceInfo compilerBuildNumber="2, 12, 0, 70453"  
 compilerVersion="2, 12, 0, 70453" 
 sinopeMinimalVersion="0" 
 compiledAt="2017-01-12T09:15:52" 
 build="375" 
 version="" 
 device="Controller" 
 project="MachRegistFT"
/>

Project Source

GET

https://(IP_Address)/projectsource/projectsource.kas

This command downloads and tries to open or save the KAS file.

Shared Directory Files

GET

https://(IP_Address)/sharedDirectoryFiles

/sharedDirectoryFiles not found.

A shared directory needs to be set up for this command to work.

User Files

GET

https://(IP_Address)/userfiles

 
{
  "Files" : [
    {
      "Name" : "TestOutput.csv"
    }
  ]
}