summaryrefslogtreecommitdiff
path: root/docs/library/machine.I2C.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/library/machine.I2C.rst')
-rw-r--r--docs/library/machine.I2C.rst4
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/library/machine.I2C.rst b/docs/library/machine.I2C.rst
index 2a33b1da4..0eb1b67f5 100644
--- a/docs/library/machine.I2C.rst
+++ b/docs/library/machine.I2C.rst
@@ -91,6 +91,10 @@ General Methods
- *sda* is a pin object for the SDA line
- *freq* is the SCL clock rate
+ In the case of hardware I2C the actual clock frequency may be lower than the
+ requested frequency. This is dependant on the platform hardware. The actual
+ rate may be determined by printing the I2C object.
+
.. method:: I2C.deinit()
Turn off the I2C bus.