Merge pull request #5 from git-user-cpp/development

v2.0.0

Author: git-user-cpp

Core/Inc/AHT20.h renamed to Core/Inc/aht20.h

@@ -19,17 +19,7 @@
 
 #pragma once
 #include "main.h"
-
-/*
- * enum for status returns
- */
-typedef enum {
-	AHT20_STATUS_OK = 1,
-	AHT20_STATUS_NOT_TRANSMITTED,
-	AHT20_STATUS_NOT_RECEIVED,
-	AHT20_STATUS_NOT_CALIBRATED,
-	AHT20_STATUS_NOT_MEASURED,
-} aht20_status_t;
+#include "aht20_api.h"
 
 /*
  * struct for holding measurment data
@@ -41,29 +31,15 @@ typedef struct {
 	float temperature_f;
 } aht20_data_t;
 
+extern const aht20_sensor_api_t aht20_api;
+
 /*
  * sends reads status_word for further calibration verification
  *
  * Datasheet: AHT20 Product manuals
  * 5.3 Send command
  */
-aht20_status_t aht20_get_calibration_status(I2C_HandleTypeDef *hi2c, UART_HandleTypeDef *huart, uint8_t *status_word, uint16_t status_word_size);
-
-/*
- * checks the 3rd bit of a received variable
- *
- * Datasheet: AHT20 Product manuals
- * 5.4 Sensor reading process, paragraph 1
- */
-aht20_status_t aht20_check_calibration(uint8_t status_word);
-
-/*
- * sends an array of integers to trigger sensor calibration
- *
- * Datasheet: AHT20 Product manuals
- * 5.4 Sensor reading process, paragraph 1
- */
-aht20_status_t aht20_calibrate(I2C_HandleTypeDef *hi2c, uint8_t status_word);
+aht20_status_t aht20_validate_calibration(I2C_HandleTypeDef *hi2c);
 
 /*
  * sends an array of integers to trigger sensor measurment

Core/Inc/aht20_api.h

@@ -0,0 +1,40 @@
+/*
+ * aht20_driver_stm32f446ret
+ * driver for aht20 temperature and humidity sensor
+ * Copyright (C) 2025 Andrew Kushyk
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published
+ * by the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+#pragma once
+
+/*
+ * enum for status returns
+ */
+typedef enum {
+	AHT20_STATUS_OK = 1,
+	AHT20_STATUS_NOT_TRANSMITTED,
+	AHT20_STATUS_NOT_RECEIVED,
+	AHT20_STATUS_NOT_MEASURED,
+} aht20_status_t;
+
+/*
+ * api for aht20 sensor
+ */
+typedef struct {
+	aht20_status_t (*aht20_validate_calibration) (I2C_HandleTypeDef *hi2c);
+	aht20_status_t (*measure) (I2C_HandleTypeDef *hi2c, uint8_t *measured_data, uint16_t measured_data_size);
+	void (*calculate_measurments) (uint8_t *measured_data, float *humidity, float *temp_c, float *temp_f);
+	aht20_status_t (*soft_reset) (I2C_HandleTypeDef *hi2c);
+} aht20_sensor_api_t;

Core/Inc/utils.h

@@ -0,0 +1,27 @@
+/*
+ * aht20_driver_stm32f446ret
+ * driver for aht20 temperature and humidity sensor
+ * Copyright (C) 2025 Andrew Kushyk
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published
+ * by the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+#pragma once
+#include <aht20.h>
+#include "main.h"
+
+/*
+ * prints error message via UART
+ */
+void print_error(UART_HandleTypeDef *huart, aht20_status_t status);

Core/Src/AHT20.c renamed to Core/Src/aht20.c

@@ -17,10 +17,11 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-#include "AHT20.h"
+#include <aht20.h>
 #include <stdio.h>
 #include <string.h>
-#include <math.h>
+#include <assert.h>
+#include <stddef.h>
 
 /*
  * device address for AHT20
@@ -72,6 +73,13 @@ static uint8_t ACK_CMD = 0x06;
  */
 static uint8_t NACK_CMD = 0x15;
 
+const aht20_sensor_api_t aht20_api = {
+		.aht20_validate_calibration = aht20_validate_calibration,
+		.measure = aht20_measure,
+		.calculate_measurments = aht20_calculate_measurments,
+		.soft_reset = aht20_soft_reset,
+};
+
 /*
  * calculates crc8 for given data
  */
@@ -83,43 +91,28 @@ static uint8_t calculate_crc(uint8_t *data);
  * Datasheet: AHT20 Product manuals
  * 5.3 Send command
  */
