Interactive documentation for integrating custom applications with Falcon Configurator.
The API runs together with the local application and allows you to read or update settings using simple HTTP requests. By default, use the same origin as the current page or manually enter the host address.
GET /api/prop/{name} to receive the current value as plain text.POST /api/prop/{name}/{value}. The value must be URL-encoded.GET /api/serialports to get a line-separated list.http://localhost:8080. On another PC on the same network, use the IP address of the machine running the application.
Main routes exposed by the local web host.
Returns the current value of the requested property.
fetch('/api/prop/SENS')
.then(r => r.text())
.then(console.log);Updates the property and saves the configuration when the value has changed.
const value = encodeURIComponent('0.45');
fetch(`/api/prop/SENS/${value}`, {
method: 'POST'
});Returns the available serial ports, one per line.
fetch('/api/serialports')
.then(r => r.text())
.then(text => text.split(/\r?\n/));Test requests directly from this page. It uses fetch() and shows the status, response time, and returned content.
Click Execute to test an endpoint.
Accepted names for /api/prop/{name}.
| Name | Type | Access | Example | Description |
|---|