Auxiliary(Aux) Input Commands

Last updated: 2026/1/7 22:26:3
Path To	Name	Description/Function
/api/auxinput	/device/{input}	Enter the aux port number.
/api/auxinput	/devicename/{input}	Get the aux device name assigned to an aux input.
/api/auxinput	/send/{input}	Send an instruction to the aux device using the specified port.
/api/auxinput	/sendhex	Send an instruction to the aux device.
/api/auxinput	/setdevice/{auxInput}/{auxDevice}	Configure the aux device (options: PanTilt, LED, Laser, TTLLaser, NMEASensor, TTLNMEASensor, SerialController, None).
/api/auxinput	/setdevice/{auxInput}/{auxDevice}/{baudRate}/{serialStandard}	Configure the aux device (options: PanTilt, LED, Laser, TTLLaser, NMEASensor, TTLNMEASensor, SerialController, None).

/device/{input}

Description	Enter the aux port number.
Method	Get
Example	`http://IP_ADDRESS:8080/api/auxinput/device/0`
Parameter(s):	֍ Input: Values between 0 to 1
Response	Aux input device.
Response Type	JSON object
Response Example	`{ "Name": "AquoreaMk3", "BaudRate": "115200", "SerialStandard": "RS485", "DeviceType": "4" }`

/devicename/{input}

Description	Get the aux device name assigned to an aux input.
Method	Get
Example	`http://IP_ADDRESS:8080/api/auxinput/devicename/0`
Parameter(s):	֍ Input: Values between 0 to 1
Response	Aux device name.
Response Type	Text
Response Example	`AquoreaMk3`

/send/{input}

Description	Send an instruction to the aux device using the specified port.
Method	Get
Example	`http://IP_ADDRESS:8080/api/auxinput/send/0`
Parameter(s):	֍ Input: Values between 0 to 1
Response	None

/sendhex

Description	Send an instruction to the aux device.
Method	Post
Example	`http://IP_ADDRESS:8080/api/auxinput/sendhex`
Parameter(s):	֍ Input: Aux port to send instruction to.
Body	`{ "Command": "YOUR_HEX_STRING_HERE" }`
Response	None
Explanation	Task

/setdevice/{auxInput}/{auxDevice}

Description	Configure the aux device (options: pantilt, led, laser, ttllaser, nmeasensor, ttlnmeasensor, serialcontroller, None).
Method	Get
Example	`http://IP_ADDRESS:8080/api/auxinput/setdevice/0/PanTilt`
Parameter(s):	֍ AuxInput: Values between 0 to 1 ֍ AuxDevice: Values between pantilt, led, laser, ttllaser, nmeasensor, ttlnmeasensor, serialcontroller or None
Response	None

/setdevice/{auxInput}/{auxDevice}/{baudRate}/{serialStandard}

Description	Configure the aux device (options: pantilt, led, laser, ttllaser, nmeasensor, ttlnmeasensor, serialcontroller, or None).
Method	Get
Example	`http://IP_ADDRESS:8080/api/auxinput/setdevice/0/PanTilt/9600/RS232`
Parameter(s):	֍ AuxInput: Values between 0 to 1 ֍ AuxDevice: Values between PanTilt or LED or Laser or TTLLaser or NMEASensor or TTLNMEASensor or SerialController or None ֍ BaudRate: Values between 9600 or 115200 ֍ SerialStandard: Values between RS232 or RS485
Response	None