EMQX 企业版

https://docs.emqx.com/zh/emqx/v6.0/
Admin
EMQX 企业版是一款大规模分布式物联网接入平台和高性能、可扩展的 MQTT 消息服务器，为物联网应用提供可靠的实时消息传输、设备连接解决方案，并支持海量数据处理、集成与路由。
Tokens:429,620
Snippets:4,426
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Clone and Navigate to Example Repository

Source: https://docs.emqx.com/zh/emqx/v6.0/deploy/cluster/lb-nginx.html

Initial setup steps to access the NGINX load balancing example configuration.

```bash
git clone https://github.com/emqx/emqx-usage-example
cd emqx-usage-example/mqtt-lb-nginx
```

--------------------------------

### Start Docker Compose Environment

Source: https://docs.emqx.com/zh/emqx/v6.0/deploy/cluster/lb-nginx.html

Launches the EMQX and NGINX containers defined in the example configuration.

```bash
docker compose up -d
```

--------------------------------

### Compile and Install NGINX

Source: https://docs.emqx.com/zh/emqx/v6.0/deploy/cluster/lb-nginx.html

Build the NGINX binary and install it to the system path.

```bash
make
sudo make install
sudo ln -s /usr/local/nginx/sbin/nginx /usr/local/bin/nginx
```

--------------------------------

### Install Dependencies

Source: https://docs.emqx.com/zh/emqx/v6.0/emqx-ai/sdks/mcp-sdk-python.html

Install the required MCP SDK and CLI tools using uv.

```bash
uv add git+https://github.com/emqx/mcp-python-sdk --branch main
uv add "mcp[cli]"
```

--------------------------------

### HTTP GET Configuration Example

Source: https://docs.emqx.com/zh/emqx/v6.0/access-control/authz/http.html

Example configuration for using the GET method for authorization.

```hcl
{
    type = http

    method = get
    url = "http://127.0.0.1:8080/authz"
    body {
        clientid = "${clientid}"
        username = "${username}"
        topic = "${topic}"
        action = "${action}"
    }
    headers {
        "X-Request-Source" = "EMQX"
    }
}
```

--------------------------------

### Subscribing to MQTT Topics

Source: https://docs.emqx.com/zh/emqx/v6.0/performance/benchmark-emqtt-bench.html

Example of starting 500 connections, each subscribing to topic 't' with QoS 0.

```bash
./emqtt_bench sub -t t -h emqx-server -c 500
```

--------------------------------

### HTTP POST Configuration Example

Source: https://docs.emqx.com/zh/emqx/v6.0/access-control/authz/http.html

Example configuration for using the POST method for authorization.

```hcl
{
    type = http

    method = post
    url = "http://127.0.0.1:8080/authz?clientid=${clientid}"
    body {
        username = "${username}"
        topic = "${topic}"
        action = "${action}"
    }
    headers {
        "Content-Type" = "application/json"
        "X-Request-Source" = "EMQX"
    }
}
```

--------------------------------

### Establishing MQTT Connections

Source: https://docs.emqx.com/zh/emqx/v6.0/performance/benchmark-emqtt-bench.html

Example of initiating 1000 concurrent MQTT connections to the server.

```bash
./emqtt_bench conn -h emqx-server -c 1000
```

--------------------------------

### 开启重平衡 CLI 命令

Source: https://docs.emqx.com/zh/emqx/v6.0/deploy/cluster/rebalancing.html

使用 rebalance start 命令启动集群负载重平衡任务，支持配置节点列表及各项阈值参数。

```bash
./bin/ rebalance start \
    [--nodes "node1@host1 node2@host2"] \
    [--wait-health-check Secs] \
    [--conn-evict-rate ConnPerSec] \
    [--abs-conn-threshold Count] \
    [--rel-conn-threshold Fraction] \
    [--conn-evict-rate ConnPerSec] \
    [--wait-takeover Secs] \
    [--sess-evict-rate CountPerSec] \
    [--abs-sess-threshold Count] \
    [--rel-sess-threshold Fraction]
```

```bash
./bin/emqx ctl rebalance start \
	--wait-health-check 10 \
	--wait-takeover 60  \
	--conn-evict-rate 5 \
	--sess-evict-rate 5 \
	--abs-conn-threshold 30 \
	--abs-sess-threshold 30 \
	--nodes "emqx1@127.0.0.1 emqx2@127.0.0.1 emqx3@127.0.0.1"
Rebalance started
```

