STM32 HAL Cheat Sheet

GPIO

HAL_GP­IO_­Rea­dPin()
HAL_GP­IO_­Wri­tePin()
HAL_GP­IO_­Tog­gle­Pin()
HAL_GP­IO_­EXT­I_C­all­back()

1. HAL_GPIO_ReadPin(): Hàm này được sử dụng để đọc trạng thái (hoạt động hoặc không hoạt động) của một chân GPIO cụ thể.

   GPIO_PinState HAL_GPIO_ReadPin(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin);
   

   • GPIOx: Tham số đầu vào, xác định GPIO port mà bạn muốn đọc.
   • GPIO_Pin: Tham số đầu vào, xác định chân GPIO cụ thể bạn muốn đọc.
   • Trả về GPIO_PIN_RESET nếu chân GPIO không hoạt động và GPIO_PIN_SET nếu chân GPIO đang hoạt động.
2. HAL_GPIO_WritePin(): Hàm này được sử dụng để ghi giá trị vào một chân GPIO cụ thể.

   void HAL_GPIO_WritePin(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin, GPIO_PinState PinState);
   

   • GPIOx: Tham số đầu vào, xác định GPIO port mà bạn muốn ghi.
   • GPIO_Pin: Tham số đầu vào, xác định chân GPIO cụ thể bạn muốn ghi.
   • PinState: Tham số đầu vào, xác định trạng thái bạn muốn ghi vào chân GPIO đó (GPIO_PIN_RESET hoặc GPIO_PIN_SET).
3. HAL_GPIO_TogglePin(): Hàm này được sử dụng để chuyển đổi trạng thái của một chân GPIO cụ thể (từ hoạt động sang không hoạt động hoặc ngược lại).

   void HAL_GPIO_TogglePin(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin);
   

   • GPIOx: Tham số đầu vào, xác định GPIO port mà bạn muốn chuyển đổi.
   • GPIO_Pin: Tham số đầu vào, xác định chân GPIO cụ thể bạn muốn chuyển đổi.
4. HAL_GPIO_EXTI_Callback(): Hàm callback này được gọi tự động khi một ngắt EXTI xảy ra trên một chân GPIO được cấu hình như EXTI.

   void HAL_GPIO_EXTI_Callback(uint16_t GPIO_Pin);
   

   • GPIO_Pin: Tham số đầu vào, xác định chân GPIO mà ngắt EXTI đã xảy ra.

ADC

HAL_AD­C_S­tart()
HAL_AD­C_S­top()
HAL_AD­C_S­tar­t_IT()
HAL_AD­C_S­top­_IT()
HAL_AD­C_P­oll­For­Con­ver­sion()
HAL_AD­C_G­etV­alue()
HAL_AD­C_C­onv­Hal­fCp­ltC­all­back()
HAL_AD­C_C­onv­Cpl­tCa­llb­ack()

1. HAL_ADC_Start(): Hàm này được sử dụng để bắt đầu quá trình chuyển đổi ADC trên một kênh ADC cụ thể.

   HAL_StatusTypeDef HAL_ADC_Start(ADC_HandleTypeDef* hadc);
   

   • hadc: Tham số đầu vào, con trỏ đến biến cấu trúc ADC_HandleTypeDef, xác định ADC instance bạn muốn bắt đầu chuyển đổi.
2. HAL_ADC_Stop(): Hàm này được sử dụng để dừng quá trình chuyển đổi ADC trên một kênh ADC cụ thể.

   HAL_StatusTypeDef HAL_ADC_Stop(ADC_HandleTypeDef* hadc);
   

   • hadc: Tham số đầu vào, con trỏ đến biến cấu trúc ADC_HandleTypeDef, xác định ADC instance bạn muốn dừng chuyển đổi.
3. HAL_ADC_Start_IT(): Hàm này được sử dụng để bắt đầu quá trình chuyển đổi ADC trên một kênh ADC cụ thể và cho phép ngắt được kích hoạt khi quá trình chuyển đổi hoàn thành.

   HAL_StatusTypeDef HAL_ADC_Start_IT(ADC_HandleTypeDef* hadc);
   

   • hadc: Tham số đầu vào, con trỏ đến biến cấu trúc ADC_HandleTypeDef, xác định ADC instance bạn muốn bắt đầu chuyển đổi và kích hoạt ngắt.
