---
# System prepended metadata

title: STM32 - GPIO
tags: [DIT Summer Camp, Senior, DIT ROBOTICS]

---

# STM32 - GPIO
## GPIO 是什麼東東 Σ(°Д°;
GPIO（General-Purpose Input/Output）是「通用輸入/輸出」的縮寫。
這些引腳可以配置為輸入(Input)模式或輸出(Output)模式，用來與其他電子元件或外部設備進行數位訊號的交換。
<details>
    <Summary>數位訊號</Summary>
    
- 在製作機器人等等機電整合系統時，我們會需要用到各種不同的訊號去跟 感測器(sensor) 或 制動器(actuator) 溝通，數位訊號便是其中一種。
    - 數位訊號是離散的，不是 **HIGH(1)** 就是 **LOW(0)**，不會有介於中間的狀況
        - **HIGH** **高電位** **1** 通常會接近 5V or 3.3V
        - **LOW** **低電位** **0** 大約等於 0V
</details>

## OUTPUT
### 腳位初始化設定
在Arduino中，我們會需要定義腳位的功能，那在STM32中當然也是需要的啦！
```cpp
ex. pinMode(D5,OUTPUT);
```
在STM32中，我們會需要到.ioc中完成設定

    Project.ioc -> 左鍵點擊要輸出訊號的腳位 -> 選單中點選 GPIO_Output -> ctrl+s 存檔
<details>
    <summary>找不到腳位嗎？</summary>
    
- 右下方的搜尋欄可以搜尋 腳位＆功能 等資訊！
    
