smartplant 0.1.0 → 0.1.2

package/README.md

@@ -1,7 +1,8 @@
-SmartPlant README
 
 # SmartPlant
 
+![banner](docs/banner.png)
+
 **SmartPlant** is a pioneering library designed for plant care with AI technology, aimed at integrating automated alerts with multi-language support. This standard prototype library is crafted for intelligent devices that manage plant care, enhancing the level of interaction and intelligence between plants and their owners. The core idea behind SmartPlant is to pave the way for advancements in plant care technology. It serves as a foundation for developing more sophisticated solutions and experimenting with innovative devices that cater to the needs of plants. By leveraging this library, developers can contribute to evolving the ecosystem of smart plant care.
 
 ## Features

package/comingsoon.js

@@ -0,0 +1,6 @@
+console.log(`COMING SOON!!
+View development progress at https://github.com/pigeonposse/smartplant
+
+Funding: https://github.com/sponsors/pigeonposse
+Repo: https://github.com/pigeonposse/smartplant    
+`)

package/package.json

@@ -1,116 +1,114 @@
 {
-    "name": "smartplant",
-    "version": "0.1.0",
-    "description": "A library for managing plant care with alerts and multi-language support.",
-    "main": "index.js",
-    "type": "module",
-
-    "dependencies": {
-        "@serialport/parser-readline": "^12.0.0",
-        "axios": "^1.7.7",
-        "chalk": "^5.3.0",
-        "enquirer": "^2.4.1",
-        "nodemailer": "^6.9.15",
-        "readline": "^1.3.0",
-        "serialport": "^12.0.0"
-    },
-    "keywords": [
-        "plant",
-        "care",
-        "alerts",
-        "multi-language",
-        "smart",
-        "AI",
-        "intelligence",
-        "npm",
-        "library"
-    ],
-    "author": "Alejo Malia <alejomalia@gmail.com>",
-    "files": [
-        "./README.md"
-    ],
-    "packageManager": "pnpm@9.7.0",
-    "publishConfig": {
-		"access": "public",
-		"registry": "https://registry.npmjs.org/"
-	},
-    "homepage": "https://github.com/pigeonposse/personality",
-	"repository": {
-		"type": "git",
-		"url": "https://github.com/pigeonposse/personality"
-	},
-    "funding": {
+  "name": "smartplant",
+  "version": "0.1.2",
+  "description": "A library for managing plant care with alerts and multi-language support.",
+  "main": "comingsoon.js",
+  "type": "module",
+  "dependencies": {
+    "@serialport/parser-readline": "^12.0.0",
+    "axios": "^1.7.7",
+    "chalk": "^5.3.0",
+    "enquirer": "^2.4.1",
+    "nodemailer": "^6.9.15",
+    "readline": "^1.3.0",
+    "serialport": "^12.0.0"
+  },
+  "keywords": [
+    "plant",
+    "care",
+    "alerts",
+    "multi-language",
+    "smart",
+    "AI",
+    "intelligence",
+    "npm",
+    "library"
+  ],
+  "author": "Alejo Malia <alejomalia@gmail.com>",
+  "files": [
+    "./README.md"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "homepage": "https://github.com/pigeonposse/smartplant",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/pigeonposse/smartplant"
+  },
+  "funding": {
     "type": "individual",
     "url": "https://pigeonposse.com/?popup=donate"
+  },
+  "bugs": {
+    "url": "https://github.com/pigeonposse/smartplant/issues",
+    "email": "dev@pigeonposse.com"
+  },
+  "license": "GPL-3.0",
+  "devDependencies": {
+    "@backan/builder": "0.0.16",
+    "@changesets/changelog-github": "0.5.0",
+    "@changesets/cli": "2.27.8",
+    "@commitlint/cli": "19.5.0",
+    "@pigeon-posse/eslint-config": "1.0.1",
+    "@typescript-eslint/eslint-plugin": "8.2.0",
+    "@typescript-eslint/parser": "8.2.0",
+    "commitizen": "4.3.0",
+    "commitlint-config-gitmoji": "2.3.1",
+    "cz-customizable": "7.2.1",
+    "cz-emoji": "1.3.2-canary.2",
+    "eslint": "8.57.0",
+    "git-cz": "4.9.0",
+    "eslint-plugin-align-assignments": "1.1.2",
+    "eslint-plugin-align-import": "1.0.0",
+    "eslint-plugin-canonical": "5.0.0",
+    "eslint-plugin-html": "7.1.0",
+    "eslint-plugin-import": "2.29.1",
+    "eslint-plugin-jsdoc": "46.10.1",
+    "eslint-plugin-json": "3.1.0",
+    "eslint-plugin-jsonc": "2.13.0",
+    "eslint-plugin-markdownlint": "0.5.0",
+    "eslint-plugin-package-json": "0.12.2",
+    "eslint-plugin-promise": "6.1.1",
+    "eslint-plugin-yaml": "0.5.0",
+    "typescript": "5.6.2",
+    "vite": "^5.4.4"
+  },
+  "commitlint": {
+    "extends": [
+      "gitmoji"
+    ],
+    "rules": {
+      "header-max-length": [
+        0,
+        "always",
+        100
+      ]
+    }
+  },
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/cz-customizable"
     },
-    "bugs": {
-        "url": "https://github.com/pigeonposse/personality/issues",
-        "email": "dev@pigeonposse.com"
-    },
-    "scripts": {
-        "start": "node index.js",
-		"update-version": "changeset && changeset version",
-		"push": "git add . && cz && git push -f origin $@",
-		"push:main": "pnpm push main"
-	},
-    "license": "GPL-3.0",
-    "devDependencies": {
-        "@backan/builder": "0.0.16",
-        "@changesets/changelog-github": "0.5.0",
-        "@changesets/cli": "2.27.8",
-        "@commitlint/cli": "19.5.0",
-        "@pigeon-posse/eslint-config": "1.0.1",
-        "@typescript-eslint/eslint-plugin": "8.2.0",
-        "@typescript-eslint/parser": "8.2.0",
-        "commitizen": "4.3.0",
-        "commitlint-config-gitmoji": "2.3.1",
-        "cz-customizable": "7.2.1",
-        "cz-emoji": "1.3.2-canary.2",
-        "eslint": "8.57.0",
-        "git-cz": "4.9.0",
-        "eslint-plugin-align-assignments": "1.1.2",
-        "eslint-plugin-align-import": "1.0.0",
-        "eslint-plugin-canonical": "5.0.0",
-        "eslint-plugin-html": "7.1.0",
-        "eslint-plugin-import": "2.29.1",
-        "eslint-plugin-jsdoc": "46.10.1",
-        "eslint-plugin-json": "3.1.0",
-        "eslint-plugin-jsonc": "2.13.0",
-        "eslint-plugin-markdownlint": "0.5.0",
-        "eslint-plugin-package-json": "0.12.2",
-        "eslint-plugin-promise": "6.1.1",
-        "eslint-plugin-yaml": "0.5.0",
-        "typescript": "5.6.2",
-        "vite": "^5.4.4"
-    },
-	"commitlint": {
-		"extends": [
-			"gitmoji"
-		],
-		"rules": {
-			"header-max-length": [
-				0,
-				"always",
-				100
-			]
-		}
-	},
-	"config": {
-		"commitizen": {
-			"path": "./node_modules/cz-customizable"
-		},
-		"cz-customizable": {
-			"config": ".dev/cz-config.cjs"
-		}
-	},
-    "extra": {
-        "scopes": [
-            {
-                "name": "lib"
-            },
-			{
-				"name": "all"
-			}
-        ]
+    "cz-customizable": {
+      "config": ".dev/cz-config.cjs"
     }
-}
+  },
+  "extra": {
+    "scopes": [
+      {
+        "name": "lib"
+      },
+      {
+        "name": "all"
+      }
+    ]
+  },
+  "scripts": {
+    "start": "node index.js",
+    "update-version": "changeset && changeset version",
+    "push": "git add . && cz && git push -f origin $@",
+    "push:main": "pnpm push main"
+  }
+}

