Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
software:digilent-instrumentation-protocol:device [2021/05/14 23:05] – ↷ Page moved from reference:software:digilent-instrumentation-protocol:device to software:digilent-instrumentation-protocol:device Arthur Brownsoftware:digilent-instrumentation-protocol:device [2022/10/04 11:38] (current) – external edit 127.0.0.1
Line 221: Line 221:
   * **device** - (Array<Object>) - Array of response objects to apply to the device.   * **device** - (Array<Object>) - Array of response objects to apply to the device.
     * **command** - (String) - The Enter Bootloader command: “enterBootloader”     * **command** - (String) - The Enter Bootloader command: “enterBootloader”
-    * **statusCode** - (Integer) - A numeric value representing the device status.  See [[reference/software/digilent-instrumentation-protocol/status-codes]]+    * **statusCode** - (Integer) - A numeric value representing the device status.  See [[software:digilent-instrumentation-protocol:status-codes]]
     * **wait** - (Integer) - The number of ms to wait before the device is ready to process another command.           * **wait** - (Integer) - The number of ms to wait before the device is ready to process another command.      
        
Line 264: Line 264:
   * **device** - (Array<Object>) - Array of response objects to apply to the device.   * **device** - (Array<Object>) - Array of response objects to apply to the device.
     * **command** - (String) - The Calibration Get Instructions command: “calibrationGetInstructions”     * **command** - (String) - The Calibration Get Instructions command: “calibrationGetInstructions”
-    * **statusCode** - (Integer) - A numeric value representing the device status.  See [[reference/software/digilent-instrumentation-protocol/status-codes]]+    * **statusCode** - (Integer) - A numeric value representing the device status.  See [[software:digilent-instrumentation-protocol:status-codes]]
     * **wait** - (Integer) - The number of ms to wait before the device is ready to process another command.     * **wait** - (Integer) - The number of ms to wait before the device is ready to process another command.
     * **calibrationInstructions** - (String) - User calibration instructions.         * **calibrationInstructions** - (String) - User calibration instructions.    
Line 309: Line 309:
   * **device** - (Array<Object>) - Array of response objects to apply to the device.   * **device** - (Array<Object>) - Array of response objects to apply to the device.
     * **command** - (String) - The Calibration Get Status command: "calibrationGetStatus"     * **command** - (String) - The Calibration Get Status command: "calibrationGetStatus"
-    * **statusCode** - (Integer) - A numeric value representing the device status.  See [[reference/software/digilent-instrumentation-protocol/status-codes]]+    * **statusCode** - (Integer) - A numeric value representing the device status.  See [[software:digilent-instrumentation-protocol:status-codes]]
     * **wait** - (Integer) - The number of ms to wait before the device is ready to process another command.         * **wait** - (Integer) - The number of ms to wait before the device is ready to process another command.    
     * **status** - (String) - The calibration process status: "idle", "runningPretest", "calibrating", "calibrationFailed".     * **status** - (String) - The calibration process status: "idle", "runningPretest", "calibrating", "calibrationFailed".
Line 354: Line 354:
   * **device** - (Array<Object>) - Array of response objects to apply to the device.   * **device** - (Array<Object>) - Array of response objects to apply to the device.
     * **command** - (String) - The Get Calibration Storage Types command: "calibrationGetStorageTypes"     * **command** - (String) - The Get Calibration Storage Types command: "calibrationGetStorageTypes"
-    * **statusCode** - (Integer) - A numeric value representing the device status.  See [[reference/software/digilent-instrumentation-protocol/status-codes]]+    * **statusCode** - (Integer) - A numeric value representing the device status.  See [[software:digilent-instrumentation-protocol:status-codes]]
     * **wait** - (Integer) - The number of ms to wait before the device is ready to process another command.         * **wait** - (Integer) - The number of ms to wait before the device is ready to process another command.    
     * **storageTypes** - (Array<String>) - Array of calibration storage types (ex. 'flash', 'sd').     * **storageTypes** - (Array<String>) - Array of calibration storage types (ex. 'flash', 'sd').
Line 403: Line 403:
   * **device** - (Array<Object>) - Array of response objects to apply to the device.   * **device** - (Array<Object>) - Array of response objects to apply to the device.
     * **command** - (String) - The Calibration Load command: "calibrationLoad"     * **command** - (String) - The Calibration Load command: "calibrationLoad"
-    * **statusCode** - (Integer) - A numeric value representing the device status.  See [[reference/software/digilent-instrumentation-protocol/status-codes]]+    * **statusCode** - (Integer) - A numeric value representing the device status.  See [[software:digilent-instrumentation-protocol:status-codes]]
     * **wait** - (Integer) - The number of ms to wait before the device is ready to process another command.         * **wait** - (Integer) - The number of ms to wait before the device is ready to process another command.    
  
