update

2026-03-05 17:32:20 +07:00
parent 060c68cd05
commit ae0f24ccb2
13 changed files with 4018 additions and 6364 deletions
--- a/examples/tutorial.md
+++ b/examples/tutorial.md
@@ -1,6 +1,6 @@
-# NATSBridge Tutorial
+# Cross-Platform NATSBridge Tutorial

-A step-by-step guide to get started with NATSBridge - a high-performance, bi-directional data bridge for **Julia**.
+A step-by-step guide to get started with NATSBridge across **Julia**, **JavaScript**, and **Python/MicroPython**.

 ## Table of Contents

@@ -15,22 +15,35 @@ A step-by-step guide to get started with NATSBridge - a high-performance, bi-dir

 ## Overview

-NATSBridge enables seamless communication for Julia applications through NATS, with automatic transport selection based on payload size:
+NATSBridge enables seamless communication across platforms through NATS, with automatic transport selection based on payload size:

 - **Direct Transport**: Payloads < 1MB are sent directly via NATS (Base64 encoded)
 - **Link Transport**: Payloads >= 1MB are uploaded to an HTTP file server and referenced via URL

+### Cross-Platform API Parity
+
+All three platforms use the same high-level API:
+
+```
+# Input format
+smartsend(subject, [(dataname, data, type), ...], options)
+
+# Output format
+(env, env_json_str) = smartsend(...)
+env = smartreceive(msg, options)
+```
+
 ### Supported Payload Types

-| Type | Description |
-|------|-------------|
-| `text` | Plain text strings |
-| `dictionary` | JSON-serializable dictionaries |
-| `table` | Tabular data (Arrow IPC format) |
-| `image` | Image data (PNG, JPG bytes) |
-| `audio` | Audio data (WAV, MP3 bytes) |
-| `video` | Video data (MP4, AVI bytes) |
-| `binary` | Generic binary data |
+| Type | Julia | JavaScript | Python | MicroPython |
+|------|-------|------------|--------|-------------|
+| `text` | `String` | `string` | `str` | `str` |
+| `dictionary` | `Dict` | `Object` | `dict` | `dict` |
+| `table` | `DataFrame` | `Array<Object>` | `DataFrame` | ❌ |
+| `image` | `Vector{UInt8}` | `Uint8Array` | `bytes` | `bytearray` |
+| `audio` | `Vector{UInt8}` | `Uint8Array` | `bytes` | `bytearray` |
+| `video` | `Vector{UInt8}` | `Uint8Array` | `bytes` | `bytearray` |
+| `binary` | `Vector{UInt8}` | `Uint8Array` | `bytes` | `bytearray` |

 ---

@@ -40,7 +53,7 @@ Before you begin, ensure you have:

 1. **NATS Server** running (or accessible)
 2. **HTTP File Server** (optional, for large payloads > 1MB)
-3. **Julia** with required packages
+3. **Platform-specific packages** installed

 ---

@@ -58,6 +71,29 @@ Pkg.add("UUIDs")
 Pkg.add("Dates")
 ```

+### JavaScript (Node.js)
+
+```bash
+npm install nats uuid apache-arrow node-fetch
+```
+
+### JavaScript (Browser)
+
+```html
+<script src="https://unpkg.com/nats-js/dist/bundle/nats.min.js"></script>
+<script src="https://unpkg.com/apache-arrow/arrow.min.js"></script>
+```
+
+### Python (Desktop)
+
+```bash
+pip install nats-py aiohttp pyarrow pandas
+```
+
+### MicroPython
+
+Uses built-in modules: `network`, `socket`, `time`, `json`, `base64`
+
 ---

 ## Quick Start
@@ -71,10 +107,7 @@ docker run -p 4222:4222 nats:latest
 ### Step 2: Start HTTP File Server (Optional)

 ```bash
-# Create a directory for file uploads
 mkdir -p /tmp/fileserver
-
-# Use any HTTP server that supports POST for file uploads
 python3 -m http.server 8080 --directory /tmp/fileserver
 ```

@@ -98,6 +131,72 @@ env, env_json_str = smartsend("/chat/room1", data, broker_url="nats://localhost:
 # env_json_str: JSON string for publishing to NATS
 ```

