Interface RecorderSettings

The general settings for the recorder. For example this includes the url to your running vant-api instance or the serial path to your connected weather station.

To configure the current conditions task call Recorder.configureCurrentConditionsTask.

Hierarchy

  • RecorderSettings

Properties

api: string

The URL to the api. E.g. http://localhost:8000/api. Corresponding environment variable: API

baudRate: BaudRate

The baud rate to use. Default is 19200. This has to match your weather station's settings! Corresponding environment variable: BAUD_RATE

consoleLog: boolean

Whether the console log is enabled. Default is true. Corresponding environment variable: CONSOLE_LOG

fileLog: boolean

Whether file logging is enabled. Default is true. Corresponding environment variable: FILE_LOG

key: string

The api key used to communicate with the api. Corresponding environment variable: API_KEY

logErrorInformation: boolean

Whether to log detailed error information. Default is true. Corresponding environment variable: `LOG_ERROR_INFORMATION´

logLevel: LogLevel

The minimimum log level that will be output. Default is "info". Corresponding environment variable: LOG_LEVEL

model: AdvancedModel

The weather station model. Default is PRO2. Corresponding environment variable: MODEL

path: string

The serial path to the weather station. E.g. COM3. Corresponding environment variable: SERIAL_PATH

preferEnvironmentVariables: boolean

Whether to prefer environment variables configured in the .env file. Default is false.

rainCollectorSize?: RainCollectorSize

The weather station's rain collector size.

units: UnitConfiguration

The default units. Important: Has to match the configured vant-api units! Corresponding environment variables: RAIN_UNIT, TEMPERATURE_UNIT, ...

Generated using TypeDoc