Echonetlite

npm version License: MIT Node >= 18 TypeScript

An MCP (Model Context Protocol) server for ECHONETLite home automation — control air conditioners, discover devices, and read sensors via the Model Context Protocol.

ECHONETLite is a Japanese IoT protocol widely used in smart home devices, particularly HVAC systems by major manufacturers like Daikin, Panasonic, Mitsubishi Electric, and Toshiba.

Features

• 🌡️ Real-time HVAC monitoring — temperature, humidity, operating status
• ❄️ Full climate control — mode, fan speed, airflow direction, swing
• 🔍 Network device discovery — find ECHONETLite devices via multicast UDP
• 🔬 Node Profile probing — discover manufacturer, product code, UID, and all EOJ instances on any device
• ⚡ Real-time notifications — async updates from device multicast listeners
• 📖 MRA enrichment — Machine Readable Index integration for property names, descriptions, and value decoding
• 🔬 EPC introspection — query property maps (STATMAP/SETMAP/GETMAP) with MRA-based names
• 🏷️ Human-readable values — raw EPC values decoded to human-friendly format using MRA definitions
• 🧩 EPC element parsing — parse complex object/array-type EPC values into named elements with MRA definitions
• 🎯 Multi-EPC queries — query multiple EPC codes in a single request
• 🔧 Generic EOJ support — set/query any ECHONETLite object by group/class/instance codes
• 📦 TypeScript-first — full type definitions included
• 🔌 MCP compatible — works with any MCP client (Claude Desktop, LM Studio, VS Code extensions, etc.)

Prerequisites

• Node.js 18+
• An ECHONETLite-compatible device on the same local network

Installation

npm install echonetlite-mcp

Or use it as an MCP server directly:

git clone https://github.com/scottyphillips/echonetlite-mcp.git
cd echonetlite-mcp
npm install
npm run build

Configuration

The server defaults to communicating with a device at 192.168.1.6 on UDP port 3610, using multicast address 224.0.23.0:3610 for discovery and notifications.

Setting the Default Device IP

Option A: Environment variable (recommended)

# Windows CMD
set ECHONET_DEFAULT_HOST=192.168.1.10 && node dist/index.js

# PowerShell
$env:ECHONET_DEFAULT_HOST="192.168.1.10"; node dist/index.js

# Linux/macOS
ECHONET_DEFAULT_HOST=192.168.1.10 node dist/index.js

Option B: Edit config.ts

export const DEFAULT_HOST = '192.168.1.10';  // Change to your device IP

Lite Mode (Restricted Tool Set)

Enable Lite Mode to restrict exposed tools to a minimal subset. In lite mode, only these 6 tools are available:

Tool	Description
discover_devices	Discover all ECHONETLite devices on the local network
discover_nodes	Active Node Profile probing of a specific device
set_epc	Generic EPC setter for any EOJ instance
get_property_maps	Query STATMAP/SETMAP/GETMAP with MRA names
query_epc	Query EPC codes from device with decoded values
get_epc_definition	Get MRA definition for EPC codes without querying

All HVAC-specific tools (get_device_status, set_operation, set_temperature, etc.) are hidden in lite mode.

Enable Lite Mode:

# Windows CMD
set ECHONET_LITE_MODE=true && node dist/index.js

# PowerShell
$env:ECHONET_LITE_MODE="true"; node dist/index.js

# Linux/macOS
ECHONET_LITE_MODE=true node dist/index.js

When lite mode is enabled, the server logs (Mode: LITE) on startup. When disabled (default), it logs (Mode: FULL) with all tools available.

Per-Tool Override

Every tool accepts an optional host parameter to override the default for that specific call:

{ "name": "get_device_status", "arguments": { "host": "192.168.1.20" } }

Running the Server

# Build first
npm run build

# Run (stdio transport)
node dist/index.js

The server communicates via stdio, making it compatible with any MCP client.

Integration with AI Clients

Claude Desktop

Add to your Claude Desktop MCP configuration (claude_desktop_config.json):