+#### JavaScript
+
+```javascript
+const NATSBridge = require('./src/natbridge.js');
+
+// Send a text message
+const data = [["message", "Hello World", "text"]];
+const [env, env_json_str] = await NATSBridge.smartsend(
+    "/chat/room1",
+    data,
+    { broker_url: "nats://localhost:4222" }
+);
+// env: Object with all metadata and payloads
+// env_json_str: JSON string for publishing
+console.log("Message sent!");
+
+// Or use is_publish=false
+const [env, env_json_str] = await NATSBridge.smartsend(
+    "/chat/room1",
+    data,
+    { broker_url: "nats://localhost:4222", is_publish: false }
+);
+```
+
+#### Python
+
+```python
+from natbridge import smartsend
+
+# Send a text message
+data = [("message", "Hello World", "text")]
+env, env_json_str = await smartsend(
+    "/chat/room1",
+    data,
+    broker_url="nats://localhost:4222"
+)
+# env: Dict with all metadata and payloads
+# env_json_str: JSON string for publishing
+print("Message sent!")
+
+# Or use is_publish=False
+env, env_json_str = await smartsend(
+    "/chat/room1",
+    data,
+    broker_url="nats://localhost:4222",
+    is_publish=False
+)
+```
+
+#### MicroPython
+
+```python
+from natbridge_mpy import NATSBridge
+
+bridge = NATSBridge()
+
+# Send a text message (limited to small payloads)
+data = [("message", "Hello World", "text")]
+env, env_json_str = bridge.smartsend(
+    "/chat/room1",
+    data,
+    size_threshold=100000  # Lower threshold for MicroPython
+)
+print("Message sent!")
+```
+
 ### Step 4: Receive Messages

 #### Julia
@@ -113,6 +212,36 @@ for (dataname, data, type) in env["payloads"]
 end
 ```

+#### JavaScript
+
+```javascript
+const NATSBridge = require('./src/natbridge.js');
+
+// Receive and process message
+const env = await NATSBridge.smartreceive(msg, {
+    fileserver_download_handler: NATSBridge.fetchWithBackoff
+});
+// env.payloads = [[dataname, data, type], ...]
+for (const [dataname, data, type] of env.payloads) {
+    console.log(`Received ${dataname}:`, data);
+}
+```
+
+#### Python
+
+```python
+from natbridge import smartreceive
+
+# Receive and process message
+env = await smartreceive(
+    msg,
+    fileserver_download_handler=fetch_with_backoff
+)
+# env["payloads"] = [(dataname, data, type), ...]
+for dataname, data, type in env["payloads"]:
+    print(f"Received {dataname}: {data}")
+```
+
 ---

 ## Basic Examples
@@ -134,6 +263,65 @@ data = [("config", config, "dictionary")]
 env, env_json_str = smartsend("/device/config", data, broker_url="nats://localhost:4222")
 ```

+#### JavaScript
+
+```javascript
+const NATSBridge = require('./src/natbridge.js');
+
+const config = {
+    wifi_ssid: "MyNetwork",
+    wifi_password: "password123",
+    update_interval: 60
+};
+
+const data = [["config", config, "dictionary"]];
+const [env, env_json_str] = await NATSBridge.smartsend(
+    "/device/config",
+    data,
+    { broker_url: "nats://localhost:4222" }
+);
+```
+
+#### Python
+
+```python
+from natbridge import smartsend
+
+config = {
+    "wifi_ssid": "MyNetwork",
+    "wifi_password": "password123",
+    "update_interval": 60
+}
+
+data = [("config", config, "dictionary")]
+env, env_json_str = await smartsend(
+    "/device/config",
+    data,
+    broker_url="nats://localhost:4222"
+)
+```
+
+#### MicroPython
+
+```python
+from natbridge_mpy import NATSBridge
+
+bridge = NATSBridge()
+
+config = {
+    "wifi_ssid": "MyNetwork",
+    "wifi_password": "password123",
+    "update_interval": 60
+}
+
+data = [("config", config, "dictionary")]
+env, env_json_str = bridge.smartsend(
+    "/device/config",
+    data,
+    size_threshold=100000
+)
+```
+
 ### Example 2: Sending Binary Data (Image)

 #### Julia
