aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/arduino/bitread.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/source/arduino/bitread.rst')
-rw-r--r--docs/source/arduino/bitread.rst48
1 files changed, 48 insertions, 0 deletions
diff --git a/docs/source/arduino/bitread.rst b/docs/source/arduino/bitread.rst
new file mode 100644
index 0000000..3d0b1a4
--- /dev/null
+++ b/docs/source/arduino/bitread.rst
@@ -0,0 +1,48 @@
+.. _arduino-bitread:
+
+bitRead()
+=========
+
+Description
+-----------
+
+Reads a bit of a number.
+
+
+
+Syntax
+------
+
+bitRead(x, n)
+
+
+
+Parameters
+----------
+
+x: the number from which to read
+
+
+
+n: which bit to read, starting at 0 for the least-significant
+(rightmost) bit
+
+
+
+Returns
+-------
+
+the value of the bit (0 or 1).
+
+
+
+See also
+--------
+
+
+- `bit <http://arduino.cc/en/Reference/Bit>`_\ ()
+- `bitWrite <http://arduino.cc/en/Reference/BitWrite>`_\ ()
+- `bitSet <http://arduino.cc/en/Reference/BitSet>`_\ ()
+- `bitClear <http://arduino.cc/en/Reference/BitClear>`_\ ()
+
+