4. HAL_ADC_Stop_IT(): Hàm này được sử dụng để dừng quá trình chuyển đổi ADC trên một kênh ADC cụ thể và ngắt liên quan.

   HAL_StatusTypeDef HAL_ADC_Stop_IT(ADC_HandleTypeDef* hadc);
   

   • hadc: Tham số đầu vào, con trỏ đến biến cấu trúc ADC_HandleTypeDef, xác định ADC instance bạn muốn dừng chuyển đổi và tắt ngắt.
5. HAL_ADC_PollForConversion(): Hàm này được sử dụng để chờ đợi cho đến khi quá trình chuyển đổi ADC trên một kênh ADC cụ thể hoàn thành.

   HAL_StatusTypeDef HAL_ADC_PollForConversion(ADC_HandleTypeDef* hadc, uint32_t Timeout);
   

   • hadc: Tham số đầu vào, con trỏ đến biến cấu trúc ADC_HandleTypeDef, xác định ADC instance bạn muốn kiểm tra.
   • Timeout: Tham số đầu vào, thời gian chờ tối đa (theo miligiây).
6. HAL_ADC_GetValue(): Hàm này được sử dụng để lấy giá trị kết quả của quá trình chuyển đổi ADC trên một kênh ADC cụ thể.

   uint32_t HAL_ADC_GetValue(ADC_HandleTypeDef* hadc);
   

   • hadc: Tham số đầu vào, con trỏ đến biến cấu trúc ADC_HandleTypeDef, xác định ADC instance bạn muốn lấy giá trị.
7. HAL_ADC_ConvHalfCpltCallback(): Hàm callback này được gọi tự động khi một nửa của bộ chuyển đổi ADC hoàn thành chuyển đổi.

   __weak void HAL_ADC_ConvHalfCpltCallback(ADC_HandleTypeDef* hadc);
   

   • hadc: Tham số đầu vào, con trỏ đến biến cấu trúc ADC_HandleTypeDef, xác định ADC instance mà ngắt đã xảy ra.
8. HAL_ADC_ConvCpltCallback(): Hàm callback này được gọi tự động khi toàn bộ quá trình chuyển đổi ADC hoàn thành.

   __weak void HAL_ADC_ConvCpltCallback(ADC_HandleTypeDef* hadc);
   

   • hadc: Tham số đầu vào, con trỏ đến biến cấu trúc ADC_HandleTypeDef, xác định ADC instance mà ngắt đã xảy ra.

UART

HAL_UA­RT_­Tra­nsmit()
HAL_UA­RT_­Rec­eive()
HAL_UA­RT_­Tra­nsm­it_IT()
HAL_UA­RT_­Rec­eiv­e_IT()
HAL_UA­RTE­x_R­ece­ive­ToI­dle()
HAL_UA­RTE­x_R­ece­ive­ToI­dle­_IT()
HAL_UA­RT_­TxC­plt­Cal­lback
HAL_UA­RT_­RxC­plt­Cal­lback
HAL_UA­RT_­TxH­alf­Cpl­tCa­llback
HAL_UA­RT_­RxC­plt­Cal­lback

1. HAL_UART_Transmit(): Hàm này được sử dụng để gửi dữ liệu qua UART.

   HAL_StatusTypeDef HAL_UART_Transmit(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size, uint32_t Timeout);
   

   • huart: Con trỏ đến biến kiểu UART_HandleTypeDef của UART bạn muốn sử dụng.
   • pData: Con trỏ đến mảng dữ liệu bạn muốn gửi.
   • Size: Kích thước dữ liệu bạn muốn gửi.
   • Timeout: Thời gian chờ (ms).
2. HAL_UART_Receive(): Hàm này được sử dụng để nhận dữ liệu từ UART.

   HAL_StatusTypeDef HAL_UART_Receive(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size, uint32_t Timeout);
   

   • huart: Con trỏ đến biến kiểu UART_HandleTypeDef của UART bạn muốn sử dụng.
   • pData: Con trỏ đến mảng để lưu dữ liệu nhận được.
   • Size: Kích thước dữ liệu bạn muốn nhận.
   • Timeout: Thời gian chờ (ms).