--------------------------------

### Start Services with Docker Compose

Source: https://docs.emqx.com/zh/emqx/v6.0/emqx-ai/rtc-services/volcengine-rtc/quick-start.html

Command to build and start all services using Docker Compose.

```bash
docker compose -f docker/docker-compose.web-volc.yml up --build
```

--------------------------------

### Install Kotlin Development Environment

Source: https://docs.emqx.com/zh/emqx/v6.0/emqx-ai/sdks/mcp-sdk-kotlin.html

Use SDKMAN to install the required JDK, Kotlin, and Gradle versions.

```bash
curl -s "https://get.sdkman.io" | bash
source "$HOME/.sdkman/bin/sdkman-init.sh"

sdk install java 21.0.9-tem
sdk install kotlin 2.2.21
sdk install gradle 9.2.1
```

--------------------------------

### Clone MCP Server Demo

Source: https://docs.emqx.com/zh/emqx/v6.0/emqx-ai/sdks/mcp-sdk-kotlin.html

Download the example source code from the repository.

```bash
git clone https://github.com/terry-xiaoyu/kotlin-mcp-server-demo.git
cd kotlin-mcp-server-demo
```

--------------------------------

### Start Services for UI Verification

Source: https://docs.emqx.com/zh/emqx/v6.0/emqx-ai/rtc-services/volcengine-rtc/quick-start.html

Starts the volc-server and web services for basic UI and configuration testing without AI Agent capabilities.

```bash
docker compose -f docker/docker-compose.web-volc.yml up --build volc-server web
```

--------------------------------

### Install SDK dependencies

Source: https://docs.emqx.com/zh/emqx/v6.0/emqx-ai/sdks/mcp-sdk-typescript.html

Commands to install the MCP MQTT SDK and necessary development dependencies using npm, yarn, or pnpm.

```bash
# 使用 npm
npm install @emqx-ai/mcp-mqtt-sdk
npm install -D typescript @types/node ts-node

# 或使用 yarn
yarn add @emqx-ai/mcp-mqtt-sdk
yarn add -D typescript @types/node ts-node

# 或使用 pnpm
pnpm add @emqx-ai/mcp-mqtt-sdk
pnpm add -D typescript @types/node ts-node
```

--------------------------------

### GET Request Serialization Example

Source: https://docs.emqx.com/zh/emqx/v6.0/access-control/authz/http.html

Configuration and resulting HTTP GET request for a specific client scenario.

```hcl
{
    method = get
    url = "http://127.0.0.1:8080/authz/${clientid}"
    body {
        username = "${username}"
        topic = "${topic}"
        action = "${action}"
    }
}
```

```bash
GET /authz/emqx_c?username=emqx_u&topic=t%2F1&action=publish HTTP/1.1
... Headers ...
```

--------------------------------

### Initialize Project with uv

Source: https://docs.emqx.com/zh/emqx/v6.0/emqx-ai/sdks/mcp-sdk-python.html

Use uv to create and navigate into a new project directory.

```bash
uv init mcp_over_mqtt_demo
cd mcp_over_mqtt_demo
```

--------------------------------

### Check RPM dependency error

Source: https://docs.emqx.com/zh/emqx/v6.0/faq/deployment.html

Example of the error message encountered when libatomic is missing during manual installation.

```bash
$ rpm -ivh emqx-5.7.0-el8-amd64.rpm
error: Failed dependencies:
libatomic is needed by emqx-5.7.0-el8-amd64.rpm
```

--------------------------------

### Start MCP Server

Source: https://docs.emqx.com/zh/emqx/v6.0/emqx-ai/sdks/mcp-sdk-kotlin.html

Execute the server using the Gradle run command with MQTT parameters.

```bash
./gradlew run --args="--mqtt kt001 demo/kotlin-mcp-server"
```

--------------------------------

### LwM2M Plugin Startup Error Log

Source: https://docs.emqx.com/zh/emqx/v6.0/changes/changes-ee-v4.html

Example of an error log encountered when starting the LwM2M plugin after the module has been closed.

```erlang
{emqx_lwm2m,{bad_return,{{emqx_lwm2m_app,start,[normal,[]]},{'EXIT',{{already_started,<0.3895.177>},[...]}}}}}
```

--------------------------------

### HTTP Configuration Examples (4.4 vs 5.1)