![Screenshot from 2024-07-24 14-49-11](https://hackmd.io/_uploads/r1P7Vm0dC.png)
</details>

![Screenshot from 2024-07-24 14-47-39](https://hackmd.io/_uploads/ByW2mXCuR.png)
<details>
    <summary>
這個視窗是問你要不要幫你生成剛剛設定的初始化code，選 "yes" 就對了！
        
![Screenshot from 2024-07-24 14-57-58](https://hackmd.io/_uploads/BkyxaEAOA.png)
    </summary>
::: info
勾 "Remember my decision"，下次就不會再跳出來了！
:::

- 下面就是他幫你生成初始化的code啦，就不用像Arduino一樣自己打了(*´∀`)~♥
    
![Screenshot from 2024-07-24 16-43-52](https://hackmd.io/_uploads/rkSGJBCd0.png)

</details>
<details>
    <summary>開發板上的腳位在哪 (´･_･`)</summary>

- 可以到包裝盒裡的紙板找！
- 也可以到 [User Manual](https://www.st.com/resource/en/user_manual/um2505-stm32g4-nucleo64-boards-mb1367-stmicroelectronics.pdf) 上找！
    ![Screenshot from 2024-07-25 15-22-29](https://hackmd.io/_uploads/HJAra_JtC.png)
</details>
::: success
到這邊腳位的功能設定就完成了 (ﾉ>ω<)ﾉ
接下來看要怎用程式控制他吧 ！
:::

---
### 控制函式
::: info
設定完腳位的功能後，我們便可以到程式中告訴他要做什麼啦！
:::
如果我們想要讓某個腳位 <font color='Violet'>輸出</font>  **<font color='LightSalmon'>高電位</font>** or **<font color='LightSkyBlue'>低電位</font>**，可以使用下方函式達成：

<!-- Code1 -->

- 使腳位輸出 **<font color='LightSalmon'>高電位</font>** or **<font color='LightSkyBlue'>低電位</font>**
    ```Cpp=
    HAL_GPIO_WritePin(GPIOx, GPIO_PIN_x, PinState);
    ```
    - <details>
        <summary>阿阿阿... 這什麼我看不懂</summary>
    
        - GPIOx -> "GPIO" + 腳位的 **英文編號**
    
        - GPIO_PIN_x -> "GPIO_PIN_" + 腳位的 **數字編號**

        - PinState -> 高電位：**GPIO_PIN_SET** , 低電位：**GPIO_PIN_RESET**
    
            - ex. 控制腳位 P<font color='orange'>A</font><font color='lime'>5</font> 輸出 <font color='LightSalmon'>高電位</font>
    
            ```Cpp=
            HAL_GPIO_WritePin(GPIOA, GPIO_PIN_5, GPIO_PIN_SET); 
            ```
    </details>
    
<!-- Code2 -->
    
  - 使腳位輸出 ***<font color='Gold'>與上次相反</font>*** 的電位
    ```Cpp=
    HAL_GPIO_TogglePin(GPIOx, GPIO_PIN_x);
    ```
    - <details>
        <summary>歐？好像有一點點不同！</summary>
    
        - GPIOx -> "GPIO" + 腳位的 **英文編號**
    
        - GPIO_PIN_x -> "GPIO_PIN_" + 腳位的 **數字編號**
    
            - ex. 控制腳位 P<font color='orange'>A</font><font color='lime'>5</font> 從剛剛的 <font color='LightSalmon'>高電位</font> 切換成 <font color='LightSkyBlue'>低電位</font>
    
            ```Cpp=
            HAL_GPIO_TogglePin(GPIOA, GPIO_PIN_5); 
            ```
        ::: warning
        使用時要特別注意腳位 **原本的狀態**
        :::
    </details>
::: warning
要特別注意的是，這些程式要放在 **MX_GPIO_Init();** 後面
<details>
    <summary>為什麼呢？</summary>

- MX_GPIO_Init() 這個函式就是剛剛 .ioc 檔生成初始化設定程式碼的地方，
  跟 Arduino 一樣，要先跟這個腳位說他的工作是什麼才能使喚他
</details>
:::
::: success
利用這些函式便可以控制腳位 <font color='violet'>輸出</font> **<font color='LightSalmon'>高電位</font>** or **<font color='LightSkyBlue'>低電位</font>** 了！
:::

---
## INPUT
### 腳位初始化設定
Input 和 Output 大同小異，設置基本上差不多！
    
    Project.ioc -> 左鍵點擊要輸出訊號的腳位 -> 選單中點選 GPIO_Input -> ctrl+s 存檔

![Screenshot from 2024-07-24 19-38-29](https://hackmd.io/_uploads/rkxJ_DR_R.png)

---
### 控制函式

如果我們想要 <font color='violet'>讀取</font> 某個腳位為 **<font color='LightSalmon'>高電位</font>** or **<font color='LightSkyBlue'>低電位</font>**，可以使用下方函式達成：

<!-- Code1 -->

- 讀取腳位為 **<font color='LightSalmon'>高電位</font>** or **<font color='LightSkyBlue'>低電位</font>**
    ```Cpp=
    HAL_GPIO_ReadPin(GPIOx, GPIO_PIN_x);
    ```
    - <details>
        <summary>umm... 跟Output滿像的！</summary>
    
        - GPIOx -> "GPIO" + 腳位的 **英文編號**
    
        - GPIO_PIN_x -> "GPIO_PIN_" + 腳位的 **數字編號**
        
        - 函式會 return <font color='LightSalmon'>GPIO_PIN_SET(1)</font> / <font color='LightSkyBlue'>GPIO_PIN_RESET(0)</font>
    
            - ex. 讀取腳位 P<font color='orange'>C</font><font color='lime'>13</font> 輸出 <font color='LightSalmon'>高電位</font>
    
            ```Cpp=
            int val = 0;
            val = HAL_GPIO_WritePin(GPIOC, GPIO_PIN_13); 
            ```
            ::: info
            可以宣告一個 **整數（int）** 型態的變數去接收回傳的數值！
            :::
    </details>
::: warning
一樣要放在 **MX_GPIO_Init();** 後面！
:::
::: info
利用這些函式便可以 <font color='violet'>讀取</font> 腳位為 **<font color='LightSalmon'>高電位</font>** or **<font color='LightSkyBlue'>低電位</font>** 了！
:::
::: success
耶！ 恭喜你們學完第一課 **GPIO** 了 ( • ̀ω•́ )
:::

---
## 實做練習
::: info
忘記 [C語言](https://hackmd.io/@wang-hsiu-cheng/C_Basic_Learn) 怎麼寫了 ٩(ŏ﹏ŏ、)۶
:::
### Beginner
- Nucleo-G431RB 開發板上，內建了一個 User LED，User Manual 告訴我們他連接到了 **PA5** 腳位，請試著讓他 **亮起 3s 再關掉**
    ![Screenshot from 2024-07-24 21-46-33](https://hackmd.io/_uploads/H1Y8IFRdR.png)
    
---    
### Basic
1. Nucleo-G431RB 開發板上，內建了一個 User LED，User Manual 告訴我們他連接到了 **PA5** 腳位，請試著讓他 **0.7s亮0.3秒暗**  (✪ω✪)
    ![Screenshot from 2024-07-24 21-46-33](https://hackmd.io/_uploads/H1Y8IFRdR.png)
    ::: info
    高電位(HIGH)可以輸出3.3V訊號讓 User LED 亮起！
    :::
    <details>
        <summary>要怎麼讓程式停下來(´・ω・`)</summary>
    
    - 在 while(1) 中，程式一般是以 幾MHz - 幾十MHz 的頻率在運行（超快！）
    - 要讓程式停下來我們可以用到下面的函式讓他等一下再繼續進行：
        ```Cpp
        HAL_Delay(millisecond);
        ```
        ::: info
        函式中輸入的單位為 **毫秒(ms)**！（1s = 1000ms）
        :::
    </details>
    
2. Nucleo-G431RB 開發板上，還內建了一個 User Button，User Manual 告訴我們他連接到了 **PC13** 腳位，請試著用 **現場表達式** 讀取這個按鈕是否被按下！
![Screenshot from 2024-07-24 22-08-50](https://hackmd.io/_uploads/rkVQn50d0.png)

<details>
    <summary>LED & 按鈕 在哪 ( ˘•ω•˘ )</summary>
    
- <font color='Orange'>橘色</font>的是 User LED 的位置
- <font color='Red'>紅色</font>的是 User Botton 的位置
- <font color='LightBlue'>藍色</font>的是 Reser Botton 的位置
    - Reset Botton 可以讓開發板重置(不是回原廠設定那種重置），讓程式 **重頭開始** 執行
   ![Screenshot from 2024-07-24 22-08-31](https://hackmd.io/_uploads/B1EdRcAOA.png)
</details>
<details>
    <summary>還記得怎麼 燒錄 ＆ 執行 嗎？</summary>
    
給我回去看 ***[STM32 - Introduction](/5YNt97VsR0OXsA0gx8pqKg)*** (╯•̀ὤ•́)╯
</details>

---
### Advanced
::: info
剛剛我們把 **Input** ＆ **Output** 分別練習過了，接下來我們把他整合在一起吧！
:::
- 請試著利用 User Button 控制 User LED 開關 ！
    - 按兩下 Button -> LED 開，再按兩下關，再按兩下開，一直重複... 
    ::: info
    可以先把基礎練習的Code **註解** 掉！ （ " **ctrl + /** " 可以單行註解 ）
    :::
<details>
    <summary>小提示</summary>
    
- 可以宣告一個 **整數變數(int)** 計算按下幾次，再用 **if/else** 判斷是否要 開/關 LED
    
- 按鈕按下可能會有訊號抖動，導致按下時可能會在高低電位來回跳動，詳細內容可以搜尋
    **按鈕 + Debounce**
    - 可以用 邏輯判斷 or 延遲 讓程式在短時間只進行一次
    - 也可以利用 [外部中斷](https://drive.google.com/file/d/13jhTRWXI9hQvq5Lg1Rcbk4oFhsoLbdIn/view?usp=sharing) 這個功能達成！
</details>

---
### 範例程式
<details>
    <summary>Beginner</summary>
    
```Cpp=
HAL_GPIO_WritePin(GPIOA, GPIO_PIN_5, GPIO_PIN_SET);
HAL_Delay(3000);
```
</details>
<details>
    <summary>Basic - 1</summary>
    
```Cpp=
HAL_GPIO_WritePin(GPIOA, GPIO_PIN_5, GPIO_PIN_SET);
HAL_Delay(700);
HAL_GPIO_WritePin(GPIOA, GPIO_PIN_5, GPIO_PIN_RESET);
HAL_Delay(300);
```
</details>
<details>
    <summary>Basic - 2</summary>
    
```Cpp=
int buttonState = 0;
buttonState = HAL_GPIO_ReadPin(GPIOC, GPIO_PIN_13);
```
</details>
<details>
    <summary>Advanced</summary>
    
```Cpp=
buttonState = HAL_GPIO_ReadPin(GPIOC, GPIO_PIN_13);
if(buttonState && !once){
  push_cnt++;
  once = 1;
}
if(!buttonState && once)	once = 0;
if(push_cnt == 2){
  HAL_GPIO_TogglePin(GPIOA, GPIO_PIN_5);
  push_cnt = 0;
}
```
</details>

<details>
    <summary>完整 main.c</summary>
    
```Cpp=
/* USER CODE BEGIN Header */
/**
  ******************************************************************************
  * @file           : main.c
  * @brief          : Main program body
  ******************************************************************************
  * @attention
  *
  * Copyright (c) 2024 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"

/* Private includes ----------------------------------------------------------*/
/* USER CODE BEGIN Includes */

/* USER CODE END Includes */

/* Private typedef -----------------------------------------------------------*/
/* USER CODE BEGIN PTD */

/* 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 ---------------------------------------------------------*/
UART_HandleTypeDef hlpuart1;

/* USER CODE BEGIN PV */
int buttonState = 0;
int push_cnt = 0;
int once = 0;
/* USER CODE END PV */

/* Private function prototypes -----------------------------------------------*/
void SystemClock_Config(void);
static void MX_GPIO_Init(void);
static void MX_LPUART1_UART_Init(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_LPUART1_UART_Init();
  /* USER CODE BEGIN 2 */

  /* USER CODE END 2 */

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

    /* USER CODE BEGIN 3 */
	  // Beginners
//	  HAL_GPIO_WritePin(GPIOA, GPIO_PIN_5, GPIO_PIN_SET);
//	  HAL_Delay(3000);
	  // Basic - 1
	  HAL_GPIO_WritePin(GPIOA, GPIO_PIN_5, GPIO_PIN_SET);
	  HAL_Delay(700);
	  HAL_GPIO_WritePin(GPIOA, GPIO_PIN_5, GPIO_PIN_RESET);
	  HAL_Delay(300);
	  // Basic - 2
	  buttonState = HAL_GPIO_ReadPin(GPIOC, GPIO_PIN_13);
	  // Advanced
//	  buttonState = HAL_GPIO_ReadPin(GPIOC, GPIO_PIN_13);
//	  if(buttonState && !once){
//		  push_cnt++;
//		  once = 1;
//	  }
//	  if(!buttonState && once)	once = 0;
//	  if(push_cnt == 2){
//		  HAL_GPIO_TogglePin(GPIOA, GPIO_PIN_5);
//		  push_cnt = 0;
//	  }
  }
  /* USER CODE END 3 */
}

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

  /** Configure the main internal regulator output voltage
  */
  HAL_PWREx_ControlVoltageScaling(PWR_REGULATOR_VOLTAGE_SCALE1_BOOST);

  /** Initializes the RCC Oscillators according to the specified parameters
  * in the RCC_OscInitTypeDef structure.
  */
  RCC_OscInitStruct.OscillatorType = RCC_OSCILLATORTYPE_HSI;
  RCC_OscInitStruct.HSIState = RCC_HSI_ON;
  RCC_OscInitStruct.HSICalibrationValue = RCC_HSICALIBRATION_DEFAULT;
  RCC_OscInitStruct.PLL.PLLState = RCC_PLL_ON;
  RCC_OscInitStruct.PLL.PLLSource = RCC_PLLSOURCE_HSI;
  RCC_OscInitStruct.PLL.PLLM = RCC_PLLM_DIV4;
  RCC_OscInitStruct.PLL.PLLN = 85;
  RCC_OscInitStruct.PLL.PLLP = RCC_PLLP_DIV2;
  RCC_OscInitStruct.PLL.PLLQ = RCC_PLLQ_DIV2;
  RCC_OscInitStruct.PLL.PLLR = RCC_PLLR_DIV2;
  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_4) != HAL_OK)
  {
    Error_Handler();
  }
}

/**
  * @brief LPUART1 Initialization Function
  * @param None
  * @retval None
  */
static void MX_LPUART1_UART_Init(void)
{

  /* USER CODE BEGIN LPUART1_Init 0 */

  /* USER CODE END LPUART1_Init 0 */

  /* USER CODE BEGIN LPUART1_Init 1 */

  /* USER CODE END LPUART1_Init 1 */
  hlpuart1.Instance = LPUART1;
  hlpuart1.Init.BaudRate = 115200;
  hlpuart1.Init.WordLength = UART_WORDLENGTH_8B;
  hlpuart1.Init.StopBits = UART_STOPBITS_1;
  hlpuart1.Init.Parity = UART_PARITY_NONE;
  hlpuart1.Init.Mode = UART_MODE_TX_RX;
  hlpuart1.Init.HwFlowCtl = UART_HWCONTROL_NONE;
  hlpuart1.Init.OneBitSampling = UART_ONE_BIT_SAMPLE_DISABLE;
  hlpuart1.Init.ClockPrescaler = UART_PRESCALER_DIV1;
  hlpuart1.AdvancedInit.AdvFeatureInit = UART_ADVFEATURE_NO_INIT;
  if (HAL_UART_Init(&hlpuart1) != HAL_OK)
  {
    Error_Handler();
  }
  if (HAL_UARTEx_SetTxFifoThreshold(&hlpuart1, UART_TXFIFO_THRESHOLD_1_8) != HAL_OK)
  {
    Error_Handler();
  }
  if (HAL_UARTEx_SetRxFifoThreshold(&hlpuart1, UART_RXFIFO_THRESHOLD_1_8) != HAL_OK)
  {
    Error_Handler();
  }
  if (HAL_UARTEx_DisableFifoMode(&hlpuart1) != HAL_OK)
  {
    Error_Handler();
  }
  /* USER CODE BEGIN LPUART1_Init 2 */

  /* USER CODE END LPUART1_Init 2 */

}

/**
  * @brief GPIO Initialization Function
  * @param None
  * @retval None
  */
static void MX_GPIO_Init(void)
{
  GPIO_InitTypeDef GPIO_InitStruct = {0};

  /* GPIO Ports Clock Enable */
  __HAL_RCC_GPIOC_CLK_ENABLE();
  __HAL_RCC_GPIOF_CLK_ENABLE();
  __HAL_RCC_GPIOA_CLK_ENABLE();
  __HAL_RCC_GPIOB_CLK_ENABLE();

  /*Configure GPIO pin Output Level */
  HAL_GPIO_WritePin(GPIOA, GPIO_PIN_5, GPIO_PIN_RESET);

  /*Configure GPIO pin : PC13 */
  GPIO_InitStruct.Pin = GPIO_PIN_13;
  GPIO_InitStruct.Mode = GPIO_MODE_INPUT;
  GPIO_InitStruct.Pull = GPIO_NOPULL;
  HAL_GPIO_Init(GPIOC, &GPIO_InitStruct);

  /*Configure GPIO pin : PA5 */
  GPIO_InitStruct.Pin = GPIO_PIN_5;
  GPIO_InitStruct.Mode = GPIO_MODE_OUTPUT_PP;
  GPIO_InitStruct.Pull = GPIO_NOPULL;
  GPIO_InitStruct.Speed = GPIO_SPEED_FREQ_LOW;
  HAL_GPIO_Init(GPIOA, &GPIO_InitStruct);

}

/* 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 */
```
</details>
