diff options
author | Marti Bolivar <mbolivar@mit.edu> | 2010-12-15 01:50:56 -0500 |
---|---|---|
committer | Marti Bolivar <mbolivar@mit.edu> | 2010-12-15 16:16:31 -0500 |
commit | d744fb826f4a6d6ce560f3b78f2e63a1f9666d9e (patch) | |
tree | 35d0939c959cec372e1a6ce2f4bdf95dbe977918 /docs/source/lang/api/constants.rst | |
parent | 74c8937446e1be4e0d21f69a8c098e2caf7814d5 (diff) | |
download | librambutan-d744fb826f4a6d6ce560f3b78f2e63a1f9666d9e.tar.gz librambutan-d744fb826f4a6d6ce560f3b78f2e63a1f9666d9e.zip |
Finalized 0.0.9 documentation.
Diffstat (limited to 'docs/source/lang/api/constants.rst')
-rw-r--r-- | docs/source/lang/api/constants.rst | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/docs/source/lang/api/constants.rst b/docs/source/lang/api/constants.rst index bc5c894..4426293 100644 --- a/docs/source/lang/api/constants.rst +++ b/docs/source/lang/api/constants.rst @@ -288,6 +288,29 @@ exponent indicators. Some examples are given in the following table: - 67.0×10\ :sup:`-12` - ``0.000000000067`` +.. _lang-constants-board: + +Board-Specific Constants +------------------------ + +This section documents constants whose value might change across +different LeafLabs boards. You can use these constants to help ensure +that your code will be portable across different boards. + +.. TODO replace "upcoming" when Mini, Native come out + +.. _lang-constants-led: + +- ``BOARD_LED_PIN``: the number of the pin which connects to the + built-in LED. On the Maple, this is pin 13, but it's not guaranteed + to be the same in upcoming boards like the Maple Mini. + +.. _lang-constants-but: + +- ``BOARD_BUTTON_PIN``: the number of the pin which connects to the + built-in button (labeled "BUT"). On the Maple, this is pin 38, but + it's not guaranteed to be the same in other boards. + See Also -------- |