SCI (Server Command Interface)

SCI (Server Command Interface) is a web service that allows users to access information and perform commands that relate to their device.

Examples of SCI requests include:

  • Retrieve live or cached information about your device(s)
  • Change settings on your device(s)
  • Interact with a Python program running on your device(s) to send commands or retrieve information
  • Read from and write to the file system on your device(s)
    • Update your Python applications
    • Retrieve data stored locally on your device(s)
  • Update device firmware
  • Update XBee radio firmware on your device(s)
  • Remotely reboot your device(s)

The operations can be performed synchronously or asynchronously. Synchronous requests are useful if you would like to execute a short request to the server and block until the operation is completed. Asynchronous requests are useful when you want to execute a request that has the possibility of taking a while to complete or you simply want to send the request off and return immediately. With asynchronous requests, you receive an ID that you can later use to check on the job status and retrieve results.

An SCI request is composed of XML that is posted to http(s)://<hostname>/ws/sci.