LEDController

Last updated: 2025/3/7 12:31:26
Path To	Name	Description/Function
/api/led	/strobe/disable	Disable the strobe.
/api/led	/strobe/enable	Enable the strobe.
/api/led	/lamp/brightness	Get the lamp brightness.
/api/led	/strobe/brightness	Get the strobe brightness.
/api/led	/isattached	Gets a value indicating whether the camera has leds.
/api/led	/lamp/ison	Gets a value indicating whether the camera lamp is on.
/api/led	/strobe/isenabled	Gets a value indicating whether the camera strobe is enabled.
/api/led	/lamp/off	Turn the lamp off.
/api/led	/lamp/on	Turns on the attached LED and sets the brightness to 100.
/api/led	/lamp/brightness/up	Increment lamp brightness by 5.
/api/led	/lamp/brightness/down	Decrement lamp brightness by 5.
/api/led	/strobe/brightness/up	Increment strobe brightness by 5.
/api/led	/strobe/brightness/down	Decrement strobe brightness by 5.
/api/led	/lamp/brightness/{value}	Set the lamp brightness.
/api/led	/strobe/brightness/{value}	Set the strobe brightness.

Function	Disable the strobe.
Method	Get
Response	Status code 200, for an completed operation being preformed.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/led/strobe/disable`

Function	Enable the strobe.
Method	Get
Response	Status code 200, for an completed operation being preformed.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/led/strobe/enable`

Function	Get the lamp brightness.
Method	Get
Response	A representing the asynchronous operation.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/led/lamp/brightness`

Function	Get the strobe brightness.
Method	Get
Response	A representing the asynchronous operation.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/led/strobe/brightness`

Function	Gets a value indicating whether the camera has leds.
Method	Get
Response	True if the Rayfin has leds.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/led/isattached`

Function	Gets a value indicating whether the camera lamp is on.
Method	Get
Response	True if the Rayfin has leds.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/led/lamp/ison`

Function	Gets a value indicating whether the camera strobe is enabled.
Method	Get
Response	True if the Rayfin strobe is enabled.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/led/strobe/isenabled`

Function	Turn the lamp off.
Method	Get
Response	A representing the asynchronous operation.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/led/lamp/off`

Function	Turns on the attached LED and sets the brightness to 100.
Method	Get
Response	A representing the asynchronous operation.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/led/lamp/on`

Function	Increment lamp brightness by 5.
Method	Get
Response	Status code 200, for an completed operation being preformed.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/led/lamp/brightness/up`

Function	Decrement lamp brightness by 5.
Method	Get
Response	Status code 200, for an completed operation being preformed.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/led/lamp/brightness/down`

Function	Increment strobe brightness by 5.
Method	Get
Response	Status code 200, for an completed operation being preformed.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/led/strobe/brightness/up`

Function	Decrement strobe brightness by 5.
Method	Get
Response	Status code 200, for an completed operation being preformed.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/led/strobe/brightness/down`

Function	Set the lamp brightness.
Method	Get
Response	A representing the asynchronous operation.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/led/lamp/brightness/{value}`

Function	Set the strobe brightness.
Method	Get
Response	A representing the asynchronous operation.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/led/strobe/brightness/{value}`