{"id":4351,"date":"2018-10-17T20:00:52","date_gmt":"2018-10-17T18:00:52","guid":{"rendered":"https:\/\/msalamon.pl\/?p=4351"},"modified":"2025-12-27T20:33:33","modified_gmt":"2025-12-27T19:33:33","slug":"the-immortal-ds18b20","status":"publish","type":"post","link":"https:\/\/msalamon.pl\/en\/the-immortal-ds18b20\/","title":{"rendered":"The Immortal DS18B20"},"content":{"rendered":"\n

Ask anywhere which temperature sensor to use and the answer you\u2019ll most often get is DS18B20. Dallas\u2019s chip is extremely popular. You can also buy a waterproof version in stores, which further strengthens its popularity. Obviously, I couldn\u2019t miss this sensor.<\/p>\n\n\n\n\n\n\n\n

Communication with DS18B20<\/h1>\n\n\n\n

You can talk to the DS18B20 only via the 1-Wire interface. What is that?! It\u2019s an invention by Dallas Semiconductor, which later merged with Maxim.  This interface, which is also a protocol, uses only a single line for bidirectional communication, hence its name.<\/p>\n\n\n\n

I don\u2019t want to go into the details of this interface and how it works. In short, the most important information is:<\/p>\n\n\n\n

    \n
  1. \n
      \n
    1. All devices are connected to a single bus.<\/li>\n\n\n\n
    2. Ones and zeros are defined as pulses with time constants defined by the interface. Because of this, the communication speed is essentially fixed.<\/li>\n\n\n\n
    3. Transmission is serial and follows the\u00a0master-slave<\/em>\u00a0rules.<\/li>\n<\/ol>\n<\/li>\n\n\n\n
    4. The protocol includes addressing, thanks to which we can activate a selected sensor, similar to I\u00b2C.<\/li>\n<\/ol>\n\n\n\n

      I recommend the official Maxim documentation, which explains the details much better than I would. On the company website there are, for example, some helpful articles: Link1<\/a> Link2<\/a><\/p>\n\n\n\n

      Connection<\/h2>\n\n\n
      \n
      \"DS18B20<\/a><\/figure>\n<\/div>\n\n\n

      <\/p>\n\n\n\n

      As I mentioned earlier, devices on the 1-Wire bus are connected with only one wire. Adding power, we typically have 3 wires. The data line must be pulled up to the supply line through a resistor. It is usually 4k7 ohm.<\/p>\n\n\n\n

      Hmm, I said 3 wires by default. And non\u2011standard? Two! Namely, the 1\u2011Wire interface allows communication in the so\u2011called parasitic mode<\/em>, where the positive supply line is not provided to the sensor. The VDD pin on the Slave<\/em> device is then shorted to ground. So where does the sensor get its power from? As the name of the mode implies \u2013 it parasitizes on the data line. In 1\u2011Wire s<\/em>lave<\/em> devices there is a capacitor that, when a high state appears on the data line, charges and maintains the supply during the low state.<\/p>\n\n\n\n

      For the purposes of this post I used the regular mode. I connected 4 DS18B20 sensors to pin PA1 on the Nucleo F401RE<\/a>.<\/p>\n\n\n

      \n
      \"\"<\/a><\/figure>\n<\/div>\n\n
      \n
      \"\"<\/a><\/figure>\n<\/div>\n\n\n

      <\/a><\/p>\n\n\n\n

      Programming<\/h2>\n\n\n\n

      On the Internet you can find tons of 1\u2011Wire communication examples for probably all microcontrollers in the world. I won\u2019t pretend my library is unique or written from scratch. When writing it I relied on various open examples that are publicly available. I made a library that suits me in use. I\u2019m not claiming it\u2019s the best \u2013 it\u2019s good \ud83d\ude42<\/p>\n\n\n\n

      For the library to work you need a t<\/em>imer<\/em> with a 1 \u00b5s tick. It\u2019s easy to obtain by using an integer number of megahertz to clock the MCU. Just set the prescaler<\/em> to (MCU clock) – 1<\/em>. Remember to enter a large value \u2013 e.g., 65000 \u2013 into the Counter Period<\/em> of the timer<\/em> configuration in CubeMX. <\/p>\n\n\n\n

      The library consists of two parts. The first is the 1\u2011Wire interface handling. It is hands\u2011off and does not require any configuration in headers. The second part is, of course, DS18B20 handling. Configuration in the header file includes:<\/p>\n\n\n\n

        \n
      1. The maximum number of DS18B20 devices that can be connected to the bus.<\/li>\n\n\n\n
      2. The GPIO pin and port used for 1\u2011Wire.<\/li>\n\n\n\n
      3. The name of the handler for the timer with a 1\u00a0\u00b5s tick.<\/li>\n\n\n\n
      4. A define flag that decides whether to use CRC. You can save a few bytes of time when reading at the possible cost of data correctness.<\/li>\n<\/ol>\n\n\n\n

        Configuration in CubeMX is trivially simple. Just define the GPIO bus pin as a regular GPIO Output<\/em> and configure the aforementioned timer<\/em>. Additionally, I threw in the on\u2011board Nucleo LED for blinking, a UART for printing temperatures to the PC, and a test output for viewing on a logic analyzer.<\/p>\n\n\n

        \n
        \"\"<\/a><\/figure>\n<\/div>\n\n\n

        <\/p>\n\n\n\n

        How does my code work? Information about each connected sensor is stored in an array of Ds18b20Sensor_t<\/em> structures with the number of elements given in the header as the maximum number of sensors. <\/em>It contains information about the full address, the last correctly read temperature, and the success of the last read. Additionally, I created a variable that says how many DS18B20 sensors were detected. There may be fewer than the MAX defined in the header. I wondered about dynamically allocating memory for the number of connected sensors, but would that make sense? In general their number doesn\u2019t change during the device\u2019s lifetime, so the number of elements in the array can be set fixed.<\/p>\n\n\n\n

        Access to data such as address or temperature is possible only through dedicated functions. There is no manual poking around in the structure. The most important functions:<\/p>\n\n\n\n

        void DS18B20_Init(DS18B20_Resolution_t resolution);\n<\/pre>\n\n\n\n
        This is, of course, initialization. Inside the initialization, the 1\u2011Wire bus is started and DS18B20 sensors that are connected are searched for and counted. You must pass the required resolution for the devices as an argument. Remember that resolution has a huge impact on the time it takes to convert the temperature to digital form. Available options:<\/p>\n\n\n\n
        DS18B20_Resolution_9bits\nDS18B20_Resolution_10bits\nDS18B20_Resolution_11bits\nDS18B20_Resolution_12bits<\/pre>\n\n\n\n
         <\/p>\n\n\n\n
        void DS18B20_StartAll(void);\n<\/pre>\n\n\n\n
        This sends the start temperature conversion command to all connected sensors. Simple.<\/p>\n\n\n\n
        void DS18B20_ReadAll(void);\n<\/pre>\n\n\n\n
        Function to read the converted temperature into the appropriate elements in the sensor array. Every sensor detected in the initialization function is read.<\/p>\n\n\n\n
        uint8_t DS18B20_Quantity(void);\n<\/pre>\n\n\n\n
        Returns the number of sensors detected during initialization.<\/p>\n\n\n\n
        uint8_t DS18B20_GetTemperature(uint8_t number, float* destination);\n<\/pre>\n\n\n\n
        Writes the temperature value from the i\u2011th sensor to the memory location pointed to by destination<\/em>.<\/p>\n\n\n\n
        void DS18B20_GetROM(uint8_t number, uint8_t* ROM);\nvoid DS18B20_WriteROM(uint8_t number, uint8_t* ROM);\n<\/pre>\n\n\n\n
        Operations on sensor addresses. With them, you can, for example, change the order of sensors in the array.<\/p>\n\n\n\n
        Putting it all together I got a sample code that prints all sensors to the terminal.<\/p>\n\n\n\n
        \/* USER CODE BEGIN 2 *\/\n\tDS18B20_Init(DS18B20_Resolution_12bits);\n\/* USER CODE END 2 *\/\n\n\/* Infinite loop *\/\n\/* USER CODE BEGIN WHILE *\/\nwhile (1)\n{\n\t\/* USER CODE END WHILE *\/\n\n\t\/* USER CODE BEGIN 3 *\/\n\tDS18B20_ReadAll();\n\tDS18B20_StartAll();\n\tuint8_t ROM_tmp[8];\n\tuint8_t i;\n\tfor(i = 0; i &lt; DS18B20_Quantity(); i++)\n\t{\n\t\tif(DS18B20_GetTemperature(i, &amp;temperature))\n\t\t{\n\t\t\tDS18B20_GetROM(i, ROM_tmp);\n\t\t\tmemset(message, 0, sizeof(message));\n\t\t\tsprintf(message, \"%d. ROM: %X%X%X%X%X%X%X%X Temp: %f\\n\\r\",i, ROM_tmp[0], ROM_tmp[1], ROM_tmp[2], ROM_tmp[3], ROM_tmp[4], ROM_tmp[5], ROM_tmp[6], ROM_tmp[7], temperature);\n\t\t\tHAL_UART_Transmit(&amp;huart2, (uint8_t*)message, sizeof(message), 100);\n\t\t}\n\t}\n\tHAL_UART_Transmit(&amp;huart2, (uint8_t*)\"\\n\\r\", sizeof(\"\\n\\r\"), 100);\n\tHAL_Delay(1000);\n\tHAL_GPIO_TogglePin(LED_GPIO_Port, LED_Pin);\n}\n\/* USER CODE END 3 *\/<\/pre>\n\n\n\n
        Warning, danger!!!<\/strong> The STM32 compiler has the quirk that after generating code in CubeMX you don\u2019t immediately have the ability to print variables of type float<\/em>! You\u2019ll get only zeros or nothing at all \ud83d\ude41 To make this work you need to add the flag -u _printf_float<\/em> to the linker.<\/p>\n\n\n
        \n
        \"\"<\/a><\/figure>\n<\/div>\n\n\n
        <\/p>\n\n\n\n
        Now that everything is clear, see the result of this little piece of code:<\/p>\n\n\n
        \n
        \"\"<\/a><\/figure>\n<\/div>\n\n\n
        <\/p>\n\n\n\n
        It\u2019s warm at my desk, isn\u2019t it? \ud83d\ude42<\/p>\n\n\n\n
        Sooo, how long will this take?<\/h2>\n\n\n\n
        Of course I had to check how long it takes to transfer the necessary data over 1\u2011Wire!<\/p>\n\n\n
        \n
        \"\"<\/a><\/figure>\n<\/div>\n\n
        \n
        \"\"<\/a><\/figure>\n<\/div>\n\n\n
        The communication to read the temperature itself takes about 14 ms.<\/p>\n\n\n
        \n
        \"\"<\/a><\/figure>\n<\/div>\n\n\n
        The start conversion command for all sensors is about 2.3 ms.
        \n<\/p>\n\n\n\n
        So the whole thing for one sensor is about 16.4 ms. Knowing that the start command is sent only once for all sensors, the formula for read and start conversion time for n sensors is 14 * n + 2.3 [ms]. Let\u2019s check.<\/p>\n\n\n
        \n
        \"\"<\/a><\/figure>\n<\/div>\n\n\n
        <\/p>\n\n\n
        \n
        \"\"<\/a><\/figure>\n<\/div>\n\n\n
        Two sensors. 14 * 2 + 2.3 = 30.3. Measurement is 30.43.<\/p>\n\n\n\n
        Four sensors. 14 * 4 + 2.3 = 58.3. Measurement 58.45.<\/p>\n\n\n\n
        So everything adds up. Can we shave off a few milliseconds? By disabling CRC.<\/p>\n\n\n
        \n
        \"\"<\/a><\/figure>\n<\/div>\n\n\n
        <\/p>\n\n\n
        \n
        \"\"<\/a><\/figure>\n<\/div>\n\n\n
        11.75 ms for the readout of a single sensor.<\/p>\n\n\n\n
        The start conversion command is of course unchanged. There is nothing related to CRC here. Without CRC, the formula for handling n sensors is 11.75 * n + 2.3 [ms].<\/p>\n\n\n
        \n
        \"\"<\/a><\/figure>\n<\/div>\n\n\n
        <\/p>\n\n\n\n
        Confirmation on four sensors.<\/p>\n\n\n
        \n
        \"\"<\/a><\/figure>\n<\/div>\n\n\n
        <\/p>\n\n\n\n
        11.75 * 4 + 2.3 = 49.3. The measurement comes out 49.05. Checks out \ud83d\ude42<\/p>\n\n\n\n
        However, be careful when giving up CRC! It may happen that you read garbage, and now you have no way to verify it.<\/p>\n\n\n\n
        Can we shave off more? We can, but not with the DS18B20 \ud83d\ude41 1\u2011Wire offers something called the Override<\/em> mode, which speeds up transmission about 10\u2011fold. Our temperature sensor does not support this mode, so unfortunately I have nothing to test. In general, few 1\u2011Wire devices support accelerated communication.<\/p>\n\n\n\n
        Summary<\/h2>\n\n\n\n
        DS18B20 temperature sensors are very pleasant. Handling them is not overly complicated, and there are thousands of examples on the Internet showing how to deal with them. I\u2019m adding one of my own, hoping it\u2019s written sensibly. An unquestionable advantage is the ability to handle many devices via only one data line. This works great for multi\u2011point measurements. Additionally, waterproof versions are perfect for measuring water temperature, e.g., in an aquarium \ud83d\ude42<\/p>\n\n\n\n
        Thank you for reading this post. If you like this topic, let me know in a comment. I\u2019ll also be grateful for topic suggestions you\u2019d like me to cover.<\/p>\n\n\n\n
        The code is, as usual, available on my GitHub: link<\/a><\/p>\n\n\n\n
        If you noticed any error, disagree with something, would like to add something important, or simply feel like discussing this topic, write a comment. Remember that the discussion should be polite and in accordance with the rules of the Polish language.<\/span><\/p>\n\n\n\n
        Contest results<\/h3>\n\n\n\n
        In the previous post I announced a mini contest. Time to pick the winners. From all comments that did not repeat by name, IP and email and met all requirements, I chose 10, in my opinion, most interesting uses of the display.<\/p>\n\n\n
        \n
        \"\"<\/figure>\n<\/div>\n\n\n
        <\/p>\n\n\n\n
        From among them I drew two winners according to the rules given in the contest. These are comments number 4 and 10 from the screenshot above. The video of the drawing is available at https:\/\/youtu.be\/vqYASbZ2Xr0<\/a><\/p>\n\n\n\n
        Congratulations to the winners! I\u2019ve already emailed you to finalize the contest. There will probably be more contests on the blog. I have a bit too much stuff in my closet \ud83d\ude09<\/p>\n\n\n
        \n            \n
        \n    \n
        \n            
        \n            \n\n
        <\/div>\n        <\/div>\n            
        \n            \n\n
        <\/div>\n        <\/div>\n            
        \n            \n\n
        <\/div>\n        <\/div>\n            
        \n            \n\n
        <\/div>\n        <\/div>\n            
        \n            \n\n
        <\/div>\n        <\/div>\n    <\/div>\n    \n
        \n            
        \n            \n\n
        <\/div>\n        <\/div>\n            
        \n            \n\n
        <\/div>\n        <\/div>\n            
        \n            \n\n
        <\/div>\n        <\/div>\n            
        \n            \n\n
        <\/div>\n        <\/div>\n            
        \n            \n\n
        <\/div>\n        <\/div>\n    <\/div>\n<\/div>\n                \n\n
        \n            <\/span>\n    <\/div>\n    <\/div>\n","protected":false},"excerpt":{"rendered":"
        Ask anywhere which temperature sensor to use and the answer you\u2019ll most often get is DS18B20. Dallas\u2019s chip is extremely popular. You can also buy a waterproof version in stores, which further strengthens its popularity. Obviously, I couldn\u2019t miss this sensor.<\/p>\n","protected":false},"author":1,"featured_media":3017,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":"","_links_to":"","_links_to_target":""},"categories":[160],"tags":[175,176,174,177],"class_list":["post-4351","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-stm32","tag-electronics","tag-programming","tag-stm32","tag-stm32cubemx"],"_links":{"self":[{"href":"https:\/\/msalamon.pl\/en\/wp-json\/wp\/v2\/posts\/4351","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/msalamon.pl\/en\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/msalamon.pl\/en\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/msalamon.pl\/en\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/msalamon.pl\/en\/wp-json\/wp\/v2\/comments?post=4351"}],"version-history":[{"count":3,"href":"https:\/\/msalamon.pl\/en\/wp-json\/wp\/v2\/posts\/4351\/revisions"}],"predecessor-version":[{"id":4467,"href":"https:\/\/msalamon.pl\/en\/wp-json\/wp\/v2\/posts\/4351\/revisions\/4467"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/msalamon.pl\/en\/wp-json\/wp\/v2\/media\/3017"}],"wp:attachment":[{"href":"https:\/\/msalamon.pl\/en\/wp-json\/wp\/v2\/media?parent=4351"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/msalamon.pl\/en\/wp-json\/wp\/v2\/categories?post=4351"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/msalamon.pl\/en\/wp-json\/wp\/v2\/tags?post=4351"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}