@@ -148,6 +336,59 @@ data = [("user_image", image_data, "binary")]
 env, env_json_str = smartsend("/chat/image", data, broker_url="nats://localhost:4222")
 ```

+#### JavaScript
+
+```javascript
+const NATSBridge = require('./src/natbridge.js');
+const fs = require('fs');
+
+// Read image file
+const image_data = fs.readFileSync('image.png');
+
+const data = [["user_image", image_data, "binary"]];
+const [env, env_json_str] = await NATSBridge.smartsend(
+    "/chat/image",
+    data,
+    { broker_url: "nats://localhost:4222" }
+);
+```
+
+#### Python
+
+```python
+from natbridge import smartsend
+
+# Read image file
+with open("image.png", "rb") as f:
+    image_data = f.read()
+
+data = [("user_image", image_data, "binary")]
+env, env_json_str = await smartsend(
+    "/chat/image",
+    data,
+    broker_url="nats://localhost:4222"
+)
+```
+
+#### MicroPython
+
+```python
+from natbridge_mpy import NATSBridge
+
+bridge = NATSBridge()
+
+# Read image file
+with open("image.png", "rb") as f:
+    image_data = f.read()
+
+data = [("user_image", image_data, "binary")]
+env, env_json_str = bridge.smartsend(
+    "/chat/image",
+    data,
+    size_threshold=100000
+)
+```
+
 ### Example 3: Request-Response Pattern

 #### Julia (Requester)
@@ -164,16 +405,47 @@ env, env_json_str = smartsend(
    reply_to="/device/response",
    reply_to_msg_id="cmd-001"
 )
-# env: msg_envelope_v1 object
-# env_json_str: JSON string for publishing to NATS
+```
+
+#### JavaScript (Requester)
+
+```javascript
+const NATSBridge = require('./src/natbridge.js');
+
+// Send command with reply-to
+const data = [["command", { action: "read_sensor" }, "dictionary"]];
+const [env, env_json_str] = await NATSBridge.smartsend(
+    "/device/command",
+    data,
+    {
+        broker_url: "nats://localhost:4222",
+        reply_to: "/device/response",
+        reply_to_msg_id: "cmd-001"
+    }
+);
+```
+
+#### Python (Requester)
+
+```python
+from natbridge import smartsend
+
+# Send command with reply-to
+data = [("command", {"action": "read_sensor"}, "dictionary")]
+env, env_json_str = await smartsend(
+    "/device/command",
+    data,
+    broker_url="nats://localhost:4222",
+    reply_to="/device/response",
+    reply_to_msg_id="cmd-001"
+)
 ```

 #### Julia (Responder)

 ```julia
-using NATS, NATSBridge
+using NATSBridge, NATS

-# Configuration
 const SUBJECT = "/device/command"
 const NATS_URL = "nats://localhost:4222"

@@ -182,13 +454,11 @@ function test_responder()
    NATS.subscribe(conn, SUBJECT) do msg
        env = smartreceive(msg, fileserver_download_handler=_fetch_with_backoff)
        
-        # Extract reply_to from the envelope metadata
        reply_to = env["reply_to"]
        
        for (dataname, data, type) in env["payloads"]
            if dataname == "command" && data["action"] == "read_sensor"
                response = Dict("sensor_id" => "sensor-001", "value" => 42.5)
-                # Send response to the reply_to subject from the request
                if !isempty(reply_to)
                    smartsend(reply_to, [("data", response, "dictionary")])
                end
@@ -226,10 +496,72 @@ env, env_json_str = smartsend(
    fileserver_url="http://localhost:8080"
 )

-# The envelope will contain the download URL
 println("File uploaded to: $(env.payloads[1].data)")
 ```