Source: https://docs.emqx.com/zh/emqx/v6.0/changes/auth-4.4-to-5.1-compatibility.html

Comparison of HTTP authentication configuration between EMQX 4.4 and 5.1.

```text
auth.http.auth_req.url = http://127.0.0.1:80/mqtt/auth
auth.http.auth_req.method = post
auth.http.auth_req.headers.content_type = application/x-www-form-urlencoded

auth.http.auth_req.params = clientid=%c,username=%u,password=%P

auth.http.timeout = 5s

auth.http.connect_timeout = 5s
auth.http.pool_size = 32

auth.http.enable_pipelining = 100

auth.http.ssl = on
auth.http.ssl.cacertfile = path/to/your/cafile.pem
auth.http.ssl.certfile = path/to/your/certfile
auth.http.ssl.keyfile = path/to/your/keyfile
auth.http.ssl.verify = true
auth.http.ssl.server_name_indication = myhttp
```

```text
{
    mechanism = password_based
    backend = http
    enable = true

    method = post
    url = "http://127.0.0.1:80/mqtt/auth"
    body {
        username = "${username}"
        clientid = "${clientid}"
        password = "${password}"
    }
    headers {
        "Content-Type" = "application/x-www-form-urlencoded"
    }
    request_timeout = "5s"
    connect_timeout = "5s"
    pool_size = 32
    
    enable_pipelining = 100
    
    ssl {
      enable = true
      verify = verify_peer
    
      keyfile = path/to/your/keyfile
      certfile = path/to/your/certfile
      cacertfile = path/to/your/cafile.pem
      
      server_name_indication = myhttp
    } 
}
```

--------------------------------

### Publishing MQTT Messages

Source: https://docs.emqx.com/zh/emqx/v6.0/performance/benchmark-emqtt-bench.html

Example of starting 10 connections that publish 100 messages per second to topic 't' with QoS 0 and 16-byte payloads.

```bash
./emqtt_bench pub -t t -h emqx-server -s 16 -q 0 -c 10 -I 10
```

--------------------------------

### Initialize Node.js project

Source: https://docs.emqx.com/zh/emqx/v6.0/emqx-ai/sdks/mcp-sdk-typescript.html

Commands to create a new directory and initialize a Node.js project.

```bash
mkdir mcp_typescript_demo
cd mcp_typescript_demo
npm init -y
```

--------------------------------

### Install libatomic dependency

Source: https://docs.emqx.com/zh/emqx/v6.0/faq/deployment.html

Install the required libatomic dependency for manual RPM or DEB package installations.

```bash
# Rocky Linux, CentOS, ...
yum install -y libatomic
# Debian, Ubuntu, ...
apt install -y libatomic
```

--------------------------------

### emqx ctl plugins install

Source: https://docs.emqx.com/zh/emqx/v6.0/admin/cli.html

Installs a plugin package.

```APIDOC
## emqx ctl plugins install <Name-Vsn>

### Description
Installs a plugin package located in the plugin installation directory.

### Parameters
- **Name-Vsn** (string) - Required - The name and version of the plugin (e.g., emqx_auth_mnesia-3.0.1).
```

--------------------------------

### 配置集群发现策略

Source: https://docs.emqx.com/zh/emqx/v6.0/deploy/cluster/create-cluster.html

在 emqx.conf 配置文件中设置节点发现策略，默认为 manual。

```bash
cluster {
    ## 可选 manual | static | dns | etcd | k8s | singleton
    discovery_strategy  =  manual
}
```

--------------------------------

### Initialize Python MCP Client Environment

Source: https://docs.emqx.com/zh/emqx/v6.0/emqx-ai/sdks/mcp-sdk-kotlin.html

Commands to set up a new project directory and install the necessary MCP Python SDK dependencies.

```bash
uv init light_controller
cd light_controller
uv add git+https://github.com/emqx/mcp-python-sdk --branch main
uv add "mcp[cli]"
source .venv/bin/activate
```

--------------------------------

### Default GET Headers

Source: https://docs.emqx.com/zh/emqx/v6.0/access-control/authz/http.html

Default headers applied to HTTP GET requests.

```hcl
{
    "accept" = "application/json"
    "cache-control" = "no-cache"
    "connection" = "keep-alive"
    "keep-alive" = "timeout=30, max=1000"
}
```

--------------------------------

### Redis Configuration Example