Line 449: Line 449:
   * **device** - (Array<Object>) - Array of response objects to apply to the device.   * **device** - (Array<Object>) - Array of response objects to apply to the device.
     * **command** - (String) - The Calibration Read command: "calibrationRead".     * **command** - (String) - The Calibration Read command: "calibrationRead".
-    * **statusCode** - (Integer) - A numeric value representing the device status.  See [[reference/software/digilent-instrumentation-protocol/status-codes]]+    * **statusCode** - (Integer) - A numeric value representing the device status.  See [[software:digilent-instrumentation-protocol:status-codes]]
     * **wait** - (Integer) - The number of ms to wait before the device is ready to process another command.         * **wait** - (Integer) - The number of ms to wait before the device is ready to process another command.    
     * **calibrationData** - (Object) - Device specific calibration data expressed as a JSON object.       * **calibrationData** - (Object) - Device specific calibration data expressed as a JSON object.  
Line 500: Line 500:
   * **device** - (Array<Object>) - Array of response objects to apply to the device.   * **device** - (Array<Object>) - Array of response objects to apply to the device.
     * **command** - (String) - The Calibration Save command: "calibrationSave"     * **command** - (String) - The Calibration Save command: "calibrationSave"
-    * **statusCode** - (Integer) - A numeric value representing the device status.  See [[reference/software/digilent-instrumentation-protocol/status-codes]]+    * **statusCode** - (Integer) - A numeric value representing the device status.  See [[software:digilent-instrumentation-protocol:status-codes]]
     * **wait** - (Integer) - The number of ms to wait before the device is ready to process another command.         * **wait** - (Integer) - The number of ms to wait before the device is ready to process another command.    
  
Line 548: Line 548:
   * **device** - (Array<Object>) - Array of response objects to apply to the device.   * **device** - (Array<Object>) - Array of response objects to apply to the device.
     * **command** - (String) - The Calibration Start command: "calibrationStart"     * **command** - (String) - The Calibration Start command: "calibrationStart"
-    * **statusCode** - (Integer) - A numeric value representing the device status.  See [[reference/software/digilent-instrumentation-protocol/status-codes]]+    * **statusCode** - (Integer) - A numeric value representing the device status.  See [[software:digilent-instrumentation-protocol:status-codes]]
     * **wait** - (Integer) - The number of ms to wait before the device is ready to process another command.         * **wait** - (Integer) - The number of ms to wait before the device is ready to process another command.    
  
Line 594: Line 594:
   * **device** - (Array<Object>) - Array of response objects to apply to the device.   * **device** - (Array<Object>) - Array of response objects to apply to the device.
     * **command** - (String) - The NIC Connect command: "nicConnect "         * **command** - (String) - The NIC Connect command: "nicConnect "    
-    * **statusCode** - (Integer) - A numeric value representing the device status.  See [[reference/software/digilent-instrumentation-protocol/status-codes]]+    * **statusCode** - (Integer) - A numeric value representing the device status.  See [[software:digilent-instrumentation-protocol:status-codes]]
     * **wait** - (Integer) - The number of ms to wait before the device is ready to process another command.         * **wait** - (Integer) - The number of ms to wait before the device is ready to process another command.    
        
Line 641: Line 641:
   * **device** - (Array<Object>) - Array of response objects to apply to the device.   * **device** - (Array<Object>) - Array of response objects to apply to the device.
     * **command** - (String) - The NIC Disconnect command: "nicDisconnect"         * **command** - (String) - The NIC Disconnect command: "nicDisconnect"    
-    * **statusCode** - (Integer) - A numeric value representing the device status.  See [[reference/software/digilent-instrumentation-protocol/status-codes]]+    * **statusCode** - (Integer) - A numeric value representing the device status.  See [[software:digilent-instrumentation-protocol:status-codes]]
     * **wait** - (Integer) - The number of ms to wait before the device is ready to process another command.         * **wait** - (Integer) - The number of ms to wait before the device is ready to process another command.    
        
Line 687: Line 687:
   * **device** - (Array<Object>) - Array of response objects to apply to the device.   * **device** - (Array<Object>) - Array of response objects to apply to the device.
     * **command** - (String) - The Get NIC Status command: "nicGetStatus"     * **command** - (String) - The Get NIC Status command: "nicGetStatus"
-    * **statusCode** - (Integer) - A numeric value representing the device status.  See [[reference/software/digilent-instrumentation-protocol/status-codes]]+    * **statusCode** - (Integer) - A numeric value representing the device status.  See [[software:digilent-instrumentation-protocol:status-codes]]
     * **wait** - (Integer) - The number of ms to wait before the device is ready to process another command.       * **wait** - (Integer) - The number of ms to wait before the device is ready to process another command.  
     * **adapter** - (String) - The network adapter (ex. eth0, eth1, wlan0, wlan1).     * **adapter** - (String) - The network adapter (ex. eth0, eth1, wlan0, wlan1).
