Keywords: DS18S20, DS18B20, DS1822 1-wire, 1 wire, 1-Wire, temperature sensors, digital temperature sensors, temperature sensor IC, microcontrollers, micro-controllers Related Parts
APPLICATION NOTE 162
Interfacing the DS18X20/DS1822 1-Wire® Temperature Sensor in a Microcontroller Environment
Mar 08, 2002
Abstract: This application introduces the user to simple 1-Wire software for interfacing a microcontroller to the DS18B20, DS18S20, and DS1822 1-Wire temperature sensors. For example purposes in the article, the DS5000 (8051 compatible) microcontroller is used. Software examples are given that illustrate the implementation of delay, reset, read bit, write bit, read byte, write byte, ROM search, CRC, read temperature, and read scratch pad routines.
Introduction
There are several methods available for interfacing 1-Wire devices such as the DS18B20, DS18S20, or DS1822 to a microcontroller. These methods range from simple software solutions, to using a Serial Interface chip such as the DS2480B, to incorporating Maxim's VHDL 1-Wire Master Controller in a custom ASIC. This article introduces the user to the simplest possible software solution for basic 1-Wire communication between a microcontroller and any number of DS18x20 or DS1822 temperature sensors.
Detailed timing and operational information for the DS18B20, DS18S20 and DS1822 is available in their respective datasheets, which can be obtained from the Maxim website.
Hardware Configuration
The block diagram in Figure 1 illustrates the simplicity of the hardware configuration when using multiple 1-Wire temperature sensors. A single-wire bus provides both communication access and power to all devices. Power to the bus is provided through the 4.7kΩ pullup resistor from a 3V to 5.5V supply rail. An almost unlimited number of 1-Wire devices can be connected to the bus because each device has a unique 64-bit ROM code identifier.
Figure 1. Host microcontroller interface.
Interface Timing
Communication with the DS18x20/DS1822 is achieved through the use of "time slots", which allow data to be transmitted over the 1-Wire bus. Every communication cycle begins with a reset pulse from the microcontroller followed by a presence pulse from the DS18x20/DS1822 as shown in Figure 2.
A write time slot is initiated when the bus master pulls the 1-Wire bus from logic high (inactive) to logic low. All write time slots must be 60µs to 120µs in duration with a 1µs minimum recovery time between cycles. Write "0" and write "1" time slots are illustrated in Figure 3. During the write "0" time slot, the host microcontroller pulls the line low for the duration of the time slot. However, during the write "1" time slot, the microcontroller pulls the line low and then releases the line within 15µs after the start of the time slot.
A read time slot is initiated when the microcontroller pulls the bus low for 1µs then releases it so the DS18x20/DS1822 can take control of the line and present valid data (high or low). All read time slots must be 60µs to 120µs in duration with a minimum 1µs recovery time between cycles (see Figure 3).
Figure 2. Reset pulse and presence pulse.
Figure 3. Write and read time slots.
Software Control
In order to accurately control the special timing requirements of the 1-Wire interface, certain key functions must first be established. The first function created must be the "delay" function which is integral to all read and write control. This function is entirely dependent on the speed of the microcontroller. For the purpose of this article, the DS5000 (8051 compatible) microcontroller is used, which runs at 11.059MHz. The example to the right illustrates the "C" prototype function for creating the timing delay.
Delay Example
// DELAY - with an 11.059MHz crystal.
// Calling the routine takes about 24us, and then
// each count takes another 16us.
//
void delay(int useconds)
{
int s;
for (s=0; s<useconds;s++);
}
Since each communication cycle must begin with a reset from the microcontroller, the "reset" function is the next most important function to be implemented. The reset time slot is 480µs. By setting a delay of "3", followed by "25" (see the example below), the reset pulse will last for the required duration. Following the reset, the microcontroller must release so the DS18x20/DS1822 can indicate its "presence" by pulling the line low. Note that if multiple temperature sensors are on the bus, they will all respond simultaneously with a presence pulse.
Reset Example
//////////////////////////////////////////////////////////////////////////////
// OW_RESET - performs a reset on the one-wire bus and
// returns the presence detect. Reset is 480us, so delay
// value is (480-24)/16 = 28.5 - we use 29. Presence checked
// another 70us later, so delay is (70-24)/16 = 2.875 - we use 3.
//
unsigned char ow_reset(void)
{
unsigned char presence;
DQ = 0; //pull DQ line low
delay(29); // leave it low for 480us
DQ = 1; // allow line to return high
delay(3); // wait for presence
presence = DQ; // get presence signal
delay(25); // wait for end of timeslot
return(presence); // presence signal returned
} // 0=presence, 1 = no part
The read and write function code segments shown in the following four examples provide the basic structure needed for all data bit and data byte read and write operations.
Read Bit Example
//////////////////////////////////////////////////////////////////////////////
// READ_BIT - reads a bit from the one-wire bus. The delay
// required for a read is 15us, so the DELAY routine won't work.
// We put our own delay function in this routine in the form of a
// for() loop.
//
unsigned char read_bit(void)
{
unsigned char i;
DQ = 0; // pull DQ low to start timeslot
DQ = 1; // then return high
for (i=0; i<3; i++); // delay 15us from start of timeslot
return(DQ); // return value of DQ line
}
Write Bit Example
//////////////////////////////////////////////////////////////////////////////
// WRITE_BIT - writes a bit to the one-wire bus, passed in bitval.
//
void write_bit(char bitval)
{
DQ = 0; // pull DQ low to start timeslot
if(bitval==1) DQ =1; // return DQ high if write 1
delay(5); // hold value for remainder of timeslot
DQ = 1;
}// Delay provides 16us per loop, plus 24us. Therefore delay(5) = 104us
Read Byte Example
//////////////////////////////////////////////////////////////////////////////
// READ_BYTE - reads a byte from the one-wire bus.
//
unsigned char read_byte(void)
{
unsigned char i;
unsigned char value = 0;
for (i=0;i<8;i++)
{
if(read_bit()) value|=0x01<<i; // reads byte in, one byte at a time and then
// shifts it left
delay(6); // wait for rest of timeslot
}
return(value);
}
Write Byte Example
//////////////////////////////////////////////////////////////////////////////
// WRITE_BYTE - writes a byte to the one-wire bus.
//
void write_byte(char val)
{
unsigned char i;
unsigned char temp;
for (i=0; i<8; i++) // writes byte, one bit at a time
{
temp = val>>i; // shifts val right 'i' spaces
temp &= 0x01; // copy that bit to temp
write_bit(temp); // write bit in temp into
}
delay(5);
}
The Search ROM Algorithm
To take full advantage of the 1-Wire net concept, the microcontroller must be able to communicate with any number of devices connected to the net. In order to do this, the microcontroller must learn the unique 64-bit ROM identification code for each device on the bus using the "Search ROM" algorithm illustrated in Figure 4. The example following Figure 4 explains a Search ROM routine for a bus with four slave devices. Sample code for a Search ROM routine is also shown. Once all the ROM codes have been identified, the "Match ROM" command can be used to communicate with any specific device on the net.
Figure 4. Search ROM algorithm.
ROM Search Example
During the ROM search process, the bus master must repeat a simple three-step routine: 1) read a ROM code bit from the slave devices, 2) read the complement of the bit, 3) write the selected value for that bit. The bus master must perform this three-step routine 64 times—once for each ROM code bit. After one complete pass, the bus master will know the ROM code for one slave device on the bus. The remaining devices and their ROM codes can be identified though additional passes.
The ROM Search process is illustrated by the following example that assumes four different devices are connected to the same 1-Wire bus. The ROM codes of the four devices are as shown:
The bus master begins the initialization sequence by issuing a reset pulse. The slave devices respond by
issuing simultaneous presence pulses.
The bus master then issues the Search ROM command on the 1-Wire bus.
Each device will respond to the Search ROM command by placing the value of the first bit of their respective ROM codes onto the 1-Wire bus. The master will then read the bus value. In this case, ROM1 and ROM4 will place a 0 onto the 1-Wire bus, i.e., they will pull it low. ROM2 and ROM3 will place a 1 onto the 1-Wire bus by allowing the line to stay high. The result is the logical AND of all devices on the line; therefore, the bus master will read a 0. All of the devices on the 1-Wire bus will respond to this read by placing the complement of the first bit of their ROM codes onto the 1-Wire bus: ROM1 and ROM4 will place a 1 onto the 1-Wire bus, allowing the line to stay high, and ROM2 and ROM3 will place a 0 onto the bus, pulling it low. The bus master will now read the bus again and will again read a 0.
Depending on the slave device ROM codes, there are four possible data combinations that the bus master can obtain from the two reads. These combinations can be interpreted as follows:
00
There are devices connected to the bus which have conflicting bits in the current ROM code bit position.
01
All devices connected to the bus have a 0 in this bit position.
10
All devices connected to the bus have a 1 in this bit position.
11
There are no devices connected to the 1-Wire bus.
In this example, bus master has read a 0 during each read, which tells it that there are some devices on the 1-Wire bus that have a 0 in the first ROM code position and others that have a 1.
In response to the previous data, the bus master writes a 0 onto the bus. This deselects ROM2 and ROM3 for the remainder of this search pass, leaving only ROM1 and ROM4 "connected" to the 1-Wire bus.
The bus master performs two more reads and receives a 0 followed by a 1. This indicates that all devices still connected to the bus have 0s as their second ROM data bit.
The bus master then writes a 0 to keep both ROM1 and ROM4 connected to the bus.
The bus master again executes two reads and receives two 0s. This indicates to the master that one of the devices on the 1-Wire bus has a 0 in the third ROM code position and the other has a 1.
The bus master writes a 0 onto the bus, which deselects ROM1 and leaves ROM4 as the only device still connected.
The bus master reads the remainder of the ROM bits from ROM4 and continues to access the ROM4 device if desired. This completes the first ROM search pass; the bus master has now uniquely identified one slave (ROM4) on the 1-Wire bus by learning its ROM code.
The bus master starts a new ROM search sequence by repeating steps 1 through 7.
The bus master now writes a 1 onto the bus (instead of a 0, as was done in step 8). This decouples ROM4, leaving only ROM1 still connected.
The bus master now reads the remainder of the ROM bits from ROM1 and can communicate with the ROM1 device if desired. This completes the second ROM search pass, and the master has now identified another slave device (ROM1).
The bus master starts a new ROM search by repeating steps 1 through 3.
The bus master now writes a 1 onto the bus (instead of a 0, as was done in step 4). This deselects ROM1 and ROM4 for the remainder of this search pass, leaving only ROM2 and ROM3 coupled to the bus.
The bus master executes two reads and receives two 0s.
The bus master writes a 0 onto the bus, which decouples ROM3, leaving only ROM2 connected to the bus.
The bus master reads the remainder of the ROM bits from ROM2 and communicates with the ROM2 device if desired. This completes the third ROM search pass, and the master has now identified the ROM2 slave device.
The bus master starts a fourth and final ROM search by repeating steps 13 through 15.
The bus master writes a 1 onto the bus (instead of a 0, as was done in step 16), which decouples ROM2, leaving only ROM3 connected to the bus.
The bus master reads the remainder of the ROM bits from ROM3 and communicates with the ROM3 device if desired. This completes the fourth ROM search pass, during which the master identified the ROM3 device. At this point the master has identified all the slave devices on the bus, and from this point on the bus master can individually address any of the devices using their ROM codes.
Note: The bus master learns the unique ROM code of one 1-Wire device during each ROM search pass. The time required to learn one ROM code is:
960µs + (8 + 3 × 64) 61µs = 13.16m
The bus master is therefore capable of identifying 75 different 1-Wire slave devices per second.
Search ROM Code Examples
As shown in the prototype function below, the "Find Devices" function begins with a 1-Wire reset to determine if any devices are on the net, and if so, to wake them up. The "First" function is then called, to keep track of the discrepancy bits and return to "Next", which finds each unique device on the net.
The "Next" function is quite extensive and does most of the work in finding each unique 64-bit ROM code identifier for each device on the net.
// FIND DEVICES
void FindDevices(void)
{
unsigned char m;
if(!ow_reset()) //Begins when a presence is detected
{
if(First()) //Begins when at least one part is found
{
numROMs=0;
do
{
numROMs++;
for(m=0;m<8;m++)
{
FoundROM[numROMs][m]=ROM[m]; //Identifies ROM
\\number on found device
} printf("\nROM CODE =%02X%02X%02X%02X\n",
FoundROM[5][7],FoundROM[5][6],FoundROM[5][5],FoundROM[5][4],
FoundROM[5][3],FoundROM[5][2],FoundROM[5][1],FoundROM[5][0]);
}while (Next()&&(numROMs<10)); //Continues until no additional devices are found
}
}
}
// FIRST
// The First function resets the current state of a ROM search and calls
// Next to find the first device on the 1-Wire bus.
//
unsigned char First(void)
{
lastDiscrep = 0; // reset the rom search last discrepancy global
doneFlag = FALSE;
return Next(); // call Next and return its return value
}
// NEXT
// The Next function searches for the next device on the 1-Wire bus. If
// there are no more devices on the 1-Wire then false is returned.
//
unsigned char Next(void)
{
unsigned char m = 1; // ROM Bit index
unsigned char n = 0; // ROM Byte index
unsigned char k = 1; // bit mask
unsigned char x = 0;
unsigned char discrepMarker = 0; // discrepancy marker
unsigned char g; // Output bit
unsigned char nxt; // return value
int flag;
nxt = FALSE; // set the next flag to false
dowcrc = 0; // reset the dowcrc
flag = ow_reset(); // reset the 1-Wire
if(flag||doneFlag) // no parts -> return false
{
lastDiscrep = 0; // reset the search
return FALSE;
}
write_byte(0xF0); // send SearchROM command
do
// for all eight bytes
{
x = 0;
if(read_bit()==1) x = 2;
delay(6);
if(read_bit()==1) x |= 1; // and its complement
if(x ==3) // there are no devices on the 1-Wire
break;
else
{
if(x>0) // all devices coupled have 0 or 1
g = x>>1; // bit write value for search
else
{
// if this discrepancy is before the last
// discrepancy on a previous Next then pick
// the same as last time
if(m<lastDiscrep)
g = ((ROM[n]&k)>0);
else // if equal to last pick 1
g = (m==lastDiscrep); // if not then pick 0
// if 0 was picked then record
// position with mask k
if (g==0) discrepMarker = m;
}
if(g==1) // isolate bit in ROM[n] with mask k
ROM[n] |= k;
else
ROM[n] &= ~k;
write_bit(g); // ROM search write
m++; // increment bit counter m
k = k<<1; // and shift the bit mask k
if(k==0) // if the mask is 0 then go to new ROM
{ // byte n and reset mask
ow_crc(ROM[n]); // accumulate the CRC
n++; k++;
}
}
}while(n<8); //loop until through all ROM bytes 0-7
if(m<65||dowcrc) // if search was unsuccessful then
lastDiscrep=0; // reset the last discrepancy to 0
else
{
// search was successful, so set lastDiscrep,
// lastOne, nxt
lastDiscrep = discrepMarker;
doneFlag = (lastDiscrep==0);
nxt = TRUE; // indicates search is not complete yet, more
// parts remain
}
return nxt;
}
Performing a Cyclic Redundancy Check
A cyclic redundancy check (CRC) can be accomplished using the functions shown below and should be included when performing the Search ROM function.
If there is a single device on the net, then the "Read Temperature" function can be used directly as shown below. However, if multiple devices are on the net, in order to avoid data collisions, the "Match ROM" function must be used to select a specific device.
The code example below was written specifically for use with the DS18S20 temperature sensor. To use this code with the DS18B20 or DS1822, it must be modified slightly due to differences in the temperature register format. Refer to the respective datasheet for temperature register format information.
void Read_Temperature(void)
{
char get[10];
char temp_lsb,temp_msb;
int k;
char temp_f,temp_c;
ow_reset();
write_byte(0xCC); //Skip ROM
write_byte(0x44); // Start Conversion
delay(5);
ow_reset();
write_byte(0xCC); // Skip ROM
write_byte(0xBE); // Read Scratch Pad
for (k=0;k<9;k++){get[k]=read_byte();}
printf("\n ScratchPAD DATA = %X%X%X%X%X\n",get[8],get[7],get[6],get[5],get[4],get[3],get[2],get[1],get[0]);
temp_msb = get[1]; // Sign byte + lsbit
temp_lsb = get[0]; // Temp data plus lsb
if (temp_msb <= 0x80){temp_lsb = (temp_lsb/2);} // shift to get whole degree
temp_msb = temp_msb & 0x80; // mask all but the sign bit
if (temp_msb >= 0x80) {temp_lsb = (~temp_lsb)+1;} // twos complement
if (temp_msb >= 0x80) {temp_lsb = (temp_lsb/2);}// shift to get whole degree
if (temp_msb >= 0x80) {temp_lsb = ((-1)*temp_lsb);} // add sign bit
printf( "\nTempC= %d degrees C\n", (int)temp_lsb ); // print temp. C
temp_c = temp_lsb; // ready for conversion to Fahrenheit
temp_f = (((int)temp_c)* 9)/5 + 32;
printf( "\nTempF= %d degrees F\n", (int)temp_f ); // print temp. F
}
Reading the Scratch Pad Memory
The Scratch Pad memory provides the user with all the necessary device data including temperature, TH and TL programmable thermometer settings, as well as the Count Remain and Count Per C data used in fractional temperature measurements. The CRC byte is also included in Scratch Pad memory.
void Read_ScratchPad(void)
{
int j;
char pad[10];
printf("\nReading ScratchPad Data\n");
write_byte(0xBE);
for (j=0;j<9;j++){pad[j]=read_byte();}
printf("\n ScratchPAD DATA =
%X%X%X%X%X%X\n",pad[8],pad[7],pad[6],pad[5],pad[4],pad[3],pad[2],pad[1],pad[0]);
}
The "Read ROM" command is used to find the 64-bit ROM code when only a single device is on the net. Multiple devices require the use of the "Search ROM" functions.
void Read_ROMCode(void)
{
int n;
char dat[9];
printf("\nReading ROM Code\n");
ow_reset();
write_byte(0x33);
for (n=0;n<8;n++){dat[n]=read_byte();}
printf("\n ROM Code = %X%X%X%X\n",dat[7],dat[6],dat[5],dat[4],dat[3],dat[2],dat[1],dat[0]);
}
The "Match ROM" function must provide the 64-bit ROM-ID to select an individual device on the net.
// Perform Match ROM
//
unsigned char Send_MatchRom(void)
{
unsigned char i;
if(ow_reset()) return false;
write_byte(0x55); // match ROM
for(i=0;i<8;i++)
{
write_byte(FoundROM[numROMs][i]); //send ROM code
}
return true;
}