3. HAL_UART_Transmit_IT(): Hàm này được sử dụng để bắt đầu gửi dữ liệu qua UART sử dụng chế độ ngắt.

   HAL_StatusTypeDef HAL_UART_Transmit_IT(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size);
   

   • huart: Con trỏ đến biến kiểu UART_HandleTypeDef của UART bạn muốn sử dụng.
   • pData: Con trỏ đến mảng dữ liệu bạn muốn gửi.
   • Size: Kích thước dữ liệu bạn muốn gửi.
4. HAL_UART_Receive_IT(): Hàm này được sử dụng để bắt đầu nhận dữ liệu từ UART sử dụng chế độ ngắt.

   HAL_StatusTypeDef HAL_UART_Receive_IT(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size);
   

   • huart: Con trỏ đến biến kiểu UART_HandleTypeDef của UART bạn muốn sử dụng.
   • pData: Con trỏ đến mảng để lưu dữ liệu nhận được.
   • Size: Kích thước dữ liệu bạn muốn nhận.
5. HAL_UARTEx_ReceiveToIdle(): Hàm này được sử dụng để nhận dữ liệu từ UART đến khi nhận được ký tự kết thúc (idle line).

   HAL_StatusTypeDef HAL_UARTEx_ReceiveToIdle(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size);
   

   • huart: Con trỏ đến biến kiểu UART_HandleTypeDef của UART bạn muốn sử dụng.
   • pData: Con trỏ đến mảng để lưu dữ liệu nhận được.
   • Size: Kích thước dữ liệu bạn muốn nhận.
6. HAL_UARTEx_ReceiveToIdle_IT(): Hàm này được sử dụng để bắt đầu nhận dữ liệu từ UART đến khi nhận được ký tự kết thúc (idle line) sử dụng chế độ ngắt.

   HAL_StatusTypeDef HAL_UARTEx_ReceiveToIdle_IT(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size);
   

   • huart: Con trỏ đến biến kiểu UART_HandleTypeDef của UART bạn muốn sử dụng.
   • pData: Con trỏ đến mảng để lưu dữ liệu nhận được.
   • Size: Kích thước dữ liệu bạn muốn nhận.
7. HAL_UART_TxCpltCallback(): Hàm callback này được gọi tự động khi việc truyền dữ liệu qua UART hoàn thành.

   void HAL_UART_TxCpltCallback(UART_HandleTypeDef *huart);
   

8. HAL_UART_RxCpltCallback(): Hàm callback này được gọi tự động khi việc nhận dữ liệu từ UART hoàn thành.

   void HAL_UART_RxCpltCallback(UART_HandleTypeDef *huart);
   

9. HAL_UART_TxHalfCpltCallback(): Hàm callback này được gọi tự động khi nửa số lượng dữ liệu đã được truyền (sự kiện DMA Half-Transfer) trong chế độ DMA.

   void HAL_UART_TxHalfCpltCallback(UART_HandleTypeDef *huart);
   

10. HAL_UART_RxHalfCpltCallback(): Hàm callback này được gọi tự động khi nửa số lượng dữ liệu đã được nhận (sự kiện DMA Half-Transfer) trong chế độ DMA.

    void HAL_UART_RxHalfCpltCallback(UART_HandleTypeDef *huart);
    

I2C

HAL_I2­C_M­ast­er_­Tra­nsmit()
HAL_I2­C_M­ast­er_­Rec­eive()
HAL_I2­C_M­em_­Write()
HAL_I2­C_M­em_­Read()
HAL_I2­C_I­sDe­vic­eRe­ady()
HAL_I2­C_M­ast­erT­xCp­ltC­all­back()
HAL_I2­C_M­ast­erR­xCp­ltC­all­back()

1. HAL_I2C_Master_Transmit(): Hàm này được sử dụng để gửi dữ liệu từ master qua giao tiếp I2C.

   HAL_StatusTypeDef HAL_I2C_Master_Transmit(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size, uint32_t Timeout);
   

   • hi2c: Con trỏ đến biến kiểu I2C_HandleTypeDef của giao tiếp I2C bạn muốn sử dụng.
   • DevAddress: Địa chỉ của thiết bị I2C.
   • pData: Con trỏ đến dữ liệu bạn muốn gửi.
   • Size: Số lượng byte dữ liệu bạn muốn gửi.
   • Timeout: Thời gian chờ (ms).
