@leonardojc/capacitor-ioboard 1.1.0

package/CapacitorIoboard.podspec

@@ -0,0 +1,13 @@
+Pod::Spec.new do |s|
+  s.name             = 'CapacitorIoboard'
+  s.version          = '1.0.0'
+  s.summary          = 'Capacitor plugin for controlling IOBOARD devices via RS485 serial communication'
+  s.license          = 'MIT'
+  s.homepage         = 'https://github.com/leonardojc/capacitor-ioboard'
+  s.author           = { 'Leonardo JC' => 'leonardojc@example.com' }
+  s.source           = { :git => 'https://github.com/leonardojc/capacitor-ioboard', :tag => s.version.to_s }
+  s.source_files     = 'ios/Plugin/**/*.{swift,h,m,c,cc,mm,cpp}'
+  s.ios.deployment_target  = '12.0'
+  s.dependency 'Capacitor'
+  s.swift_version = '5.1'
+end

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Leonardo JC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,292 @@
+# @leonardojc/capacitor-ioboard
+
+Capacitor plugin for controlling IOBOARD devices via RS485 serial communication.
+
+## Install
+
+```bash
+npm install @leonardojc/capacitor-ioboard
+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.
+
+```bash
+npm install @leonardojc/capacitor-serial-port
+```
+
+## Hardware Requirements
+
+- IOBOARD MTC3P08L device
+- Serial to RS485 adapter (transparent to the application)
+- Android device with USB OTG support or USB-to-serial adapter
+
+## API
+
+### Connection Management
+
+#### `openConnection(options)`
+
+Opens a serial connection with the specified parameters.
+
+```typescript
+import { CapacitorIoboard } from '@leonardojc/capacitor-ioboard';
+
+const result = await CapacitorIoboard.openConnection({
+  baudRate: 115200,
+  dataBits: 8,
+  stopBits: 1,
+  parity: 'none',
+  timeout: 5000
+});
+```
+
+**Parameters:**
+
+| 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)          |
+
+#### `closeConnection()`
+
+Closes the serial connection.
+
+```typescript
+const result = await CapacitorIoboard.closeConnection();
+```
+
+#### `isConnected()`
+
+Checks if a serial connection is active.
+
+```typescript
+const status = await CapacitorIoboard.isConnected();
+console.log('Connected:', status.connected);
+```
+
+### Device Control
+
+#### `queryStatus(options)`
+
+Queries the status of an IOBOARD device.
+
+```typescript
+const response = await CapacitorIoboard.queryStatus({ address: 1 });
+
+if (response.success && response.data) {
+  console.log('Door Lock Status:', response.data.doorLockStatus);
+  console.log('Software Version:', response.data.softwareVersion);
+}
+```
+
+**Parameters:**
+
+| Name    | Type   | Description                        |
+|---------|--------|------------------------------------|
+| address | number | IOBOARD address (1-63)             |
+
+**Response:**
+
+```typescript
+{
+  success: boolean;
+  message?: string;
+  data?: {
+    doorLockStatus: number; // 8-bit status (each bit represents a lock)
+    softwareVersion: {
+      major: number;
+      minor: number;
+      patch: number;
+    };
+  };
+}
+```
+
+#### `controlSinglePallet(options)`
+
+Controls a single pallet on the IOBOARD.
+
+```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
+  }
+});
+```
+
+**Parameters:**
+
+| 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            |
+
+#### `controlFullPallet(options)`
+
+Controls all pallets on the IOBOARD.
+
+```typescript
+const ledControls = Array(8).fill({
+  red: 0, green: 255, blue: 0,
+  intensity: 50, blinkTimes: 0, blinkSpeed: 0
+});
+
+const response = await CapacitorIoboard.controlFullPallet({
+  address: 1,
+  doorLockControl: 0xFF, // 8-bit mask (unlock all)
+  extendedControl: 0x00,
+  ledControls: ledControls
+});
+```
+
+**Parameters:**
+
+| 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 |
+
+### LED Control Options
+
+```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
+}
+```
+
+### OTA (Over-The-Air) Updates
+
+#### `otaNotification(options)`
+
+Sends an OTA update notification to the IOBOARD.
+
+```typescript
+const response = await CapacitorIoboard.otaNotification({
+  address: 1,
+  majorVersion: 1,
+  minorVersion: 1,
+  patchVersion: 0,
+  firmwareSize: 65536 // Size in bytes
+});
+```
+
+#### `otaData(options)`
+
+Sends an OTA data packet to the IOBOARD.
+
+```typescript
+const response = await CapacitorIoboard.otaData({
+  address: 1,
+  packetNumber: 0,
+  data: 'base64EncodedFirmwareData...' // Base64 encoded, max 128 bytes
+});
+```
+
+## Protocol Details
+
+The plugin implements the IOBOARD MTC3P08L communication 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)
+
+## Error Handling
+
+All methods return a response object with a `success` boolean field:
+
+```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);
+}
+```
+
+## Example Usage
+
+```typescript
+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;
+  }
+}
+```
+
+## License
+
+MIT
+
+## Author
+
+Leonardo JC - [@leonardojc](https://github.com/leonardojc)

package/android/build.gradle

@@ -0,0 +1,39 @@
+apply plugin: 'com.android.library'
+
+android {
+    namespace 'com.leonardojc.capacitor.ioboard'
+    compileSdkVersion project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 34
+    defaultConfig {
+        minSdkVersion project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 22
+        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 34
+        versionCode 1
+        versionName "1.0"
+        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
+    }
+    buildTypes {
+        release {
+            minifyEnabled false
+            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
+        }
+    }
+    lintOptions {
+        abortOnError false
+    }
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_1_8
+        targetCompatibility JavaVersion.VERSION_1_8
+    }
+}
+
+repositories {
+    google()
+    mavenCentral()
+}
+
+dependencies {
+    implementation fileTree(dir: 'libs', include: ['*.jar'])
+    implementation project(':capacitor-android')
+    testImplementation 'junit:junit:4.13.2'
+    androidTestImplementation 'androidx.test.ext:junit:1.1.5'
+    androidTestImplementation 'androidx.test.espresso:espresso-core:3.5.1'
+}

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+    
+    <!-- Permissions required for serial communication -->
+    <uses-permission android:name="android.permission.USB_PERMISSION" />
+    <uses-feature android:name="android.hardware.usb.host" android:required="false" />
+    
+</manifest>