HC-SR04 Ultrasonic Sensor Interfacing with TM4C123 – Distance Measurement Example

In this tutorial, we will learn to interface HC-SR04 ultrasonic sensor with TM4C123 Tiva C Launchpad. HC-SR04 is a contactless ultrasonic based distance or range measurement sensor. It provides an output signal in the form of active high signal and the duration for which the output signal remains high depends on the distance between the ultrasonic sensor and the object under test.

By measuring the time for which this active signal remains active high, we can measure distance. Furthermore, the timer modules of the TM4C123 microcontroller provide an input capture mode that can be used to measure pulse duration or time between events. Therefore, we will use TM4C123 Timer in input-edge time mode to measure the time duration of the output signal of the HC-SR04 sensor. 

HC-SR04 Ultrasonic Sensor 

Let’s start with the basic introduction of the HC-SR04  ultrasonic sensor. It is a contactless range or distance measurement sensor and it provides a distance range between 2cm to 400cm. It consists of three main circuits such as an ultrasonic transmitter, ultrasonic receiver, and the control circuit. We will see the function of each circuit later. 

Pinout

The figure given below shows the pinout diagram of the HC-SR04 ultrasonic sensor. It consists of 4 pins.

Two of them are power supply pins such as +5V and ground. The other two pins are Trigger and echo pin. The echo output pulse pin is used to get output from the sensor. Trigger pin is used to initiate the sensor to start ranging. 

Note: This sensor does not work properly on a 3.3 volts power supply. Additionally, TM4C123 Tiva Launchpad does not have an onboard 5 volts signal. Therefore, you must connect an external 5 volt supply to power HC-SR04.

How HC-SR04 Sensor Works? 

In this section, we will see how HC-SR04 ultrasonic sensor work. As you mentioned earlier, it consists of one ultrasonic transmitter circuit and one ultrasonic receiver circuit. The ultrasonic transmitter circuit converts the electrical signals into 40kHz ultrasonic sound waves. On the other hand,  an ultrasonic receiver listens to these ultrasonic sound waves and if the receiver circuit receives these ultrasonic sound waves,  it produces a pulse on the output pin. The width of this pulse or pulse duration can be used to measure the distance. 

Distance Measurement Steps

Now let’s see the steps to initiate distance ranging or get echo pulse output: 

• First of all, we apply 10 microseconds pulse to the Trigger pin of HC-SR04 sensor from general purpose input output pin of TM4C123 microcontroller. 
• As a result, the transmitter circuit produces 8 pulses burst of ultrasound waves and each pulse has 40KHz frequency. 
• As soon as all eight pulses are transmitted through the air, the echo pin goes high. In other words, the output echo pin makes transition from an active low to active high level. 
• The echo pin remains active high until the ultrasonic sound wave does not reflect back to the receiver circuit after striking the object Under test.
• As soon as the ultrasonic signal received by the receiver circuit after striking with an object, the echo pin goes low. 
• By measuring the width of the output pulse, we can measure the distance. 

The pulse width can vary between 150 µS to 25 mS depending on the distance between the sensor and the obstacle. More the distance, the more time the sonar sound wave takes to receive after reflecting back. 

Note: If there is no obstacle or out of the range of the maximum range of the sonar sensor ( 400cm), the transmitted signal will not reflect back. In this case, the echo output signal will go high for 38ms. Hence, if the width of the output pulse is 38ms, that means there is no object in the range of the obstacle sensor. Hence, the measured distance will be zero. 

The figure below shows the timing diagram and it illustrates all the steps metioned above.

Measure HC-SR04 Output Pulse width using TM4C123

Now let’s see how to measure the output signal time or pulse duration of the HC-SR04 sensor. As you know that the time duration for which the output signal remains high depends on the distance between the ultrasonic sensor and the object under test. Greater the distance, the higher the time it will take by the Ultrasonic wave to reflect to the receiver circuit. Therefore, by measuring this time we can measure the distance between the sensor and the object. 

In idle condition, when the sensor is not initiated by applying a trigger signal, the echo output signal remains active low. When we want to measure the distance, we apply a 10us pulse to the trigger input. In response, the HC-SR04 sensor produces a burst of 8 sonar wave pulses and raises its echo output pin active high. That means a rising edge occurs at the echo pin. After that as soon as the ultrasonic wave is detected by the receiver circuit, echo output goes low which means a falling edge occurs. Therefore, the time between two consecutive rising and falling edges gives us the pulse duration. 

