ماژول تشخیص کدری و آلودگی آب GEBRABIT TSW-20M

هدف ما از انجام این پروژه چیست؟

در این بخش قصد داریم سنسور TSW-20M را به وسیله میکروکنترلر آرم، سری STM32F راه اندازی کنیم. به منظور استفاده راحت تر و بهینه تر در این پروژه از دو ماژول آماده GB626EN و GebraBit STM32F303 استفاده میکنیم.

این دو ماژول شامل مینیمم قطعات لازم سنسور TSW-20M و میکروکنترلر STM32F میباشند که توسط تیم جبرابیت جهت آسان سازی کار فراهم شده اند.

در این آموزش چه چیزهایی یاد میگیریم؟

شما در این بخش ضمن راه اندازی و استفاده از سنسور TSW-20M، به طور خلاصه با نحوه تنظیم بخش های مختلف میکروکنترلر STM32 برای راه اندازی این سنسور با استفاده از ADC، چگونگی استفاده از فایل کتابخانه و درایور مختص ماژول GB626EN ، نحوه فراخوانی توابع و در نهایت دریافت داده های سنسور در کامپایلر  Keil نیز آشنا خواهید شد.

برای انجام این پروژه به چه چیزهایی نیاز داریم؟

همانطور که احتمالا میدانید برای انجام این پروژه به سخت افزارها و نرم افزارهایی نیاز داریم. عناوین این سخت افزارها و نرم افزارها در جدول زیر در اختیارتان قرار داده شده که میتوانید با کلیک روی هرکدام از آنها، آنها را تهیه/دانلود کنید و برای شروع آماده شوید.

سخت افزارهای مورد نیاز	نرم افزارهای مورد نیاز
GebraBit TSW-20M	Keil compiler
GebraBit STM32F303 module	STM32CubeMX program
ST-LINK/V2 programmer

ابتدا مانند تصویر زیر ماژول GebraBit TSW-20M را به صورت زیر به ماژول GebraBit STM32F303  متصل می کنیم:

در نهایت مقادیر کدورت آب را به صورت Real Time در پنجره Watch1 کامپایلر Keil در حالت Debug Session مشاهده خواهیم کرد.

تنظیمات STM32CubeMX

در ادامه تنظیمات مربوط به هریک از بخش ADC, GPIO , RCC , Debug , Clock را در میکروکنترلر  STM32F303 برای راه اندازی ماژول GebraBit TSW-20M را مرور می کنیم.

تنظیمات RCC

با توجه به وجود کریستال 8Mhz  در ماژول GebraBit STM32F303 کلاک خارجی را در بخش RCC انتخاب می کنیم:

تنظیمات Debug&Programming

با توجه به دسترسی به پین های SWCLK و SWDIO در ماژول GebraBit STM32F303، برای کاهش تعداد پین هنگام Debug&Programming در بلوک SYS گزینه Serial Wire را در بخش Debug  انتخاب می کنیم:

تنظیمات ADC

برای خواندن مقادیر آنالوگ و تبدیل آن به مقادیر دیجیتال از واحد ADC استفاده می کنیم. در بخش mode از پنجره ی کشویی IN1 گزینه ی IN1 Signle-ended را انتخاب می کنیم. از قسمت Configuration و در بخش Resolution گزینه ی ADC 12bit-resolution را انتخاب می کنیم. گزینه ی Continuous conversion mode را نیز Enable می کنیم و پین PA0 را به عنوان ADC1_IN1 انتخاب می کنیم.

تنظیمات GPIO

برای گرفتن دیتای دیجیتال ماژول TSW-20M پین PA10 را به عنوان GPIO_INPUT انتخاب می کنیم. ماژول Gebrabit STM32F303 دارای یک LED در پین PB6 و یک pushbutton در پین PA3 میباشد که به ترتیب این پین هارا به شکل GPIO_OUTPUT و GPIO_INPUT در می آوریم برای این که تنظیمات نرم افزاری کاربردی تر باشد و ایده های خود را به واقعیت تبدیل کنید.

تنظیمات Clock

تنظیمات کلاک مربوط به هریک از بخش های میکروکنترلر STM32F303 در این کد به شرح ذیل می باشد:

تنظیمات Project Manager

تنظیمات Project Manager به صورت زیر می باشد ، ابتدا وارد بخش Code Generator می شویم و سپس وارد قسمت Generated files میشویم و تنظیمات خط کشیده شده را انجام می دهیم.

در این جا ما از ورژن “5.32”  کامپایلر “MDK-ARM” استفاده می کنیم:

بعد از اتمام تمام تنظیمات فوق ، بر روی GENERATE CODE کلیک کرده و با اضافه کردن کتابخانه و درایور(تهیه شده توسط  GebraBit) TSW-20M ، کد خود را به راحتی توسعه می دهیم.

کتابخانه و درایور TSW-20M

GebraBit علاوه بر طراحی ماژولار سنسورها و آی سی های مختلف ، پیشرو در ارائه انواع کتابخانه های ساختاریافته و مستقل از سخت افزار به زبان C، جهت سهولت کاربران در راه اندازی و توسعه نرم افزاری آنها نیز بوده است.

بدین منظور پس از تهیه هر یک از ماژول های  GebraBit  ، کاربر می تواند با مراجعه به بخش آموزش ماژول مربوطه، کتابخانه مختص به آن ماژول که حاوی فایل h. و c (Header and Source). و یک برنامه نمونه آموزشی تحت سخت افزار های GebraBit STM32F303 ,GebraBit ATMEGA32A یا Arduino می باشد را دانلود کند.

تمامی توابع و Structure های تعریف شده در کتابخانه ، با جزئیات کامل، کامنت گذاری شده و تمامی پارامتر های دریافتی در آرگومان توابع و مقادیر بازگشتی از آنها ، به اختصار توضیح داده شده است.با توجه به مستقل از سخت افزار بودن کتابخانه ها،کاربر به راحتی می تواند آن را در هر یک از کامپایلر های دلخواه اضافه کرده و با میکروکنترلر و برد توسعه مورد علاقه خود، آن را توسعه دهد.

فایل هدر GebraBit_TSW_20M.h

در این فایل بر اساس دیتاشیت سنسور یا ای سی ، بدنه سنسور TSW-20M و کانفیگ های مربوط به هریک از بلوک های داخلی سنسور TSW-20M به صورت STRUCT با نام GebraBit_TSW_20M نیز تعریف شده است. که نهایتا در محیط Debug Session تمامی کانفیگ های مربوط به هر بلوک به صورت Real Time قابل مشاهده است.

TSW_20M struct

تمام ویژگی های سنسور و داده های سنسور در این Struct تعریف شده است و تمامی اطلاعات و کانفیگ اجرا شده بر روی سنسور در این Structure ذخیره شده و می توان تغییرات در هر بخش از سنسور را در محیط Debug Session مشاهده نمود:

typedef struct TSW_20M
{
            uint8_t                            DIGITAL_VALUE;
            uint32_t                           ADC_RAW_VALUE;
            float                              TURBIDITY;
            float                              ADC_INPUT_VOLTAGE_VALUE;
            ADC_HandleTypeDef                  ADC_HANDELER;
}GebraBit_TSW_20M;

اعلان توابع

در پایان این فایل تمامی توابع جهت خواندن و نوشتن ، کانفیگ سنسور و دریافت داده از سنسور اعلان شده است:

void GB_TSW_20M_Configuration(GebraBit_TSW_20M * TSW_20M);
void GB_TSW_20M_Read_ADC_Value(GebraBit_TSW_20M * TSW_20M);
void GB_TSW_20M_Read_Digital_Value(GebraBit_TSW_20M * TSW_20M);
void GB_TSW_20M_Calculate_Turbidity(GebraBit_TSW_20M * TSW_20M);
void GB_TSW_20M_Get_Data(GebraBit_TSW_20M * TSW_20M);

فایل سورس GebraBit_TSW_20M.c

در این فایل که به زبان C نوشته شده ، تمامی توابع با جزئیات کامل، کامنت گذاری شده و تمامی پارامتر های دریافتی در آرگومان توابع و مقادیر بازگشتی از آنها ، بطور واضح توضیح داده شده است.از این رو در این قسمت به همین توضیحات اکتفا کرده و کاربران را برای اطلاعات بیشتر به بررسی مستقیم از این فایل دعوت می کنیم

برنامه نمونه در Keil

بعد از تولید پروژه Keil با استفاده از STM32CubeMX و اضافه کردن کتابخانه GebraBit_TSW_20M.c ارائه شده توسط GebraBit ، به بررسی قسمت اصلی برنامه آموزشی نمونه، فایل main.c و مشاهده خروجی ماژول GebraBit TSW_20M در قسمت watch در محیط Debugging برنامه Keil می پردازیم.

شرح فایل main.c