Source: https://docs.emqx.com/zh/emqx/v6.0/changes/auth-4.4-to-5.1-compatibility.html

Example configuration for Redis authentication in EMQX 5.1.

```hocon
  cmd = "HMGET mqtt_user:${username}"
  database = 0
  password = "pass"
  auto_reconnect = true
  ssl {
    enable = true
    verify = verify_peer
   
    keyfile = path/to/your/keyfile
    certfile = path/to/your/certfile
    cacertfile = path/to/your/cafile.pem
    
    server_name_indication = myredis
  }
}
```

--------------------------------

### 使用 MQTTX CLI 订阅延迟消息

Source: https://docs.emqx.com/zh/emqx/v6.0/messaging/mqtt-delayed-publish.html

在终端中订阅目标主题以接收延迟发布的消息。

```bash
mqttx sub -t t/1 -v
```

--------------------------------

### 测试单向认证连接

Source: https://docs.emqx.com/zh/emqx/v6.0/network/emqx-mqtt-tls.html

使用 MQTTX CLI 进行单向认证测试，验证服务器身份。

```bash
mqttx sub -t 't/1' -h localhost -p 8883 \
  --protocol mqtts \
  --ca certs/rootCA.crt
```

--------------------------------

### Install Volcengine RTC SDK

Source: https://docs.emqx.com/zh/emqx/v6.0/emqx-ai/rtc-services/volcengine-rtc/installation-and-testing.html

Install the required RTC package via npm.

```bash
npm install @volcengine/rtc
```

--------------------------------

### Initialize MongoDB Container and Database

Source: https://docs.emqx.com/zh/emqx/v6.0/data-integration/data-bridge-mongodb.html

Commands to start a MongoDB container and prepare the database and collection for EMQX data.

```bash
docker run -d --name mongodb -p 27017:27017 mongo

docker exec -it mongodb bash

mongosh

use admin
db.createUser({ user: "admin", pwd: "public", roles: [ { role: "root", db: "admin" } ] })

use emqx_data

db.createCollection('emqx_messages')
```

--------------------------------

### Prometheus Metric Example

Source: https://docs.emqx.com/zh/emqx/v6.0/changes/changes-ee-v5.html

Example of the cluster sessions count metric exposed for Prometheus.

```text
# TYPE emqx_cluster_sessions_count gauge
emqx_cluster_sessions_count 1234
```

--------------------------------

### Deploy and Initialize TDengine

Source: https://docs.emqx.com/zh/emqx/v6.0/data-integration/data-bridge-tdengine.html

Commands to start a TDengine container and initialize the database via the command line.

```bash
docker run --name TDengine -p 6041:6041 tdengine/tdengine

docker exec -it TDengine bash

taos

CREATE DATABASE mqtt;

use mqtt;
```

--------------------------------

### Observe Command Example

Source: https://docs.emqx.com/zh/emqx/v6.0/gateway/lwm2m.html

A concrete example of an MQTT message body for an observe command.

```json
{
  "reqID": 10,
  "msgType": "observe",
  "data": {
    "path": "/31024/0/1"
  }
}
```

--------------------------------

### Initialize MySQL Container and Database

Source: https://docs.emqx.com/zh/emqx/v6.0/data-integration/data-bridge-mysql.html

Commands to start a MySQL Docker container and prepare the database schema.

```bash
docker run --name mysql -p 3306:3306 -e MYSQL_ROOT_PASSWORD=public -d mysql

docker exec -it mysql bash

mysql -u root -p

CREATE DATABASE emqx_data CHARACTER SET utf8mb4;
use emqx_data;
```

--------------------------------

### Install NGINX Dependencies

Source: https://docs.emqx.com/zh/emqx/v6.0/deploy/cluster/lb-nginx.html

Install required build tools and libraries on Ubuntu before compiling NGINX.

```bash
sudo apt-get update
sudo apt-get install build-essential libpcre3-dev zlib1g-dev libssl-dev
```

--------------------------------

### Allow Plugin Installation via CLI

Source: https://docs.emqx.com/zh/emqx/v6.0/changes/changes-ee-v5.html

Use the emqx ctl command to whitelist a plugin version, optionally specifying a SHA-256 hash for security verification.

```bash
emqx ctl plugins allow <name-vsn> sha256:<HEX>
```

--------------------------------

### Install FreeTDS on Ubuntu

Source: https://docs.emqx.com/zh/emqx/v6.0/data-integration/data-bridge-sqlserver.html