TM4C123 Timers and Pulse Duration 

TM4C123 microcontroller timers can be in input edge timer capture mode. In this mode, timers can measure time between events such as rising or falling edges. For example, read the TM4C123 timer value when the rising edge is captured by the GPIO pin of TM4C123 microcontroller and also read the timer value when the falling edge is detected. After that takes the difference of two measured timer values, it will give you pulse duration. 

In the previous tutorial, we have posted an in-depth guide to measure pulse duration using TM4C123 Timers. You must read this post: 

• Pulse Duration Measurement using TM4C123 Timer in input-edge Time mode 

In short, by measuring the time of this output pulse with TM4C123 timers, we can measure the distance. 

Convert HC-SR04 Ouput Pulse Duration into Distance

Once we measured the output pulse duration, the distance can be calculated by using distance speed and time relationship that is:

 S = v x t

In this equation, S, t, and v are distance, time, and speed respectively.  Here time (t) is the pulse duration of the ultrasonic output signal. But how do we find the speed of ultrasonic waves? That’s pretty easy. If you studied physics in high school, you may remember that ultrasonic waves travel with the speed of sound. The speed of sound in air is 340 m/sec meters per second. 

But as per the datasheet of the HC-SR04 ultrasonic sensor, the value of speed should be in units of a centimeter per second (cm/s). To convert speed into cm/sec, multiply 340 with 100. The result will be 34000cm/sec. Hence, the above formula to calculate distance from pulse duration becomes: 

S = 34000cm/sec x t 

But there is one more point to consider here that is the time taken by the ultrasonic wave to reach the obstacle and reflect back to the receiver indicates the distance for both forward and reverse path. Hence, we should also divide the above equation by 2 to get one way distance. 

S = ( 34000cm/sec x t ) / 2

HC-SR04 Driver for TM4C123 MCU

Follow these steps to write API:

1. First, make any TM4C123 microcontroller GPIO as a digital output pin to send the trigger signal to the ultrasonic sensor.

If you don’t know how to configure GPIO pins of TM4C123 microcontroller as digital output pins, read this guide:

How to use GPIO pins of TM4C123G Tiva launchPad

2. Create a precise microseconds delay function using TM4C123 Timer
3. Initialize another Timer module of TM4C123 microcontroller in input edge time mode and configure the respective GPIO capture pin of Timer as a digital input pin.

We have previously posted tutorials on TM4C123 microcontroller timers. If you want to explore further on how to create delay and configure timer in input-edge time mode, read these guides:

• Timer TM4C123 – Generate Delay
• TM4C123 Timers in Input-Edge Capture Mode

4. 4. Now make the digital output pin active high followed by a 10 microseconds delay using the microseconds delay function 
5. After that, make the digital pin active low. Steps 2-4 will produce a 10us pulse. Connect this pulse signal with the trigger pin of the HC-SR04 range sensor.
6. After that wait for the event to occur on the input edge capture pin. When the rising edge of the echo output signal occurs on the input edge capture pin of TM4C123, reads the content of the Timer register and saves its value in an integer variable.
7. Again, wait for the falling edge of the echo output signal. When the input capture pin detects the falling edge, save the content of the timer register into another variable.
8. Now take the difference of two measured time values, it will give us the pulse duration.
9. In the end, convert the pulse duration into distance using the formula that we derived in the last section. 

Distance Measurement Code TM4C123

This example code measures the distance using the HC-SR04 Ultrasonic range sensor. It displays the measured distance value on the computer using the UART communication module of TM4C123. Timer0A is used to measure distance by measuring the pulse duration of the Echo output signal. Timer1A is used to make a precise microsecond delay function.

/* This example code Measures the distance using HC-SR04 Ultrasonic range sensor*/
/* It displays the measured distance value on computer using UART communication moduel of TM4C123 */
/* Timer0A is used to measure distance by measuring pulse duration of Echo output signal */
/* Timer1A is used to make percise microsecond delay function */

/*header files for TM4C123 device and sprintf library */
#include "TM4C123GH6PM.h"
#include <stdio.h>

/*Function prototype for Timer0A and UART module initialization */

uint32_t Measure_distance(void);
void Timer0ACapture_init(void);
void Delay_MicroSecond(int time);
void UART5_init(void);
void UART5_Transmitter(unsigned char data);
void printstring(char *str);
void Delay(unsigned long counter);