+#### JavaScript
+
+```javascript
+const NATSBridge = require('./src/natbridge.js');
+
+// Create large data (> 1MB)
+const large_data = Buffer.alloc(2_000_000);
+for (let i = 0; i < large_data.length; i++) {
+    large_data[i] = Math.floor(Math.random() * 256);
+}
+
+const [env, env_json_str] = await NATSBridge.smartsend(
+    "/data/large",
+    [["large_file", large_data, "binary"]],
+    {
+        broker_url: "nats://localhost:4222",
+        fileserver_url: "http://localhost:8080"
+    }
+);
+
+console.log("File uploaded to:", env.payloads[0].data);
+```
+
+#### Python
+
+```python
+from natbridge import smartsend
+
+# Create large data (> 1MB)
+import os
+large_data = os.urandom(2_000_000)
+
+env, env_json_str = await smartsend(
+    "/data/large",
+    [("large_file", large_data, "binary")],
+    broker_url="nats://localhost:4222",
+    fileserver_url="http://localhost:8080"
+)
+
+print(f"File uploaded to: {env['payloads'][0]['data']}")
+```
+
+#### MicroPython
+
+MicroPython enforces a hard limit of 50KB per payload:
+
+```python
+from natbridge_mpy import NATSBridge
+
+bridge = NATSBridge()
+
+# MicroPython has a hard limit of 50KB per payload
+# Use streaming or chunking for larger data
+small_data = bytes(1000)  # 1KB
+
+data = [("small_file", small_data, "binary")]
+env, env_json_str = bridge.smartsend(
+    "/data/small",
+    data,
+    size_threshold=100000  # Enforced max: 50000 bytes
+)
+```
+
 ### Example 5: Mixed Content (Chat with Text + Image)

 NATSBridge supports sending multiple payloads with different types in a single message:
@@ -249,6 +581,46 @@ data = [
 env, env_json_str = smartsend("/chat/mixed", data, broker_url="nats://localhost:4222")
 ```

+#### JavaScript
+
+```javascript
+const NATSBridge = require('./src/natbridge.js');
+const fs = require('fs');
+
+const image_data = fs.readFileSync('avatar.png');
+
+const data = [
+    ["message_text", "Hello with image!", "text"],
+    ["user_avatar", image_data, "image"]
+];
+
+const [env, env_json_str] = await NATSBridge.smartsend(
+    "/chat/mixed",
+    data,
+    { broker_url: "nats://localhost:4222" }
+);
+```
+
+#### Python
+
+```python
+from natbridge import smartsend
+
+with open("avatar.png", "rb") as f:
+    image_data = f.read()
+
+data = [
+    ("message_text", "Hello with image!", "text"),
+    ("user_avatar", image_data, "image")
+]
+
+env, env_json_str = await smartsend(
+    "/chat/mixed",
+    data,
+    broker_url="nats://localhost:4222"
+)
+```
+
 ### Example 6: Table Data (Arrow IPC)

 For tabular data, NATSBridge uses Apache Arrow IPC format:
@@ -270,12 +642,58 @@ data = [("students", df, "table")]
 env, env_json_str = smartsend("/data/students", data, broker_url="nats://localhost:4222")
 ```

+#### JavaScript
+
+```javascript
+const NATSBridge = require('./src/natbridge.js');
+
+// Create table data (array of objects)
+const table_data = [
+    { id: 1, name: "Alice", score: 95 },
+    { id: 2, name: "Bob", score: 88 },
+    { id: 3, name: "Charlie", score: 92 }
+];
+
+const data = [["students", table_data, "table"]];
+const [env, env_json_str] = await NATSBridge.smartsend(
+    "/data/students",
+    data,
+    { broker_url: "nats://localhost:4222" }
+);
+```
+
+#### Python
+
+```python
+from natbridge import smartsend
+import pandas as pd
+
+# Create DataFrame
+df = pd.DataFrame({
+    'id': [1, 2, 3],
+    'name': ['Alice', 'Bob', 'Charlie'],
+    'score': [95, 88, 92]
+})
+
+data = [("students", df, "table")]
+env, env_json_str = await smartsend(
+    "/data/students",
+    data,
+    broker_url="nats://localhost:4222"
+)
+```
+
+#### MicroPython
+
+MicroPython does not support table type due to memory constraints. Use dictionary or binary instead.
+
 ---

 ## Next Steps

 1. **Explore the test directory** for more examples
 2. **Check the documentation** for advanced configuration options
+3. **Read the walkthrough** for building real-world applications

 ---

@@ -296,7 +714,8 @@ env, env_json_str = smartsend("/data/students", data, broker_url="nats://localho
 ### Serialization Errors

 - Verify data type matches the specified type
- Check that binary data is in the correct format (Vector{UInt8})
+- Check that binary data is in the correct format
+- MicroPython: Ensure payload size < 50KB

 ---