Alteriom EByte LoRa E220 Series Library

This is the Alteriom fork of the EByte LoRa E220 Series Library, enhanced with modern CI/CD practices, automated releases, and improved package management.

🚀 What's New in the Alteriom Fork

• ✅ Automated CI/CD with GitHub Actions
• ✅ Automatic releases with semantic versioning
• ✅ Arduino Library Manager ready
• ✅ PlatformIO fully supported
• ✅ NPM package for MCP server integration
• ✅ Comprehensive testing across multiple platforms
• ✅ Enhanced documentation and examples

📋 Features

• Long Range Communication: 5-10km range with LLCC68 chipset
• Multi-Platform Support: Arduino, ESP32, ESP8266, STM32, Raspberry Pi Pico, SAMD
• Power Management: Wake-on-Radio (WOR) support for low power applications
• Flexible Communication: Transparent, fixed, and broadcast messaging modes
• RSSI Monitoring: Signal strength measurement and monitoring
• Easy Configuration: Simple API for device setup and management

🛠️ Installation

Arduino Library Manager

1. Open Arduino IDE
2. Go to Tools → Manage Libraries
3. Search for "Alteriom_EByte_LoRa_E220"
4. Click Install

PlatformIO

Add to your platformio.ini:

lib_deps = 
    Alteriom/Alteriom_EByte_LoRa_E220@^1.0.0

Manual Installation

1. Download the latest release from GitHub Releases
2. Extract to your Arduino libraries folder
3. Restart Arduino IDE

NPM Package (Node.js/MCP Integration)

NPM Registry (Public):

npm install alteriom-ebyte-lora-e220

GitHub Packages (Requires Authentication):

# Configure registry
echo "@alteriom:registry=https://npm.pkg.github.com" >> .npmrc
# Install package
npm install @alteriom/alteriom-ebyte-lora-e220

🔌 Quick Start

#include "Alteriom_EByte_LoRa_E220.h"

// Initialize with Serial pins (adjust for your board)
LoRa_E220 e220ttl(&Serial2, 15, 21, 19); // ESP32: RX, TX, AUX, M0, M1

void setup() {
    Serial.begin(9600);
    e220ttl.begin();
    
    // Get current configuration
    ResponseStructContainer c = e220ttl.getConfiguration();
    Configuration configuration = *(Configuration*) c.data;
    
    Serial.println("LoRa E220 initialized successfully!");
    c.close();
}

void loop() {
    // Send a message
    ResponseStatus rs = e220ttl.sendMessage("Hello from Alteriom LoRa!");
    
    delay(5000);
}

📚 Examples

The library includes comprehensive examples:

• 01_getConfiguration - Read device configuration
• 01_setConfiguration - Configure device parameters
• 02_sendTransparentTransmission - Simple message sending
• 04_sendFixedTransmission - Targeted message delivery
• 05_sendFixedTransmissionStructure - Send structured data
• 06_sendWORMessage - Wake-on-Radio messaging
• 07_receiveMessages - Message reception handling

🔧 Supported Platforms

| Platform | Framework | Status | |----------|-----------|--------| | Arduino UNO/Nano | Arduino | ✅ Tested | | ESP32 | Arduino/ESP-IDF | ✅ Tested | | ESP8266 | Arduino | ✅ Tested | | STM32 | Arduino/STM32Cube | ✅ Tested | | Raspberry Pi Pico | Arduino | ✅ Tested | | SAMD21/SAMD51 | Arduino | ✅ Tested |

🏗️ Building and Testing

PlatformIO

# Build for all platforms
pio run

# Run tests
pio test

# Build specific platform
pio run -e esp32dev

Arduino CLI

# Compile example
arduino-cli compile --fqbn esp32:esp32:esp32 examples/01_getConfiguration/

📖 Documentation

• Complete Documentation - Full documentation structure
• Original Technical Docs - Complete technical documentation
• API Reference - Detailed API documentation
• Examples Guide - Step-by-step examples
• Changelog - Version history and updates

🤝 Contributing

We welcome contributions! Please see our Contributing Guidelines for details.

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

📄 License

This project is licensed under the MIT License - see the LICENSE.md file for details.

🙏 Acknowledgments

• Renzo Mischianti - Original author and creator of the EByte LoRa E220 library
• Original Repository: xreef/EByte_LoRa_E220_Series_Library
• Alteriom Team - CI/CD enhancements and modern packaging

🔗 Links

• GitHub Repository: https://github.com/Alteriom/EByte_LoRa_E220_Series_Library
• Original Author's Website: https://www.mischianti.org
• Arduino Library Registry: Submit here
• PlatformIO Registry: View package

Ready to get started? Check out our Quick Start Guide and start building your LoRa projects today!