initial check-in of arduino docs in RST format (converted using wget+pandoc)

1 files changed, 60 insertions, 0 deletions

diff --git a/source/arduino/constrain.rst b/source/arduino/constrain.rst
new file mode 100644
index 0000000..2769219
--- /dev/null
+++ b/source/arduino/constrain.rst
@@ -0,0 +1,60 @@
+.. _arduino-constrain:
+
+constrain(x, a, b)
+==================
+
+Description
+-----------
+
+Constrains a number to be within a range.
+
+
+
+Parameters
+----------
+
+x: the number to constrain, all data types
+
+
+
+a: the lower end of the range, all data types
+
+
+
+b: the upper end of the range, all data types
+
+
+
+Returns
+-------
+
+**x**: if **x** is between **a** and **b**
+
+
+
+**a**: if **x** is less than **a**
+
+
+
+**b**: if **x** is greater than **b**
+
+
+
+Example
+-------
+
+::
+
+    sensVal = constrain(sensVal, 10, 150);
+    // limits range of sensor values to between 10 and 150 
+
+
+
+See also
+--------
+
+
+-  `min <http://arduino.cc/en/Reference/Min>`_\ ()
+-  `max <http://arduino.cc/en/Reference/Max>`_\ ()
+
+