ESP32 KY-003 Hall Magnetic Sensor Module

🛠️ KY-003 Hall Magnetic Sensor Module Troubleshooting

This guide outlines a systematic approach to troubleshoot and resolve common problems with the . Start by confirming that the hardware connections are correct, as wiring mistakes are the most frequent cause of issues. If you are sure the connections are correct, follow the below steps to debug common issues.

❌ No Response from KY-003 Module

⚠️ False Triggering of Magnetic Detection

💻 Code Examples

Below you can find code examples of KY-003 Hall Magnetic Sensor Module with ESP32 in several frameworks:

• Arduino IDE
• ESP-IDF
• ESPHome
• PlatformIO
• MicroPython

If you encounter issues while using the KY-003 Hall Magnetic Sensor Module, check the Common Issues Troubleshooting Guide.

ESP32 KY-003 Arduino IDE Code Example

Example in Arduino IDE

Fill in your main Arduino IDE sketch file with the following code to use the KY-003 Hall Magnetic Sensor Module:

#define HALL_SENSOR_PIN 7
#define LED_PIN 13

void setup() {
    pinMode(HALL_SENSOR_PIN, INPUT);
    digitalWrite(HALL_SENSOR_PIN, HIGH); // Enable internal pull-up resistor
    pinMode(LED_PIN, OUTPUT);
    Serial.begin(9600);
    Serial.println("KY-003 Hall Magnetic Sensor Test");
}

void loop() {
    int sensorValue = digitalRead(HALL_SENSOR_PIN);
    if (sensorValue == LOW) {
        Serial.println("Magnetic field detected");
        digitalWrite(LED_PIN, HIGH);
    } else {
        Serial.println("No magnetic field detected");
        digitalWrite(LED_PIN, LOW);
    }
    delay(1000);
}

This Arduino code sets up the KY-003 Hall Magnetic Sensor on pin 7 and an LED on pin 13. When a magnetic field is detected, the sensor outputs a LOW signal, triggering the LED to turn on and a message to be printed to the serial monitor.

Connect your ESP32 to your computer via a USB cable, Ensure the correct Board and Port are selected under Tools, Click the "Upload" button in the Arduino IDE to compile and upload the code to your ESP32.

ESP32 KY-003 ESP-IDF Code Example

Example in Espressif IoT Framework (ESP-IDF)

If you're using ESP-IDF to work with the KY-003 Hall Magnetic Sensor Module, here's how you can set it up and read data from the sensor. Fill in this code in the main ESP-IDF file:

#include <stdio.h>
#include "freertos/FreeRTOS.h"
#include "freertos/task.h"
#include "driver/gpio.h"

#define HALL_SENSOR_PIN GPIO_NUM_4
#define LED_PIN GPIO_NUM_2

void app_main(void) {
    gpio_set_direction(HALL_SENSOR_PIN, GPIO_MODE_INPUT);
    gpio_set_pull_mode(HALL_SENSOR_PIN, GPIO_PULLUP_ONLY);
    gpio_set_direction(LED_PIN, GPIO_MODE_OUTPUT);
    printf("KY-003 Hall Magnetic Sensor Test\n");
    while (1) {
        int sensor_value = gpio_get_level(HALL_SENSOR_PIN);
        if (sensor_value == 0) {
            printf("Magnetic field detected\n");
            gpio_set_level(LED_PIN, 1);
        } else {
            printf("No magnetic field detected\n");
            gpio_set_level(LED_PIN, 0);
        }
        vTaskDelay(pdMS_TO_TICKS(1000));
    }
}

This ESP-IDF code configures GPIO4 as an input for the KY-003 Hall Magnetic Sensor and GPIO2 as an output for an LED. When a magnetic field is detected (sensor outputs LOW), the LED turns on, and a message is printed to the console.

Update the I2C pins (I2C_MASTER_SDA_IO and I2C_MASTER_SCL_IO) to match your ESP32 hardware setup, Use idf.py build to compile the project, Use idf.py flash to upload the code to your ESP32.

ESP32 KY-003 ESPHome Code Example

Example in ESPHome (Home Assistant)

Fill in this configuration in your ESPHome YAML configuration file (example.yml) to integrate the KY-003 Hall Magnetic Sensor Module

binary_sensor:
  - platform: gpio
    pin:
      number: GPIO4
      mode: INPUT_PULLUP
    name: "KY-003 Hall Magnetic Sensor"
    filters:
      - delayed_on: 10ms
      - delayed_off: 10ms
    on_press:
      - then:
          - lambda: |-
              ESP_LOGD("sensor", "Magnetic field detected!");

This ESPHome configuration sets up the KY-003 Hall Magnetic Sensor as a binary sensor on GPIO4 with an internal pull-up resistor. It applies filtering to debounce false triggers and logs when a magnetic field is detected.

Upload this code to your ESP32 using the ESPHome dashboard or the esphome run command.

ESP32 KY-003 PlatformIO Code Example

Example in PlatformIO Framework

For PlatformIO, make sure to configure the platformio.ini file with the appropriate environment and libraries, and then proceed with the code.

Configure platformio.ini

First, your platformio.ini should look like below. You might need to include some libraries as shown. Make sure to change the board to your ESP32:

[env:esp32]
platform = espressif32
board = esp32dev
framework = arduino

ESP32 KY-003 PlatformIO Example Code

Write this code in your PlatformIO project under the src/main.cpp file to use the KY-003 Hall Magnetic Sensor Module:

#include <Arduino.h>

#define HALL_SENSOR_PIN 4
#define LED_PIN 2

void setup() {
    pinMode(HALL_SENSOR_PIN, INPUT_PULLUP);
    pinMode(LED_PIN, OUTPUT);
    Serial.begin(115200);
    Serial.println("KY-003 Hall Magnetic Sensor Test");
}

void loop() {
    if (digitalRead(HALL_SENSOR_PIN) == LOW) {
        Serial.println("Magnetic field detected");
        digitalWrite(LED_PIN, HIGH);
    } else {
        Serial.println("No magnetic field detected");
        digitalWrite(LED_PIN, LOW);
    }
    delay(1000);
}

This PlatformIO code configures the KY-003 Hall Magnetic Sensor on GPIO4 and an LED on GPIO2. When a magnetic field is detected, the LED turns on, and a message is printed to the serial monitor.

Upload the code to your ESP32 using the PlatformIO "Upload" button in your IDE or the pio run --target upload command.

ESP32 KY-003 MicroPython Code Example

Example in Micro Python Framework

Fill in this script in your MicroPython main.py file (main.py) to integrate the KY-003 Hall Magnetic Sensor Module with your ESP32.

import machine
import time

HALL_SENSOR_PIN = machine.Pin(4, machine.Pin.IN, machine.Pin.PULL_UP)
LED_PIN = machine.Pin(2, machine.Pin.OUT)

while True:
    if HALL_SENSOR_PIN.value() == 0:
        print("Magnetic field detected")
        LED_PIN.on()
    else:
        print("No magnetic field detected")
        LED_PIN.off()
    time.sleep(1)

This MicroPython script configures the KY-003 Hall Magnetic Sensor on GPIO4 and an LED on GPIO2. When a magnetic field is detected (LOW signal), the LED turns on, and a message is printed to the console.

Upload this code to your ESP32 using a MicroPython-compatible IDE, such as Thonny, uPyCraft, or tools like ampy.