ESP32 KY-017 Mercury Tilt Switch Module

🛠️ KY-017 Mercury Tilt Switch 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 Sensor

⚠️ False Triggering

💻 Code Examples

Below you can find code examples of KY-017 Mercury Tilt Switch Module with ESP32 in several frameworks:

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

If you encounter issues while using the KY-017 Mercury Tilt Switch Module, check the Common Issues Troubleshooting Guide.

ESP32 KY-017 Arduino IDE Code Example

Example in Arduino IDE

Fill in your main Arduino IDE sketch file with the following code to use the KY-017 Mercury Tilt Switch Module:

int tiltPin = 10; // Tilt sensor connected to digital pin 10
int ledPin = 13;  // LED connected to digital pin 13
int sensorValue = 0;

void setup() {
    pinMode(tiltPin, INPUT);
    pinMode(ledPin, OUTPUT);
    Serial.begin(9600);
    Serial.println("KY-017 Tilt Sensor Test");
}

void loop() {
    sensorValue = digitalRead(tiltPin);
    if (sensorValue == LOW) {
        digitalWrite(ledPin, HIGH);
        Serial.println("Tilt detected");
    } else {
        digitalWrite(ledPin, LOW);
    }
    delay(1000);
}

This Arduino code sets up the KY-017 tilt sensor on digital pin 10 and an LED on digital pin 13. When the sensor detects a tilt (sensor output is LOW), the LED lights up, and a message is printed to the serial monitor. The status is checked every second.

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-017 ESP-IDF Code Example

Example in Espressif IoT Framework (ESP-IDF)

If you're using ESP-IDF to work with the KY-017 Mercury Tilt Switch 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 TILT_SENSOR_PIN GPIO_NUM_4
#define LED_PIN GPIO_NUM_2

void app_main(void) {
    gpio_config_t io_conf = {
        .pin_bit_mask = (1ULL << TILT_SENSOR_PIN) | (1ULL << LED_PIN),
        .mode = GPIO_MODE_INPUT_OUTPUT,
        .pull_up_en = GPIO_PULLUP_ENABLE,
        .pull_down_en = GPIO_PULLDOWN_DISABLE,
        .intr_type = GPIO_INTR_DISABLE
    };
    gpio_config(&io_conf);

    printf("KY-017 Tilt Sensor Test\n");

    while (1) {
        int sensor_value = gpio_get_level(TILT_SENSOR_PIN);
        if (sensor_value == 0) {
            gpio_set_level(LED_PIN, 1);
            printf("Tilt detected\n");
        } else {
            gpio_set_level(LED_PIN, 0);
        }
        vTaskDelay(pdMS_TO_TICKS(1000));
    }
}

This ESP-IDF code configures GPIO4 as an input for the KY-017 tilt sensor and GPIO2 as an output for an LED. When the sensor detects a tilt (sensor output is LOW), the LED turns on, and a message is printed to the console. The status is checked every second.

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-017 ESPHome Code Example

Example in ESPHome (Home Assistant)

Fill in this configuration in your ESPHome YAML configuration file (example.yml) to integrate the KY-017 Mercury Tilt Switch Module

binary_sensor:
  - platform: gpio
    pin:
      number: GPIO4
      mode: INPUT_PULLUP
    name: "KY-017 Tilt Sensor"
    filters:
      - delayed_on: 50ms
      - delayed_off: 50ms
    on_press:
      - then:
          - lambda: |-
              ESP_LOGD("sensor", "Tilt detected!");

This ESPHome configuration sets up the KY-017 mercury tilt switch as a binary sensor on GPIO4. The internal pull-up resistor is enabled, and debounce filtering is applied to prevent false triggering. When the sensor detects a tilt, a log message is generated.

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

ESP32 KY-017 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-017 PlatformIO Example Code

Write this code in your PlatformIO project under the src/main.cpp file to use the KY-017 Mercury Tilt Switch Module:

#include <Arduino.h>

#define TILT_SENSOR_PIN 4
#define LED_PIN 2

void setup() {
    pinMode(TILT_SENSOR_PIN, INPUT_PULLUP);
    pinMode(LED_PIN, OUTPUT);
    Serial.begin(115200);
    Serial.println("KY-017 Tilt Sensor Test");
}

void loop() {
    if (digitalRead(TILT_SENSOR_PIN) == LOW) {
        Serial.println("Tilt detected");
        digitalWrite(LED_PIN, HIGH);
    } else {
        digitalWrite(LED_PIN, LOW);
    }
    delay(1000);
}

This PlatformIO code configures GPIO4 as an input with an internal pull-up resistor for the KY-017 tilt sensor. GPIO2 is used to control an LED. When the sensor detects a tilt (output is LOW), 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-017 MicroPython Code Example

Example in Micro Python Framework

Fill in this script in your MicroPython main.py file (main.py) to integrate the KY-017 Mercury Tilt Switch Module with your ESP32.

import machine
import time

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

while True:
    if TILT_SENSOR_PIN.value() == 0:
        print("Tilt detected")
        LED_PIN.on()
    else:
        LED_PIN.off()
    time.sleep(1)

This MicroPython script configures GPIO4 as an input with a pull-up resistor for the KY-017 tilt sensor. GPIO2 controls an LED. When a tilt is detected (sensor output is LOW), 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.