Added Lab4a project explaining the CMock API usage examples.

Author: Bharathgopal

Lab4a/Makefile

@@ -0,0 +1,15 @@
+CEEDLING = ceedling
+
+.PHONY: test coverage clean generate_mocks
+
+test:
+	$(CEEDLING) test:all
+
+coverage:
+	$(CEEDLING) gcov:all
+
+clean:
+	rm -rf build
+
+generate_mocks:
+	$(CEEDLING) test:all

Lab4a/inc/adc_drv.h

@@ -0,0 +1,15 @@
+#ifndef ADC_DRV_H
+#define ADC_DRV_H
+
+#include <stdint.h>
+
+/**
+ * @brief Read battery voltage.
+ *
+ * Reads the battery voltage from the ADC driver.
+ *
+ * @return Battery voltage in millivolts.
+ */
+uint16_t adc_read_battery_mv(void);
+
+#endif /* ADC_DRV_H */

Lab4a/inc/battery.h

@@ -0,0 +1,74 @@
+#ifndef BATTERY_H
+#define BATTERY_H
+
+#include <stdint.h>
+
+/**
+ * @brief Battery health status.
+ *
+ * Represents the current health condition of the battery
+ * based on measured battery voltage.
+ */
+typedef enum
+{
+    BATTERY_HEALTH_GOOD = 0,    /**< Battery voltage is healthy */
+    BATTERY_HEALTH_LOW,         /**< Battery voltage is low */
+    BATTERY_HEALTH_CRITICAL     /**< Battery voltage is critical */
+} battery_health_t;
+
+/**
+ * @brief Get battery percentage.
+ *
+ * Reads the battery voltage and converts it to a
+ * percentage value between 0 and 100.
+ *
+ * @return Battery percentage.
+ */
+uint8_t battery_get_percentage(void);
+
+/**
+ * @brief Determine battery health state.
+ *
+ * Evaluates the battery voltage and returns the
+ * corresponding health status.
+ *
+ * @return Battery health status.
+ */
+battery_health_t battery_get_health(void);
+
+/**
+ * @brief Update battery warning LED state.
+ *
+ * Turns the warning LED ON when battery level is low
+ * and OFF when battery level is healthy.
+ */
+void battery_update_led(void);
+
+/**
+ * @brief Send battery telemetry packet.
+ *
+ * Creates and transmits a telemetry packet containing
+ * battery information over UART.
+ */
+void battery_send_telemetry(void);
+
+/**
+ * @brief Get battery temperature.
+ *
+ * Reads the battery temperature from the temperature
+ * sensor driver.
+ *
+ * @return Battery temperature in degrees Celsius.
+ */
+int16_t battery_get_temperature(void);
+
+/**
+ * @brief Execute battery monitoring task.
+ *
+ * Periodically checks battery status and performs
+ * required actions such as updating LEDs and sending
+ * telemetry.
+ */
+void battery_monitor_task(void);
+
+#endif /* BATTERY_H */

Lab4a/inc/led_drv.h

@@ -0,0 +1,18 @@
+#ifndef LED_DRV_H
+#define LED_DRV_H
+
+/**
+ * @brief Turn warning LED ON.
+ *
+ * Indicates low battery condition.
+ */
+void led_warning_on(void);
+
+/**
+ * @brief Turn warning LED OFF.
+ *
+ * Indicates battery condition is healthy.
+ */
+void led_warning_off(void);
+
+#endif /* LED_DRV_H */

Lab4a/inc/sensor_drv.h

@@ -0,0 +1,21 @@
+#ifndef SENSOR_DRV_H
+#define SENSOR_DRV_H
+
+#include <stdbool.h>
+#include <stdint.h>
+
+/**
+ * @brief Read temperature sensor.
+ *
+ * Reads the current temperature and stores the result
+ * in the supplied output parameter.
+ *
+ * @param temperature Pointer to temperature value.
+ *
+ * @return true if reading succeeded.
+ * @return false if reading failed.
+ */
+bool sensor_read_temperature(
+    int16_t *temperature);
+
+#endif /* SENSOR_DRV_H */

