Device Commands

Last updated: 2025/5/22 17:47:13
Path To	Name	Description/Function
/api/device	/ambient	Gets the Ambient temperature of the device.
/api/device	/cpu	Gets the CPU temperature of the device.
/api/device	/firmwareversion	Gets the ROM version number.
/api/device	/buildpropversion	Gets the build prop script version number.
/api/device	/generation	Gets the camera generation.
/api/device	/humidity	Gets the Humidity of the device.
/api/device	/internalstoragefound	Gets a value indicating whether the camera has internal storage.
/api/device	/isupdating	Gets a value indicating whether the camera has updating.
/api/device	/model	Gets the camera model.
/api/device	/nickname	Gets the Nickname of the device.
/api/device	/nickname/{nickname}	Gets the Nickname of the device.
/api/device	/ping	A simple way to ping the application.
/api/device	/restart	Reboot the camera.
/api/device	/romversion	Gets the ROM version number.
/api/device	/serialnumber	Gets the camera serial number.
/api/device	/storage	Returns the remaining storage space in GB.
/api/device	/totalstorage	Returns the total storage space in GB.
/api/device	/teensymode	Gets the teensy mode at last startup.

Function	Gets the Ambient temperature of the device.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/device/ambient`
Response	Ambient temperature.
Response Type	number
Response Example	CODE `31.71`

Function	Gets the CPU temperature of the device.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/device/cpu`
Response	CPU temperature.
Response Type	number
Response Example	CODE `466`

Function	Gets the ROM version number.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/device/firmwareversion`
Response	The ROM version.
Response Type	string
Response Example	CODE `SubC Rayfin v12.2.5`

Function	Gets the build prop script version number.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/device/buildpropversion`
Response	The build prop script version.
Response Type	string
Response Example	CODE `4.0.2`

Function	Gets the camera generation.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/device/generation`
Response	The model of the camera.
Response Type	string
Response Example	CODE `Mk2`

Function	Gets the Humidity of the device.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/device/humidity`
Response	Humidity.
Response Type	number
Response Example	CODE `0`

Function	Gets a value indicating whether the camera has internal storage.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/device/internalstoragefound`
Response	The model of the camera.
Response Type	boolean
Response Example	CODE `true`

Function	Gets a value indicating whether the camera has updating.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/device/isupdating`
Response	The model of the camera.
Response Type	boolean
Response Example	CODE `false`

Function	Gets the camera model.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/device/model`
Response	The model of the camera.
Response Type	string
Response Example	CODE `Rayfin`

Function	Gets the Nickname of the device.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/device/nickname`
Response	Nickname.
Response Type	string
Response Example	CODE `Software BPC`

Function	Sets the Nickname of the device.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/device/nickname/{nickname}`
Response	Nickname.
Response Type	Not Available
Response Example	CODE `Not Available`

Function	A simple way to ping the application.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/device/ping`
Response	Pong as a response.
Response Type	string
Response Example	CODE `pong`

Function	Reboot the camera.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/device/restart`
Response	Status code 200, for completed operation being preformed.
Response Type	Not Available
Response Example	CODE `Not Available`

Function	Gets the ROM version number.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/device/romversion`
Response	The ROM version.
Response Type	string
Response Example	CODE `4.5.0.15-dev-705`

Function	Gets the camera serial number.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/device/serialnumber`
Response	The serial number of the camera.
Response Type	string
Response Example	CODE `61756`

Function	Returns the remaining storage space in GB.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/device/storage`
Response	Free storage in GB.
Response Type	number
Response Example	CODE `419`

Function	Returns the total storage space in GB.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/device/totalstorage`
Response	Total storage in GB.
Response Type	number
Response Example	CODE `422`

Function	Gets the teensy mode at last startup.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/device/teensymode`
Response	Teensy mode.
Response Type	string
Response Example	CODE `Normal`