Experience our modern, interactive documentation with live search, mobile-friendly design, and copy-paste Arduino examples!

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

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

Our GitHub Wiki provides community-driven content that supplements the main documentation:

💡 Note: For complete documentation and getting started guides, visit our 📚 Modern Documentation Site

• 📖 Visit the Wiki - Community guides and tutorials
• 🤝 Community Guides - User-contributed content
• 📋 Wiki Integration Guide - How to contribute to the wiki

💡 Tip: For the most comprehensive and up-to-date documentation, start with our 📚 Live Documentation

• ✅ 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

• 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

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

Add to your platformio.ini:

lib_deps = 
    Alteriom/Alteriom_EByte_LoRa_E220@^1.0.0

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

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

#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);
}

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

# Build for all platforms
pio run

# Run tests
pio test

# Build specific platform
pio run -e esp32dev

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

Experience our modern, interactive documentation with:

✨ Beautiful responsive design - Works perfectly on desktop, tablet, and mobile
🔍 Live search - Find what you need instantly
💡 Interactive examples - Copy-paste ready Arduino code
🎯 Guided tutorials - Step-by-step instructions for every platform
📱 Mobile-friendly - Read docs anywhere, anytime
⚡ Fast loading - Optimized for quick access

This library features world-class documentation built with modern web technologies:

• 📚 Complete API Reference: Interactive documentation with live examples
• 🚀 Modern Web Interface: Beautiful, responsive design powered by Docsify
• 💡 Step-by-Step Guides: 8+ Arduino sketches with detailed explanations
• 🔧 Platform-Specific Setup: Tailored instructions for each supported platform
• ⚡ 5-Minute Quick Start: Get your first LoRa message working fast
• 🔍 Full-Text Search: Find any information instantly
• 📱 Mobile Optimized: Perfect experience on any device

Maximize battery life in your LoRa projects with Wake-on-Radio mode:

• 📡 WOR Documentation - Complete guide to power-saving techniques
• 💤 WOR Example - Send messages to sleeping devices
• ⏰ Wake from WOR - Receive and handle WOR messages
• Power Savings: Reduce power consumption from 100mA to <10μA in sleep mode
• Use Cases: Battery-powered sensors, remote monitoring, solar-powered nodes

Achieve maximum communication range (5-10km) with proper configuration:

• 📏 Range Optimization Guide - Maximize transmission distance
• 🔧 Configuration Guide - Optimize power, speed, and channel settings
• 📶 Wiring Guide - Proper antenna connections
• Key Factors:
  • Transmission Power: Up to 30dBm (1W) configurable
  • Air Data Rate: Lower rates = longer range (1.2kbps to 62.5kbps)
  • Antenna Quality: Use proper 50Ω antennas matched to frequency
  • Line of Sight: Clear path significantly improves range
  • Frequency Band: Choose appropriate band (433MHz, 868MHz, 915MHz)

Choose the right mode for your application:

• 🔄 Transparent Mode - Simple peer-to-peer communication

  • No address configuration needed
  • Broadcast to all devices on same channel
  • Best for: Simple point-to-point links

• 🎯 Fixed Mode - Addressed messaging with channel control

  • Target specific devices by address
  • Control channel and power per message
  • Best for: Complex networks, multiple nodes

• 📢 Broadcast Mode - One-to-many communication

  • Send to all devices simultaneously
  • Efficient for sensor networks
  • Best for: Environmental monitoring, alerts

Platform-specific guides for seamless integration:

• 🔷 Arduino Setup - Arduino UNO, Nano, Mega
• 🔶 ESP32 Setup - ESP32 with hardware serial
• 🔸 ESP8266 Setup - ESP8266 with software serial
• 📋 All Platforms - Complete platform guide (STM32, Pi Pico, SAMD)

• Frequency Bands: 433MHz, 868MHz, 915MHz (region-specific)
• Range: 5-10km line-of-sight, 1-2km urban environments
• Data Rates: 1.2kbps to 62.5kbps (configurable)
• Power Output: Up to 30dBm (1W) maximum
• Interface: UART (3.3V/5V compatible with level shifter)
• Current: 100mA TX, 15mA RX, <10μA sleep mode

• 📖 Complete API Reference - Every method documented with examples
• 🚀 5-Minute Quick Start - Get your first LoRa project working
• 📚 Examples Library - 8+ complete Arduino sketches
• 🔧 Platform Setup Guides - Arduino, ESP32, ESP8266, STM32, Pi Pico
• ⚙️ Configuration Guide - Optimize for your application
• 🛠️ Troubleshooting - Solutions to common issues
• 📊 Performance Optimization - Maximize range and efficiency
• 🔒 Security Guide - Encryption and secure communication

• ✅ 100% API Coverage: Every method documented with examples
• ✅ Multi-Platform: Arduino, ESP32, STM32, Pi Pico specific notes
• ✅ Real Examples: Working code for every major feature
• ✅ Error Handling: Comprehensive status codes and recovery
• ✅ Performance Data: Range testing and power consumption
• ✅ Auto-Generated: Always up-to-date with latest code changes

Documentation is automatically updated on every code change:

View Latest: https://alteriom.github.io/EByte_LoRa_E220_Series_Library/

For a comprehensive list of all documentation resources, including LoRa-specific guides, see: 📚 Documentation Index - Complete documentation reference with categorized links

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

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

• 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

• 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!