هدف ما از انجام این پروژه چیست؟
در این بخش قصد داریم سنسورSGP41-D-R4 را به وسیله میکروکنترلر آرم، سری STM32F راه اندازی کنیم. به منظور استفاده راحت تر و بهینه تر در این پروژه از دو ماژول آماده GB605EN و GebraBit STM32F303 استفاده میکنیم.
این دو ماژول شامل مینیمم قطعات لازم سنسور SGP41-D-R4 و میکروکنترلر STM32F میباشند که توسط تیم جبرابیت جهت آسان سازی کار فراهم شده اند.
در این آموزش چه چیزهایی یاد میگیریم؟
شما در این بخش ضمن راه اندازی و استفاده از سنسور SGP41-D-R4، به طور خلاصه با تمامی رجیسترهای سنسور SGP41-D-R4، نحوه تنظیم بخش های مختلف میکروکنترلر STM32 برای راه اندازی این سنسور با استفاده از پروتکل I2C، چگونگی استفاده از فایل کتابخانه و درایور مختص ماژول GB605EN، نحوه فراخوانی توابع و در نهایت دریافت داده های سنسور در کامپایلر Keil نیز آشنا خواهید شد.
برای انجام این پروژه به چه چیزهایی نیاز داریم؟
همانطور که احتمالا میدانید برای انجام این پروژه به سخت افزارها و نرم افزارهایی نیاز داریم. عناوین این سخت افزارها و نرم افزارها در جدول زیر در اختیارتان قرار داده شده که میتوانید با کلیک روی هرکدام از آنها، آنها را تهیه/دانلود کنید و برای شروع آماده شوید.
سخت افزارهای مورد نیاز
|
نرم افزارهای مورد نیاز
|
---|---|
Keil compiler
|
|
STM32CubeMX program
|
|
ST-LINK/V2 programmer
|
ابتدا مانند تصویر زیر ماژول GebraBit SGP41 را به صورت زیر به ماژول GebraBit STM32F303 متصل می کنیم:
توجه : با توجه به اینکه پین PA14 ماژول میکروکنترلرGebraBit STM32F303 برای پروگرام کردن میکروکنترلر استفاده میشود،تنظیم I2C بر روی پین های PA14 و PA15 در این ورژن مقدور نمی باشد،لذا در اتصال I2C به ماژول میکروکنترلرGebraBit STM32F303 در این ورژن ، ماژول GebraBit SGP41 نمی تواند به صورت Pin to Pin بر روی آن قرار گیرد.
در نهایت مقادیر VOC و NOX را به صورت Real Time در پنجره Watch1 کامپایلر Keil در حالت Debug Session مشاهده خواهیم کرد.
تنظیمات STM32CubeMX
در ادامه تنظیمات مربوط به هریک از بخش های I2C , RCC , Debug , Clock را در میکروکنترلر STM32F303 برای راه اندازی ماژول GebraBit SGP41 را مرور می کنیم.
تنظیمات RCC
با توجه به وجود کریستال 8Mhz در ماژول GebraBit STM32F303 ، کلاک خارجی را در بخش RCC انتخاب می کنیم:
تنظیمات Debug&Programming
با توجه به دسترسی به پین های SWCLK و SWDIO در ماژول GebraBit STM32F303 ، برای کاهش تعداد پین هنگام Debug&Programming در بلوک SYS گزینه Serial Wire را در بخش Debug انتخاب می کنیم:
تنظیمات I2C
برای ارتباط از طریق I2C با ماژول GebraBit STM32F303 حالت Standard Mode با سرعت 100khz را انتخاب کرده و پین های PB8 و PB9 را به عنوان SCL و SDA انتخاب می کنیم :
با توجه به دیتاشیت سنسور ، تنظیمات پارامتر های I2C در بخش Parameter Settings همانند تصویر بالا مقدار دهی خواهد شد.
تنظیمات Clock
تنظیمات کلاک مربوط به هریک از بخش های میکروکنترلر STM32F303 در این کد به شرح ذیل می باشد:
تنظیمات Project Manager
تنظیمات Project Manager به صورت زیر بوده که در اینجا ما از کامپایلر MDK-ARM ورژن 5.32 استفاده کرده ایم:
بعد از اتمام تمام تنظیمات فوق ، بر روی GENERATE CODE کلیک کرده و با اضافه کردن کتابخانه و درایور(تهیه شده توسط GebraBit) SGP41، کد خود را به راحتی توسعه می دهیم. فایل STM32CubeMX , کتابخانه و درایور و پروژه KEIL را می توانید از انتهای این آموزش دانلود کنید.
کتابخانه و درایور SGP41
GebraBit علاوه بر طراحی ماژولار سنسورها و آی سی های مختلف ، پیشرو در ارائه انواع کتابخانه های ساختاریافته و مستقل از سخت افزار به زبان C، جهت سهولت کاربران در راه اندازی و توسعه نرم افزاری آنها نیز بوده است.
بدین منظور پس از تهیه هر یک از ماژول های GebraBit ، کاربر می تواند با مراجعه به بخش آموزش ماژول مربوطه، کتابخانه مختص به آن ماژول که حاوی فایل .h و .c (Header and Source) و یک برنامه نمونه آموزشی تحت سخت افزار های GebraBit STM32F303, GebraBit ATMEGA32A یا Arduino می باشد را دانلود کند.
تمامی توابع و Structure های تعریف شده در کتابخانه ، با جزئیات کامل، کامنت گذاری شده و تمامی پارامتر های دریافتی در آرگومان توابع و مقادیر بازگشتی از آنها ، به اختصار توضیح داده شده است.با توجه به مستقل از سخت افزار بودن کتابخانه ها،کاربر به راحتی می تواند آن را در هر یک از کامپایلر های دلخواه اضافه کرده و با میکروکنترلر و برد توسعه مورد علاقه خود، آن را توسعه دهد.
فایل هدر GebraBit_SGP41.h
در این فایل بر اساس دیتاشیت سنسور یا ای سی ، تمامی آدرس رجیسترها، مقادیر هریک از رجیسترها به صورت Enumeration تعریف شده است.همچنین بدنه سنسور SGP41 و کانفیگ های مربوط به هریک از بلوک های داخلی سنسور SGP41 به صورت STRUCT با نام GebraBit_SGP41 نیز تعریف شده است.که نهایتا در محیط Debug Session تمامی کانفیگ های مربوط به هر بلوک به صورت Real Time قابل مشاهده است.
USER REGISTER MAP
نقشه رجیستری یا Command های سنسور در این بخش تعریف شده است :
1. #define SGP41_I2C &hi2c1
2. #define SGP41_ADDRESS 0x59
3. #define SGP41_WRITE_ADDRESS ((SGP41_ADDRESS<<1)|0)
4. #define SGP41_READ_ADDRESS ((SGP41_ADDRESS<<1)|1)
5. #define SGP41_GET_SERIAL_NUMBER 0x3682
6. #define SGP41_PERFORM_SELF_TEST 0x280E
7. #define SGP41_EXECUTE_CONDITIONING 0x2612
8. #define SGP41_MEASURE_RAW_SIGNAL 0x2619
9. #define SGP41_TURN_HEATER_OFF 0x3615
10. #define DATA_BUFFER_SIZE 9
11. #define CMD_BUFFER_SIZE 8
12. #define CRC8_POLYNOMIAL 0x31
13. #define CRC8_INIT 0xFF
14. #define CRC8_LEN 1
15. #define WORD_SIZE 2
16.
enum SGP41_Ability
برای فعال و غیر فعال کردن بخش های مختلف سنسوراز این enum استفاده میشود :
1. typedef enum Ability
2. {
3. Disable = 0 ,
4. Enable
5. }SGP41_Ability;
6.
enum SGP41_Activity
با استفاده از این enum وضعیت انجام شدن عملی در سنسورمشخص می شود:
1. typedef enum Activity
2. {
3. NOT_DONE = 0,
4. DONE = 1
5. } SGP41_Activity;
6.
enum SGP41_ Command
برای اجرای Command های سنسور از مقادیر این enum استفاده می شود:
1. typedef enum Command
2. {
3. GET_SERIAL_NUMBER = 0x3682 ,
4. PERFORM_SELF_TEST = 0x280E ,
5. EXECUTE_CONDITIONING = 0x2612 ,
6. MEASURE_RAW_SIGNAL = 0x2619 ,
7. TURN_HEATER_OFF = 0x3615
8. }SGP41_Command;
9.
enum SGP41_CRC_Status
برای اگاهی از وضعیتCRC از مقادیر این Enum استفاده می شود :
1. typedef enum CRC_Status
2. {
3. CRC_ERROR = 0 ,
4. CRC_OK
5. }SGP41_CRC_Status;
6.
struct SGP41
تمام ویژگی های سنسور، ضرایب کالیبراسیون و داده های سنسور در این Struct تعریف شده است و تمامی اطلاعات و کانفیگ اجرا شده بر روی سنسور در این Structure ذخیره شده و می توان تغییرات در هر بخش از سنسور را در محیط Debug Session مشاهده نمود:
1. typedef struct SGP41
2. {
3. uint8_t REGISTER_CACHE;
4. uint8_t BUFFER[DATA_BUFFER_SIZE];
5. SGP41_Command COMMAND;
6. uint8_t CMD_BUFFER[CMD_BUFFER_SIZE];
7. uint16_t SERIAL_NUMBER1;
8. uint16_t SERIAL_NUMBER2;
9. uint16_t SERIAL_NUMBER3;
10. SGP41_Activity SELF_TEST;
11. SGP41_Ability HUMIDITY_COMPENSATION;
12. SGP41_Activity HEATER_OFF;
13. float COMPENSATION_HUMIDITY;
14. float COMPENSATION_TEMPERATURE;
15. uint16_t DEFAULT_HUMIDITY;
16. uint16_t DEFAULT_TEMPERATURE;
17. SGP41_Activity FACTORY_RESET;
18. uint8_t SGP41_CRC;
19. SGP41_CRC_Status CRC_CHECK;
20. uint16_t SRAW_VOC;
21. uint16_t SRAW_NOX;
22. int32_t VOC_INDEX_VALUE;
23. int32_t NOX_INDEX_VALUE;
24. }GebraBit_SGP41;
25.
اعلان توابع
در پایان این فایل تمامی توابع جهت خواندن و نوشتن در رجیستر های SGP41 ، کانفیک سنسور و دریافت داده از سنسور اعلان شده است:
1. extern void GB_SGP41_Send_Command(GebraBit_SGP41 * SGP41 , uint16_t cmd) ;
2. extern void GB_SGP41_Write_Data(GebraBit_SGP41 * SGP41 , uint16_t cmd , uint16_t data1 , uint16_t data2 ) ;
3. extern void GB_SGP41_Read_Data(GebraBit_SGP41 * SGP41 , uint8_t* buffer, uint16_t size) ;
4. extern void GB_SGP41_Delay_uSecond(uint32_t useconds) ;
5. extern void GB_SGP41_CRC_Generate(GebraBit_SGP41 * SGP41 ,const uint8_t* data, uint16_t count) ;
6. extern void GB_SGP41_CRC_Check(GebraBit_SGP41 * SGP41 ,const uint8_t* data,uint16_t count,uint8_t checksum) ;
7. extern void GB_SGP41_Get_Serial_Number(GebraBit_SGP41 * SGP41 ) ;
8. extern void GB_SGP41_Perform_Self_Test(GebraBit_SGP41 * SGP41 ) ;
9. extern void GB_SGP41_Turn_Heater_Off(GebraBit_SGP41 * SGP41 ) ;
10. extern void GB_SGP41_Deactivate_Humidity_Compensation (GebraBit_SGP41 * SGP41) ;
11. extern void GB_SGP41_Set_Compensation_Humidity_Temperature_Values(GebraBit_SGP41 * SGP41 , float humidity , float temp , SGP41_Ability Compensation ) ;
12. extern void GB_SGP41_Execute_Conditioning(GebraBit_SGP41 * SGP41) ;
13. extern void GB_SGP41_Measure_Raw_Signal(GebraBit_SGP41 * SGP41) ;
14. extern void GB_SGP41_initialize( GebraBit_SGP41 * SGP41 ) ;
15. extern void GB_SGP41_Configuration(GebraBit_SGP41 * SGP41, SGP41_Ability Compensation) ;
16. extern void GB_SGP41_Get_Data(GebraBit_SGP41 * SGP41) ;
17.
فایل سورس GebraBit_SGP41.c
در این فایل که به زبان C نوشته شده ، تمامی توابع با جزئیات کامل، کامنت گذاری شده و تمامی پارامتر های دریافتی در آرگومان توابع و مقادیر بازگشتی از آنها ، بطور واضح توضیح داده شده است.از این رو در این قسمت به همین توضیحات اکتفا کرده و کاربران را برای اطلاعات بیشتر به بررسی مستقیم از این فایل دعوت می کنیم.
برنامه نمونه در Keil
بعد از تولید پروژه Keil با استفاده از STM32CubeMX و اضافه کردن کتابخانه GebraBit_SGP41.c ارائه شده توسط GebraBit ، به بررسی قسمت اصلی برنامه آموزشی نمونه، فایل main.c و مشاهده خروجی ماژول GebraBit SGP41 در قسمت watch در محیط Debugging برنامه Keil می پردازیم.
شرح فایل main.c
به ساختار ها ، Enum ها و توابع مورد نیاز ماژول GebraBit SGP41 ، اضافه شده است.در قسمت بعدی متغیری به نام SGP41_Module از نوع ساختار GebraBit_SGP41 (این ساختار در هدر GebraBit_SGP41 بوده و در بخش توضیحات کتابخانه GebraBit_SGP41توضیح داده شد) که برای پیکربندی ماژول GebraBit SGP41 می باشد،تعریف شده است:
/* Private typedef -----------------------------------------------------------*/
/* USER CODE BEGIN PTD */
GebraBit_SGP41 SGP41_Module;
/* USER CODE END PTD */
در بخش بعدی کد نوشته شده، با استفاده از تابع GB_SGP41_initialize(&SGP41_Module) و GB_SGP41_Configuration(&SGP41_Module) ماژول GebraBit SGP41 را مقدار دهی می کنیم و در نهایت در قسمت while برنامه ،داده را از سنسور خوانده و مقادیر VOC وNOx به طور پیوسته دریافت میشود:
1. /* USER CODE BEGIN 2 */
2. GB_SGP41_initialize(&SGP41_Module);
3. GB_SGP41_Configuration(&SGP41_Module);
4. /* USER CODE END 2 */
5.
6. /* Infinite loop */
7. /* USER CODE BEGIN WHILE */
8. while (1)
9. {
10. /* USER CODE END WHILE */
11.
12. /* USER CODE BEGIN 3 */
//GB_SGP41_Get_Data(&SGP41_Module);
14. }
15. /* USER CODE END 3 */
16. }
17.
متن کد فایل main.c:
1. /* USER CODE BEGIN Header */
2. /*
3. * ________________________________________________________________________________________________________
4. * Copyright (c) 2020 GebraBit Inc. All rights reserved.
5. *
6. * This software, related documentation and any modifications thereto (collectively “Software”) is subject
7. * to GebraBit and its licensors' intellectual property rights under U.S. and international copyright
8. * and other intellectual property rights laws.
9. *
10. * GebraBit and its licensors retain all intellectual property and proprietary rights in and to the Software
11. * and any use, reproduction, disclosure or distribution of the Software without an express license agreement
12. * from GebraBit is strictly prohibited.
13.
14. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
15. * NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT IN
16. * NO EVENT SHALL GebraBit BE LIABLE FOR ANY DIRECT, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES,
17. * OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
18. * NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
19. * OF THE SOFTWARE.
20. * ________________________________________________________________________________________________________
21. */
22. /**
23. ******************************************************************************
24. * @file : main.c
25. * @brief : Main program body
26. * @Author : Mehrdad Zeinali
27. ******************************************************************************
28. * @attention
29. *
30. * Copyright (c) 2022 STMicroelectronics.
31. * All rights reserved.
32. *
33. * This software is licensed under terms that can be found in the LICENSE file
34. * in the root directory of this software component.
35. * If no LICENSE file comes with this software, it is provided AS-IS.
36. *
37. ******************************************************************************
38. */
39. /* USER CODE END Header */
40. /* Includes ------------------------------------------------------------------*/
41. #include "main.h"
42. #include "i2c.h"
43. #include "gpio.h"
44.
45. /* Private includes ----------------------------------------------------------*/
46. /* USER CODE BEGIN Includes */
47. #include "GebraBit_SGP41.h"
48. //#include "sensirion_gas_index_algorithm.h"
49. /* USER CODE END Includes */
50.
51. /* Private typedef -----------------------------------------------------------*/
52. /* USER CODE BEGIN PTD */
53. GebraBit_SGP41 SGP41_Module;
54. /* USER CODE END PTD */
55.
56. /* Private define ------------------------------------------------------------*/
57. /* USER CODE BEGIN PD */
58. /* USER CODE END PD */
59.
60. /* Private macro -------------------------------------------------------------*/
61. /* USER CODE BEGIN PM */
62.
63. /* USER CODE END PM */
64.
65. /* Private variables ---------------------------------------------------------*/
66.
67. /* USER CODE BEGIN PV */
68.
69. /* USER CODE END PV */
70.
71. /* Private function prototypes -----------------------------------------------*/
72. void SystemClock_Config(void);
73. /* USER CODE BEGIN PFP */
74.
75. /* USER CODE END PFP */
76.
77. /* Private user code ---------------------------------------------------------*/
78. /* USER CODE BEGIN 0 */
79.
80. /* USER CODE END 0 */
81.
82. /**
83. * @brief The application entry point.
84. * @retval int
85. */
86. int main(void)
87. {
88. /* USER CODE BEGIN 1 */
89.
90. /* USER CODE END 1 */
91.
92. /* MCU Configuration--------------------------------------------------------*/
93.
94. /* Reset of all peripherals, Initializes the Flash interface and the Systick. */
95. HAL_Init();
96.
97. /* USER CODE BEGIN Init */
98.
99. /* USER CODE END Init */
100.
101. /* Configure the system clock */
102. SystemClock_Config();
103.
104. /* USER CODE BEGIN SysInit */
105.
106. /* USER CODE END SysInit */
107.
108. /* Initialize all configured peripherals */
109. MX_GPIO_Init();
110. MX_I2C1_Init();
111. /* USER CODE BEGIN 2 */
112. // initialize gas index parameters
113. GB_SGP41_initialize( &SGP41_Module );
114. GB_SGP41_Configuration( &SGP41_Module , Enable );
115. //GB_SGP41_Configuration( &SGP41_Module , Disable );
116. /* USER CODE END 2 */
117.
118. /* Infinite loop */
119. /* USER CODE BEGIN WHILE */
120. while (1)
121. {
122. /* USER CODE END WHILE */
123.
124. /* USER CODE BEGIN 3 */
125. GB_SGP41_Get_Data( &SGP41_Module );
126. }
127. /* USER CODE END 3 */
128. }
129.
130. /**
131. * @brief System Clock Configuration
132. * @retval None
133. */
134. void SystemClock_Config(void)
135. {
136. RCC_OscInitTypeDef RCC_OscInitStruct = {0};
137. RCC_ClkInitTypeDef RCC_ClkInitStruct = {0};
138. RCC_PeriphCLKInitTypeDef PeriphClkInit = {0};
139.
140. /** Initializes the RCC Oscillators according to the specified parameters
141. * in the RCC_OscInitTypeDef structure.
142. */
143. RCC_OscInitStruct.OscillatorType = RCC_OSCILLATORTYPE_HSE;
144. RCC_OscInitStruct.HSEState = RCC_HSE_ON;
145. RCC_OscInitStruct.HSEPredivValue = RCC_HSE_PREDIV_DIV1;
146. RCC_OscInitStruct.HSIState = RCC_HSI_ON;
147. RCC_OscInitStruct.PLL.PLLState = RCC_PLL_ON;
148. RCC_OscInitStruct.PLL.PLLSource = RCC_PLLSOURCE_HSE;
149. RCC_OscInitStruct.PLL.PLLMUL = RCC_PLL_MUL9;
150. if (HAL_RCC_OscConfig(&RCC_OscInitStruct) != HAL_OK)
151. {
152. Error_Handler();
153. }
154.
155. /** Initializes the CPU, AHB and APB buses clocks
156. */
157. RCC_ClkInitStruct.ClockType = RCC_CLOCKTYPE_HCLK|RCC_CLOCKTYPE_SYSCLK
158. |RCC_CLOCKTYPE_PCLK1|RCC_CLOCKTYPE_PCLK2;
159. RCC_ClkInitStruct.SYSCLKSource = RCC_SYSCLKSOURCE_PLLCLK;
160. RCC_ClkInitStruct.AHBCLKDivider = RCC_SYSCLK_DIV1;
161. RCC_ClkInitStruct.APB1CLKDivider = RCC_HCLK_DIV2;
162. RCC_ClkInitStruct.APB2CLKDivider = RCC_HCLK_DIV1;
163.
164. if (HAL_RCC_ClockConfig(&RCC_ClkInitStruct, FLASH_LATENCY_2) != HAL_OK)
165. {
166. Error_Handler();
167. }
168. PeriphClkInit.PeriphClockSelection = RCC_PERIPHCLK_I2C1;
169. PeriphClkInit.I2c1ClockSelection = RCC_I2C1CLKSOURCE_SYSCLK;
170. if (HAL_RCCEx_PeriphCLKConfig(&PeriphClkInit) != HAL_OK)
171. {
172. Error_Handler();
173. }
174. }
175.
176. /* USER CODE BEGIN 4 */
177.
178. /* USER CODE END 4 */
179.
180. /**
181. * @brief This function is executed in case of error occurrence.
182. * @retval None
183. */
184. void Error_Handler(void)
185. {
186. /* USER CODE BEGIN Error_Handler_Debug */
187. /* User can add his own implementation to report the HAL error return state */
188. __disable_irq();
189. while (1)
190. {
191. }
192. /* USER CODE END Error_Handler_Debug */
193. }
194.
195. #ifdef USE_FULL_ASSERT
196. /**
197. * @brief Reports the name of the source file and the source line number
198. * where the assert_param error has occurred.
199. * @param file: pointer to the source file name
200. * @param line: assert_param error line source number
201. * @retval None
202. */
203. void assert_failed(uint8_t *file, uint32_t line)
204. {
205. /* USER CODE BEGIN 6 */
206. /* User can add his own implementation to report the file name and line number,
207. ex: printf("Wrong parameters value: file %s on line %d\r\n", file, line) */
208. /* USER CODE END 6 */
209. }
210. #endif /* USE_FULL_ASSERT */
211.
خروجی برنامه
بعد از تولید پروژه Keil با استفاده از STM32CubeMX و اضافه کردن کتابخانه ، پروگرامر STLINK V2 را با استفاده از آداپتور تبدیل STLINKV2 به GebraBit STM32F303 متصل می کنیم:
آداپتور تبدیل STLINKV2
با اتصال پروگرامر STLINK V2 به GebraBit STM32F303 دیگر نیازی به اعمال تغذیه به ماژول های GebraBit STM32F303 و GebraBit SGP41 نمی باشد، زیرا ولتاژ کاری خود را مستقیما از پروگرامر STLINK V2 دریافت میکنند.
در نهایت وارد حالت Debug شده و با اضافه کردن SGP41_Module به پنجره watch و اجرای برنامه ، تغییرات مقادیر VOC و NOX ماژول GebraBit SGP41 را مشاهده می کنیم:
در ادامه می توانید پروژه راه اندازی ماژول GebraBit SGP41 را با استفاده از ماژول GebraBit STM32F303 در محیط Keil و فایل STM32CubeMX ، شماتیک ماژول ها و دیتاشیت SGP41 را دانلود کنید.