{
  "mcpServers": {
    "echonetlite": {
      "command": "node",
      "args": ["/path/to/echonetlite-mcp/dist/index.js"],
      "env": {
        "ECHONET_DEFAULT_HOST": "192.168.1.6"
      }
    }
  }
}

LM Studio

LM Studio supports MCP servers via stdio transport. Create or edit the MCP config file:

Windows: %APPDATA%\lm-studio\mcp_config.json macOS/Linux: ~/.config/lm-studio/mcp_config.json

{
  "mcpServers": {
    "echonetlite-mcp": {
      "command": "node",
      "args": ["C:\\path\\to\\echonetlite-mcp\\dist/index.js"],
      "env": {
        "ECHONET_DEFAULT_HOST": "192.168.1.6"
      }
    }
  }
}

VS Code MCP Extension

Configure in your VS Code MCP extension settings:

{
  "mcp.servers": [
    {
      "name": "echonetlite",
      "command": "node",
      "args": ["/path/to/echonetlite-mcp/dist/index.js"],
      "env": {
        "ECHONET_DEFAULT_HOST": "192.168.1.6"
      }
    }
  ]
}

Available Tools

Note: When ECHONET_LITE_MODE=true, only discover_devices, discover_nodes, set_epc, get_property_maps, query_epc, and get_epc_definition are available.

Device Discovery

Tool	Description	Parameters
discover_devices	Discover all ECHONETLite devices on the local network via multicast	timeout (optional) - Discovery timeout in ms (default: 3000)
discover_nodes	Active Node Profile probing of a specific device — discovers manufacturer, product code, UID, and all EOJ instances with MRA enrichment	host (required), timeout (optional)

HVAC Control (Full Mode Only)

Tool	Description	Parameters
get_device_status	Get full status of the HVAC device	host (optional) - IP address
set_operation	Turn HVAC ON or OFF	host, operation ("on" / "off")
set_operating_mode	Set operating mode	host, mode ("auto" / "cool" / "heat" / "dry" / "fan_only")
set_temperature	Set target temperature	host, temperature (0-50°C)
set_fan_speed	Set air flow rate	host, speed ("auto" / "level1"-"level8")
set_airflow_vertical	Set vertical vane position	host, position ("upper" / "upper-central" / "central" / "lower-central" / "lower")
set_airflow_horizontal	Set horizontal vane position	host, position (28 positions: rc-right, left-lc, lc-center-rc, ...)
set_swing_mode	Set swing mode function	host, mode ("not-used" / "vert" / "horiz" / "vert-horiz")
set_auto_direction	Set automatic direction mode	host, mode ("auto" / "non-auto" / "auto-vert" / "auto-horiz")
set_silent_mode	Set silent operation mode	host, mode ("normal" / "high-speed" / "silent")
set_power_saving	Set power-saving mode	host, state ("saving" / "normal")

Sensor Readings (Full Mode Only)

Tool	Description	Parameters
get_temperatures	Get room + outdoor temperatures	host (optional) - IP address
get_humidity	Get room humidity	host (optional) - IP address

EPC Introspection & MRA Lookup (Available in All Modes)

Tool	Description	Parameters
get_property_maps	Query STATMAP/SETMAP/GETMAP with MRA-based property names and descriptions	host, eojgc, eojcc, eojInstance (all optional)
query_epc	Query one or more EPC codes from device, returns raw + human-readable decoded values	epcs (required), host, eojgc, eojcc, eojInstance (all optional)
get_epc_definition	Get MRA definition for EPC codes without querying the device — includes enum values, bitmaps, level ranges, $ref-resolved definitions	epcs (required), host, eojgc, eojcc, eojInstance (all optional)
set_epc	Generic EPC setter — set any writable property on any EOJ instance by hex value	host, eojgc, eojcc, eojInstance, epc, value
parse_epc_elements	Parse object/array-type EPC values into named elements with raw hex bytes per element — use after querying EPC data (e.g., 0xE2) to get structured breakdown	epc (required), rawHex (required), host, eojgc, eojcc, eojInstance, propertyName, shortName (all optional)

Available Resources