-aht20_status_t aht20_get_calibration_status(I2C_HandleTypeDef *hi2c, UART_HandleTypeDef *huart, uint8_t *status_word, uint16_t status_word_size) {
+aht20_status_t aht20_validate_calibration(I2C_HandleTypeDef *hi2c) {
+	assert(hi2c != NULL);
+	uint8_t status_word = 0;
+
+	HAL_Delay(40);
+
 	if (HAL_OK != HAL_I2C_Master_Transmit(hi2c, DEVICE_ADDRESS, &GET_STATUS_CMD, (uint16_t)sizeof(GET_STATUS_CMD), HAL_MAX_DELAY)) {
 		return AHT20_STATUS_NOT_TRANSMITTED;
 	}
 
-	if (HAL_OK != HAL_I2C_Master_Receive(hi2c, DEVICE_ADDRESS, status_word, status_word_size, HAL_MAX_DELAY)) {
+	if (HAL_OK != HAL_I2C_Master_Receive(hi2c, DEVICE_ADDRESS, &status_word, (uint16_t)sizeof(status_word), HAL_MAX_DELAY)) {
 		return AHT20_STATUS_NOT_RECEIVED;
 	}
 
-	return AHT20_STATUS_OK;
-}
-
-/*
- * checks the 3rd bit of a received variable
- *
- * Datasheet: AHT20 Product manuals
- * 5.4 Sensor reading process, paragraph 1
- */
-aht20_status_t aht20_check_calibration(uint8_t status_word) {
 	if (status_word & (1 << 3)) {
 		return AHT20_STATUS_OK;
 	} else {
-		return AHT20_STATUS_NOT_CALIBRATED;
-	}
-}
-
-/*
- * sends an array of integers to trigger sensor calibration
- *
- * Datasheet: AHT20 Product manuals
- * 5.4 Sensor reading process, paragraph 1
- */
-aht20_status_t aht20_calibrate(I2C_HandleTypeDef *hi2c, uint8_t status_word) {
-	if (HAL_OK != HAL_I2C_Master_Transmit(hi2c, DEVICE_ADDRESS, INIT_CMD, (uint16_t)sizeof(INIT_CMD), HAL_MAX_DELAY)) {
-		return AHT20_STATUS_NOT_TRANSMITTED;
+		if (HAL_OK != HAL_I2C_Master_Transmit(hi2c, DEVICE_ADDRESS, INIT_CMD, (uint16_t)sizeof(INIT_CMD), HAL_MAX_DELAY)) {
+			return AHT20_STATUS_NOT_TRANSMITTED;
+		}
+		HAL_Delay(10);
 	}
-
 	return AHT20_STATUS_OK;
 }
 
@@ -130,6 +123,9 @@ aht20_status_t aht20_calibrate(I2C_HandleTypeDef *hi2c, uint8_t status_word) {
  * 5.4 Sensor reading process, paragraph 2
  */
 aht20_status_t aht20_measure(I2C_HandleTypeDef *hi2c, uint8_t *measured_data, uint16_t measured_data_size) {
+	assert(hi2c != NULL);
+	assert(measured_data != NULL);
+
 	if (HAL_OK != HAL_I2C_Master_Transmit(hi2c, DEVICE_ADDRESS, MEASURE_CMD, (uint16_t)sizeof(MEASURE_CMD), HAL_MAX_DELAY)) {
 		return AHT20_STATUS_NOT_TRANSMITTED;
 	}
@@ -167,6 +163,11 @@ aht20_status_t aht20_measure(I2C_HandleTypeDef *hi2c, uint8_t *measured_data, ui
  * 6.2 Temperature transformation
  */
 void aht20_calculate_measurments(uint8_t *measured_data, float *humidity, float *temp_c, float *temp_f) {
+	assert(measured_data != NULL);
+	assert(humidity != NULL);
+	assert(temp_c != NULL);
+	assert(temp_f != NULL);
+
 	uint32_t raw_humidity = ((measured_data[1] << 12) | (measured_data[2] << 4) | (measured_data[3] >> 4));
 	uint32_t raw_temperature = (((measured_data[3] & 0x0F) << 16) | (measured_data[4] << 8) | measured_data[5]);
 
@@ -182,6 +183,8 @@ void aht20_calculate_measurments(uint8_t *measured_data, float *humidity, float
  * 5.5 Soft reset
  */
 aht20_status_t aht20_soft_reset(I2C_HandleTypeDef *hi2c) {
+	assert(hi2c != NULL);
+
 	if (HAL_OK != HAL_I2C_Master_Transmit(hi2c, DEVICE_ADDRESS, &SOFT_RESET_CMD, (uint16_t)sizeof(SOFT_RESET_CMD), HAL_MAX_DELAY)) {
 		return AHT20_STATUS_NOT_TRANSMITTED;
 	}
@@ -194,6 +197,8 @@ aht20_status_t aht20_soft_reset(I2C_HandleTypeDef *hi2c) {
  * calculates crc8 for given data
  */
 static uint8_t calculate_crc(uint8_t *data) {
+	assert(data != NULL);
+
     uint8_t crc = 0xFF;
     uint8_t i = 0, j = 0;
 

Core/Src/main.c

@@ -21,11 +21,12 @@
 
 /* USER CODE END Header */
 /* Includes ------------------------------------------------------------------*/
+#include <aht20.h>
 #include "main.h"
 
 /* Private includes ----------------------------------------------------------*/
 /* USER CODE BEGIN Includes */
-#include "AHT20.h"
+#include "utils.h"
 #include <stdio.h>
 #include <string.h>
 /* USER CODE END Includes */
@@ -69,31 +70,6 @@ void UART_Send_String(const char* str)
 	HAL_UART_Transmit(&huart2, (uint8_t*)str, strlen(str), HAL_MAX_DELAY);
 }
 
-/* prints error message to UART based on received status */
-void print_error(aht20_status_t status) {
-	char debug_msg[64] = "\0";
-
-	if(status == AHT20_STATUS_NOT_TRANSMITTED) {
-		sprintf(debug_msg, "I2C initialization transmit error: 0x71\r\n");
-		UART_Send_String(debug_msg);
-	} else if (status == AHT20_STATUS_NOT_RECEIVED) {
-		sprintf(debug_msg, "I2C initialization recieve error: status_word\r\n");
-		UART_Send_String(debug_msg);
-	} else if (status == AHT20_STATUS_NOT_CALIBRATED) {
-		sprintf(debug_msg, "I2C device calibration error\r\n");
-		UART_Send_String(debug_msg);
-	} else if (status == AHT20_STATUS_NOT_MEASURED) {
-		sprintf(debug_msg, "I2C device couldn't perform measuring\r\n");
-		UART_Send_String(debug_msg);
-	} else if (status == AHT20_STATUS_OK) {
-		/* doing nothing if ok */
-	}
-	else {
-		sprintf(debug_msg, "Unknown error\r\n");
-		UART_Send_String(debug_msg);
-	}
-}
-
 /* transmits data to UART */
 void transmit_data(float humidity, float temperature_c, float temperature_f) {
 	char data_to_display[60] = "\0";
@@ -138,27 +114,13 @@ int main(void)
 	 * Datasheet: AHT20 Product manuals
 	 * 5.4 Sensor reading process, paragraph 1
 	 */
-	HAL_Delay(40);
-
-	uint8_t status_word = 0;
 	aht20_status_t status = AHT20_STATUS_OK;
 
 	/* getting info about sensor calibration */
-	status = aht20_get_calibration_status(&hi2c1, &huart2, &status_word, (uint16_t)sizeof(status_word));
+	status = aht20_validate_calibration(&hi2c1);
 	if (status != AHT20_STATUS_OK) {
-		print_error(status);
+		print_error(&huart2, status);
 		return 1;
-	} else {
-		/* checks if calibration is valid */
-		status = aht20_check_calibration(status_word);
-		if (status != AHT20_STATUS_OK) {
-			/* calibrates if not calibrated*/
-			status = aht20_calibrate(&hi2c1, status_word);
-			if (status != AHT20_STATUS_OK) {
-				print_error(status);
-				return 2;
-			}
-		}
 	}
 
 	/* USER CODE END 2 */
@@ -172,7 +134,7 @@ int main(void)
 		/* triggering measuring */
 		status = aht20_measure(&hi2c1, sensor_data.measured_data, (uint16_t)sizeof(sensor_data.measured_data));
 		if (status != AHT20_STATUS_OK) {
-			print_error(status);
+			print_error(&huart2, status);
 			aht20_soft_reset(&hi2c1);
 			continue;
 		}

Core/Src/utils.c

@@ -0,0 +1,41 @@
+/*
+ * aht20_driver_stm32f446ret
+ * driver for aht20 temperature and humidity sensor
+ * Copyright (C) 2025 Andrew Kushyk
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published
+ * by the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+#include "utils.h"
+#include <stdio.h>
+#include <string.h>
+
+/*
+ * prints error message via UART
+ */
+void print_error(UART_HandleTypeDef *huart, aht20_status_t status) {
+    char debug_msg[64] = "\0";
+    if (status == AHT20_STATUS_NOT_TRANSMITTED) {
+        sprintf(debug_msg, "I2C initialization transmit error: 0x71\r\n");
+    } else if (status == AHT20_STATUS_NOT_RECEIVED) {
+        sprintf(debug_msg, "I2C initialization receive error: status_word\r\n");
+    } else if (status == AHT20_STATUS_NOT_MEASURED) {
+        sprintf(debug_msg, "I2C device couldn't perform measuring\r\n");
+    } else if (status == AHT20_STATUS_OK) {
+        return; // No action needed
+    } else {
+        sprintf(debug_msg, "Unknown error\r\n");
+    }
+    HAL_UART_Transmit(huart, (uint8_t*)debug_msg, strlen(debug_msg), HAL_MAX_DELAY);
+}