Line 745: Line 745:
   * **device** - (Array<Object>) - Array of response objects to apply to the device.   * **device** - (Array<Object>) - Array of response objects to apply to the device.
     * **command** - (String) - The Enter Bootloader command: “enterBootloader”     * **command** - (String) - The Enter Bootloader command: “enterBootloader”
-    * **statusCode** - (Integer) - A numeric value representing the device status.  See [[reference/software/digilent-instrumentation-protocol/status-codes]]+    * **statusCode** - (Integer) - A numeric value representing the device status.  See [[software:digilent-instrumentation-protocol:status-codes]]
     * **wait** - (Integer) - The number of ms to wait before the device is ready to process another command.         * **wait** - (Integer) - The number of ms to wait before the device is ready to process another command.    
     * **nics** - (Array<String>) - An array of all the NICs on the device.     * **nics** - (Array<String>) - An array of all the NICs on the device.
Line 791: Line 791:
   * **device** - (Array<Object>) - Array of response objects to apply to the device.   * **device** - (Array<Object>) - Array of response objects to apply to the device.
     * **command** - (String) - The Reset Instruments command: “resetInstruments”.     * **command** - (String) - The Reset Instruments command: “resetInstruments”.
-    * **statusCode** - (Integer) - A numeric value representing the device status.  See [[reference/software/digilent-instrumentation-protocol/protocol-status-codes]]+    * **statusCode** - (Integer) - A numeric value representing the device status.  See [[software:digilent-instrumentation-protocol:protocol-status-codes]]
     * **wait** - (Integer) - The number of ms to wait before the device is ready to process another command.     * **wait** - (Integer) - The number of ms to wait before the device is ready to process another command.
  
Line 835: Line 835:
   * **device** - (Array<Object>) - Array of response objects to apply to the device.   * **device** - (Array<Object>) - Array of response objects to apply to the device.
     * **command** - (String) - The Storage Get Locations command: "storageGetLocations".     * **command** - (String) - The Storage Get Locations command: "storageGetLocations".
-    * **statusCode** - (Integer) - A numeric value representing the device status.  See [[reference/software/digilent-instrumentation-protocol/status-codes]]+    * **statusCode** - (Integer) - A numeric value representing the device status.  See [[software:digilent-instrumentation-protocol:status-codes]]
     * **wait** - (Integer) - The number of ms to wait before the device is ready to process another command.         * **wait** - (Integer) - The number of ms to wait before the device is ready to process another command.    
     * **storageLocations** - (Array<String>) - The devices storage locations (ex. "flash", "sd0", "/tmp/")     * **storageLocations** - (Array<String>) - The devices storage locations (ex. "flash", "sd0", "/tmp/")
Line 885: Line 885:
   * **device** - (Array<Object>) - Array of response objects to apply to the device.   * **device** - (Array<Object>) - Array of response objects to apply to the device.
     * **command** - (String) - The Wifi Delete Saved Parameters command: "wifiDeleteParameters".     * **command** - (String) - The Wifi Delete Saved Parameters command: "wifiDeleteParameters".
-    * **statusCode** - (Integer) - A numeric value representing the device status.  See [[reference/software/digilent-instrumentation-protocol/status-codes]]+    * **statusCode** - (Integer) - A numeric value representing the device status.  See [[software:digilent-instrumentation-protocol:status-codes]]
     * **wait** - (Integer) - The number of ms to wait before the device is ready to process another command.         * **wait** - (Integer) - The number of ms to wait before the device is ready to process another command.    
  
Line 931: Line 931:
   * **device** - (Array<Object>) - Array of response objects to apply to the device.   * **device** - (Array<Object>) - Array of response objects to apply to the device.
     * **command** - (String) - The Wifi List Saved Parameters command: "wifiListSavedParameters".     * **command** - (String) - The Wifi List Saved Parameters command: "wifiListSavedParameters".
-    * **statusCode** - (Integer) - A numeric value representing the device status.  See [[reference/software/digilent-instrumentation-protocol/status-codes]]+    * **statusCode** - (Integer) - A numeric value representing the device status.  See [[software:digilent-instrumentation-protocol:status-codes]]
     * **wait** - (Integer) - The number of ms to wait before the device is ready to process another command.         * **wait** - (Integer) - The number of ms to wait before the device is ready to process another command.    
     * **parameterSets** - (Object) - An object describing the network parameters.     * **parameterSets** - (Object) - An object describing the network parameters.
Line 987: Line 987:
   * **device** - (Array<Object>) - Array of response objects to apply to the device.   * **device** - (Array<Object>) - Array of response objects to apply to the device.
     * **command** - (String) - The Wifi Load Parameters command: "wifiLoadParameters".     * **command** - (String) - The Wifi Load Parameters command: "wifiLoadParameters".
