🔋 APIS - Autonomous Power Interchange System

Share energy like sharing WiFi - Connect your batteries and let communities power themselves

🎯 What is APIS?

APIS is an innovative open-source platform that enables Physical Peer-to-Peer (PP2P) energy sharing between distributed batteries in microgrids. By leveraging Variable Renewable Energy (VRE) sources, APIS builds resilient microgrids that enhance community self-sufficiency and reduce dependency on traditional centralized power generation.

🌟 Why This Matters

Imagine if your home battery could automatically share power with your neighbors when they need it, and get power back when you need it. That's exactly what APIS does!

• 💰 Save Money: Share excess solar power instead of selling it back to the grid at low prices
• 🔋 Stay Powered: Never run out of energy when your neighbors have extra
• 🌱 Go Green: Maximize renewable energy use in your community
• 🏠 Be Independent: Reduce reliance on big power companies
• 🛡️ Build Resilience: Keep communities powered during grid outages

Click here for more details about the research behind APIS.

🔧 How It Works

Physical Peer to Peer (PP2P) Energy Sharing

APIS achieves precise energy sharing between batteries using constant current control. This technology:

• ✅ Offsets energy shortages by delivering the necessary amount from surplus batteries
• ✅ Enables fixed-amount power transfers between specific users (batteries)
• ✅ Supports P2P energy trading based on energy amount and price conditions
• ✅ Works where voltage control fails - providing true peer-to-peer transactions

Autonomous Distributed Control

The same software is installed on every battery system, creating a truly decentralized network where:

• 🤖 Smart Decision Making: Each system makes autonomous trading decisions
• ⚙️ Flexible Conditions: Set different trading rules for each battery system
• 🕐 Dynamic Updates: Change conditions for each time window
• 📊 Custom Parameters: Configure energy amount, pricing, and timing preferences

🚀 Quick Start (5 Minutes)

Want to try it out? Here's how:

# 1. Get the code
git clone https://github.com/hyphae/APIS.git
cd APIS

# 2. Build everything  
make build

# 3. Start the system
make run

That's it! Now open your web browser and go to:

Starting Your First Energy Exchange

1. Access the Main Controller at http://0.0.0.0:4382/
2. Clear your browser cache (recommended for best performance)
3. Set Global Mode to "Run" to start energy exchange simulation

4. Watch the magic happen - energy will start flowing between simulated batteries automatically!

To stop the system:

make stop

🛠️ System Components

APIS consists of several interconnected software modules that work together seamlessly:

🔋 Core Components (Essential for Basic Operation)

🏢 Extended Services (For Advanced Users & Communities)

⚡ Real Hardware Integration (For Production Deployments)

💻 Installation Guide

🖥️ System Requirements

Tested Operating Systems:

• Ubuntu: 18.04, 20.04 ✅
• CentOS: 7, 8 ✅
• macOS: Catalina, Big Sur ✅

⚠️ Important: Virtual environments are not currently supported.

📋 Prerequisites

Before you start, make sure you have:

# Ubuntu/Debian systems:
sudo apt update
sudo apt install git make maven groovy python3-venv python3-pip

Also Required:

• Java Development Kit (JDK): Latest version
• Python: 3.6.9 or later
• SQLite: 3.8.3 or later (required for CentOS 7)

🚀 Installation Steps

1. Clone the Repository

git clone https://github.com/hyphae/APIS.git
cd APIS

2. Build All Components

make build

This downloads and compiles all necessary software - takes 5-10 minutes

3. Start the System

make run

4. Verify Installation

• Open http://0.0.0.0:4382/ in your browser
• You should see the APIS control panel
• All components should show as "Running" status

🔧 Troubleshooting

If you encounter issues:

• "Command not found" errors: Install all prerequisites first
• "make build" or "make run" fails: Open a new terminal and try again
• Port conflicts: Stop other web servers or restart your computer
• Permission issues: Check file permissions or try with appropriate privileges

📖 How to Use APIS

🎮 Basic Operations

Start the System:

make run

Monitor System Health:

• Check component status through the Main Controller interface
• Monitor energy flow patterns and transaction logs
• Review system performance metrics in the Service Center

Stop the System:

make stop

⚙️ Configuration

Energy Trading Setup:

1. Access the web interfaces to modify transaction parameters
2. Adjust energy trading conditions per time window
3. Configure battery system preferences and constraints
4. Set pricing rules and availability schedules