Commands to install necessary ODBC packages and edit the configuration file.

```bash
$ apt-get install unixodbc unixodbc-dev tdsodbc freetds-bin freetds-common freetds-dev libdbd-odbc-perl liblocal-lib-perl
$ vim /etc/odbcinst.ini
```

--------------------------------

### Configuring SSL Connections

Source: https://docs.emqx.com/zh/emqx/v6.0/performance/benchmark-emqtt-bench.html

Examples for establishing secure MQTT connections using either one-way or two-way SSL certificates.

```bash
./emqtt_bench sub -c 100 -i 10 -t bench/%i -p 8883 -S
./emqtt_bench pub -c 100 -I 10 -t bench/%i -p 8883 -s 256 -S
```

```bash
./emqtt_bench sub -c 100 -i 10 -t bench/%i -p 8883 --certfile path/to/client-cert.pem --keyfile path/to/client-key.pem
./emqtt_bench pub -c 100 -i 10 -t bench/%i -s 256 -p 8883 --certfile path/to/client-cert.pem --keyfile path/to/client-key.pem
```

--------------------------------

### Implement MCP server with tools and resources

Source: https://docs.emqx.com/zh/emqx/v6.0/emqx-ai/sdks/mcp-sdk-typescript.html

Example implementation of an MCP server exposing calculator tools and greeting resources over MQTT.

```typescript
// demo_mcp_server.ts
import { McpMqttServer } from "@emqx-ai/mcp-mqtt-sdk";

// 创建 MCP 服务器
const server = new McpMqttServer({
  host: "mqtt://broker.emqx.io:1883",
  serverId: "demo-calculator-server",
  serverName: "demo_server/calculator",
  name: "Calculator MCP Server",
  version: "1.0.0",
  description: "一个简单的计算器 MCP 服务器",
  capabilities: {
    tools: { listChanged: true },
    resources: { listChanged: true },
  },
});

// 添加加法工具
server.tool(
  "add",
  "两个数字相加",
  {
    type: "object",
    properties: {
      a: { type: "number", description: "第一个数字" },
      b: { type: "number", description: "第二个数字" },
    },
    required: ["a", "b"],
  },
  async (params: Record<string, any>) => {
    const { a, b } = params as { a: number; b: number };
    const result = a + b;
    return {
      content: [
        {
          type: "text",
          text: `${a} + ${b} = ${result}`,
        },
      ],
    };
  },
);

// 添加乘法工具
server.tool(
  "multiply",
  "两个数字相乘",
  {
    type: "object",
    properties: {
      a: { type: "number", description: "第一个数字" },
      b: { type: "number", description: "第二个数字" },
    },
    required: ["a", "b"],
  },
  async (params: Record<string, any>) => {
    const { a, b } = params as { a: number; b: number };
    const result = a * b;
    return {
      content: [
        {
          type: "text",
          text: `${a} × ${b} = ${result}`,
        },
      ],
    };
  },
);

// 添加具体的问候资源
const names = ["Alice", "Bob", "Charlie", "Diana", "World"];
names.forEach((name) => {
  server.resource(
    `greeting://${name}`,
    `个性化问候 - ${name}`,
    async () => {
      return {
        contents: [
          {
            uri: `greeting://${name}`,
            mimeType: "text/plain",
            text: `Hello, ${name}! Welcome to our calculator service.`,
          },
        ],
      };
    },
    {
      description: `生成给${name}的个性化问候消息`,
      mimeType: "text/plain",
    },
  );
});

// 添加服务器状态资源
server.resource(
  "status://server",
  "服务器状态",
  async () => {
    return {
      contents: [
        {
          uri: "status://server",
          mimeType: "application/json",
          text: JSON.stringify(
            {
              name: "Calculator MCP Server",
              status: "running",
              uptime: process.uptime(),
              availableTools: ["add", "multiply"],
              timestamp: new Date().toISOString(),
            },
            null,
            2,
          ),
        },
      ],
    };
  },
  {
    description: "服务器运行状态信息",
    mimeType: "application/json",
  },
);

// 事件处理
server.on("ready", () => {
  console.log("Calculator MCP Server 已启动");
});

server.on("error", (error) => {
  console.error("服务器错误:", error);
});

// 启动服务器
async function startServer() {
  try {
    await server.start();
  } catch (error) {
    console.error("启动服务器失败:", error);
    process.exit(1);
  }
}