2. HAL_I2C_Master_Receive(): Hàm này được sử dụng để nhận dữ liệu từ slave qua giao tiếp I2C.

   HAL_StatusTypeDef HAL_I2C_Master_Receive(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size, uint32_t Timeout);
   

   • hi2c: Con trỏ đến biến kiểu I2C_HandleTypeDef của giao tiếp I2C bạn muốn sử dụng.
   • DevAddress: Địa chỉ của thiết bị I2C.
   • pData: Con trỏ đến vùng nhớ bạn muốn lưu dữ liệu nhận được.
   • Size: Số lượng byte dữ liệu bạn muốn nhận.
   • Timeout: Thời gian chờ (ms).
3. HAL_I2C_Mem_Write(): Hàm này được sử dụng để ghi dữ liệu vào bộ nhớ của một thiết bị I2C (memory write).

   HAL_StatusTypeDef HAL_I2C_Mem_Write(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint16_t MemAddress, uint16_t MemAddSize, uint8_t *pData, uint16_t Size, uint32_t Timeout);
   

   • hi2c: Con trỏ đến biến kiểu I2C_HandleTypeDef của giao tiếp I2C bạn muốn sử dụng.
   • DevAddress: Địa chỉ của thiết bị I2C.
   • MemAddress: Địa chỉ bộ nhớ trên thiết bị I2C bạn muốn ghi dữ liệu vào.
   • MemAddSize: Kích thước của địa chỉ bộ nhớ (8-bit hoặc 16-bit).
   • pData: Con trỏ đến dữ liệu bạn muốn ghi.
   • Size: Số lượng byte dữ liệu bạn muốn ghi.
   • Timeout: Thời gian chờ (ms).
4. HAL_I2C_Mem_Read(): Hàm này được sử dụng để đọc dữ liệu từ bộ nhớ của một thiết bị I2C (memory read).

   HAL_StatusTypeDef HAL_I2C_Mem_Read(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint16_t MemAddress, uint16_t MemAddSize, uint8_t *pData, uint16_t Size, uint32_t Timeout);
   

   • hi2c: Con trỏ đến biến kiểu I2C_HandleTypeDef của giao tiếp I2C bạn muốn sử dụng.
   • DevAddress: Địa chỉ của thiết bị I2C.
   • MemAddress: Địa chỉ bộ nhớ trên thiết bị I2C bạn muốn đọc dữ liệu từ.
   • MemAddSize: Kích thước của địa chỉ bộ nhớ (8-bit hoặc 16-bit).
   • pData: Con trỏ đến vùng nhớ bạn muốn lưu dữ liệu đọc được.
   • Size: Số lượng byte dữ liệu bạn muốn đọc.
   • Timeout: Thời gian chờ (ms).
5. HAL_I2C_IsDeviceReady(): Hàm này được sử dụng để kiểm tra xem thiết bị I2C có sẵn sàng hay không.

   HAL_StatusTypeDef HAL_I2C_IsDeviceReady(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint32_t Trials, uint32_t Timeout);
   

   • hi2c: Con trỏ đến biến kiểu I2C_HandleTypeDef của giao tiếp I2C bạn muốn sử dụng.
   • DevAddress: Địa chỉ của thiết bị I2C bạn muốn kiểm tra.
   • Trials: Số lần thử kiểm tra.
   • Timeout: Thời gian chờ (ms).
6. HAL_I2C_MasterTxCpltCallback(): Hàm callback này được gọi tự động khi quá trình truyền dữ liệu từ master qua giao tiếp I2C hoàn thành.

   __weak void HAL_I2C_MasterTxCpltCallback(I2C_HandleTypeDef *hi2c);
   

7. HAL_I2C_MasterRxCpltCallback(): Hàm callback này được gọi tự động khi quá trình nhận dữ liệu từ slave qua giao tiếp I2C hoàn thành.

   __weak void HAL_I2C_MasterRxCpltCallback(I2C_HandleTypeDef *hi2c);

TIMER

HAL_TI­M_B­ase­_St­art()
HAL_TI­M_B­ase­_Stop()
HAL_TI­M_B­ase­_St­art­_IT()
HAL_TI­M_B­ase­_St­op_IT()
HAL_TI­M_P­WM_­Start()
HAL_TI­M_P­WM_­Stop()
__HAL_­TIM­_SE­T_C­OMP­ARE()
__HAL_­TIM­_GE­T_C­OMP­ARE()
HAL_TI­M_P­eri­odE­lap­sed­Hal­fCp­ltC­all­back()
HAL_TI­M_P­eri­odE­lap­sed­Cal­lback()

