Skip to content

configuration.md

Latest commit

 

History

History
170 lines (108 loc) · 3.7 KB

configuration.md

File metadata and controls

170 lines (108 loc) · 3.7 KB

Smart Brightness Configuration Guide

This document explains all available configuration options for Smart Brightness.

Daemon Modes

mode

  • Default: "realtime"
  • Options:
    • "realtime": Continuously adjusts brightness.
    • "interval": Runs for active_seconds, then sleeps for pause_seconds.
    • "boot": Runs once for active_seconds, then exits.

active_seconds

  • Type: Float
  • Default: 300.0 (5 minutes)
  • Description: Time to remain active in boot or interval modes.

pause_seconds

  • Type: Float
  • Default: 60.0 (1 minute)
  • Description: Time to sleep between checks in interval mode.

Camera Settings

camera_id

  • Type: Integer
  • Default: 0
  • Description: Index of the camera device (0 is usually the built-in webcam).

resolution

  • Type: Array [width, height]
  • Default: [640, 480]
  • Description: Resolution for light sensing. Higher = more accurate but more CPU.

warmup_frames

  • Type: Integer
  • Default: 30
  • Description: Frames to discard while the camera auto-adjusts its exposure.

half_precision

  • Type: Boolean
  • Default: true
  • Description: Processes every other pixel to save CPU. Recommended for low-power devices.

Display Control

backlight

  • Type: String (optional)
  • Description: Manual override for the backlight device (e.g., "intel_backlight").

min_brightness

  • Type: Integer
  • Description: Lowest hardware brightness level (set during calibration).

max_brightness

  • Type: Integer
  • Description: Highest hardware brightness level (set during calibration).

Sensing & Logic

smoothing

  • Type: Float (0.01 - 1.0)
  • Default: 0.15
  • Description: Controls how quickly the screen reacts. Lower is smoother; higher is faster.

capture_interval

  • Type: Integer (ms)
  • Default: 150
  • Description: Milliseconds between light samples.

min_light / max_light

  • Type: Float
  • Description: Calibrated ambient light floor and ceiling.

min_change

  • Type: Float
  • Default: 0.01
  • Description: Sensitivity threshold. Changes smaller than this are ignored to prevent flickering.

anti_reflection

  • Type: Float (0.0 - 1.0)
  • Default: 0.07
  • Description: Subtracts a portion of screen brightness from the sensor reading to prevent face-reflection loops in dim rooms.

Transitions

step_interval

  • Type: Integer (ms)
  • Default: 20
  • Description: Frequency of brightness increments.

transition_speed

  • Type: Integer
  • Default: 10
  • Description: Controls movement speed. Higher is faster; lower is smoother.

max_step

  • Type: Integer
  • Default: 100
  • Description: Maximum brightness jump allowed per step.

Day/Night Boost

day_night_mode

  • Type: Boolean
  • Default: true
  • Description: Enables time-based brightness multipliers.

day_multiplier / night_multiplier

  • Type: Float
  • Default: 1.05 / 0.95
  • Description: Brightness adjustment factor for day and night.

day_start / night_start

  • Type: Integer (0-23)
  • Default: 6 / 18
  • Description: Hours when day/night modes begin.

Logging & Status

log_level

  • Default: "low"
  • Options: "off", "minimal", "low", "medium", "high", "verbose"

status_interval

  • Type: Integer (seconds)
  • Default: 5
  • Description: Frequency of status updates in the log.

log_changes_only

  • Type: Boolean
  • Default: true
  • Description: Only log status if the brightness actually changes.