توابع مورد نیاز ماژول GebraBit TSW_20M ، به ساختار اضافه شده است.در قسمت بعدی متغیری به نام TSW_20M_Module از نوع ساختار) GebraBit_TSW_20M این ساختار در هدر  GebraBit_TSW_20M بوده و در بخش توضیحات کتابخانه  GebraBit_TSW_20M توضیح داده شد (که برای پیکربندی ماژول GebraBit TSW-20M می باشد، تعریف شده است:

/* USER CODE BEGIN PTD */
GebraBit_TSW_20M TSW_20M_Module;
/* USER CODE END PTD */

در بخش بعدی از کد ما از تابع GB_TSW_20M_Configuration(&TSW_20M_Module) استفاده می کنیم تا تنظیمات مورد نظرمان روی ماژول اعمال شوند و در آخر در قسمت حلقه while کد دیتا ADC و دیجیتال به صورت پیوسته از سنسور خوانده می شود:

/* USER CODE BEGIN 2 */
GB_TSW_20M_Configuration(&TSW_20M_Module);
/* USER CODE END 2 */

/* Infinite loop */
/* USER CODE BEGIN WHILE */
while (1)
{
  /* USER CODE END WHILE */

  /* USER CODE BEGIN 3 */
  GB_TSW_20M_Get_Data(&TSW_20M_Module);
  HAL_Delay(500);
}

متن کد main.c

/* USER CODE BEGIN Header */
/*
 * ________________________________________________________________________________________________________
 * Copyright (c) 2020 GebraBit Inc. All rights reserved.
 *
 * This software, related documentation and any modifications thereto (collectively �Software�) is subject
 * to GebraBit and its licensors' intellectual property rights under U.S. and international copyright
 * and other intellectual property rights laws.
 *
 * GebraBit and its licensors retain all intellectual property and proprietary rights in and to the Software
 * and any use, reproduction, disclosure or distribution of the Software without an express license agreement
 * from GebraBit is strictly prohibited.

 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
 * NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT IN
 * NO EVENT SHALL GebraBit BE LIABLE FOR ANY DIRECT, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES,
 * OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
 * NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
 * OF THE SOFTWARE.
 * ________________________________________________________________________________________________________
 */
/**
  ******************************************************************************
  * @file           : main.c
  * @brief          : Main program body
  * @Author         : Sepehr Azimi
  ******************************************************************************
  * @attention
  *
  * Copyright (c) 2022 STMicroelectronics.
  * All rights reserved.
  *
  * This software is licensed under terms that can be found in the LICENSE file
  * in the root directory of this software component.
  * If no LICENSE file comes with this software, it is provided AS-IS.
  *
  ******************************************************************************
  */
/* USER CODE END Header */
/* Includes ------------------------------------------------------------------*/
#include "main.h"
#include "adc.h"
#include "gpio.h"

/* Private includes ----------------------------------------------------------*/
/* USER CODE BEGIN Includes */
#include "GebraBit_TSW_20M.h"
/* USER CODE END Includes */

/* Private typedef -----------------------------------------------------------*/
/* USER CODE BEGIN PTD */
GebraBit_TSW_20M TSW_20M_Module;
/* USER CODE END PTD */

/* Private define ------------------------------------------------------------*/
/* USER CODE BEGIN PD */
/* USER CODE END PD */

/* Private macro -------------------------------------------------------------*/
/* USER CODE BEGIN PM */

/* USER CODE END PM */

/* Private variables ---------------------------------------------------------*/

/* USER CODE BEGIN PV */

/* USER CODE END PV */

/* Private function prototypes -----------------------------------------------*/
void SystemClock_Config(void);
/* USER CODE BEGIN PFP */

/* USER CODE END PFP */

/* Private user code ---------------------------------------------------------*/
/* USER CODE BEGIN 0 */

/* USER CODE END 0 */

/**
  * @brief  The application entry point.
  * @retval int
  */
int main(void)
{
  /* USER CODE BEGIN 1 */

  /* USER CODE END 1 */

  /* MCU Configuration--------------------------------------------------------*/

  /* Reset of all peripherals, Initializes the Flash interface and the Systick. */
  HAL_Init();

  /* USER CODE BEGIN Init */

  /* USER CODE END Init */

  /* Configure the system clock */
  SystemClock_Config();

  /* USER CODE BEGIN SysInit */

  /* USER CODE END SysInit */

  /* Initialize all configured peripherals */
  MX_GPIO_Init();
  MX_ADC1_Init();
  /* USER CODE BEGIN 2 */
  GB_TSW_20M_Configuration(&TSW_20M_Module);
  /* USER CODE END 2 */

  /* Infinite loop */
  /* USER CODE BEGIN WHILE */
  while (1)
  {
    /* USER CODE END WHILE */

    /* USER CODE BEGIN 3 */
    GB_TSW_20M_Get_Data(&TSW_20M_Module);
    HAL_Delay(500);
  }
  /* USER CODE END 3 */
}

/**
  * @brief System Clock Configuration
  * @retval None
  */
void SystemClock_Config(void)
{
  RCC_OscInitTypeDef RCC_OscInitStruct = {0};
  RCC_ClkInitTypeDef RCC_ClkInitStruct = {0};
  RCC_PeriphCLKInitTypeDef PeriphClkInit = {0};

  /** Initializes the RCC Oscillators according to the specified parameters
  * in the RCC_OscInitTypeDef structure.
  */
  RCC_OscInitStruct.OscillatorType = RCC_OSCILLATORTYPE_HSE;
  RCC_OscInitStruct.HSEState = RCC_HSE_BYPASS;
  RCC_OscInitStruct.HSEPredivValue = RCC_HSE_PREDIV_DIV1;
  RCC_OscInitStruct.HSIState = RCC_HSI_ON;
  RCC_OscInitStruct.PLL.PLLState = RCC_PLL_ON;
  RCC_OscInitStruct.PLL.PLLSource = RCC_PLLSOURCE_HSE;
  RCC_OscInitStruct.PLL.PLLMUL = RCC_PLL_MUL2;
  if (HAL_RCC_OscConfig(&RCC_OscInitStruct) != HAL_OK)
  {
    Error_Handler();
  }

  /** Initializes the CPU, AHB and APB buses clocks
  */
  RCC_ClkInitStruct.ClockType = RCC_CLOCKTYPE_HCLK|RCC_CLOCKTYPE_SYSCLK
                              |RCC_CLOCKTYPE_PCLK1|RCC_CLOCKTYPE_PCLK2;
  RCC_ClkInitStruct.SYSCLKSource = RCC_SYSCLKSOURCE_PLLCLK;
  RCC_ClkInitStruct.AHBCLKDivider = RCC_SYSCLK_DIV1;
  RCC_ClkInitStruct.APB1CLKDivider = RCC_HCLK_DIV1;
  RCC_ClkInitStruct.APB2CLKDivider = RCC_HCLK_DIV1;

  if (HAL_RCC_ClockConfig(&RCC_ClkInitStruct, FLASH_LATENCY_0) != HAL_OK)
  {
    Error_Handler();
  }
  PeriphClkInit.PeriphClockSelection = RCC_PERIPHCLK_ADC12;
  PeriphClkInit.Adc12ClockSelection = RCC_ADC12PLLCLK_DIV1;
  if (HAL_RCCEx_PeriphCLKConfig(&PeriphClkInit) != HAL_OK)
  {
    Error_Handler();
  }
}

/* USER CODE BEGIN 4 */

/* USER CODE END 4 */

/**
  * @brief  This function is executed in case of error occurrence.
  * @retval None
  */
void Error_Handler(void)
{
  /* USER CODE BEGIN Error_Handler_Debug */
  /* User can add his own implementation to report the HAL error return state */
  __disable_irq();
  while (1)
  {
  }
  /* USER CODE END Error_Handler_Debug */
}

#ifdef  USE_FULL_ASSERT
/**
  * @brief  Reports the name of the source file and the source line number
  *         where the assert_param error has occurred.
  * @param  file: pointer to the source file name
  * @param  line: assert_param error line source number
  * @retval None
  */
void assert_failed(uint8_t *file, uint32_t line)
{
  /* USER CODE BEGIN 6 */
  /* User can add his own implementation to report the file name and line number,
     ex: printf("Wrong parameters value: file %s on line %d\r\n", file, line) */
  /* USER CODE END 6 */
}
#endif /* USE_FULL_ASSERT */

خروجی برنامه

بعد از تولید پروژه Keil با استفاده از STM32CubeMX و اضافه کردن کتابخانه ، پروگرامر STLINK V2 را با استفاده از آداپتور تبدیل STLINKV2 به GebraBit STM32F303 متصل می کنیم:

تبدیل STLINKV2

با اتصال پروگرامر STLINK V2 به GebraBit STM32F303 دیگر نیازی به اعمال تغذیه به ماژول های GebraBit STM32F303 و GebraBit TSW-20M نمی باشد، زیرا ولتاژ کاری خود را مستقیما از پروگرامر STLINK V2 دریافت میکنند.
در نهایت وارد حالت Debug شده و با اضافه کردن TSW_20M_Module به پنجره watch و اجرای برنامه ، تغییرات مقادیر GebraBit TSW_20M را مشاهده می کنیم: