Skip to content

Commit 727822b

Browse files
authored
Small doc fixes
1 parent a5164c9 commit 727822b

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -175,10 +175,22 @@ detection at start of `mchess.py`.
175175
| `orientation` | true | Orientation of the Millennium chess board. The orientation is detected and saved automatically as soon as the start position is setup on the Millennium board. |
176176
| `autodetect` | `true` | On `true`, automatic hardware detection of Millennium ChessLink is tried on each start of `mchess.py`, if the default connection does not work. Setting to `false` disables automatic hardware detection (e.g. if no board hardware is available) |
177177
| `transports_blacklist` | [] | List of transports that should not be used for autodetect. Valid transport names are `chess_link_usb` and `chess_link_bluepy` (linux). This option is useful to prevent probing on serial or USB channels that have other devices (e.g. a terminal) connected. |
178-
179178
| `protocol_debug` | `false` | On `true` extensive logging of the hardware communication with the Millennium board is enabled for debugging purposes. |
180179
| `btle_iface` | `0` | Linux Bluetooth LE interface number. If scanning continues to fail (with `17, error: Invalid Index`), it might help to use values from 0..2 for alternative tests. Not used for USB connections. |
181180

181+
#### Sample chess_link_config.json for USB-connection
182+
183+
```json
184+
{
185+
"transport": "chess_link_usb",
186+
"address": "/dev/ttyUSB0",
187+
"orientation": true,
188+
"btle_iface": 0,
189+
"autodetect": true,
190+
"protocol_debug": false
191+
}
192+
```
193+
182194
### Json files in `mchess/engines`
183195

184196
Currently `mchess` supports up to two concurrent UCI chess engines. Each engine needs a configuration file `mchess/engines/<engine-name>.json`. On first start `mchess.py` automatically searches for stockfish, komodo and crafty.

0 commit comments

Comments
 (0)