docs/library/machine.SPI: Add note about baudrate imprecision.

2018-09-20 13:48:52 +01:00 · 2018-09-20 13:48:52 +01:00 · 09c5c58a1f
commit 09c5c58a1f
parent af2030dec6
1 changed files with 4 additions and 0 deletions
--- a/docs/library/machine.SPI.rst
+++ b/docs/library/machine.SPI.rst
@ -47,6 +47,10 @@ Methods
     - ``pins`` - WiPy port doesn't ``sck``, ``mosi``, ``miso`` arguments, and instead allows to
       specify them as a tuple of ``pins`` parameter.

+   In the case of hardware SPI the actual clock frequency may be lower than the
+   requested baudrate. This is dependant on the platform hardware. The actual
+   rate may be determined by printing the SPI object.
+
 .. method:: SPI.deinit()

   Turn off the SPI bus.