diff options
Diffstat (limited to 'docs/source/lang/api/bitread.rst')
| -rw-r--r-- | docs/source/lang/api/bitread.rst | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/docs/source/lang/api/bitread.rst b/docs/source/lang/api/bitread.rst new file mode 100644 index 0000000..fd9fbbe --- /dev/null +++ b/docs/source/lang/api/bitread.rst @@ -0,0 +1,39 @@ +.. _lang-bitread: + +bitRead() +========= + +(Macro) Gets the value of a bit in a number. + +Syntax +------ + +``bitRead(x, n)`` + +Parameters +---------- + +* **x** the number from which to read the bit. + +* **n** which bit to read, starting at 0 for the least-significant + (rightmost) bit + +Value +----- + +The value of the bit (0 or 1). + +Arduino Compatibility +--------------------- + +The Maple implementation of ``bitRead`` is compatible with Arduino. + +See Also +-------- + +- :ref:`lang-bit` +- :ref:`lang-bitwrite` +- :ref:`lang-bitset` +- :ref:`lang-bitclear` + +.. include:: /arduino-cc-attribution.txt |