1. HAL_TIM_Base_Start(): Hàm này được sử dụng để bắt đầu đếm thời gian với các cài đặt cơ bản (chế độ đếm và giá trị của bộ chia nhận được cấu hình trước đó).

   HAL_StatusTypeDef HAL_TIM_Base_Start(TIM_HandleTypeDef *htim);
   

   • htim: Con trỏ đến biến kiểu TIM_HandleTypeDef của timer bạn muốn bắt đầu.
2. HAL_TIM_Base_Stop(): Hàm này được sử dụng để dừng đếm thời gian.

   HAL_StatusTypeDef HAL_TIM_Base_Stop(TIM_HandleTypeDef *htim);
   

   • htim: Con trỏ đến biến kiểu TIM_HandleTypeDef của timer bạn muốn dừng.
3. HAL_TIM_Base_Start_IT(): Hàm này được sử dụng để bắt đầu đếm thời gian và kích hoạt chế độ ngắt.

   HAL_StatusTypeDef HAL_TIM_Base_Start_IT(TIM_HandleTypeDef *htim);
   

   • htim: Con trỏ đến biến kiểu TIM_HandleTypeDef của timer bạn muốn bắt đầu và kích hoạt chế độ ngắt.
4. HAL_TIM_Base_Stop_IT(): Hàm này được sử dụng để dừng đếm thời gian và ngắt kích hoạt chế độ.

   HAL_StatusTypeDef HAL_TIM_Base_Stop_IT(TIM_HandleTypeDef *htim);
   

   • htim: Con trỏ đến biến kiểu TIM_HandleTypeDef của timer bạn muốn dừng và ngắt kích hoạt chế độ.
5. HAL_TIM_PWM_Start(): Hàm này được sử dụng để bắt đầu sử dụng chế độ PWM trên timer.

   HAL_StatusTypeDef HAL_TIM_PWM_Start(TIM_HandleTypeDef *htim, uint32_t Channel);
   

   • htim: Con trỏ đến biến kiểu TIM_HandleTypeDef của timer bạn muốn bắt đầu PWM.
   • Channel: Kênh PWM bạn muốn sử dụng.
6. HAL_TIM_PWM_Stop(): Hàm này được sử dụng để dừng chế độ PWM trên timer.

   HAL_StatusTypeDef HAL_TIM_PWM_Stop(TIM_HandleTypeDef *htim, uint32_t Channel);
   

   • htim: Con trỏ đến biến kiểu TIM_HandleTypeDef của timer bạn muốn dừng PWM.
   • Channel: Kênh PWM bạn muốn dừng.
7. __HAL_TIM_SET_COMPARE(): Hàm này được sử dụng để đặt giá trị so sánh cho bộ so sánh của timer.

   void __HAL_TIM_SET_COMPARE(TIM_HandleTypeDef* htim, uint32_t Channel, uint32_t Compare);
   

   • htim: Con trỏ đến biến kiểu TIM_HandleTypeDef của timer bạn muốn cấu hình.
   • Channel: Kênh bạn muốn cấu hình.
   • Compare: Giá trị so sánh bạn muốn đặt.
8. __HAL_TIM_GET_COMPARE(): Hàm này được sử dụng để đọc giá trị so sánh hiện tại từ bộ so sánh của timer.

   uint32_t __HAL_TIM_GET_COMPARE(TIM_HandleTypeDef* htim, uint32_t Channel);
   

   • htim: Con trỏ đến biến kiểu TIM_HandleTypeDef của timer bạn muốn đọc.
   • Channel: Kênh bạn muốn đọc.
9. HAL_TIM_PeriodElapsedHalfCpltCallback(): Hàm callback này được gọi tự động khi nửa chu kỳ đếm của timer kết thúc.

   __weak void HAL_TIM_PeriodElapsedHalfCpltCallback(TIM_HandleTypeDef *htim);
   

10. HAL_TIM_PeriodElapsedCallback(): Hàm callback này được gọi tự động khi một chu kỳ đếm của timer kết thúc.

    __weak void HAL_TIM_PeriodElapsedCallback(TIM_HandleTypeDef *htim);