-    * **statusCode** - (Integer) - A numeric value representing the device status.  See [[reference/software/digilent-instrumentation-protocol/status-codes]]+    * **statusCode** - (Integer) - A numeric value representing the device status.  See [[software:digilent-instrumentation-protocol:status-codes]]
     * **wait** - (Integer) - The number of ms to wait before the device is ready to process another command.         * **wait** - (Integer) - The number of ms to wait before the device is ready to process another command.    
        
Line 1033: Line 1033:
   * **device** - (Array<Object>) - Array of response objects to apply to the device.   * **device** - (Array<Object>) - Array of response objects to apply to the device.
     * **command** - (String) - The Wifi Read Scanned Networks command: "wifiReadScannedNetworks".     * **command** - (String) - The Wifi Read Scanned Networks command: "wifiReadScannedNetworks".
-    * **statusCode** - (Integer) - A numeric value representing the device status.  See [[reference/software/digilent-instrumentation-protocol/status-codes]]+    * **statusCode** - (Integer) - A numeric value representing the device status.  See [[software:digilent-instrumentation-protocol:status-codes]]
     * **wait** - (Integer) - The number of ms to wait before the device is ready to process another command.         * **wait** - (Integer) - The number of ms to wait before the device is ready to process another command.    
     * **adapter** - (String) - The network adapter to use (ex. wlan0, wlan1).     * **adapter** - (String) - The network adapter to use (ex. wlan0, wlan1).
Line 1090: Line 1090:
   * **device** - (Array<Object>) - Array of command objects to apply to the device.   * **device** - (Array<Object>) - Array of command objects to apply to the device.
     * **command** - (String) - The Wifi Save Parameters command: "wifiSaveParameters".     * **command** - (String) - The Wifi Save Parameters command: "wifiSaveParameters".
-    * **storageLocation** - (String) - The location to save the current network parameters.  \\ //**Note that locations outside of flash may not be secure!** See [[/reference/software/digilent-instrumentation-protocol/protocol#storage_-_get_locations | storageGetLocations]] for a list of available storage locations. //+    * **storageLocation** - (String) - The location to save the current network parameters.  \\ //**Note that locations outside of flash may not be secure!** See [[software:digilent-instrumentation-protocol:protocol#storage_-_get_locations| storageGetLocations]] for a list of available storage locations. //
      
  
Line 1096: Line 1096:
   * **device** - (Array<Object>) - Array of response objects to apply to the device.   * **device** - (Array<Object>) - Array of response objects to apply to the device.
     * **command** - (String) - The Wifi Save Parameters command: "wifiSaveParameters".        * **command** - (String) - The Wifi Save Parameters command: "wifiSaveParameters".   
-    * **statusCode** - (Integer) - A numeric value representing the device status.  See [[reference/software/digilent-instrumentation-protocol/status-codes]]+    * **statusCode** - (Integer) - A numeric value representing the device status.  See [[software:digilent-instrumentation-protocol:status-codes]]
     * **wait** - (Integer) - The number of ms to wait before the device is ready to process another command.         * **wait** - (Integer) - The number of ms to wait before the device is ready to process another command.    
  
Line 1141: Line 1141:
   * **device** - (Array<Object>) - Array of response objects to apply to the device.   * **device** - (Array<Object>) - Array of response objects to apply to the device.
     * **command** - (String) - The Wifi Scan command: "wifiScan".     * **command** - (String) - The Wifi Scan command: "wifiScan".
-    * **statusCode** - (Integer) - A numeric value representing the device status.  See [[reference/software/digilent-instrumentation-protocol/status-codes]]+    * **statusCode** - (Integer) - A numeric value representing the device status.  See [[software:digilent-instrumentation-protocol:status-codes]]
     * **wait** - (Integer) - The number of ms to wait before the device is ready to process another command.         * **wait** - (Integer) - The number of ms to wait before the device is ready to process another command.    
        
Line 1193: Line 1193:
   * **device** - (Array<Object>) - Array of response objects to apply to the device.   * **device** - (Array<Object>) - Array of response objects to apply to the device.
     * **command** - (String) - The Enter Bootloader command: “enterBootloader”     * **command** - (String) - The Enter Bootloader command: “enterBootloader”
-    * **statusCode** - (Integer) - A numeric value representing the device status.  See [[reference/software/digilent-instrumentation-protocol/status-codes]]+    * **statusCode** - (Integer) - A numeric value representing the device status.  See [[software:digilent-instrumentation-protocol:status-codes]]
     * **wait** - (Integer) - The number of ms to wait before the device is ready to process another command.         * **wait** - (Integer) - The number of ms to wait before the device is ready to process another command.