// 优雅关闭
process.on("SIGINT", async () => {
  console.log("正在关闭服务器...");
  await server.stop();
  process.exit(0);
});
```

--------------------------------

### Install Paho MQTT Python Client

Source: https://docs.emqx.com/zh/emqx/v6.0/connect-emqx/python.html

Use pip to install the required paho-mqtt library.

```bash
pip install paho-mqtt
```

--------------------------------

### 接收 MQTTX CLI 遗嘱消息输出

Source: https://docs.emqx.com/zh/emqx/v6.0/messaging/mqtt-will-message.html

当发布者客户端断开连接后，订阅者终端将接收到的遗嘱消息内容。

```bash
topic:  t/1
payload:  A will message from MQTTX CLI
```

--------------------------------

### LDAP Data Example (LDIF)

Source: https://docs.emqx.com/zh/emqx/v6.0/access-control/authn/ldap.html

Example LDIF entry for a user with ACL attributes configured.

```sql
dn:dc=emqx,dc=io
objectclass: top
objectclass: dcobject
objectclass: organization
dc:emqx
o:emqx,Inc.

# 创建组织单元 testdevice.emqx.io
dn:ou=testdevice,dc=emqx,dc=io
objectClass: top
objectclass:organizationalUnit
ou:testdevice

## 创建用户 mqttuser0002
#         密码为 mqttuser0002
#         哈希后的密码为：{SSHA}n9XdtoG4Q/TQ3TQF4Y+khJbMBH4qXj4M
#         Base64 编码的哈希为：e1NTSEF9bjlYZHRvRzRRL1RRM1RRRjRZK2toSmJNQkg0cVhqNE0=
dn:uid=mqttuser0002,ou=testdevice,dc=emqx,dc=io
objectClass: top
objectClass: mqttUser
objectClass: mqttDevice
objectClass: mqttSecurity
uid: mqttuser0002
isEnabled: TRUE
mqttAccountName: user2
mqttPublishTopic: mqttuser0002/pub/1
mqttPublishTopic: mqttuser0002/pub/+
mqttPublishTopic: mqttuser0002/pub/#
mqttSubscriptionTopic: mqttuser0002/sub/1
mqttSubscriptionTopic: mqttuser0002/sub/+
mqttSubscriptionTopic: mqttuser0002/sub/#
mqttPubSubTopic: mqttuser0002/pubsub/1
mqttPubSubTopic: mqttuser0002/pubsub/+
mqttPubSubTopic: mqttuser0002/pubsub/#
mqttAclRule: [{"permission": "allow", "action": "pub", "topic": "mqttuser0002/complexrule1/1"}]
mqttAclRule: {"permission": "allow", "action": "pub", "topic": "mqttuser0002/complexrule2/#"}
mqttAclTtl: 1s
userPassword:: e1NTSEF9bjlYZHRvRzRRL1RRM1RRRjRZK2toSmJNQkg0cVhqNE0=
```

--------------------------------

### 使用 MQTTX CLI 发布消息

Source: https://docs.emqx.com/zh/emqx/v6.0/messaging/publish-and-subscribe.html

使用 pub 命令向指定主题发布消息，执行后将自动断开连接。

```bash
mqttx pub -t 'testtopic/1' -q 1 -h 'localhost' -p 1883 -m 'from MQTTX CLI'
```

--------------------------------

### Create an MCP Server in C

Source: https://docs.emqx.com/zh/emqx/v6.0/emqx-ai/sdks/mcp-sdk-paho-c.html

Defines a tool callback, registers the tool, and initializes the MCP server connection to an MQTT broker.

```c
#include "mcp_server.h"

// Callback function to get temperature
const char* get_temperature_callback(int n_args, property_t *args) {
    // Read sensor data
    float temp = read_temperature_sensor();

    // Return JSON formatted result
    static char result[64];
    snprintf(result, sizeof(result), "{\"temperature\": %.2f}", temp);
    return result;
}

// Define MCP tools
mcp_tool_t my_tools[] = {
    {
        .name = "get_temperature",
        .description = "Get device temperature",
        .property_count = 0,
        .properties = NULL,
        .call = get_temperature_callback
    }
};

// Initialize MCP server
mcp_server_t *server = mcp_server_init(
    "sensor",           // Server name
    "Sensor MCP Server", // Description
    "mqtt://broker.example.com", // MQTT Broker URI
    "client_001",       // Client ID
    "username",               // Username
    "password",               // Password
    NULL                      // Certificate (optional)
);

