aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/arduino/randomseed.rst
diff options
context:
space:
mode:
authorMarti Bolivar <mbolivar@mit.edu>2010-10-20 06:46:52 -0400
committerMarti Bolivar <mbolivar@mit.edu>2010-10-20 06:46:52 -0400
commit22ff1db8a76c7047b61a424ae1fa5f43697fcb34 (patch)
treebf722c8a5a6bd40e0b33fc4a425e0e5b8b9f4216 /docs/source/arduino/randomseed.rst
parentbac6548fe90b0721e191d68df2677beb4b15f60a (diff)
downloadlibrambutan-22ff1db8a76c7047b61a424ae1fa5f43697fcb34.tar.gz
librambutan-22ff1db8a76c7047b61a424ae1fa5f43697fcb34.zip
initial check-in of arduino docs in RST format (converted using wget+pandoc)
Diffstat (limited to 'docs/source/arduino/randomseed.rst')
-rw-r--r--docs/source/arduino/randomseed.rst70
1 files changed, 70 insertions, 0 deletions
diff --git a/docs/source/arduino/randomseed.rst b/docs/source/arduino/randomseed.rst
new file mode 100644
index 0000000..b0b5d71
--- /dev/null
+++ b/docs/source/arduino/randomseed.rst
@@ -0,0 +1,70 @@
+.. _arduino-randomseed:
+
+randomSeed(seed)
+================
+
+Description
+-----------
+
+randomSeed() initializes the pseudo-random number generator,
+causing it to start at an arbitrary point in its random sequence.
+This sequence, while very long, and random, is always the same.
+
+
+
+If it is important for a sequence of values generated by random()
+to differ, on subsequent executions of a sketch, use randomSeed()
+to initialize the random number generator with a fairly random
+input, such as analogRead() on an unconnected pin.
+
+
+
+Conversely, it can occasionally be useful to use pseudo-random
+sequences that repeat exactly. This can be accomplished by calling
+randomSeed() with a fixed number, before starting the random
+sequence.
+
+
+
+Parameters
+----------
+
+long, int - pass a number to generate the seed.
+
+
+
+Returns
+-------
+
+no returns
+
+
+
+Example
+-------
+
+::
+
+ long randNumber;
+
+ void setup(){
+ Serial.begin(9600);
+ randomSeed(analogRead(0));
+ }
+
+ void loop(){
+ randNumber = random(300);
+ Serial.println(randNumber);
+
+ delay(50);
+ }
+
+
+
+See also
+--------
+
+
+- `random <http://arduino.cc/en/Reference/Random>`_
+
+