Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
warhog committed Oct 1, 2019
1 parent edd10af commit 5921a1e
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 6 deletions.
29 changes: 27 additions & 2 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,32 @@ the following options are available:
|---|---|
|admin.password|the admin password for the race admin|
|shutdown.machine|if a shutdown command using webui is made shutdown the operating system as well|
|audio.language|language to use for speech output. usa a BCP 47 language tag here, e.g. en-US or en-UK or de-DE|
|server.port|webserver port to use (should be 80)|
|network.server.ip|ip address to listen for udp packets by the node (optional, see extra section)|
|network.server.broadcast|broadcast ip address to listen for udp packets by the node (optional, see extra section)|

## network configuration
you need to configure the ip and broadcast addresses the server should listen to.

this can be either done using the ip addresses or the network interface names for easier configuration.

if you don't provide `network.server.ip` and `network.server.broadcast` in your configuration it defaults to `GET_FROM_wlan0`.

### configuration by ip address
simply give the ip addresses:
```
network.server.ip=192.168.1.5
network.server.broadcast=192.168.1.255
```

### configuration by network interface name
configuration using the network interface names is more generic. instead of an ip address you give a string like `GET_FROM_wlan0`.
the ip address configuration is then fetched from the interface wlan0 (default on rpi for wifi).
you can give whatever name is needed, e.g. `GET_FROM_enp0s32e6` or `GET_FROM_wlx74da285ed9a3`.
```
network.server.ip=GET_FROM_wlan0
network.server.broadcast=GET_FROM_wlan0
```


## example
Expand All @@ -17,5 +41,6 @@ example application.properties file
admin.password=admin
audio.playLocal=false
shutdown.machine=false
audio.language=de-DE
network.server.ip=GET_FROM_wlan0
network.server.broadcast=GET_FROM_wlan0
```
3 changes: 0 additions & 3 deletions web/release_files/application.properties
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,6 @@ shutdown.machine=true
# port the web server is listening to
server.port=80

# speech language
audio.language=en-US

# ip to listen for udp packets by the nodes, can be an IP address or a
# string "GET_FROM_<interface>" to get from network interface on startup, e.g.
# GET_FROM_wlan0
Expand Down
2 changes: 1 addition & 1 deletion web/webpage/src/app/settings/settings.component.html
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@
<label for="audioLanguage">audio language</label>
<input class="form-control" type="text" name="audioLanguage" [(ngModel)]="data.audioLanguage" required
aria-describedby="audioLanguageHelp" />
<small id="audioLanguageHelp" class="form-text text-muted">sets the audio language.</small>
<small id="audioLanguageHelp" class="form-text text-muted">sets the audio language, usa a BCP 47 language tag (e.g. en-US or en-UK or de-DE).</small>
</div>
<button [disabled]="storing" (click)="storeSettings()" class="btn btn-outline-secondary">save</button>
<br /><br />
Expand Down

0 comments on commit 5921a1e

Please sign in to comment.