Skip to content

Commit 6cab27d

Browse files
authored
Update README.md
1 parent 03f52b6 commit 6cab27d

1 file changed

Lines changed: 7 additions & 5 deletions

File tree

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,9 @@ optional arguments:
5959
```
6060

6161
## Configuration
62-
The configuration file is of the YAML format. It is provided with a default configuration which you should change to suit your needs. You will need to reference in-line comments and external module documentation to fully understand all configuration options. Many configuration options can be overwritten by command line provided arguments.
62+
The configuration file is of the YAML format. It is provided with a default configuration which you should change to suit your needs. You will need to reference in-line comments and external module documentation to fully understand all configuration options.
63+
64+
The configuration YAML will only be used if specified as a commadn line argument. Many indiviudal configuration options can be overwritten by command line provided arguments.
6365

6466
```yaml
6567
# Configuration file for piPACT reference collection software
@@ -122,7 +124,7 @@ In this mode, the advertiser will run infinitely until a user commanded stop is
122124
123125
1. Start the advertiser. The addition of the `&` flag causes the command to be executed in the background. This allows the user to retain control of the command line which makes commanding the advertiser to stop much easier.
124126
```console
125-
pi@raspberrypi:~ $ sudo python3 pi_pact.py -a &
127+
pi@raspberrypi:~ $ sudo python3 pi_pact.py -a --config pi_pact_config.yml &
126128
[1] 2083
127129
```
128130
2. Observe the informational log messages.
@@ -142,7 +144,7 @@ In this mode, the advertiser will run either until the specified timeout or unti
142144

143145
1. Start the advertiser. The addition of the `&` flag causes the command to be executed in the background. This allows the user to retain control of the command line which makes commanding the advertiser to stop much easier.
144146
```console
145-
pi@raspberrypi:~ $ sudo python3 pi_pact.py -a --timeout 20 &
147+
pi@raspberrypi:~ $ sudo python3 pi_pact.py -a --config pi_pact_config.yml --timeout 20 &
146148
[1] 2282
147149
```
148150
2. Observe the informational log messages.
@@ -169,7 +171,7 @@ In this mode, the scanner will run infinitely until a user commanded stop is spe
169171

170172
1. Start the scanner. The addition of the `&` flag causes the command to be executed in the background. This allows the user to retain control of the command line which makes commanding the scanner to stop much easier.
171173
```console
172-
pi@raspberrypi:~ $ sudo python3 pi_pact.py -s &
174+
pi@raspberrypi:~ $ sudo python3 pi_pact.py -s --config pi_pact_config.yml &
173175
[1] 2083
174176
```
175177
2. Observe the informational log messages.
@@ -189,7 +191,7 @@ In this mode, the scanner will run either until the specified timeout or until a
189191

190192
1. Start the scanner. The addition of the `&` flag causes the command to be executed in the background. This allows the user to retain control of the command line which makes commanding the scanner to stop much easier.
191193
```console
192-
pi@raspberrypi:~ $ sudo python3 pi_pact.py -s --timeout 20 &
194+
pi@raspberrypi:~ $ sudo python3 pi_pact.py -s --config pi_pact_config.yml --timeout 20 &
193195
[1] 2282
194196
```
195197
2. Observe the informational log messages.

0 commit comments

Comments
 (0)