~ubuntu-branches/ubuntu/precise/arduino/precise

<p><strong>Reference</strong>   <a class='wikilink' href='index.html'>Language</a> (<a class='wikilink' href='Extended.html'>extended</a>) | <a class='wikilink' href='Libraries.html'>Libraries</a> | <a class='wikilink' href='Comparison.html'>Comparison</a> | <a class='wikilink' href='Changes.html'>Changes</a>

</p>

<p class='vspace'></p><h2>shiftOut()</h2>

<h4>Description</h4>

<p>Shifts out a byte of data one bit at a time. Starts from either the most (i.e. the leftmost) or least (rightmost) significant bit. Each bit is written in turn to a data pin, after which a clock pin is toggled to indicate that the bit is available.

</p>

<p class='vspace'></p><p>This is known as synchronous serial protocol and is a common way that microcontrollers communicate with sensors, and with other microcontrollers. The two devices stay synchronized, and communicate at close to maximum speeds, since they both share the same clock line. This is often referred to in chip hardware documentation as <a class='urllink' href='http://en.wikipedia.org/wiki/Serial_Peripheral_Interface_Bus' rel='nofollow'>Serial Peripheral Interface (SPI)</a>.

</p>

<p class='vspace'></p><h4>Syntax</h4>

<p>shiftOut(dataPin, clockPin, bitOrder, value)

</p>

<p class='vspace'></p><h4>Parameters</h4>

<p>dataPin: the pin on which to output each bit (<em>int</em>)

</p>

<p class='vspace'></p><p>clockPin: the pin to toggle once the <strong>dataPin</strong> has been set to the correct value (<em>int</em>)

</p>

<p class='vspace'></p><p>bitOrder: which order to shift out the bits; either <strong>MSBFIRST</strong> or <strong>LSBFIRST</strong>.<br />(Most Significant Bit First, or, Least Significant Bit First)

</p>

<p class='vspace'></p><p>value: the data to shift out. (<em>byte</em>)

</p>

<p class='vspace'></p><h4>Returns</h4>

<p>None

</p>

<p>The <strong>dataPin</strong> and <strong>clockPin</strong> must already be configured as outputs by a call to <a class='wikilink' href='PinMode.html'>pinMode</a>().

</p>

<p class='vspace'></p><p><strong>shiftOut</strong> is currently written to output 1 byte (8 bits) so it requires a two step operation to output values larger than 255.

</p><pre>

// Do this for MSBFIRST serial

int data = 500;

// shift out highbyte

shiftOut(dataPin, clock, MSBFIRST, (data >> 8));

// shift out lowbyte

shiftOut(data, clock, MSBFIRST, data);

// Or do this for LSBFIRST serial

data = 500;

// shift out lowbyte

shiftOut(dataPin, clock, LSBFIRST, data);

// shift out highbyte

shiftOut(dataPin, clock, LSBFIRST, (data >> 8));

</pre>

<p class='vspace'></p><h4>Example</h4>

<p><em>For accompanying circuit, see the <a class='wikilink' href='http://arduino.cc/en/Tutorial/ShiftOut'>tutorial on controlling a 74HC595 shift register</a>.</em>

</p>

100

<p class='vspace'></p><pre>//**************************************************************//

101

// Name : shiftOutCode, Hello World //

102

// Author : Carlyn Maw,Tom Igoe //

103

// Date : 25 Oct, 2006 //

104

// Version : 1.0 //

105

// Notes : Code for using a 74HC595 Shift Register //

106

// : to count from 0 to 255 //

107

//****************************************************************

108

109

//Pin connected to ST_CP of 74HC595

110

int latchPin = 8;

111

//Pin connected to SH_CP of 74HC595

112

int clockPin = 12;

113

////Pin connected to DS of 74HC595

114

int dataPin = 11;

115

116

void setup() {

117

//set pins to output because they are addressed in the main loop

118

pinMode(latchPin, OUTPUT);

119

pinMode(clockPin, OUTPUT);

120

pinMode(dataPin, OUTPUT);

121

}

122

123

void loop() {

124

//count up routine

125

for (int j = 0; j < 256; j++) {

126

//ground latchPin and hold low for as long as you are transmitting

127

digitalWrite(latchPin, LOW);

128

shiftOut(dataPin, clockPin, LSBFIRST, j);

129

//return the latch pin high to signal chip that it

130

//no longer needs to listen for information

131

digitalWrite(latchPin, HIGH);

132

delay(1000);

133

}

134

}

135

</pre>

136

<p class='vspace'></p><p><a class='wikilink' href='index.html'>Reference Home</a>

137

</p>

138

<p class='vspace'></p><p><em>Corrections, suggestions, and new documentation should be posted to the <a class='urllink' href='http://www.arduino.cc/cgi-bin/yabb2/YaBB.pl?board=swbugs' rel='nofollow'>Forum</a>.</em>

139

</p>

140

<p class='vspace'></p><p>The text of the Arduino reference is licensed under a

141

<a class='urllink' href='http://creativecommons.org/licenses/by-sa/3.0/' rel='nofollow'>Creative Commons Attribution-ShareAlike 3.0 License</a>. Code samples in the reference are released into the public domain.

142

</p>

143

</div>

144

145

</div>

146

147

148

<a href='#'>Edit Page</a> | <a href='#'>Page History</a> | <a href='#' target='_blank'>Printable View</a> | <a href='http://arduino.cc/en/Site/AllRecentChanges'>All Recent Site Changes</a>

149

</div>

150

151

</div>

152

</body>

153

</html>

Older »