// Register tools
mcp_server_register_tool(server, 1, my_tools);

// Start server
mcp_server_run(server);
```

--------------------------------

### NATS Gateway Message Example

Source: https://docs.emqx.com/zh/emqx/v6.0/changes/changes-ee-v5.html

Example of a NATS message that the NATS gateway converts into an MQTT message.

```text
PUB sub.t 5  
hello
```

--------------------------------

### Kafka Message Payload Example

Source: https://docs.emqx.com/zh/emqx/v6.0/data-integration/data-bridge-kafka.html

Example of the JSON structure received from Kafka when processed by an EMQX rule.

```json
{
  "value": "{\"msg\": \"Hello EMQX\"}",
  "ts_type": "create",
  "ts": 1679665968238,
  "topic": "testtopic-out",
  "offset": 2,
  "key": "key",
  "headers": {
    "header_key": "header_value"
  }
}
```

--------------------------------

### 验证集群连接

Source: https://docs.emqx.com/zh/emqx/v6.0/cluster-linking/quick-start.html

使用 MQTTX CLI 工具在两个集群之间进行消息发布和订阅测试。

```bash
mqttx sub -h emqx.us-east.myinfra.net --topic linked/# --qos 1 --verbose
[6/4/2024] [3:53:32 PM] › …  连接中...
[6/4/2024] [3:53:32 PM] › ✔  已连接
[6/4/2024] [3:53:32 PM] › …  订阅 linked/#...
[6/4/2024] [3:53:32 PM] › ✔  已订阅 linked/#
```

```bash
mqttx pub -h emqx.eu-west.myinfra.net --topic linked/42 --message "Hello from the other side!"
[6/4/2024] [3:53:35 PM] › …  连接中...
[6/4/2024] [3:53:35 PM] › ✔  已连接
[6/4/2024] [3:53:35 PM] › …  正在发布消息...
[6/4/2024] [3:53:35 PM] › ✔  已发布消息
```

```bash
[6/4/2024] [3:53:35 PM] › 主题: linked/42
内容: Hello from the other side!
```

```bash
mqttx sub -h emqx.eu-west.myinfra.net --topic linked/# --qos 1 --verbose
[6/4/2024] [3:54:12 PM] › …  连接中...
[6/4/2024] [3:54:12 PM] › ✔  已连接
[6/4/2024] [3:54:12 PM] › …  订阅 linked/#...
[6/4/2024] [3:54:12 PM] › ✔  已订阅 linked/#
```

```bash
mqttx pub -h emqx.us-east.myinfra.net --topic linked/1 --message "Hello from US!"
[6/4/2024] [3:54:15 PM] › …  连接中...
[6/4/2024] [3:54:15 PM] › ✔  已连接
[6/4/2024] [3:54:15 PM] › …  正在发布消息...
[6/4/2024] [3:54:15 PM] › ✔  已发布消息
```

```bash
[6/4/2024] [3:54:15 PM] › 主题: linked/1
内容: Hello from US!
```

--------------------------------

### 添加 EMQX Apt 仓库

Source: https://docs.emqx.com/zh/emqx/v6.0/deploy/install-ubuntu.html

使用官方脚本添加 EMQX 企业版仓库以供 Apt 管理。

```bash
curl -s https://packagecloud.io/install/repositories/emqx/emqx-enterprise5/script.deb.sh | sudo bash
```

--------------------------------

### emqx ctl traces start

Source: https://docs.emqx.com/zh/emqx/v6.0/admin/cli.html

Starts a cluster-wide trace for a specific client, topic, or IP address.

```APIDOC
## emqx ctl traces start <Name> <Type> <Value> [<Duration>]

### Description
Starts a trace across all nodes in the cluster for a specified target.

### Parameters
- **Name** (string) - Required - The name of the trace.
- **Type** (string) - Required - The type of trace target: 'client', 'topic', or 'ip_address'.
- **Value** (string) - Required - The identifier for the target (ClientId, Topic, or IP Address).
- **Duration** (integer) - Optional - The duration of the trace in seconds.
```

--------------------------------

### substr(String: string, Start: integer, [Length: integer]) -> string

Source: https://docs.emqx.com/zh/emqx/v6.0/data-integration/rule-sql-builtin-functions.html

Extracts a substring starting from a specific index.

```APIDOC
## substr(String: string, Start: integer, [Length: integer]) -> string

