@alteriom/painlessmesh 1.8.14 → 1.9.0

package/docs/wiki/API-Reference.md

@@ -1,246 +0,0 @@
-# API Reference
-
-This page contains the complete API reference for the Alteriom painlessMesh Library.
-
-## Core Classes
-
-### painlessMesh
-
-The main class for creating and managing mesh networks.
-
-#### Initialization Methods
-
-```cpp
-void init(String ssid, String password, Scheduler *baseScheduler, uint16_t port = 5555);
-void setDebugMsgTypes(uint16_t types);
-```
-
-#### Network Management
-
-```cpp
-void update();                                    // Call in loop()
-bool sendBroadcast(String &msg);                // Send to all nodes
-bool sendSingle(uint32_t &destId, String &msg); // Send to specific node
-```
-
-#### Event Callbacks
-
-```cpp
-void onReceive(std::function<void(uint32_t from, String &msg)> cb);
-void onNewConnection(std::function<void(uint32_t nodeId)> cb);
-void onChangedConnections(std::function<void()> cb);
-void onNodeTimeAdjusted(std::function<void(int32_t offset)> cb);
-```
-
-#### Node Information
-
-```cpp
-uint32_t getNodeId();                    // Get this node's ID
-std::list<uint32_t> getNodeList();      // Get all connected nodes
-uint32_t getNodeTime();                  // Get synchronized time
-size_t connectionCount();                // Number of direct connections
-```
-
-## Alteriom Extensions
-
-### SensorPackage (Type 200)
-
-Environmental data collection package for sensor networks.
-
-```cpp
-class SensorPackage : public painlessmesh::plugin::BroadcastPackage {
-public:
-    uint32_t sensorId = 0;        // Unique sensor identifier
-    uint32_t timestamp = 0;       // Unix timestamp
-    double temperature = 0.0;     // Temperature in Celsius
-    double humidity = 0.0;        // Relative humidity (0-100%)
-    double pressure = 0.0;        // Atmospheric pressure in hPa
-    uint8_t batteryLevel = 0;     // Battery level (0-100%)
-    
-    // Constructors
-    SensorPackage();
-    SensorPackage(JsonObject jsonObj);
-    
-    // Serialization
-    JsonObject addTo(JsonObject&& jsonObj) const;
-    size_t jsonObjectSize() const;
-};
-```
-
-**Usage Example:**
-```cpp
-SensorPackage sensor;
-sensor.sensorId = mesh.getNodeId();
-sensor.timestamp = mesh.getNodeTime();
-sensor.temperature = 23.5;
-sensor.humidity = 65.0;
-sensor.pressure = 1013.25;
-sensor.batteryLevel = 85;
-
-// Send as broadcast
-auto variant = painlessmesh::protocol::Variant(&sensor);
-String message;
-variant.printTo(message);
-mesh.sendBroadcast(message);
-```
-
-### CommandPackage (Type 400)
-
-Device control and automation commands for remote node management.
-
-```cpp
-class CommandPackage : public painlessmesh::plugin::SinglePackage {
-public:
-    uint8_t command = 0;          // Command type identifier
-    uint32_t targetDevice = 0;    // Target node ID
-    uint32_t commandId = 0;       // Unique command identifier
-    TSTRING parameters = "";      // JSON parameters string
-    
-    // Constructors
-    CommandPackage();
-    CommandPackage(JsonObject jsonObj);
-    
-    // Serialization
-    JsonObject addTo(JsonObject&& jsonObj) const;
-    size_t jsonObjectSize() const;
-};
-```
-
-**Usage Example:**
-```cpp
-CommandPackage cmd;
-cmd.dest = targetNodeId;
-cmd.command = 1;              // LED control
-cmd.targetDevice = targetNodeId;
-cmd.commandId = millis();
-cmd.parameters = "{\"state\":\"ON\",\"brightness\":75}";
-
-// Send to specific node
-auto variant = painlessmesh::protocol::Variant(&cmd);
-String message;
-variant.printTo(message);
-mesh.sendSingle(targetNodeId, message);
-```
-
-### StatusPackage (Type 202)
-
-Health monitoring and system status reporting for network diagnostics.
-
-```cpp
-class StatusPackage : public painlessmesh::plugin::BroadcastPackage {
-public:
-    uint8_t deviceStatus = 0;         // Device status flags
-    uint32_t uptime = 0;              // Uptime in seconds
-    uint16_t freeMemory = 0;          // Free memory in KB
-    uint8_t wifiStrength = 0;         // WiFi signal strength (0-100)
-    TSTRING firmwareVersion = "";     // Firmware version string
-    
-    // Constructors
-    StatusPackage();
-    StatusPackage(JsonObject jsonObj);
-    
-    // Serialization
-    JsonObject addTo(JsonObject&& jsonObj) const;
-    size_t jsonObjectSize() const;
-};
-```
-
-**Usage Example:**
-```cpp
-StatusPackage status;
-status.deviceStatus = 0x01;   // Operational
-status.uptime = millis() / 1000;
-status.freeMemory = ESP.getFreeHeap() / 1024;
-status.wifiStrength = 75;
-status.firmwareVersion = "1.6.1-alteriom";
-
-// Broadcast status
-auto variant = painlessmesh::protocol::Variant(&status);
-String message;
-variant.printTo(message);
-mesh.sendBroadcast(message);
-```
-
-## Message Handling
-
-### Receiving Messages
-
-```cpp
-void receivedCallback(uint32_t from, String& msg) {
-    DynamicJsonDocument doc(1024);
-    deserializeJson(doc, msg);
-    JsonObject obj = doc.as<JsonObject>();
-    uint8_t msgType = obj["type"];
-    
-    switch(msgType) {
-        case 200: // SensorPackage
-            handleSensorData(alteriom::SensorPackage(obj), from);
-            break;
-        case 400: // CommandPackage  
-            handleCommand(alteriom::CommandPackage(obj), from);
-            break;
-        case 202: // StatusPackage
-            handleStatus(alteriom::StatusPackage(obj), from);
-            break;
-        default:
-            Serial.printf("Unknown message type: %d\n", msgType);
-    }
-}
-```
-
-### Debug Message Types
-
-```cpp
-// Debug levels (can be combined with |)
-#define ERROR           0x00000001
-#define STARTUP         0x00000002  
-#define CONNECTION      0x00000004
-#define SYNC            0x00000008
-#define COMMUNICATION   0x00000010
-#define GENERAL         0x00000020
-#define MSG_TYPES       0x00000040
-#define REMOTE          0x00000080
-
-// Usage
-mesh.setDebugMsgTypes(ERROR | STARTUP | CONNECTION);
-```
-
-## Platform Constants
-
-### Memory Constraints
-- **ESP32**: ~320KB RAM available
-- **ESP8266**: ~80KB RAM available
-- **MAX_CONN**: Typically 4-10 connections depending on platform
-
-### Network Limits
-- **Message Size**: Recommended max 4KB
-- **String Length**: Recommended max 256 characters for compatibility
-- **Network Delay**: ~50-200ms typical mesh routing delay
-
-## Error Handling
-
-### Common Return Values
-- **`true`**: Operation successful
-- **`false`**: Operation failed (check network/memory)
-
-### Best Practices
-```cpp
-// Always check return values
-if (!mesh.sendBroadcast(message)) {
-    Serial.println("Failed to send message");
-    // Implement retry logic or error handling
-}
-
-// Monitor connection changes
-void changedConnectionCallback() {
-    auto nodeList = mesh.getNodeList();
-    Serial.printf("Network size: %d nodes\n", nodeList.size() + 1);
-}
-```
-
-## See Also
-
-- [Installation Guide](Installation)
-- [Examples](Examples)
-- [GitHub Repository](https://github.com/Alteriom/painlessMesh)
-- [Release Notes](https://github.com/Alteriom/painlessMesh/releases)

package/docs/wiki/Complete-Documentation.md

@@ -1,123 +0,0 @@
-# Complete Documentation
-
-Welcome to the complete documentation for Alteriom painlessMesh Library!
-
-## 📖 Documentation Sections
-
-### Getting Started
-- [Installation Guide](Installation) - Set up the library in your development environment
-- [Quick Start](https://github.com/Alteriom/painlessMesh/blob/main/docs/getting-started/quickstart.md) - Your first mesh network
-- [First Mesh Tutorial](https://github.com/Alteriom/painlessMesh/blob/main/docs/getting-started/first-mesh.md) - Step-by-step guide
-
-### API Documentation
-- [API Reference](API-Reference) - Complete class and method documentation
-- [Core API](https://github.com/Alteriom/painlessMesh/blob/main/docs/api/core-api.md) - painlessMesh core functionality
-- [Plugin System](https://github.com/Alteriom/painlessMesh/blob/main/docs/architecture/plugin-system.md) - Extensible architecture
-
-### Examples and Tutorials
-- [Examples](Examples) - Working code examples
-- [Basic Examples](https://github.com/Alteriom/painlessMesh/blob/main/docs/tutorials/basic-examples.md) - Fundamental usage patterns
-- [Alteriom Extensions](https://github.com/Alteriom/painlessMesh/blob/main/docs/alteriom/overview.md) - SensorPackage, CommandPackage, StatusPackage
-
-### Architecture
-- [Mesh Architecture](https://github.com/Alteriom/painlessMesh/blob/main/docs/architecture/mesh-architecture.md) - How the mesh network works
-- [Plugin System](https://github.com/Alteriom/painlessMesh/blob/main/docs/architecture/plugin-system.md) - Extensible package system
-
-### Troubleshooting
-- [FAQ](https://github.com/Alteriom/painlessMesh/blob/main/docs/troubleshooting/faq.md) - Frequently asked questions
-- [Common Issues](https://github.com/Alteriom/painlessMesh/blob/main/docs/troubleshooting/common-issues.md) - Solutions to common problems
-
-### Development
-- [Contributing Guidelines](Contributing) - How to contribute to the project
-- [Release Guide](https://github.com/Alteriom/painlessMesh/blob/main/RELEASE_GUIDE.md) - Release process documentation
-
-## 🚀 Quick Links
-
-### Installation
-```bash
-# Arduino Library Manager
-Tools → Manage Libraries → Search "Alteriom PainlessMesh"
-
-# PlatformIO
-lib_deps = alteriom/painlessMesh@^1.6.1
-
-# NPM
-npm install @alteriom/painlessmesh
-```
-
-### Basic Usage
-```cpp
-#include "painlessMesh.h"
-
-#define MESH_PREFIX     "YourMeshName"
-#define MESH_PASSWORD   "YourPassword"
-#define MESH_PORT       5555
-
-Scheduler userScheduler;
-painlessMesh mesh;
-
-void setup() {
-  Serial.begin(115200);
-  mesh.init(MESH_PREFIX, MESH_PASSWORD, &userScheduler, MESH_PORT);
-  mesh.onReceive([](uint32_t from, String& msg) {
-    Serial.printf("Received: %s from %u\n", msg.c_str(), from);
-  });
-}
-
-void loop() {
-  mesh.update();
-}
-```
-
-## 📦 Package Types
-
-### SensorPackage (Type 200)
-For environmental sensor data collection:
-- Temperature, humidity, pressure measurements
-- Battery level monitoring
-- Timestamp synchronization
-
-### CommandPackage (Type 400)
-For device control and automation:
-- Remote device commands
-- Parameter passing via JSON
-- Command acknowledgment tracking
-
-### StatusPackage (Type 202)
-For system health monitoring:
-- Device operational status
-- Memory usage tracking
-- Network connectivity metrics
-
-## 🌟 Key Features
-
-- **Automatic Mesh Formation** - Nodes discover and connect automatically
-- **JSON-Based Messaging** - Easy to use and extend
-- **Time Synchronization** - Coordinated behaviors across nodes
-- **Multi-Platform Support** - ESP32, ESP8266
-- **Alteriom Extensions** - Enhanced packages for common use cases
-- **Comprehensive Testing** - Full CI/CD pipeline with automated testing
-
-## 📚 External Resources
-
-- **GitHub Repository**: https://github.com/Alteriom/painlessMesh
-- **NPM Package**: https://www.npmjs.com/package/@alteriom/painlessmesh
-- **PlatformIO Registry**: https://registry.platformio.org/libraries/alteriom/painlessMesh
-- **Issue Tracker**: https://github.com/Alteriom/painlessMesh/issues
-- **Discussions**: https://github.com/Alteriom/painlessMesh/discussions
-
-## 📝 License
-
-This project is licensed under LGPL-3.0 - see the [LICENSE](https://github.com/Alteriom/painlessMesh/blob/main/LICENSE) file for details.
-
-## 🤝 Contributing
-
-We welcome contributions! Please see our [Contributing Guidelines](Contributing) for details on:
-- Code style and standards
-- Pull request process
-- Issue reporting
-- Feature requests
-
----
-
-**Need Help?** Check the [FAQ](https://github.com/Alteriom/painlessMesh/blob/main/docs/troubleshooting/faq.md) or [open an issue](https://github.com/Alteriom/painlessMesh/issues).

package/examples/alteriomImproved/alteriom_sensor_package.hpp

@@ -1,224 +0,0 @@
-#ifndef ALTERIOM_SENSOR_PACKAGE_HPP
-#define ALTERIOM_SENSOR_PACKAGE_HPP
-
-#include "painlessmesh/plugin.hpp"
-
-namespace alteriom {
-
-/**
- * @brief Sensor data package for broadcasting environmental measurements
- *
- * This package is designed for Alteriom's IoT sensor network requirements,
- * allowing nodes to share environmental data across the mesh.
- */
-class SensorPackage : public painlessmesh::plugin::BroadcastPackage {
- public:
-  double temperature = 0.0;  // Temperature in Celsius
-  double humidity = 0.0;     // Relative humidity percentage
-  double pressure = 0.0;     // Atmospheric pressure in hPa
-  uint32_t sensorId = 0;     // Unique sensor identifier
-  uint32_t timestamp = 0;    // Unix timestamp of measurement
-  uint8_t batteryLevel = 0;  // Battery level percentage
-
-  SensorPackage()
-      : BroadcastPackage(200) {}  // Type ID 200 for Alteriom sensors
-
-  SensorPackage(JsonObject jsonObj) : BroadcastPackage(jsonObj) {
-    temperature = jsonObj["temp"];
-    humidity = jsonObj["hum"];
-    pressure = jsonObj["press"];
-    sensorId = jsonObj["sid"];
-    timestamp = jsonObj["ts"];
-    batteryLevel = jsonObj["bat"];
-  }
-
-  JsonObject addTo(JsonObject&& jsonObj) const {
-    jsonObj = BroadcastPackage::addTo(std::move(jsonObj));
-    jsonObj["temp"] = temperature;
-    jsonObj["hum"] = humidity;
-    jsonObj["press"] = pressure;
-    jsonObj["sid"] = sensorId;
-    jsonObj["ts"] = timestamp;
-    jsonObj["bat"] = batteryLevel;
-    return jsonObj;
-  }
-
-#if ARDUINOJSON_VERSION_MAJOR < 7
-  size_t jsonObjectSize() const { return JSON_OBJECT_SIZE(noJsonFields + 6); }
-#endif
-};
-
-/**
- * @brief Command package for controlling Alteriom devices
- *
- * Single-destination package for sending specific commands to individual nodes.
- */
-class CommandPackage : public painlessmesh::plugin::SinglePackage {
- public:
-  uint8_t command = 0;        // Command type
-  uint32_t targetDevice = 0;  // Target device ID
-  TSTRING parameters = "";    // Command parameters as JSON string
-  uint32_t commandId = 0;     // Unique command identifier for tracking
-
-  CommandPackage() : SinglePackage(400) {}  // Type ID 201 for Alteriom commands
-
-  CommandPackage(JsonObject jsonObj) : SinglePackage(jsonObj) {
-    command = jsonObj["cmd"];
-    targetDevice = jsonObj["target"];
-    parameters = jsonObj["params"].as<TSTRING>();
-    commandId = jsonObj["cid"];
-  }
-
-  JsonObject addTo(JsonObject&& jsonObj) const {
-    jsonObj = SinglePackage::addTo(std::move(jsonObj));
-    jsonObj["cmd"] = command;
-    jsonObj["target"] = targetDevice;
-    jsonObj["params"] = parameters;
-    jsonObj["cid"] = commandId;
-    return jsonObj;
-  }
-
-#if ARDUINOJSON_VERSION_MAJOR < 7
-  size_t jsonObjectSize() const {
-    return JSON_OBJECT_SIZE(noJsonFields + 4) + parameters.length();
-  }
-#endif
-};
-
-/**
- * @brief Status report package for device health monitoring
- */
-class StatusPackage : public painlessmesh::plugin::BroadcastPackage {
- public:
-  uint8_t deviceStatus = 0;      // Device status flags
-  uint32_t uptime = 0;           // Device uptime in seconds
-  uint16_t freeMemory = 0;       // Free memory in KB
-  uint8_t wifiStrength = 0;      // WiFi signal strength
-  TSTRING firmwareVersion = "";  // Current firmware version
-
-  StatusPackage() : BroadcastPackage(202) {}  // Type ID 202 for Alteriom status
-
-  StatusPackage(JsonObject jsonObj) : BroadcastPackage(jsonObj) {
-    deviceStatus = jsonObj["status"];
-    uptime = jsonObj["uptime"];
-    freeMemory = jsonObj["mem"];
-    wifiStrength = jsonObj["wifi"];
-    firmwareVersion = jsonObj["fw"].as<TSTRING>();
-  }
-
-  JsonObject addTo(JsonObject&& jsonObj) const {
-    jsonObj = BroadcastPackage::addTo(std::move(jsonObj));
-    jsonObj["status"] = deviceStatus;
-    jsonObj["uptime"] = uptime;
-    jsonObj["mem"] = freeMemory;
-    jsonObj["wifi"] = wifiStrength;
-    jsonObj["fw"] = firmwareVersion;
-    return jsonObj;
-  }
-
-#if ARDUINOJSON_VERSION_MAJOR < 7
-  size_t jsonObjectSize() const {
-    return JSON_OBJECT_SIZE(noJsonFields + 5) + firmwareVersion.length();
-  }
-#endif
-};
-
-/**
- * @brief Enhanced status package with comprehensive health metrics (Phase 1)
- *
- * This is an extended version of StatusPackage that includes additional
- * mesh statistics, performance metrics, and alerting capabilities.
- * Type ID 203 is used to distinguish from the basic StatusPackage (202).
- */
-class EnhancedStatusPackage : public painlessmesh::plugin::BroadcastPackage {
- public:
-  // Device Health (from original StatusPackage)
-  uint8_t deviceStatus = 0;      // Device status flags
-  uint32_t uptime = 0;           // Device uptime in seconds
-  uint16_t freeMemory = 0;       // Free memory in KB
-  uint8_t wifiStrength = 0;      // WiFi signal strength
-  TSTRING firmwareVersion = "";  // Current firmware version
-  TSTRING firmwareMD5 = "";      // Firmware hash for OTA verification
-
-  // Mesh Statistics
-  uint16_t nodeCount = 0;         // Number of known nodes in mesh
-  uint8_t connectionCount = 0;    // Number of direct connections
-  uint32_t messagesReceived = 0;  // Total messages received
-  uint32_t messagesSent = 0;      // Total messages sent
-  uint32_t messagesDropped = 0;   // Total messages dropped/failed
-
-  // Performance Metrics
-  uint16_t avgLatency = 0;     // Average message latency in ms
-  uint8_t packetLossRate = 0;  // Packet loss rate percentage (0-100)
-  uint16_t throughput = 0;     // Network throughput in bytes/sec
-
-  // Warnings/Alerts
-  uint8_t alertFlags = 0;  // Bit flags for various alert conditions
-  TSTRING lastError = "";  // Last error message for diagnostics
-
-  EnhancedStatusPackage()
-      : BroadcastPackage(203) {}  // Type ID 203 for enhanced status
-
-  EnhancedStatusPackage(JsonObject jsonObj) : BroadcastPackage(jsonObj) {
-    deviceStatus = jsonObj["status"];
-    uptime = jsonObj["uptime"];
-    freeMemory = jsonObj["mem"];
-    wifiStrength = jsonObj["wifi"];
-    firmwareVersion = jsonObj["fw"].as<TSTRING>();
-    firmwareMD5 = jsonObj["fwMD5"].as<TSTRING>();
-
-    nodeCount = jsonObj["nodes"];
-    connectionCount = jsonObj["conns"];
-    messagesReceived = jsonObj["msgRx"];
-    messagesSent = jsonObj["msgTx"];
-    messagesDropped = jsonObj["msgDrop"];
-
-    avgLatency = jsonObj["latency"];
-    packetLossRate = jsonObj["loss"];
-    throughput = jsonObj["throughput"];
-
-    alertFlags = jsonObj["alerts"];
-    lastError = jsonObj["lastErr"].as<TSTRING>();
-  }
-
-  JsonObject addTo(JsonObject&& jsonObj) const {
-    jsonObj = BroadcastPackage::addTo(std::move(jsonObj));
-
-    // Device Health
-    jsonObj["status"] = deviceStatus;
-    jsonObj["uptime"] = uptime;
-    jsonObj["mem"] = freeMemory;
-    jsonObj["wifi"] = wifiStrength;
-    jsonObj["fw"] = firmwareVersion;
-    jsonObj["fwMD5"] = firmwareMD5;
-
-    // Mesh Statistics
-    jsonObj["nodes"] = nodeCount;
-    jsonObj["conns"] = connectionCount;
-    jsonObj["msgRx"] = messagesReceived;
-    jsonObj["msgTx"] = messagesSent;
-    jsonObj["msgDrop"] = messagesDropped;
-
-    // Performance Metrics
-    jsonObj["latency"] = avgLatency;
-    jsonObj["loss"] = packetLossRate;
-    jsonObj["throughput"] = throughput;
-
-    // Alerts
-    jsonObj["alerts"] = alertFlags;
-    jsonObj["lastErr"] = lastError;
-
-    return jsonObj;
-  }
-
-#if ARDUINOJSON_VERSION_MAJOR < 7
-  size_t jsonObjectSize() const {
-    return JSON_OBJECT_SIZE(noJsonFields + 18) + firmwareVersion.length() +
-           firmwareMD5.length() + lastError.length();
-  }
-#endif
-};
-
-}  // namespace alteriom
-
-#endif  // ALTERIOM_SENSOR_PACKAGE_HPP