Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
bobbydilley authored Jan 22, 2022
1 parent f5a5854 commit ae800a3
Showing 1 changed file with 74 additions and 1 deletion.
75 changes: 74 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,22 @@ To start JVSCore in the terminal to view debug messages, you can start it by typ
sudo jvscore
```

The RS485 converter device path is set in `/etc/jvscore.conf`, with any other configuration values that may come in the future. If you only have one serial device plugged in, you shouldn't have to change it! The fuzz value can also be set in this config file. Fuzz is how much the analogue value has to change by before it is reported to the computer. This is useful if you've got super noisy pots on your controllers!
There are various command line arguments that can be used to configure JVSCore. If running in the background as a service, these can be changed with the settings file as well.

```
Options:
--disable-analogue Disables analogue reading
--analogue-fuzz Specifies the analogue fuzz value
--device-path Specifies the RS485 device path
```

## Settings file

All settings can be set by changing values in the `/etc/jvscore.conf` settings file.

- The default RS485 converter device path can be changed using the `DEVICE_PATH` keyword.
- The default analogue fuzz value can be changed using the `ANALOGUE_FUZZ` keyword. Fuzz is how much the analogue value has to change by before it is reported to the computer. This is useful if you've got super noisy pots on your controllers!
- Enabling and disabling of analogue controls can be done with the `ENABLE_ANALOGUE` keyword, and `1` or `0` as the value. JVSCore will run faster with analogue controls disabled.

## Systemd Service

Expand All @@ -66,6 +81,64 @@ sudo journalctl -u jvscore

The best adapters are those with an FTDI chipset.

## Latency Testing

Thanks to JaviRodasG for testing the latency of JVSCore.

Results for JVSCore **with** analogue controls enabled are as follows:

```
15.14 - 15.80 [ 9] **
15.80 - 16.46 [ 35] ********
16.46 - 17.11 [116] ***************************
17.11 - 17.77 [158] ************************************
17.77 - 18.43 [128] ******************************
18.43 - 19.08 [161] *************************************
19.08 - 19.74 [167] **************************************
19.74 - 20.40 [137] ********************************
20.40 - 21.06 [165] **************************************
21.06 - 21.71 [147] **********************************
21.71 - 22.37 [148] **********************************
22.37 - 23.03 [176] ****************************************
23.03 - 23.68 [144] *********************************
23.68 - 24.34 [145] *********************************
24.34 - 25.00 [164] **************************************
Samples: 2000 of 2000
Average: 20.7348 ms
Maximum: 24.997 ms
Minimum: 15.143 ms
Std-dev: 2.4883 ms
```

Results for JVSCore **without** analogue controls enabled are as follows:

```
12.29 - 12.75 [ 32] ********
12.75 - 13.20 [ 72] *****************
13.20 - 13.66 [101] ***********************
13.66 - 14.12 [114] **************************
14.12 - 14.58 [141] ********************************
14.58 - 15.04 [179] ****************************************
15.04 - 15.50 [158] ************************************
15.50 - 15.96 [151] **********************************
15.96 - 16.41 [141] ********************************
16.41 - 16.87 [159] ************************************
16.87 - 17.33 [162] *************************************
17.33 - 17.79 [128] *****************************
17.79 - 18.25 [162] *************************************
18.25 - 18.71 [126] *****************************
18.71 - 19.17 [ 94] *********************
19.17 - 19.63 [ 58] *************
19.63 - 20.08 [ 22] *****
Samples: 2000 of 2000
Average: 16.1385 ms
Maximum: 20.084 ms
Minimum: 12.287 ms
Std-dev: 1.8312 ms
```

## Credits

Thank you very much to @chunksin and @JaviRodasG for helping to test and debug issues with the software!

0 comments on commit ae800a3

Please sign in to comment.