Runtime Application Settings

This README provides an explanation of the various settings available in the settings.toml file for the Aqueduct application.

1. Example for Raspberry Pi with Aqueduct RS485 Hat
2. Example for Desktop Deployment

Server Settings

• [servers.http]

  • ip (string): The IP address for the HTTP server. Default: 127.0.0.1.
  • port (unsigned integer): The port number for the HTTP server. Default: 5000.

• [servers.ws]

  • ip (string): The IP address for the WebSocket server. Default: 127.0.0.1.
  • port (unsigned integer): The port number for the WebSocket server. Default: 8080.

• [servers.tcp]

  • ip (string): The IP address for the TCP server. Default: 127.0.0.1.
  • port (unsigned integer): The port number for the TCP server. Default: 59000.

Application Settings

• [settings.app]
  • lab_recordable_limit (unsigned integer): The recordable limit for lab mode. Default: 10000000.
  • sim_recordable_limit (unsigned integer): The recordable limit for simulation mode. Default: 1000000.
  • sim_tick_ms (unsigned integer): The tick interval in milliseconds for simulation mode. Default: 100.

CAN Settings

• [settings.can]
  • interface (string): The interface name for CAN communication.

Database Settings

• [settings.db]
  • recordable_limit (unsigned integer): The recordable limit for the database. Default: 1000000.

Device Settings

• [settings.devices]
  • default_record (boolean): Determines if devices are recorded by default.
  • timeout_ms (unsigned integer): The timeout duration in milliseconds for device communication. Default: 5000.
  • round_trip (boolean): Specifies if round-trip communication is enabled. Round trip communications ensure that, where possible, connected devices respond to each command before the next command is sent.
  • round_trip_attempts (unsigned integer): The number of attempts for round-trip communication before considering the transmission failed.

Recipe Settings

• [settings.recipe]
  • force_kill_on_queue (boolean): Specifies if an active recipe should be forcibly killed on queuing a new recipe. If set to true, no warning will be presented to the user to confirm killing the current recipe. Default: false.
  • pause_on_queue (boolean): Determines if the recipe should be paused when queued. Default: true.
  • python_path (string): The path to the Python executable. Default: `` (not set).

Serial Settings

• [settings.serial.common]

  • shared_bus (boolean): Specifies if the serial port is considered shared, i.e. connected nodes shared a transmit data line.
  • discovery_delay_ms (unsigned integer): The delay duration in milliseconds for device discovery.
  • transmit_interval_ms (unsigned integer): The transmit interval in milliseconds for serial communication.
  • baud_rate (unsigned integer): The baud rate for serial communication.
  • rediscovery_interval_ms (unsigned integer): The interval duration in milliseconds for device rediscovery.
  • rediscovery_duration_ms (unsigned integer): The duration in milliseconds for device rediscovery.

• [[settings.serial.ports]]

  • port (string): The serial port name.
  • shared_bus (boolean): Specifies if the serial port shares a bus.
  • discovery_delay_ms (unsigned integer): The delay duration in milliseconds for device discovery.
  • transmit_interval_ms (unsigned integer): The transmit interval in milliseconds for serial communication.
  • baud_rate (unsigned integer): The baud rate for serial communication.
  • block (boolean): Prevent the application from looking for connected devices on this port.

WebSocket Settings

• [settings.ws]
  • live_interval_ms (unsigned integer): The interval duration in milliseconds at which live data is sent to connected clients. Default: 50.
  • recordable_interval_ms (unsigned integer): The interval duration in milliseconds at which new recorded data is sent to connected clients. Default: 50.

Deployment Settings

• [deployment]
  • rpi (boolean): Specifies if the deployment is on a Raspberry Pi.
  • secret_key (string): The secret key used for encrypting user session data.