package/index.js

@@ -1,314 +0,0 @@
-import { execSync } from 'child_process';
-import { prompt } from 'enquirer';
-import path from 'path';
-import fs from 'fs'
-import { fileURLToPath } from 'url';
-import { dirname } from 'path';
-
-// Get the directory name of the current module
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = dirname(__filename);
-// Load messages based on selected language
-function loadMessages(language) {
-    const languageFile = path.join(__dirname, `language/messages-${language}.json`);
-    try {
-        return JSON.parse(fs.readFileSync(languageFile, 'utf8'));
-    } catch (error) {
-        console.error(`Error loading language file: ${error.message}`);
-        return JSON.parse(fs.readFileSync(path.join(__dirname, 'language/messages-en.json'), 'utf8')); // Fallback to English
-    }
-}
-
-class PlantInfoGenerator {
-    async generatePlantInfo(name, type) {
-        try {
-            const info = await this.fetchInfoFromAI(name, type);
-            return info;
-        } catch (error) {
-            console.error(`Error generating plant info: ${error.message}`);
-            return {
-                description: 'No description available.',
-                characteristics: 'No characteristics available.',
-                moisture: { ideal: 50, min: 30, max: 70 },
-                light: { ideal: 500, min: 200, max: 800 },
-                temperature: { ideal: 22, min: 15, max: 30 }
-            };
-        }
-    }
-
-    async fetchInfoFromAI(name, type) {
-        // Simulated AI response. Replace with actual AI interaction or API call.
-        return new Promise((resolve) => {
-            setTimeout(() => {
-                const info = {
-                    description: `The ${name} is a ${type === 'indoor' ? 'popular indoor' : 'common outdoor'} plant, known for its ${type === 'indoor' ? 'air-purifying qualities' : 'resilience to various weather conditions'}.`,
-                    characteristics: `${name} typically has ${type === 'indoor' ? 'glossy, dark green leaves' : 'vibrant flowers and sturdy stems'}. It's ${type === 'indoor' ? 'well-suited for low-light environments' : 'adaptable to different soil types'}.`,
-                    moisture: {
-                        ideal: type === 'indoor' ? 60 : 40,
-                        min: type === 'indoor' ? 40 : 20,
-                        max: type === 'indoor' ? 80 : 60
-                    },
-                    light: {
-                        ideal: type === 'indoor' ? 400 : 700,
-                        min: type === 'indoor' ? 200 : 500,
-                        max: type === 'indoor' ? 600 : 900
-                    },
-                    temperature: {
-                        ideal: type === 'indoor' ? 22 : 25,
-                        min: type === 'indoor' ? 18 : 15,
-                        max: type === 'indoor' ? 26 : 35
-                    }
-                };
-                resolve(info);
-            }, 1000);
-        });
-    }
-}
-
-class SmartPlant {
-    constructor() {
-        this.apiKey = null;
-        this.plantType = null;
-        this.plantName = '';
-        this.alerts = {};
-        this.language = 'en';
-        this.messages = null;
-        this.sensors = {
-            moisture: null,
-            light: null,
-            temperature: null
-        };
-        this.plantInfo = null;
-        this.plantInfoGenerator = new PlantInfoGenerator();
-    }
-
-    async init() {
-        this.messages = loadMessages(this.language);
-    }
-
-    async setLanguage(language) {
-        this.language = language;
-        this.messages = loadMessages(this.language);
-    }
-
-    welcome() {
-        console.log(this.messages.general.welcome);
-    }
-
-    async start() {
-        await this.init();
-        this.welcome();
-        await this.selectLanguage();
-        await this.selectPlatform();
-        await this.selectInputMethod();
-        await this.selectPlantType();
-        await this.setPlantName();
-        await this.generatePlantInfo();
-        await this.setupSensors();
-        this.setupAlerts();
-        this.activateAlerts();
-        this.startMonitoring();
-    }
-
-    async selectLanguage() {
-        const response = await prompt({
-            type: 'select',
-            name: 'language',
-            message: 'Select language:',
-            choices: [
-                { name: 'en', message: 'English' },
-                { name: 'es', message: 'Español' },
-                { name: 'fr', message: 'Français' },
-                { name: 'de', message: 'Deutsch' },
-                { name: 'it', message: 'Italiano' },
-                { name: 'pt', message: 'Português' },
-                { name: 'nl', message: 'Nederlands' },
-                { name: 'ru', message: 'Русский' },
-                { name: 'zh', message: '中文' },
-                { name: 'ja', message: '日本語' }
-            ]
-        });
-
-        await this.setLanguage(response.language);
-    }
-
-    async selectPlatform() {
-        const response = await prompt({
-            type: 'select',
-            name: 'platform',
-            message: this.messages.general.selectPlatform,
-            choices: [
-                { name: 'raspberry', message: 'Raspberry Pi' },
-                { name: 'arduino', message: 'Arduino' }
-            ]
-        });
-
-        this.platform = response.platform;
-    }
-
-    async selectInputMethod() {
-        const response = await prompt({
-            type: 'select',
-            name: 'method',
-            message: this.messages.general.selectInputMethod,
-            choices: [
-                { name: 'local', message: this.messages.general.local },
-                { name: 'extern', message: this.messages.general.external }
-            ]
-        });
-
-        if (response.method === 'local') {
-            console.log(this.messages.general.localSelected);
-            const aiDetector = new AIDetector();
-            const aiModels = await aiDetector.detectAI();
-            if (aiModels) {
-                const modelResponse = await prompt({
-                    type: 'select',
-                    name: 'model',
-                    message: this.messages.general.selectAIModel,
-                    choices: aiModels.models
-                });
-                console.log(this.messages.general.selectedAIModel.replace('{model}', modelResponse.model));
-            } else {
-                console.log(this.messages.general.noLocalAI);
-            }
-        } else if (response.method === 'extern') {
-            console.log(this.messages.general.externSelected);
-            const apiKeyResponse = await prompt({
-                type: 'password',
-                name: 'apiKey',
-                message: this.messages.general.enterAPIKey
-            });
-            this.apiKey = apiKeyResponse.apiKey;
-        } else {
-            console.log(this.messages.general.invalidMethod);
-        }
-    }
-
-    async selectPlantType() {
-        const response = await prompt({
-            type: 'select',
-            name: 'type',
-            message: this.messages.general.selectPlantType,
-            choices: [
-                { name: 'indoor', message: this.messages.general.indoor },
-                { name: 'outdoor', message: this.messages.general.outdoor }
-            ]
-        });
-
-        if (['indoor', 'outdoor'].includes(response.type)) {
-            this.plantType = response.type;
-        } else {
-            console.log(this.messages.general.invalidType);
-        }
-    }
-
-    async setPlantName() {
-        const response = await prompt({
-            type: 'input',
-            name: 'name',
-            message: this.messages.general.enterPlantName
-        });
-        this.plantName = response.name;
-        console.log(this.messages.general.plantNameSet.replace('{name}', this.plantName));
-    }
-
-    async generatePlantInfo() {
-        console.log(this.messages.general.generatingPlantInfo);
-        try {
-            this.plantInfo = await this.plantInfoGenerator.generatePlantInfo(this.plantName, this.plantType);
-            console.log(this.formatPlantInfo(this.plantInfo));
-        } catch (error) {
-            console.error(`Error generating plant info: ${error.message}`);
-        }
-    }
-
-    formatPlantInfo(data) {
-        return `
-📋 Description: ${data.description}
-🔍 Characteristics: ${data.characteristics}
-💧 Moisture level: Ideal ${data.moisture.ideal}%, Range ${data.moisture.min}%-${data.moisture.max}%
-🌞 Light level: Ideal ${data.light.ideal} lux, Range ${data.light.min}-${data.light.max} lux
-🌡️ Temperature range: Ideal ${data.temperature.ideal}°C, Range ${data.temperature.min}-${data.temperature.max}°C
-        `;
-    }
-
-    async setupSensors() {
-        console.log(this.messages.general.settingUpSensors);
-        // Initialize sensors based on plant info
-        this.sensors.moisture = this.plantInfo.moisture.ideal + (Math.random() - 0.5) * 10;
-        this.sensors.light = this.plantInfo.light.ideal + (Math.random() - 0.5) * 100;
-        this.sensors.temperature = this.plantInfo.temperature.ideal + (Math.random() - 0.5) * 2;
-        console.log(this.messages.general.sensorsReady);
-    }
-
-    setupAlerts() {
-        this.alerts = {
-            moisture: { min: this.plantInfo.moisture.min, max: this.plantInfo.moisture.max },
-            light: { min: this.plantInfo.light.min, max: this.plantInfo.light.max },
-            temperature: { min: this.plantInfo.temperature.min, max: this.plantInfo.temperature.max }
-        };
-        console.log(this.messages.general.alertsConfigured);
-    }
-
-    activateAlerts() {
-        console.log(this.messages.general.alertsActivated);
-    }
-
-    startMonitoring() {
-        console.log(this.messages.general.startingMonitoring);
-        setInterval(() => this.checkPlantStatus(), 5000); // Check every 5 seconds
-    }
-
-    checkPlantStatus() {
-        console.log(this.messages.general.checkingStatus);
-        this.updateSensorData();
-        this.checkAlerts();
-    }
-
-    updateSensorData() {
-        // Simulate sensor data changes
-        this.sensors.moisture += (Math.random() - 0.5) * 5;
-        this.sensors.light += (Math.random() - 0.5) * 50;
-        this.sensors.temperature += (Math.random() - 0.5) * 2;
-
-        // Ensure values stay within realistic ranges
-        this.sensors.moisture = Math.max(0, Math.min(100, this.sensors.moisture));
-        this.sensors.light = Math.max(0, Math.min(1000, this.sensors.light));
-        this.sensors.temperature = Math.max(0, Math.min(50, this.sensors.temperature));
-    }
-
-    checkAlerts() {
-        for (const [sensor, value] of Object.entries(this.sensors)) {
-            if (value < this.alerts[sensor].min) {
-                console.log(this.messages.alerts[sensor].low.replace('{value}', value.toFixed(2)));
-            } else if (value > this.alerts[sensor].max) {
-                console.log(this.messages.alerts[sensor].high.replace('{value}', value.toFixed(2)));
-            }
-        }
-    }
-}
-
-class AIDetector {
-    async detectAI() {
-        try {
-            const output = execSync('ollama list', { encoding: 'utf-8' });
-            const models = output.split('\n').filter(line => line.trim()).map(line => line.split(' ')[0]);
-            if (models.length > 0) {
-                return {
-                    name: 'ollama',
-                    models: models
-                };
-            }
-        } catch (error) {
-            console.error('Error detecting AI:', error.message);
-        }
-        return null;
-    }
-}
-
-// Initialize SmartPlant
-const smartPlant = new SmartPlant();
-smartPlant.start();
-
-export default SmartPlant