System Monitoring:

• Real-time energy flow visualization
• Transaction history and analytics
• Performance metrics and system health
• Community-wide energy balance reports

🌍 Key Benefits

For Homeowners 🏠

• 💰 Lower Bills: Reduce electricity costs significantly
• 🔋 Backup Power: Access community energy when your battery runs low
• 🤖 Fully Automatic: Set preferences once, let APIS handle everything
• 📱 Easy Monitoring: Simple web interface accessible from any device

For Communities 🏘️

• 🌱 Environmental Impact: Maximize clean energy use and reduce carbon footprint
• 🛡️ Disaster Resilience: Keep power flowing during grid outages and emergencies
• 💼 Economic Benefits: Keep energy money in the community
• 🏠 Energy Independence: Reduce reliance on big power companies

For Developers 👨‍💻

• 🔓 Open Source: Free to use and modify under Apache License 2.0
• 📚 Well Documented: Comprehensive guides and API references
• 🤝 Active Community: Get help and contribute back
• ✅ Proven Technology: Already working in real installations worldwide

🤝 Contributing

We welcome contributions from the community! Here's how you can help:

🌟 Ways to Contribute

Even if you're not a programmer:

• 📝 Improve documentation (fix typos, add examples)
• 🧪 Test new features and report bugs
• 🗣️ Help answer questions in forums
• 📢 Share your APIS success stories

If you code:

• 🐛 Fix bugs and improve stability
• ⚡ Add new features and capabilities
• 🔧 Create better tools and interfaces
• 📊 Improve performance and efficiency

If you're a hardware person:

• 🔌 Create drivers for new battery systems
• ⚙️ Design better integration methods
• 📐 Contribute hardware compatibility guides
• 🛠️ Help with installation and setup

🚀 Getting Started

1. Fork the Repository: Create your own fork of the APIS project
2. Create Feature Branch: git checkout -b feature/your-feature-name
3. Make Changes: Implement your improvements or fixes
4. Test Thoroughly: Ensure all tests pass and functionality works
5. Submit Pull Request: Describe your changes and their benefits

📋 Contribution Guidelines

• Follow existing code style and conventions
• Include comprehensive tests for new features
• Update documentation for any API changes
• Provide clear commit messages and PR descriptions

🆘 Getting Help & Support

🔍 Self-Service Options

• 📖 Documentation: Most questions answered in our comprehensive guides
• 🔍 GitHub Issues: Search existing problems and solutions
• 💬 Community Forums: Ask and answer questions with other users

📞 Direct Support

• 🐛 Bug Reports: Create a GitHub issue for bug reports
• 💡 Feature Requests: Suggest improvements through GitHub issues
• 🔒 Security Issues: Contact maintainers directly for sensitive matters

📄 License & Legal

APIS is released under the Apache License Version 2.0

What this means for you:

• ✅ Use it for free, forever
• ✅ Modify it however you want
• ✅ Use it in commercial products
• ✅ No fees or royalties
• ✅ Patent protection included

What you need to do:

• 📋 Include the license notice if you redistribute
• 📋 Note any changes you make
• 📋 That's pretty much it!

See the LICENSE file for all legal details.
See the NOTICE for additional notices.

🎯 What's Next for APIS

🔜 Coming Soon

• 📱 Mobile App: Control APIS from your smartphone
• ☁️ Cloud Integration: Connect with major cloud platforms
• 🤖 AI Optimization: Smarter energy trading decisions
• 🔌 More Hardware: Support for additional battery brands

🚀 Long-Term Vision

• 🌐 Global Network: Connect APIS communities worldwide
• 🌱 Carbon Credits: Automatic environmental impact tracking
• 💹 Dynamic Pricing: Real-time energy market integration
• 👥 Peer Review: Community-driven system improvements

🏁 Ready to Get Started?

Choose your path:

🏠 For Homeowners

Try the Quick Start guide above and start saving on your energy bills today!

👨‍💻 For Developers

Explore the system components and documentation to start building energy applications.

🏘️ For Communities

Set up APIS for your neighborhood and bring energy independence to your community.

🎓 For Researchers

Contribute to the future of distributed energy systems through APIS development and research.

Made with ❤️ by the APIS Community - Powering the future, one battery at a time.