Lab4a/inc/uart_drv.h

@@ -0,0 +1,18 @@
+#ifndef UART_DRV_H
+#define UART_DRV_H
+
+#include <stdint.h>
+
+/**
+ * @brief Send data over UART.
+ *
+ * Transmits a data buffer over UART.
+ *
+ * @param data Pointer to transmit buffer.
+ * @param length Number of bytes to transmit.
+ */
+void uart_send(
+    uint8_t *data,
+    uint16_t length);
+
+#endif /* UART_DRV_H */

Lab4a/project.yml

@@ -0,0 +1,28 @@
+:project:
+  :build_root: build
+  :test_file_prefix: test_
+
+:paths:
+  :source:
+    - src/**
+  :include:
+    - inc/**
+  :test:
+    - test/**
+
+:plugins:
+  :enabled:
+    - module_generator
+    - gcov
+
+:gcov:
+  :reports:
+    - HtmlDetailed
+
+:cmock:
+  :mock_prefix: Mock
+  :plugins:
+    - callback
+    - array
+    - return_thru_ptr
+    - ignore_arg

Lab4a/src/adc_drv.c

@@ -0,0 +1,11 @@
+/**
+ * @file adc_drv.c
+ * @brief ADC driver implementation.
+ */
+
+#include "adc_drv.h"
+
+uint16_t adc_read_battery_mv(void)
+{
+    return 3700U;
+}

Lab4a/src/battery.c

@@ -0,0 +1,88 @@
+#include "battery.h"
+
+#include "adc_drv.h"
+#include "led_drv.h"
+#include "uart_drv.h"
+#include "sensor_drv.h"
+
+#define BATTERY_MIN_MV    (3200U)
+#define BATTERY_MAX_MV    (4200U)
+
+uint8_t battery_get_percentage(void)
+{
+    uint16_t mv = adc_read_battery_mv();
+
+    if (mv <= BATTERY_MIN_MV)
+    {
+        return 0;
+    }
+
+    if (mv >= BATTERY_MAX_MV)
+    {
+        return 100;
+    }
+
+    return (uint8_t)(
+        ((uint32_t)(mv - BATTERY_MIN_MV) * 100U) /
+        (BATTERY_MAX_MV - BATTERY_MIN_MV));
+}
+
+battery_health_t battery_get_health(void)
+{
+    uint16_t mv = adc_read_battery_mv();
+
+    if (mv <= 3300U)
+    {
+        return BATTERY_HEALTH_CRITICAL;
+    }
+
+    if (mv <= 3600U)
+    {
+        return BATTERY_HEALTH_LOW;
+    }
+
+    return BATTERY_HEALTH_GOOD;
+}
+
+void battery_update_led(void)
+{
+    if (battery_get_percentage() < 20U)
+    {
+        led_warning_on();
+    }
+    else
+    {
+        led_warning_off();
+    }
+}
+
+void battery_send_telemetry(void)
+{
+    uint8_t packet[3];
+
+    packet[0] = 0xAA;
+    packet[1] = battery_get_percentage();
+    packet[2] = 0x55;
+
+    uart_send(
+        packet,
+        sizeof(packet));
+}
+
+int16_t battery_get_temperature(void)
+{
+    int16_t temperature = 0;
+
+    (void)sensor_read_temperature(
+        &temperature);
+
+    return temperature;
+}
+
+void battery_monitor_task(void)
+{
+    if (battery_get_percentage() < 20U)
+    {
+        led_warning_on();
+    }
+}

Lab4a/src/led_drv.c

@@ -0,0 +1,14 @@
+/**
+ * @file led_drv.c
+ * @brief LED driver implementation.
+ */
+
+#include "led_drv.h"
+
+void led_warning_on(void)
+{
+}
+
+void led_warning_off(void)
+{
+}