Renault & Dacia Homey App v3.0

Modern, type-safe Homey app for Renault and Dacia electric vehicles built with TypeScript.

🎯 Features

• ✅ Full TypeScript support with strict type checking
• ✅ Homey SDK 4.x - Latest platform support
• ✅ Node.js 25+ - Modern JavaScript runtime
• ✅ TypeScript 7-ready - Future-proof module configuration
• ✅ Comprehensive test coverage with Jest
• ✅ Modern API client based on renault-api Python library
• ✅ Automatic token management and caching
• ✅ Model-specific capabilities detection
• ✅ Fallback mechanisms for API changes
• ✅ ESLint + Prettier for code quality

📦 Supported Vehicles

• Renault Zoe Phase 1 (X101VE)
• Renault Zoe Phase 2 (X102VE)
• Renault Megane E-Tech (XCB1VE)
• Dacia Spring (XBG1VE)
• Renault Kangoo EV (XJA1VP)

🚀 Quick Start

Prerequisites

• Node.js >= 25.0.0 (we recommend using nvm)
• Homey CLI: npm install -g homey

Installation

# Install dependencies
npm install

# Build TypeScript
npm run build

# Run tests
npm test

# Deploy to Homey
homey app run

🏗️ Project Structure

src/
├── api/                    # API client implementation
│   ├── renault-api-client.ts
│   └── __tests__/
├── config/                 # Configuration files
│   └── renault-config.ts
├── drivers/               # Homey device drivers
│   ├── renault-zoe/
│   └── dacia-spring/
└── types/                 # TypeScript type definitions
    └── renault-api.types.ts

📝 Available Scripts

npm run build           # Compile TypeScript
npm run watch           # Auto-rebuild on changes
npm test                # Run all tests
npm run test:watch      # Run tests in watch mode
npm run test:coverage   # Generate coverage report
npm run lint            # Check code quality
npm run lint:fix        # Fix linting issues
npm run format          # Format code with Prettier
npm run format:check    # Check code formatting
npm run type-check      # Type check without building
npm run clean           # Clean build artifacts
npm run validate        # Validate Homey app
npm run ci              # Run all checks (CI pipeline)

🧪 Testing

Tests are written using Jest with 50%+ coverage threshold:

# Run all tests
npm test

# Run specific test file
npm test -- renault-api-client.test.ts

# Coverage report
npm run test:coverage

� API Testing with Postman

A complete Postman collection is available in the postman/ directory for testing all Renault API endpoints:

• 🔐 Authentication flow (Gigya login, JWT tokens)
• 🚗 Vehicle data endpoints (battery, location, HVAC, etc.)
• 🎛️ Control commands (charge mode, climate control, etc.)
• 🌍 Pre-configured environments for 7+ countries

See postman/README.md for setup instructions.

�🛠️ Development Tools

• TypeScript 5.9 - Type safety with nodenext module resolution
• ESLint 9 - Code quality and consistency
• Prettier 3 - Automatic code formatting
• Jest 29 - Comprehensive testing framework
• EditorConfig - Consistent coding styles across editors

🔧 Configuration

Vehicle capabilities are automatically detected based on model code. The app supports multiple locales including:

• Sweden (sv-SE)
• Norway (nb-NO, no-NO)
• Denmark (da-DK)
• Finland (fi-FI)
• UK (en-GB)
• Germany (de-DE)
• France (fr-FR)
• Netherlands (nl-NL)
• Italy (it-IT)
• Spain (es-ES)

📖 Usage

1. Install the app on your Homey
2. Add a new device and select Renault/Dacia
3. Login with your My Renault credentials
4. Select your vehicle from the list (identified by VIN)
5. The app will sync battery status, location, charging state, etc.

Note: This app uses the unofficial Renault API which may change without notice. Updates will be made as quickly as possible if changes occur.

🆘 Troubleshooting

Having problems? Check these common issues:

"Another pair session is already active"

Solution: Restart the app in Homey settings or run homey app restart

"Wrong credentials" or authentication fails

Most common cause: Wrong locale/region selected!

Each country has different API keys. Using Swedish API key with Norwegian account will fail immediately.

Solution:

1. Default is now Norway (nb-NO). If you're in Sweden, Denmark, or Finland, you may need to change this in the code
2. Verify you can log in to my.renault.no (or your country's site)
3. Check that your account region matches the selected locale
4. See TROUBLESHOOTING.md for detailed debugging steps

Important: The authentication must follow exact API order:

1. Login → Get Account Info → Get JWT → Get Person Details

Wrong order will cause immediate failure. The app now follows correct Postman flow (v3.0+).

API errors or "not supported" messages

Some features depend on your vehicle model. Not all Renault/Dacia models support all features.

📖 Full troubleshooting guide: TROUBLESHOOTING.md

🧪 Test API manually: See postman/QUICKSTART.md

🤝 Contributing

1. Fork the repository
2. Create a feature branch
3. Write tests for new features
4. Ensure all tests pass
5. Submit a pull request

For detailed file structure and development guidelines, see FILE_GUIDE.md.

📄 License

LGPL-3.0-only

👥 Authors & Contributors

• Jonathan Cohen - Original app (jonathan@cohen.se)
• Oreste Dimaggio - Contributions (oreste@dimaggio.it)
• Reidar Gran - v3.0 TypeScript rewrite

🙏 Acknowledgments

Special thanks to:

• hacf-fr/renault-api - Python library inspiration
• jamesremuscat/pyze - Original API research
• Homey community for support and testing

📚 Documentation

• Renault API Documentation
• Homey Apps SDK3
• FILE_GUIDE.md - Detailed file structure guide