diff options
| author | Marti Bolivar <mbolivar@mit.edu> | 2010-10-25 21:15:28 -0400 |
|---|---|---|
| committer | Marti Bolivar <mbolivar@mit.edu> | 2010-11-17 12:44:28 -0500 |
| commit | 2d429e75ce69e77f8c95490ac03881ec9aa0354a (patch) | |
| tree | a3b810a6c75625b07a4b976e5d1e319c60e19a6b /source/arduino/bitread.rst | |
| parent | 30ac55d80c18e93f9c39a6dd850c10f9e7fd92ac (diff) | |
| download | librambutan-2d429e75ce69e77f8c95490ac03881ec9aa0354a.tar.gz librambutan-2d429e75ce69e77f8c95490ac03881ec9aa0354a.zip | |
arduino language reference nearing completion, properly CC-BY-SA 3.0 attributed
Diffstat (limited to 'source/arduino/bitread.rst')
| -rw-r--r-- | source/arduino/bitread.rst | 32 |
1 files changed, 15 insertions, 17 deletions
diff --git a/source/arduino/bitread.rst b/source/arduino/bitread.rst index 3d0b1a4..c3a79c4 100644 --- a/source/arduino/bitread.rst +++ b/source/arduino/bitread.rst @@ -6,43 +6,41 @@ bitRead() Description ----------- -Reads a bit of a number. - +(Macro) Gets the value of a bit in a number. Syntax ------ -bitRead(x, n) - +``bitRead(x, n)`` Parameters ---------- -x: the number from which to read - +* **x** the number from which to read the bit. +* **n** which bit to read, starting at 0 for the least-significant + (rightmost) bit -n: which bit to read, starting at 0 for the least-significant -(rightmost) bit +Value +----- +The value of the bit (0 or 1). -Returns -------- -the value of the bit (0 or 1). +Arduino Compatibility +--------------------- +The Maple implementation of ``bitRead`` is compatible with Arduino. 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>`_\ () - - +- :ref:`arduino-bit` +- :ref:`arduino-bitwrite` +- :ref:`arduino-bitset` +- :ref:`arduino-bitclear` |