@leonardojc/capacitor-ioboard 1.2.7 → 2.0.0

package/README.md

@@ -1,292 +1,340 @@
-# @leonardojc/capacitor-ioboard
+# 🚀 IOBoard Plugin v2.0 - Integrated Serial + Protocol
 
-Capacitor plugin for controlling IOBOARD devices via RS485 serial communication.
+**@leonardojc/capacitor-ioboard v2.0.0** - Complete IOBoard control with integrated serial communication
 
-## Install
+## ✨ What's New in v2.0
+
+- **🔗 Integrated Serial Communication** - No need for separate serial plugin
+- **🎯 Simplified API** - Single plugin handles everything
+- **⚡ Real-time Events** - Connection state, data received, error handling
+- **🎨 Enhanced Color Control** - Predefined colors and custom RGB support
+- **🚀 Complete OTA Support** - Firmware updates with progress tracking
+- **🌐 Web Compatible** - Works in browser with simulation mode
+
+## 📦 Installation
 
 ```bash
-npm install @leonardojc/capacitor-ioboard
+npm install @leonardojc/capacitor-ioboard@2.0.0
 npx cap sync
 ```
 
-## Prerequisites
-
-This plugin requires the [@leonardojc/capacitor-serial-port](https://www.npmjs.com/package/@leonardojc/capacitor-serial-port) plugin for serial communication.
+## 🚀 Quick Start
 
-```bash
-npm install @leonardojc/capacitor-serial-port
-```
+```typescript
+import { ioboard } from '@leonardojc/capacitor-ioboard';
 
-## Hardware Requirements
+// Connect to device
+const result = await ioboard.connect('/dev/ttyS2', 115200);
 
-- IOBOARD MTC3P08L device
-- Serial to RS485 adapter (transparent to the application)
-- Android device with USB OTG support or USB-to-serial adapter
+// Unlock pallet with green color
+await ioboard.unlockPallet(1, 3, 'GREEN', {
+  intensity: 100,
+  blinkTimes: 3,
+  blinkSpeed: 2
+});
 
-## API
+// Set all pallets to red
+await ioboard.setAllPalletsColor(1, 'RED');
 
-### Connection Management
+// Get device status
+const status = await ioboard.getStatus(1);
+console.log(\`Firmware: \${status.status.firmwareVersion}\`);
+```
 
-#### `openConnection(options)`
+## 📚 Complete API Reference
 
-Opens a serial connection with the specified parameters.
+### 🔌 Connection Methods
 
+#### `connect(portPath?, baudRate?)`
+Connect to IOBoard device
 ```typescript
-import { CapacitorIoboard } from '@leonardojc/capacitor-ioboard';
-
-const result = await CapacitorIoboard.openConnection({
-  baudRate: 115200,
-  dataBits: 8,
-  stopBits: 1,
-  parity: 'none',
-  timeout: 5000
-});
+await ioboard.connect('/dev/ttyS2', 115200);
 ```
 
-**Parameters:**
+#### `disconnect()`
+Disconnect from device
+```typescript
+await ioboard.disconnect();
+```
 
-| Name         | Type                          | Default   | Description                    |
-|--------------|-------------------------------|-----------|--------------------------------|
-| baudRate     | number                        | 115200    | Baud rate for communication    |
-| dataBits     | number                        | 8         | Number of data bits            |
-| stopBits     | number                        | 1         | Number of stop bits            |
-| parity       | 'none' \| 'even' \| 'odd'     | 'none'    | Parity checking                |
-| flowControl  | 'none' \| 'hardware' \| 'software' | 'none' | Flow control method       |
-| timeout      | number                        | 5000      | Response timeout (ms)          |
+#### `isDeviceConnected()`
+Check connection status
+```typescript
+const status = await ioboard.isDeviceConnected();
+console.log(status.connected); // true/false
+```
 
-#### `closeConnection()`
+#### `listPorts()`
+List available serial ports
+```typescript
+const result = await ioboard.listPorts();
+console.log(result.ports); // ['/dev/ttyS0', '/dev/ttyS1', ...]
+```
 
-Closes the serial connection.
+### 🎮 IOBoard Device Methods
 
+#### `getStatus(address)`
+Get device status and information
 ```typescript
-const result = await CapacitorIoboard.closeConnection();
+const result = await ioboard.getStatus(1);
+console.log(result.status);
+// {
+//   address: 1,
+//   connected: true,
+//   firmwareVersion: "2.1.0",
+//   palletStates: [false, false, ...], // 8 pallets
+//   temperature: 25.5,
+//   voltage: 12.0,
+//   uptime: 86400
+// }
 ```
 
-#### `isConnected()`
+#### `unlockPallet(address, palletNumber, color, options?)`
+Unlock specific pallet with color and effects
+```typescript
+await ioboard.unlockPallet(1, 3, 'GREEN', {
+  intensity: 100,      // 0-100
+  blinkTimes: 3,       // Number of blinks (0 = solid)
+  blinkSpeed: 2        // Blink speed (1-5)
+});
 
-Checks if a serial connection is active.
+// Using custom RGB color
+await ioboard.unlockPallet(1, 5, { red: 255, green: 128, blue: 0 });
+```
 
+#### `setAllPalletsColor(address, color, options?)`
+Set color for all 8 pallets
 ```typescript
-const status = await CapacitorIoboard.isConnected();
-console.log('Connected:', status.connected);
+await ioboard.setAllPalletsColor(1, 'BLUE', {
+  intensity: 80,
+  blinkTimes: 0  // Solid color
+});
 ```
 
-### Device Control
+#### `controlMultipleLEDs(address, ledConfigs)`
+Control each pallet individually
+```typescript
+const configs = [
+  { color: 'RED', intensity: 100 },
+  { color: 'GREEN', intensity: 90 },
+  { color: 'BLUE', intensity: 80 },
+  { color: { red: 255, green: 128, blue: 0 }, intensity: 70 },
+  // ... up to 8 configurations
+];
+
+await ioboard.controlMultipleLEDs(1, configs);
+```
 
-#### `queryStatus(options)`
+### 🎨 Predefined Colors
 
-Queries the status of an IOBOARD device.
+Available color presets:
+- `RED`, `GREEN`, `BLUE`
+- `YELLOW`, `MAGENTA`, `CYAN`
+- `WHITE`, `OFF`
+- `ORANGE`, `PURPLE`, `PINK`, `LIME`
 
 ```typescript
-const response = await CapacitorIoboard.queryStatus({ address: 1 });
+// Using predefined colors
+await ioboard.unlockPallet(1, 0, 'PURPLE');
 
-if (response.success && response.data) {
-  console.log('Door Lock Status:', response.data.doorLockStatus);
-  console.log('Software Version:', response.data.softwareVersion);
-}
-```
-
-**Parameters:**
+// Using custom RGB
+await ioboard.unlockPallet(1, 1, { red: 128, green: 64, blue: 192 });
 
-| Name    | Type   | Description                        |
-|---------|--------|------------------------------------|
-| address | number | IOBOARD address (1-63)             |
+// Get available colors
+const colors = ioboard.getColorPresets();
+```
 
-**Response:**
+### 🚀 OTA Firmware Update
 
+#### `startOTAUpdate(address, fileName, fileSize)`
+Initialize OTA update process
 ```typescript
-{
-  success: boolean;
-  message?: string;
-  data?: {
-    doorLockStatus: number; // 8-bit status (each bit represents a lock)
-    softwareVersion: {
-      major: number;
-      minor: number;
-      patch: number;
-    };
-  };
-}
+await ioboard.startOTAUpdate(1, 'firmware.bin', 32768);
 ```
 
-#### `controlSinglePallet(options)`
-
-Controls a single pallet on the IOBOARD.
-
+#### `sendOTAData(address, packetNumber, data)`
+Send OTA data packet
 ```typescript
-const response = await CapacitorIoboard.controlSinglePallet({
-  address: 1,
-  palletNumber: 0,
-  doorLock: true, // true = unlock, false = no action
-  ledControl: {
-    red: 255,
-    green: 0,
-    blue: 0,
-    intensity: 100,
-    blinkTimes: 5,
-    blinkSpeed: 2
-  }
-});
+await ioboard.sendOTAData(1, 0, [0x48, 0x65, 0x6C, 0x6C, 0x6F]); // "Hello"
 ```
 
-**Parameters:**
+#### `performOTAUpdate(address, file, onProgress?)`
+Complete OTA update with progress callback
+```typescript
+const file = new File([firmwareData], 'firmware.bin');
 
-| Name         | Type              | Description                       |
-|--------------|-------------------|-----------------------------------|
-| address      | number            | IOBOARD address (1-63)            |
-| palletNumber | number            | Pallet number (0-7)               |
-| doorLock     | boolean           | true = unlock, false = no action  |
-| ledControl   | LEDControlOptions | LED control parameters            |
+await ioboard.performOTAUpdate(1, file, (progress, packet, total) => {
+  console.log(\`Progress: \${progress.toFixed(1)}% (\${packet}/\${total})\`);
+});
+```
 
-#### `controlFullPallet(options)`
+### 📡 Event Handling
 
-Controls all pallets on the IOBOARD.
+#### `addDataReceivedListener(callback)`
+Listen for data received from device
+```typescript
+await ioboard.addDataReceivedListener((event) => {
+  console.log('Data received:', event);
+});
+```
 
+#### `addConnectionStateListener(callback)`
+Listen for connection state changes
 ```typescript
-const ledControls = Array(8).fill({
-  red: 0, green: 255, blue: 0,
-  intensity: 50, blinkTimes: 0, blinkSpeed: 0
+await ioboard.addConnectionStateListener((event) => {
+  console.log(\`Connection: \${event.connected}\`);
 });
+```
 
-const response = await CapacitorIoboard.controlFullPallet({
-  address: 1,
-  doorLockControl: 0xFF, // 8-bit mask (unlock all)
-  extendedControl: 0x00,
-  ledControls: ledControls
+#### `addSerialErrorListener(callback)`
+Listen for serial communication errors
+```typescript
+await ioboard.addSerialErrorListener((event) => {
+  console.error('Serial error:', event.error);
 });
 ```
 
-**Parameters:**
+#### `removeAllListeners()`
+Remove all event listeners
+```typescript
+await ioboard.removeAllListeners();
+```
 
-| Name            | Type                | Description                    |
-|-----------------|---------------------|--------------------------------|
-| address         | number              | IOBOARD address (1-63)         |
-| doorLockControl | number              | 8-bit mask for door control    |
-| extendedControl | number              | Extended control byte          |
-| ledControls     | LEDControlOptions[] | Array of 8 LED control configs |
+## 🛠️ Utility Methods
 
-### LED Control Options
+#### `getConnectionInfo()`
+Get current connection information
+```typescript
+const info = ioboard.getConnectionInfo();
+console.log(info.isConnected, info.currentPort);
+```
 
+#### `createColor(red, green, blue)`
+Create RGB color object
 ```typescript
-interface LEDControlOptions {
-  red: number;        // 0-255
-  green: number;      // 0-255
-  blue: number;       // 0-255
-  intensity: number;  // 0-255 (0=off, 1-100=percentage, 101-255=max)
-  blinkTimes: number; // 0-255 (0=no blink, 255=infinite)
-  blinkSpeed: number; // 1-30 seconds interval
-}
+const orange = ioboard.createColor(255, 165, 0);
+await ioboard.unlockPallet(1, 0, orange);
 ```
 
-### OTA (Over-The-Air) Updates
+## 🌟 React Component Example
 
-#### `otaNotification(options)`
+```jsx
+import React, { useState, useEffect } from 'react';
+import { ioboard } from '@leonardojc/capacitor-ioboard';
 
-Sends an OTA update notification to the IOBOARD.
+const IOBoardController = () => {
+  const [isConnected, setIsConnected] = useState(false);
 
-```typescript
-const response = await CapacitorIoboard.otaNotification({
-  address: 1,
-  majorVersion: 1,
-  minorVersion: 1,
-  patchVersion: 0,
-  firmwareSize: 65536 // Size in bytes
-});
-```
+  useEffect(() => {
+    // Setup event listeners
+    ioboard.addConnectionStateListener((event) => {
+      setIsConnected(event.connected);
+    });
 
-#### `otaData(options)`
+    return () => {
+      ioboard.removeAllListeners();
+    };
+  }, []);
 
-Sends an OTA data packet to the IOBOARD.
+  const handleConnect = async () => {
+    const result = await ioboard.connect('/dev/ttyS2');
+    if (result.success) {
+      console.log('Connected successfully!');
+    }
+  };
 
-```typescript
-const response = await CapacitorIoboard.otaData({
-  address: 1,
-  packetNumber: 0,
-  data: 'base64EncodedFirmwareData...' // Base64 encoded, max 128 bytes
-});
+  const handleUnlockPallet = async (pallet) => {
+    await ioboard.unlockPallet(1, pallet, 'GREEN', {
+      intensity: 100,
+      blinkTimes: 3
+    });
+  };
+
+  return (
+    <div>
+      <button onClick={handleConnect} disabled={isConnected}>
+        {isConnected ? 'Connected' : 'Connect'}
+      </button>
+      
+      {isConnected && (
+        <div>
+          {[0,1,2,3,4,5,6,7].map(pallet => (
+            <button 
+              key={pallet} 
+              onClick={() => handleUnlockPallet(pallet)}
+            >
+              Unlock Pallet {pallet}
+            </button>
+          ))}
+        </div>
+      )}
+    </div>
+  );
+};
 ```
 
-## Protocol Details
+## 📋 MTC3P08L Protocol
 
-The plugin implements the IOBOARD MTC3P08L communication protocol:
+The plugin implements the complete MTC3P08L protocol:
 
-- **Baud Rate:** 115200 bps
-- **Data Format:** 8N1 (8 data bits, no parity, 1 stop bit)
-- **Frame Structure:** SOI (0x0D) + Address + FrameType + Data + CRC16 + EOI (0x0A)
-- **CRC:** CRC-16 CCITT checksum
-- **Address Range:** 1-63
-- **Response Timeout:** Configurable (default 5000ms)
+- **Device Status** - Get firmware version, temperature, voltage
+- **Pallet Control** - Individual pallet unlock with RGB LEDs
+- **Multiple Control** - Control all 8 pallets simultaneously  
+- **OTA Updates** - Complete firmware update support
+- **Error Handling** - Comprehensive error reporting
 
-## Error Handling
+## 🔧 Configuration
 
-All methods return a response object with a `success` boolean field:
+Default connection settings:
+- **Baud Rate**: 115200
+- **Data Bits**: 8
+- **Stop Bits**: 1
+- **Parity**: None
+- **Default Port**: '/dev/ttyS2'
 
-```typescript
-const response = await CapacitorIoboard.queryStatus({ address: 1 });
-
-if (response.success) {
-  console.log('Operation successful:', response.message);
-  // Use response.data if available
-} else {
-  console.error('Operation failed:', response.message);
-}
-```
+## 🌐 Platform Support
+
+- ✅ **Android** - Full native support
+- ✅ **iOS** - Full native support  
+- ✅ **Web** - Simulation mode for testing
 
-## Example Usage
+## 🆚 Migration from v1.x
 
+Version 2.0 is a complete rewrite with breaking changes:
+
+### Before (v1.x - Two plugins)
 ```typescript
+// Required two separate plugins
+import { CapacitorSerialPort } from '@leonardojc/capacitor-serial-port';
 import { CapacitorIoboard } from '@leonardojc/capacitor-ioboard';
 
-class IOBoardController {
-  async initialize() {
-    // Open serial connection
-    const connection = await CapacitorIoboard.openConnection({
-      baudRate: 115200,
-      timeout: 5000
-    });
-    
-    if (!connection.success) {
-      throw new Error('Failed to open connection');
-    }
-    
-    console.log('Connection established');
-  }
-
-  async unlockPallet(address: number, palletNumber: number) {
-    const response = await CapacitorIoboard.controlSinglePallet({
-      address,
-      palletNumber,
-      doorLock: true,
-      ledControl: {
-        red: 0, green: 255, blue: 0,    // Green light
-        intensity: 100,
-        blinkTimes: 3,
-        blinkSpeed: 1
-      }
-    });
-    
-    return response.success;
-  }
-
-  async getDeviceStatus(address: number) {
-    const response = await CapacitorIoboard.queryStatus({ address });
-    
-    if (response.success && response.data) {
-      return {
-        doorStatus: response.data.doorLockStatus,
-        version: response.data.softwareVersion
-      };
-    }
-    
-    return null;
-  }
-}
+// Complex coordination required
+await CapacitorSerialPort.connect({...});
+await CapacitorIoboard.unlockPallet({...});
+```
+
+### After (v2.0 - Single plugin)
+```typescript
+// Single integrated plugin
+import { ioboard } from '@leonardojc/capacitor-ioboard';
+
+// Simple, unified API
+await ioboard.connect('/dev/ttyS2');
+await ioboard.unlockPallet(1, 3, 'GREEN');
 ```
 
-## License
+## 🔗 Links
+
+- **NPM Package**: [@leonardojc/capacitor-ioboard](https://www.npmjs.com/package/@leonardojc/capacitor-ioboard)
+- **GitHub**: [IOBoard Plugin Repository](#)
+- **Documentation**: [Complete API Docs](#)
+
+## 📄 License
+
+MIT License - see LICENSE file for details.
 
-MIT
+---
 
-## Author
+### 🎉 IOBoard v2.0 - Simplified, Powerful, Complete!
 
-Leonardo JC - [@leonardojc](https://github.com/leonardojc)
+Single plugin, comprehensive control, zero hassle. Everything you need for IOBoard device integration.

package/android/build.gradle

@@ -33,7 +33,6 @@ repositories {
 dependencies {
     implementation fileTree(dir: 'libs', include: ['*.jar'])
     implementation project(':capacitor-android')
-    implementation project(':leonardojc-capacitor-serial-port')  // SerialPort plugin dependency
     testImplementation 'junit:junit:4.13.2'
     androidTestImplementation 'androidx.test.ext:junit:1.1.5'
     androidTestImplementation 'androidx.test.espresso:espresso-core:3.5.1'