### Description
Returns a portion of the string starting at the zero-based index 'Start', optionally limited by 'Length'.
```

--------------------------------

### 在 emqx.conf 中启用 PSK 认证

Source: https://docs.emqx.com/zh/emqx/v6.0/network/psk-authentication.html

通过 psk_authentication 配置组启用功能并指定凭据文件路径。

```bash
psk_authentication {
  enable = true
  init_file = "data/psk_file.txt"
}
```

--------------------------------

### Install EMQX Operator

Source: https://docs.emqx.com/zh/emqx/v6.0/deploy/kubernetes/operator/tasks/configure-emqx-restricted-k8s.html

Helm command to install the EMQX operator with custom security contexts and private registry configuration.

```bash
helm repo add emqx https://repos.emqx.io/charts
helm repo update
helm upgrade --install emqx-operator emqx/emqx-operator \
  --namespace emqx \
  --create-namespace \
  --set singleNamespace=true \
  --set webhook.enabled=false \
  --set crds.enabled=false \
  --set-json='podSecurityContext={"runAsNonRoot":true}' \
  --set-json='containerSecurityContext={"allowPrivilegeEscalation":false}' \
  --set image.repository=$REGISTRY/emqx/emqx-operator-controller \
  --set image.tag=$EMQX_OPERATOR_VERSION
```

--------------------------------

### 测试 MQTT Source 规则

Source: https://docs.emqx.com/zh/emqx/v6.0/data-integration/data-bridge-mqtt.html

使用 MQTTX CLI 验证消息从外部 MQTT 服务转发到 EMQX 的过程。

```bash
mqttx sub -t sub/# -q 1 -v
```

```bash
mqttx pub -t f/1 -m "I'm from broker.emqx.io" -r -h broker.emqx.io
```

```bash
[2024-1-31] [16:49:22] › topic: sub/f/1
payload: I'm from broker.emqx.io
```

--------------------------------

### Log Throttling Notification Example

Source: https://docs.emqx.com/zh/emqx/v6.0/changes/changes-ee-v4.html

Example of the log message generated when the log throttling feature drops messages due to frequency limits.

```text
log throttled during last 60s, dropped_msg: #{{emqx_channel,1400} => #{msg => "Client ~s (Username: '~s') login failed for ~0p", count => 33}}
```

--------------------------------

### Start RabbitMQ Server with Docker

Source: https://docs.emqx.com/zh/emqx/v6.0/data-integration/data-bridge-rabbitmq.html

Launches a RabbitMQ container with the management plugin enabled for web-based monitoring.

```bash
docker run -it --rm --name rabbitmq -p 127.0.0.1:5672:5672 -p 127.0.0.1:15672:15672 rabbitmq:3.11-management
```

--------------------------------

### 使用 MQTTX CLI 发布消息

Source: https://docs.emqx.com/zh/emqx/v6.0/durability/durability_introduction.html

使用 bench 命令模拟客户端向指定主题发布消息。

```bash
mqttx bench pub -t t/1 -c 1 -q 1
```

--------------------------------

### Data Integration Warning Log Example

Source: https://docs.emqx.com/zh/emqx/v6.0/changes/changes-ee-v5.html

Example of a warning log generated when a data source receives data immediately upon node startup.

```text
2025-01-08T07:48:36.421822+00:00 [warning] tag: RESOURCE, msg: handle_resource_metrics_failed, reason: {badkey,received}, stacktrace: ..., event: received, kind: error, hint: transient failures may occur when restarting a resource, resource_id: <<"source:mqtt:tset:connector:mqtt:test">>
```

--------------------------------

### UpdateVoiceChat API Usage Examples

Source: https://docs.emqx.com/zh/emqx/v6.0/emqx-ai/rtc-services/volcengine-rtc/api.html

Examples for sending commands to an active voice chat session, including interrupting the agent and triggering custom text-to-speech.

```json
{
  "AppId": "your-app-id",
  "RoomId": "room-uuid",
  "TaskId": "task-id",
  "Command": "Interrupt"
}
```

```json
{
  "AppId": "your-app-id",
  "RoomId": "room-uuid",
  "TaskId": "task-id",
  "Command": "ExternalTextToSpeech",
  "Message": "您有一条新消息",
  "InterruptMode": 1
}
```
Tokens:
Raw