Devices
Gives access to the SpringCard devices that are attached to the computer, or available in the nearby.
Objects
- DEVICE : represent a device that is currently attached to the computer
- CONFIG_DATA : used to send a configuration to a device
Routes
List connected devices, get device data
-
List devices :
GET /devices
-
Get device data :
GET /device/{$id}
Real-time control
-
Wink a device (short light/sound sequence to identify it among others) :
POST /device/{$id}/wink
-
Control the device’s user interface (light/sound) :
POST /device/{$id}/ui
-
Restore the device’s user interface to its default behavior :
DELETE /device/{$id}/ui
Smart Reader operation
-
Start a Smart Reader device :
POST /device/{$id}/reader/start
-
Stop a Smart Reader device :
POST /device/{$id}/reader/stop
-
Perform a RFID inventory :
POST /device/{$id}/reader/inventory
Configuration
-
Write a configuration in the device :
PUT /device/{$id}/config
-
Restore device’s factory defaults :
DELETE /device/{$id}/config
-
Read the device-specific part of the configuration :
GET /device/{$id}/config/specific
-
Update the device-specific part of the configuration :
PUT /device/{$id}/config/specific
-
Load a configuration into the device from an URL or a file :
POST /device/{$id}/load-config
Diagnostics
-
Read the device’s detailed data :
GET /device/{$id}/data
-
Read the device’s statistics :
GET /device/{$id}/stats
Advanced control and firmware upgrade
-
Restart the device :
POST /device/{$id}/reset
-
Shutdown the device :
POST /device/{$id}/shutdown
-
Restart the device in bootloader mode :
POST /device/{$id}/reset-bootloader
-
Read the device’s bootloader info :
GET /device/{$id}/bootloader-info
-
Read the device’s firmware info :
GET /device/{$id}/firmware-info
-
Load a new firmware into the device :
POST /device/{$id}/load-firmware
-
Read the device’s power info :
GET /device/{$id}/power-info