Skip to content

Commit e791f32

Browse files
committed
Update documentation system
1 parent b4590c0 commit e791f32

File tree

3 files changed

+12
-11
lines changed

3 files changed

+12
-11
lines changed

docs/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
# -- Project information -----------------------------------------------------
2525

2626
project = 'BlueParrot XCP'
27-
copyright = '2019, Christoph Schueler'
27+
copyright = '2019-2025, Christoph Schueler'
2828
author = 'Christoph Schueler'
2929

3030
# The short X.Y version
@@ -65,7 +65,7 @@
6565
#
6666
# This is also used if you do content translation via gettext catalogs.
6767
# Usually you set "language" from the command line for these cases.
68-
language = None
68+
language = "en"
6969

7070
# List of patterns, relative to source directory, that match files and
7171
# directories to ignore when looking for source files.

docs/tutorial.rst

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@ Tutorial
22
========
33

44
This tutorial gives you a practical, step-by-step path to get a BlueParrot XCP slave running on
5-
- Arduino boards (Ethernet/WiFi or CAN shields, and optional serial SXI)
5+
- Arduino boards (serial SXI, Ethernet/WiFi or CAN shields)
66
- Raspberry Pi Pico (RP2040)
77

8-
It focuses on minimal configuration in your `xcp_config.h`, building/flashing, and connecting from an XCP master.
8+
It focuses on minimal configuration in your `xcp_config.h`, building/flashing, and connecting from an XCP client.
99
For a full description of all configuration options, see :doc:`options`.
1010

1111
Quick overview
@@ -25,8 +25,9 @@ Prerequisites
2525
^^^^^^^^^^^^^
2626
- Arduino IDE or Arduino CLI installed
2727
- For Ethernet: an Ethernet-capable board/shield (e.g., W5100/W5500) or WiFi board (ESP32)
28-
- For CAN: a CAN shield (e.g., Seeed Studio CAN v2 or CAN FD shield)
29-
- Optional serial SXI over the board’s UART
28+
- For CAN: a CAN shield (MKR Zero CAN Shield, Seeed Studio CAN Shield, and SparkFun CAN Shield are currently supported).
29+
- Serial SXI over the board’s UART (recommended starting point).
30+
3031

3132
1) Choose a transport
3233
^^^^^^^^^^^^^^^^^^^^^

tools/arduino/hello_xcp/xcp_config.h

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@
3535
** General Options.
3636
*/
3737
// #define TP_CAN
38-
#define TP_ETHER
39-
// #define TP_SXI
38+
// #define TP_ETHER
39+
#define TP_SXI
4040

4141
/*
4242
** Transport-Layer specific Options.
@@ -78,9 +78,9 @@
7878
#define XCP_ON_ETHERNET_IP_OCTETS 192, 168, 137, 100
7979
#define XCP_ON_ETHERNET_PORT (5555)
8080

81-
#define XCP_ON_ETHERNET_ARDUINO_DRIVER (XCP_ON_ETHERNET_DRIVER_WIFI)
82-
#define XCP_ON_ETHERNET_WIFI_SSID ("A1_CE8A")
83-
#define XCP_ON_ETHERNET_WIFI_PASSWORD ("6H54726A66")
81+
#define XCP_ON_ETHERNET_ARDUINO_DRIVER (XCP_ON_ETHERNET_DRIVER_ETHERNET)
82+
#define XCP_ON_ETHERNET_WIFI_SSID ("")
83+
#define XCP_ON_ETHERNET_WIFI_PASSWORD ("")
8484
#define XCP_ON_ETHERNET_MAC_ADDRESS { 0xBE, 0xEF, 0xCA, 0xAA, 0xFF, 0xFE }
8585

8686
#define XCP_MAX_CTO (32) // (16)

0 commit comments

Comments
 (0)