diff --git a/components/canbus.rst b/components/canbus.rst index 9dd29e304..37ed0e9c3 100644 --- a/components/canbus.rst +++ b/components/canbus.rst @@ -259,7 +259,7 @@ Configuration variables: - **cs_pin** (**Required**, :ref:`Pin Schema `): Is used to tell the receiving SPI device when it should listen for data on the SPI bus. Each device has an individual ``CS`` line. Sometimes also called ``SS``. -- **clock** (*Optional*): One of ``8MHZ``, ``16MHZ`` or ``20MHZ``. Clock crystal used on the MCP2515 device. +- **clock** (*Optional*): One of ``8MHZ``, ``12MHz``, ``16MHZ`` or ``20MHZ``. Clock crystal used on the MCP2515 device. Defaults to ``8MHZ``. - **mode** (*Optional*): Operation mode. Default to ``NORMAL`` @@ -269,6 +269,10 @@ Configuration variables: - All other options from :ref:`Canbus `. +Note that not all combinations of clock and bitrate are supported. An unsupported +combination will not be flagged at compile time, check the runtime log for a message like +``Invalid frequency/bitrate combination`` if you suspect this is an issue. + Wiring options **************