Resource URI	Description
device://status	Current HVAC status (updated via async notifications from multicast listener)
device://capabilities	Device property map (GETMAP, SETMAP, NTFMAP)

EPC Reference Table

EPC	Property	Access	Values
0x80	Operation status	Set/Get	0x30=ON, 0x31=OFF
0x8F	Power-saving operation	Set/Get	Saving/Normal
0xA0	Air flow rate (fan speed)	Set/Get	Auto=0x41, Levels=0x31-0x38
0xA1	Automatic airflow direction	Set/Get	Auto/Non-auto/Auto-vert/Auto-horiz
0xA3	Air swing mode	Set/Get	Not-used/Vert/Horiz/Vert-horiz
0xA4	Airflow direction (vertical)	Set/Get	Upper/Upper-central/Central/Lower-central/Lower
0xA5	Airflow direction (horizontal)	Set/Get	28 positions (rc-right, left-lc, center, etc.)
0xB0	Operation mode	Set/Get	Auto=0x41, Cool=0x42, Heat=0x43, Dry=0x44, Fan-only=0x45
0xB1	Automatic temperature control	Set/Get	—
0xB2	Normal/High-speed/Silent operation	Set/Get	—
0xB3	Set temperature	Set/Get	0-50°C (signed int)
0xB4	Set humidity in dehumidifying mode	Set/Get	—
0xBA	Room relative humidity	Get	Percentage
0xBB	Room temperature	Get	-127 to 125°C (signed int)
0xBE	Outdoor air temperature	Get	Signed int
0xC0	Ventilation function	Set/Get	—
0xC1	Humidifier function	Set/Get	—
0xCC	Special function setting	Set/Get	Clothes dryer, Mite/mold control, etc.
0xCF	Air purification mode	Set/Get	—
0x9D	STATMAP (access capability)	Get	Property access map
0x9E	SETMAP (settable properties)	Get	Settable property map
0x9F	GETMAP (readable properties)	Get	Readable property map

Example Prompts

Try these natural language prompts with your MCP client:

• "Turn on my air conditioner" → calls set_operation with operation="on" (Full Mode)
• "Set temperature to 23 degrees" → calls set_temperature with temperature=23
• "Switch to cooling mode" → calls set_operating_mode with mode="cool"
• "What are the current temperatures?" → calls get_temperatures
• "Find all ECHONET devices on my network" → calls discover_devices
• "Set fan speed to level 3" → calls set_fan_speed with speed="level3"
• "What EPC codes can I query on this device?" → calls get_property_maps
• "Get the current operation status and target temperature" → calls query_epc with epcs=["0x80", "0xB3"]
• "What settings are available for operating mode?" → calls get_epc_definition with epcs=["0xB0"]
• "Discover all nodes on 192.168.1.6" → calls discover_nodes with full MRA enrichment
• "Parse the EPC 0xE2 value 0x00 0x0A 0xFF 0xFF for EOJ 0x02 0x88 0x01" → calls parse_epc_elements to split raw bytes into named elements

Project Structure

echonetlite-mcp/
├── src/
│   ├── index.ts              # MCP server entry point & tool definitions (~1200 lines)
node dist/index.js

MRA Integration

This server includes full MRA (Machine Readable Index) data integration:

• Property names & descriptions — human-readable labels for each EPC code from MRA definitions
• Value decoding — raw hex values decoded to meaningful strings/numbers using MRA type schemas
• Enum/bitmap support — full enumeration of possible values with $ref resolution
• Level ranges & number formats — signed/unsigned integers, fixed-point decimals
• $ref resolution — external definition references from definitions.json resolved automatically
• MRA enrichment in all tools — query_epc, get_property_maps, get_epc_definition return enriched responses

The MRA data enables intelligent discovery of what settings are available for any EPC code without needing to query the device first.

References

• ECHONETLite Standard Spec
• MCP Specification
• node-echonet-lite
• pychonet

License

MIT License — see LICENSE for details.

Support

For issues, questions, or contributions, please open an issue on GitHub.

Buy Me A Coffee