Skip to content

Commit

Permalink
Merge pull request #5 from TimOrme/config_note_update
Browse files Browse the repository at this point in the history 
Quick note on configs, formatting
  • Loading branch information
@TimOrme
TimOrme authored Mar 20, 2023
2 parents 6bb2bf1 + 6417d03 commit a228d51
Showing 1 changed file with 13 additions and 11 deletions.
24 changes: 13 additions & 11 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,17 +55,19 @@ sudo systemctl start aqimon

## Configuration

| Variable | Default | Description |
|------------------------------|---------------------|-----------------------------------------------------------------------------------------------------------------------------------|
| AQIMON_DB_PATH | ~/.aqimon/db.sqlite | The path to the database file, where read information is stored. It should be an absolute path; user home expansion is supported. |
| AQIMON_POLL_FREQUENCY_SEC | 900 (15 minutes) | Sets how frequently to read from the device, in seconds. |
| AQIMON_RETENTION_MINUTES | 10080 (1 week) | Sets how long data will be kept in the database, in minutes. |
| AQIMON_READER_TYPE | NOVAPM | The reader type to use, either NOVAPM or MOCK. |
| AQIMON_USB_PATH | /dev/ttyUSB0 | The path to the USB device for the sensor. |
| AQIMON_SLEEP_TIME_SEC | 5 | The number of seconds to wait for between each read in a set of reads. |
| AQIMON_SAMPLE_COUNT_PER_READ | 5 | The number of reads to take with each sample. |
| AQIMON_SERVER_PORT | 8000 | The port to run the server on. |
| AQIMON_SERVER_HOST | 0.0.0.0 | The host to run the server on. |
Aqimon uses environment variables for configuration, but all values should ship with sensible defaults.

| Variable | Default | Description |
|----------------------------------|---------------------|-----------------------------------------------------------------------------------------------------------------------------------|
| **AQIMON_DB_PATH** | ~/.aqimon/db.sqlite | The path to the database file, where read information is stored. It should be an absolute path; user home expansion is supported. |
| **AQIMON_POLL_FREQUENCY_SEC** | 900 (15 minutes) | Sets how frequently to read from the device, in seconds. |
| **AQIMON_RETENTION_MINUTES** | 10080 (1 week) | Sets how long data will be kept in the database, in minutes. |
| **AQIMON_READER_TYPE** | NOVAPM | The reader type to use, either NOVAPM or MOCK. |
| **AQIMON_USB_PATH** | /dev/ttyUSB0 | The path to the USB device for the sensor. |
| **AQIMON_SLEEP_TIME_SEC** | 5 | The number of seconds to wait for between each read in a set of reads. |
| **AQIMON_SAMPLE_COUNT_PER_READ** | 5 | The number of reads to take with each sample. |
| **AQIMON_SERVER_PORT** | 8000 | The port to run the server on. |
| **AQIMON_SERVER_HOST** | 0.0.0.0 | The host to run the server on. |


## Contributing
Expand Down

0 comments on commit a228d51

Please sign in to comment.