LED Commands

Last updated: 2025/12/1 9:25:11
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	/lamp/brightness/{value}/{port}	Set each individual lamp brightness separately by passing in the desired aux port.
/api/led	/strobe/brightness/{value}	Set the strobe brightness.

Description	Disable the strobe.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/led/strobe/disable`
Response	None

Description	Enable the strobe.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/led/strobe/enable`
Response	None

Description	Get the lamp brightness.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/led/lamp/brightness`
Parameter(s):	֍ Value: Brightness value from 0-100.
Response	A representing the asynchronous operation.
Response Type	Number
Response Example	CODE `30`

Description	Get the strobe brightness.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/led/strobe/brightness`
Parameter(s):	֍ Value: Brightness value from 0-100.
Response	A representing the asynchronous operation.
Response Type	Number
Response Example	CODE `100`

Description	Gets a value indicating whether the camera has leds.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/led/isattached`
Response	True if the Rayfin has leds.
Response Type	Boolean
Response Example	CODE `true`

Description	Gets a value indicating whether the camera lamp is on.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/led/lamp/ison`
Response	True if the led(s) are on.
Response Type	Boolean
Response Example	CODE `false`

Description	Gets a value indicating whether the camera strobe is enabled.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/led/strobe/isenabled`
Response	True if the Rayfin strobe is enabled.
Response Type	Boolean
Response Example	CODE `true`

Description	Turn the lamp off.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/led/lamp/off`
Response	None

Description	Turns on the attached LED and sets the brightness to 100.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/led/lamp/on`
Response	None

Description	Increment lamp brightness by 5.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/led/lamp/brightness/up`
Response	None

Description	Decrement lamp brightness by 5.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/led/lamp/brightness/down`
Response	None

Description	Increment strobe brightness by 5.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/led/strobe/brightness/up`
Response	None

Description	Decrement strobe brightness by 5.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/led/strobe/brightness/down`
Response	None

Description	Set the lamp brightness.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/led/lamp/brightness/50`
Parameter(s):	֍ Value: Values between 0 to 100
Response	None

Description	Set each individual lamp brightness separately by passing in the desired aux port.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/led/lamp/brightness/0/100`
Parameter(s):	֍ Port: Values between 0 to 1 ֍ Value: Values between 0 to 100
Response	None

Description	Set the strobe brightness.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/led/strobe/brightness/20`
Parameter(s):	֍ Value: Values between 0 to 100
Response	None