README
This commit is contained in:
parent
7cfed93cfb
commit
14f7c13021
35
README.md
35
README.md
@ -33,28 +33,20 @@ Features not yet implemented but planned:
|
||||
This program is controlled with a config file `config.toml` in which the user can configure each thermocouple channel independently, enable a web view, configure database logging, etc.
|
||||
The TH7 software uses sane default values where possible.
|
||||
|
||||
```properties
|
||||
```toml
|
||||
# EXAMPLE TH7 CONFIG
|
||||
[TH7]
|
||||
# port used by the web view
|
||||
port = 9090
|
||||
# enable the blinking lights on the Raspberry Pi Hat
|
||||
LED = true
|
||||
# if true, the software will use a simulated TH7
|
||||
debug = false
|
||||
port = 9090 # port used by the web view
|
||||
LED = true # enable the blinking lights on the Raspberry Pi Hat
|
||||
debug = false # if true, the software will use a simulated TH7
|
||||
|
||||
# Configure channel 1
|
||||
[Channel_1]
|
||||
# set type to K-type thermocouple
|
||||
type = 'K'
|
||||
# gain is used during signal conversion
|
||||
gain = 106.8
|
||||
# offset is added to the final converted value (in °C)
|
||||
offset = -5.6
|
||||
# samples for the filter function
|
||||
filter.samples = 50
|
||||
# integer representing the filter function type
|
||||
filter.type = 0
|
||||
type = 'K' # set type to K-type thermocouple
|
||||
gain = 106.8 # gain is used during signal conversion
|
||||
offset = -5.6 # offset is added to the final converted value (in °C)
|
||||
filter.samples = 50 # samples for the filter function
|
||||
filter.type = 0 # integer representing the filter function type
|
||||
|
||||
# Filter functions:
|
||||
# 0: simple alpha-beta filter (default)
|
||||
@ -65,18 +57,15 @@ filter.type = 0
|
||||
# Configure channel 2 to read μV
|
||||
# this example uses default values for gain, offset and filter.
|
||||
[Channel_2]
|
||||
# set thermocouple type to 'U' to just read μV
|
||||
type = 'U'
|
||||
type = 'U' # set thermocouple type to 'U' to just read μV
|
||||
|
||||
# Database
|
||||
# Each database type (so far only SQLite3) requires its own set of values
|
||||
# Below is an example for SQLite3
|
||||
[DB]
|
||||
type = "sqlite3"
|
||||
# where to save the database file
|
||||
path = "/home/pi/th7.db"
|
||||
# logging frequency. specified in seconds.
|
||||
freq = 60
|
||||
path = "/home/pi/th7.db" # where to save the database file
|
||||
freq = 60 # logging frequency. specified in seconds
|
||||
```
|
||||
|
||||
## Building on a Raspberry Pi
|
||||
|
Loading…
Reference in New Issue
Block a user