/* global variables to store and display distance in cm */
uint32_t time; /*stores pulse on time */
uint32_t distance; /* stores measured distance value */
char mesg[20];  /* string format of distance value */

/* main code to take distance measurement and send data to UART terminal */
int main(void)
{
Timer0ACapture_init();  /*initialize Timer0A in edge edge time */
UART5_init(); /* initialize UART5 module to transmit data to computer */
	while(1)
	{
time = Measure_distance(); /* take pulse duration measurement */ 
distance = (time * 10625)/10000000; /* convert pulse duration into distance */
sprintf(mesg, "\r\nDistance = %d cm", distance); /*convert float type distance data into string */
printstring(mesg); /*transmit data to computer */
Delay(2000);

	}
	
}


/* This function captures consecutive rising and falling edges of a periodic signal */
/* from Timer Block 0 Timer A and returns the time difference (the period of the signal). */
uint32_t Measure_distance(void)
{
    int lastEdge, thisEdge;
	
	  /* Given 10us trigger pulse */
	  GPIOA->DATA &= ~(1<<4); /* make trigger  pin high */
	  Delay_MicroSecond(10); /*10 seconds delay */
	  GPIOA->DATA |= (1<<4); /* make trigger  pin high */
	  Delay_MicroSecond(10); /*10 seconds delay */
	  GPIOA->DATA &= ~(1<<4); /* make trigger  pin low */

 	while(1)
	{
    TIMER0->ICR = 4;            /* clear timer0A capture flag */
    while((TIMER0->RIS & 4) == 0) ;    /* wait till captured */
	  if(GPIOB->DATA & (1<<6)) /*check if rising edge occurs */
		{
    lastEdge = TIMER0->TAR;     /* save the timestamp */
		/* detect falling edge */
    TIMER0->ICR = 4;            /* clear timer0A capture flag */
    while((TIMER0->RIS & 4) == 0) ;    /* wait till captured */
    thisEdge = TIMER0->TAR;     /* save the timestamp */
		return (thisEdge - lastEdge); /* return the time difference */
		}
	}
}

/* Timer0A initialization function */
/* Initialize Timer0A in input-edge time mode with up-count mode */
void Timer0ACapture_init(void)
{
    SYSCTL->RCGCTIMER |= 1;     /* enable clock to Timer Block 0 */
    SYSCTL->RCGCGPIO |= 2;      /* enable clock to PORTB */
    
    GPIOB->DIR &= ~0x40;        /* make PB6 an input pin */
    GPIOB->DEN |= 0x40;         /* make PB6 as digital pin */
    GPIOB->AFSEL |= 0x40;       /* use PB6 alternate function */
    GPIOB->PCTL &= ~0x0F000000;  /* configure PB6 for T0CCP0 */
    GPIOB->PCTL |= 0x07000000;
    
	  /* PB2 as a digital output signal to provide trigger signal */
	  SYSCTL->RCGCGPIO |= 1;      /* enable clock to PORTA */
	  GPIOA->DIR |=(1<<4);         /* set PB2 as a digial output pin */
	  GPIOA->DEN |=(1<<4);         /* make PB2 as digital pin */

    TIMER0->CTL &= ~1;          /* disable timer0A during setup */
    TIMER0->CFG = 4;            /* 16-bit timer mode */
    TIMER0->TAMR = 0x17;        /* up-count, edge-time, capture mode */
    TIMER0->CTL |=0x0C;        /* capture the rising edge */
    TIMER0->CTL |= (1<<0);           /* enable timer0A */
}



/* Create one microsecond second delay using Timer block 1 and sub timer A */

