aranet4-mcp-server

by diegobit

226 downloads
Not rated
GitHub

About

SImple MCP server to manage your aranet4 device and local db.

Details

Author
diegobit
Downloads
226
Categories
Other

- Scan for nearby Aranet4 devices via Bluetooth
- Fetch and store measurement history in a local SQLite database
- Query recent data or data within a specific time range
- Generate plots for MCP clients that support images
- Assisted configuration via the init aranet4 command

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

  1. Download and install Highlight from highlightai.com/download
  2. Navigate to the plugins tab and select "Add Custom Plugin"
  3. Configure the plugin with the settings below
    Plugin Name aranet4-mcp-server
    Command (node, npx, python, etc.)

    Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.

  4. Enable "Start Automatically" if you want the plugin to start when Highlight launches

From the repository

Clone the repository, prepare the environment (recommended with uv, alternative with pip install .), and add the server to your MCP client configuration (e.g., Claude Desktop or Cursor). After installation, start your client and ask init aranet4 for guided configuration, or manually edit config.yaml with the device's MAC address. Use the fetch_new_data tool to update the database, and query data with get_recent_data or get_data_by_timerange. Optionally, set up a cron job or LaunchAgent for automatic periodic fetching.

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

{
    "mcpServers": {
        "aranet4-mcp-server": {
            "aranet4": {
                "command": "{{PATH_TO_UV}}",
                "args": [
                    "--directory",
                    "{{PATH_TO_SRC}}/aranet4-mcp-server/",
                    "run",
                    "src/server.py"
                ]
            }
        }
    }
}

McpServers

{
    "aranet4": {
        "command": "{{PATH_TO_UV}}",
        "args": [
            "--directory",
            "{{PATH_TO_SRC}}/aranet4-mcp-server/",
            "run",
            "src/server.py"
        ]
    }
}

aranet4-mcp-server

MCP server to manage your Aranet4 CO2 sensor. Built upon Aranet4-Python.

> [!TIP]
> For the standalone python version without MCP logic, see aranet4-archiver.

Example screenshot of the Aranet4 MCP Server running

Features:

- Scan for nearby devices. - Fetch new data from embedded device memory and save to a local sqlite db for tracking and later viewing. For automatic updates, see at the bottom. - Ask questions about recent measurements or about a specific past date. - [For MCP clients that support images] Ask data to be plotted to also have a nice visualization! - Assisted configuration! πŸ’« After installation, just ask init aranet4 in your client to set up everything for the mcp server to work with your device.

Installation

1. Clone repo:

    git clone git@github.com:diegobit/aranet4-mcp-server.git
    cd aranet4-mcp-server
    

2. Prepare environment:

- Recommended (with uv): Nothing to do. The provided pyproject.toml handles dependencied and virtual environments.
- Alternative (with pip): install with
pip install .

3. Add to MCP client configuration:

    "aranet4": {
      "command": "{{PATH_TO_UV}}", // run which uv
        "args": [
          "--directory",
          "{{PATH_TO_SRC}}/aranet4-mcp-server/",
          "run",
          "src/server.py"
        ]
    }
    

- Claude Desktop MacOS config file path: ~/Library/Application Support/Claude/claude_desktop_config.json
- Cursor MacOS config file path:
~/.cursor/mcp.json

4. Configure:

- Recommended (AI assisted config!): start your client and ask init aranet4 to get a guided configuration.
- Alternative (manual): edit file
config.yaml. You need to provide the mac address and the device name. You can get the mac address with aranetctl --scan from Aranet4-Python (installed with this repo dependencies).

Dockerfile

Dockerfile is available. Remember to pass env variables or update config.yaml.

List of tools

Configuration and utils:
-
init_aranet4_config: assisted configuration of device.
-
scan_devices: scan nearby bluetooth aranet4 devices.
-
get_configuration_and_db_stats: get current config.yaml and general stats from the local sqlite3 db.
-
set_configuration: set values in config.yaml.

To update historical data:
-
fetch_new_data: fetch new data from configured nearby aranet4 device and save to local db.

To query historical data:
-
get_recent_data: get recent data from local db. Can specify how many measurements.
-
get_data_by_timerange: get data in specific timerange from local db. Can specify how many measurements (careful, if the range is big and the limit is low, datapoints will be skipped).

For both, ask to receive a plot to have it generated and displayed.

Automatic data fetch job

If you want your local db to always be updated, you can setup a cronjob or a launch agent that fetches data automatically every few hours. In MacOS, do as follows:

1. Configure absolute paths in com.diegobit.aranet4-fetch.plist.
2. Install LaunchAgent:

   cp com.diegobit.aranet4-fetch.plist ~/Library/LaunchAgents/
launchctl load ~/Library/LaunchAgents/com.diegobit.aranet4-fetch.plist

For other platforms, just run fetch-job.py` periodically however you prefer.

No reviews yet β€” be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.