skills.rest
JasonYANG170
JasonYANG170COMMUNITY
Explore all skills by this author →
WebsiteGitHub

esp-insights-skill

Integrates and configures ESP-Insights remote diagnostics in ESP-IDF firmware projects.

28|3|Updated Jun 24, 2026
Search Tags:#embedded#esp32#telemetry#esp-idf#core dump#remote diagnostics#esp-insights
One-click install
npx skills add https://github.com/JasonYANG170/esp-dev-skill --skill esp-insights-skill-jasonyang170
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: esp-insights-skill
Source: https://github.com/JasonYANG170/esp-dev-skill/tree/main/repos/esp-insights
Command: npx skills add https://github.com/JasonYANG170/esp-dev-skill --skill esp-insights-skill-jasonyang170

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Integrating ESP-Insights remote diagnostics into an ESP32 firmware project involves many failure-prone details: HTTPS auth keys, MQTT claiming, core dump partitions, metadata 1.0 vs 2.0 API differences, and RTC data store sizing. This Skill grounds every API, Kconfig symbol, and code snippet in the real esp-insights repository so the AI generates correct integration code instead of hallucinated calls. ## Core Features & Use Cases - Scenario Recipes: Ten step-by-step recipes covering HTTPS quickstart, MQTT transport with RainMaker claiming, custom transports, log capture, core dump reporting, custom metrics/variables, system metrics, data store tuning, and runtime control. - Grounded API & Config Reference: Real function signatures grouped by header (esp_insights, esp_diagnostics, metrics, variables, data store) plus the full Kconfig symbol list from the three components. - Pitfall Prevention: Fourteen documented pitfalls with wrong/correct code pairs, such as missing auth key embedding, incorrect metadata version API usage, and missing coredump partitions. - Use Case: A developer asks the AI to add crash reporting to an ESP32-S3 project; the Skill guides it to enable coredump-to-flash with ELF format, add the coredump partition, and upload the firmware zip to the dashboard. ## Quick Start Ask the AI to integrate ESP-Insights over HTTPS into your ESP-IDF project and it will follow the https_quickstart recipe to produce the initialization code, sdkconfig defaults, and partition table.

Frequently Asked Questions about esp-insights-skill

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I integrate ESP-Insights into an ESP-IDF project?▼

Add the espressif/esp_insights dependency in idf_component.yml, enable CONFIG_ESP_INSIGHTS_ENABLED, then call esp_insights_init with a config struct after NVS, network, and event loop initialization. For HTTPS transport you must also embed an auth key file via target_add_binary_data.

How do I enable core dump reporting with ESP-Insights?▼

Enable coredump-to-flash with ELF data format in Kconfig, add a coredump partition to your custom partition table, and keep CONFIG_ESP_INSIGHTS_COREDUMP_ENABLE on. After a crash, the next boot uploads a summary with PC, cause, registers, and backtrace, then erases it from flash.

What is the difference between ESP-Insights metadata 1.0 and 2.0 APIs?▼

Metadata 1.0 (CONFIG_ESP_INSIGHTS_META_VERSION_10=y) uses key-only add_* functions like esp_diag_metrics_add_uint. Version 2.0 uses tag plus key with report_* functions like esp_diag_metrics_report_uint. Mixing them causes link errors, and migrating to 2.0 hides old metric data.

Does ESP-Insights support ESP-IDF 4.x or non-ESP32 chips?▼

ESP-IDF 4.x is only supported through the idf_4_x_compat branch or registry version 1.2.x; the main branch requires ESP-IDF v5.1 or later. It only works on ESP32 family chips because it depends on ESP-IDF and RTC memory.

Why are my error logs not showing on the ESP-Insights dashboard?▼

The most common cause is setting Default log verbosity to No output, which removes ESP_LOGE and ESP_LOGW at compile time along with the diagnostics hook. Set verbosity to Warning or higher, or set the console output channel to None while keeping log verbosity enabled.

When should I use MQTT instead of HTTPS for ESP-Insights?▼

Use MQTT when your project already uses ESP RainMaker, since Insights can reuse the existing MQTT connection and save a separate TLS session. MQTT requires RainMaker claiming via the CLI and an fctry partition, and it is the only transport that supports command-response remote control.

Related Skills

Explore More Software Engineering Skills→
laurigateslaurigates
6

esp-idf-setup

Set up ESP-IDF environments, create ESP32 projects, and configure CMake build files.

Community
Intermediate
Ivanblancoinusual-2106Ivanblancoinusual-2106

ruview-hardware-setup

Automate firmware build, flashing, WiFi provisioning, and serial monitoring for RuView CSI nodes.

Community
Advanced
armoin2018armoin2018
4

ailey-tools-esp-manager

Automate ESP32/ESP8266 device lifecycle management across USB and network connections.

Community
Advanced
clawperatorclawperator
2

evals-live-run

Orchestrate repeatable live-device skill evaluations and controlled debugging sessions.

Official
Intermediate