void Delay_MicroSecond(int time)
{
    int i;
    SYSCTL->RCGCTIMER |= 2;     /* enable clock to Timer Block 1 */
    TIMER1->CTL = 0;            /* disable Timer before initialization */
    TIMER1->CFG = 0x04;         /* 16-bit option */ 
    TIMER1->TAMR = 0x02;        /* periodic mode and down-counter */
    TIMER1->TAILR = 16 - 1;  /* TimerA interval load value reg */
    TIMER1->ICR = 0x1;          /* clear the TimerA timeout flag */
    TIMER1->CTL |= 0x01;        /* enable Timer A after initialization */

    for(i = 0; i < time; i++)
    {
        while ((TIMER1->RIS & 0x1) == 0) ;      /* wait for TimerA timeout flag */
        TIMER1->ICR = 0x1;      /* clear the TimerA timeout flag */
    }
}
void UART5_init(void)
{
	  SYSCTL->RCGCUART |= 0x20;  /* enable clock to UART5 */
    SYSCTL->RCGCGPIO |= 0x10;  /* enable clock to PORTE for PE4/Rx and RE5/Tx */
    /* UART0 initialization */
    UART5->CTL = 0;         /* UART5 module disbable */
    UART5->IBRD = 104;      /* for 9600 baud rate, integer = 104 */
    UART5->FBRD = 11;       /* for 9600 baud rate, fractional = 11*/
    UART5->CC = 0;          /*select system clock*/
    UART5->LCRH = 0x60;     /* data lenght 8-bit, not parity bit, no FIFO */
    UART5->CTL = 0x301;     /* Enable UART5 module, Rx and Tx */

    /* UART5 TX5 and RX5 use PE4 and PE5. Configure them digital and enable alternate function */
    GPIOE->DEN = 0x30;      /* set PE4 and PE5 as digital */
    GPIOE->AFSEL = 0x30;    /* Use PE4,PE5 alternate function */
    GPIOE->AMSEL = 0;    /* Turn off analg function*/
    GPIOE->PCTL = 0x00110000;     /* configure PE4 and PE5 for UART */
}
void UART5_Transmitter(unsigned char data)  
{
    while((UART5->FR & (1<<5)) != 0); /* wait until Tx buffer not full */
    UART5->DR = data;                  /* before giving it another byte */
}

void printstring(char *str)
{
  while(*str)
	{
		UART5_Transmitter(*(str++));
	}
}
void Delay(unsigned long counter)
{
	unsigned long i = 0;
	
	for(i=0; i< counter*1000; i++);
}
/* This function is called by the startup assembly code to perform system specific initialization tasks. */
void SystemInit(void)
{
    __disable_irq();    /* disable all IRQs */
    
    /* Grant coprocessor access */
    /* This is required since TM4C123G has a floating point coprocessor */
    SCB->CPACR |= 0x00F00000;
}

Keil uvision v5 Instructions

Note: If you are using Keil uvision v5, you should remove the void SystemInit(void) function from the above code. Because the startup file in Keil v5 already contains the function SystemInit().

After that follow these steps to build above code with Keil uvision 5:

The other issue with the SystemInit() function in the new system_TM4C123.c is that it configures the clock generation which results in a different system clock rate than the default 16 MHz frequency. But the above sample code works on the default 16 MHz system clock. Therefore, the above program creates timing issues with Keil v5. You may retain the default system clock rate in Keil v5, by the following steps:

1. Expand the Project->Device to show system_TM4C123.c (startup)
2. Double click to open the file in the editor window
3. Find the line “#define CLOCK_SETUP 1” as the figure below
4. Comment out the line
5. Rebuild the project

The UART functions used in the code are developed in the previous tutorial available here: 

• UART Communication TM4C123 Tiva Launchpad

This example code is written using Keil uvision. Now upload this code to TM4C123 Tiva C Launchpad.

Hardware Demo

To see the hardware demo, make connections of HC-SR04 ultrasonic sensor with TM4C123 Tiva Launchpad according to this schematic diagram. Also, connect Tiva Launchpad with computer through USB to serial converter. 

After that open the serial monitor by selecting the COM pin to which USB to Serial converter is connected through the UART5 module of TM4C123 MCU. You will get the distance measurements on the serial monitor.

Video Demo

Other TM4C123 Tutorials:

• RPM Measurement using TM4C123 Tiva Launchpad
• Frequency Measurement using TM4C123 Timers
• Interrupt Processing ARM Cortex-M Microcontrollers
• GPIO Interrupts TM4C123 Tiva Launchpad 
• MPU6050 interfacing with TM4C123G Tiva C Launchpad
• I2C Communication TM4C123G Tiva C Launchpad

Other Ultrasonic Sensor Related Tutorials:

• IoT based Contactless Water level Monitoring with ESP32 and HC-SR04
• Ultrasonic sensor interfacing with pic microcontroller
• Distance measurement using Ultrasonic sensor and Arduino
• Pic Based Ultrasonic Radar System for distance measurement
• VL53L0X LIDAR Distance Sensor Interfacing with Arduino
• Advanced Informative Blind Stick Using GPS and GSM Module
• IoT based Liquid Level Monitoring System
• Contactless Liquid Level Controller System using pic microcontroller